Murl::IGameControllerMapping::AxisMapping Class Reference

The raw axis mapping. More...

#include "murl_i_game_controller_mapping.h"

Public Member Functions

 AxisMapping ()
 The default constructor.
 
 AxisMapping (AxisType axisType, Float rangeStart, Float rangeEnd, AxisEvent destinationEvent)
 Constructor taking initialization values. More...
 
bool operator== (const AxisMapping &rhs) const
 The "equal to" comparison operator. More...
 
bool operator!= (const AxisMapping &rhs) const
 The "not equal to" comparison operator. More...
 

Public Attributes

AxisType mAxisType
 The axis type to read the raw value from.
 
Float mRangeStart
 The axis raw data range start value. More...
 
Float mRangeEnd
 The axis raw data range end value. More...
 
AxisEvent mDestinationEvent
 The destination axis event to post the scaled axis value.
 

Detailed Description

The raw axis mapping.

Describes how to map the axis raw data to a game controller axis event.

Constructor & Destructor Documentation

◆ AxisMapping()

Murl::IGameControllerMapping::AxisMapping::AxisMapping ( AxisType  axisType,
Float  rangeStart,
Float  rangeEnd,
AxisEvent  destinationEvent 
)
inline

Constructor taking initialization values.

Parameters
axisTypeThe axis type to read the raw value from.
rangeStartThe axis raw data range start value. Represents the raw data value for the lowest destination value.
rangeEndThe axis raw data range end value. Represents the raw data value for the highest destination value.
destinationEventThe destination axis event to post the scaled axis value.

Member Function Documentation

◆ operator==()

bool Murl::IGameControllerMapping::AxisMapping::operator== ( const AxisMapping rhs) const
inline

The "equal to" comparison operator.

Parameters
rhsThe right hand side raw axis mapping to compare.
Returns
true if all members are exactly the same.

References mAxisType, mDestinationEvent, mRangeEnd, and mRangeStart.

◆ operator!=()

bool Murl::IGameControllerMapping::AxisMapping::operator!= ( const AxisMapping rhs) const
inline

The "not equal to" comparison operator.

Parameters
rhsThe right hand side raw axis mapping to compare.
Returns
true if the objects differ.

References mAxisType, mDestinationEvent, mRangeEnd, and mRangeStart.

Member Data Documentation

◆ mRangeStart

Float Murl::IGameControllerMapping::AxisMapping::mRangeStart

The axis raw data range start value.

Represents the raw data value for the lowest destination value.

Referenced by operator!=(), and operator==().

◆ mRangeEnd

Float Murl::IGameControllerMapping::AxisMapping::mRangeEnd

The axis raw data range end value.

Represents the raw data value for the highest destination value.

Referenced by operator!=(), and operator==().


The documentation for this class was generated from the following file:
  • murl_i_game_controller_mapping.h


Copyright © 2011-2018 Spraylight GmbH.