The DtGameControlInformation class contains information about how a function within a function group should be processed once active. More...

Classes
struct	GameControlEvent

Public Types
enum	GameControllerFlags { TransitionUp = 0x00000001, TransitionDown = 0x00000002, Repeat = 0x00000004, ResetToZeroOnRelease = 0x00000008, Reverse = 0x00000010, Toggle = 0x00000020, SetTo = 0x00000040 }

typedef std::vector < GameControlEvent >	GameControlEvents

Public Member Functions
	DtGameControlInformation ()
	CTOR. More...

virtual	~DtGameControlInformation ()
	DTOR. More...

void	addControllerEvent (const DtGenericControllerEvent &, int flags, double transitionValue, const std::string &controllerName, const std::string &controllerGuid)

void	addControllerEvent (int flags, double transitionValue, const std::string &controllerName, const std::string &controllerGuid)
	Use this call to add a placeholder event. More...

void	addControllerEvent (const GameControlEvent &)

void	addControllerEvents (const GameControlEvents &)

void	removeControllerEvent (const DtGenericControllerEvent &)

bool	eventMatches (DtGenericControllerEvent *rhs) const
	Return true if any of the contained events matches the supplied event. More...

bool	isMatchingUpEvent (DtGenericControllerEvent *e) const
	Return true if, for any of the contained events, there is a possible key up or other button/HAT event for the given event. More...

const GameControlEvents &	controllerEvents () const

bool	isSpecified () const

void	clear ()

DtUnicode	controllerName () const

DtUnicode	descriptiveString () const

DtGameControlInformation &	operator= (const DtGameControlInformation &)

Protected Member Functions
template<class Archive >
void	serialize (Archive &ar, const unsigned int version)
	When the class Archive corresponds to an output archive, the & operator is defined similar to <<. More...

Protected Attributes
GameControlEvents	myControllerEvents

Friends
class	boost::serialization::access

Detailed Description

The DtGameControlInformation class contains information about how a function within a function group should be processed once active.

The DtGameControlProcessor will use this information to set a value of a function to between the minimum and maximum. Regardless of the minimum and maximum, 0 is always considered at rest

Member Typedef Documentation

typedef std::vector<GameControlEvent> makVrv::DtGameControlInformation::GameControlEvents

Member Enumeration Documentation

enum makVrv::DtGameControlInformation::GameControllerFlags

Enumerator
TransitionUp
TransitionDown
Repeat
ResetToZeroOnRelease
Reverse
Toggle
SetTo

Constructor & Destructor Documentation

makVrv::DtGameControlInformation::DtGameControlInformation ( )

CTOR.

virtual makVrv::DtGameControlInformation::~DtGameControlInformation ( )

virtual

DTOR.

Member Function Documentation

void makVrv::DtGameControlInformation::addControllerEvent	(	const DtGenericControllerEvent &	,
		int	flags,
		double	transitionValue,
		const std::string &	controllerName,
		const std::string &	controllerGuid
	)

void makVrv::DtGameControlInformation::addControllerEvent	(	int	flags,
		double	transitionValue,
		const std::string &	controllerName,
		const std::string &	controllerGuid
	)

Use this call to add a placeholder event.

void makVrv::DtGameControlInformation::addControllerEvent ( const GameControlEvent & )

void makVrv::DtGameControlInformation::addControllerEvents ( const GameControlEvents & )

void makVrv::DtGameControlInformation::removeControllerEvent ( const DtGenericControllerEvent & )

bool makVrv::DtGameControlInformation::eventMatches ( DtGenericControllerEvent * rhs ) const

Return true if any of the contained events matches the supplied event.

bool makVrv::DtGameControlInformation::isMatchingUpEvent ( DtGenericControllerEvent * e ) const

Return true if, for any of the contained events, there is a possible key up or other button/HAT event for the given event.

const GameControlEvents& makVrv::DtGameControlInformation::controllerEvents ( ) const

inline

bool makVrv::DtGameControlInformation::isSpecified ( ) const

inline

void makVrv::DtGameControlInformation::clear ( )

DtUnicode makVrv::DtGameControlInformation::controllerName ( ) const

DtUnicode makVrv::DtGameControlInformation::descriptiveString ( ) const

DtGameControlInformation& makVrv::DtGameControlInformation::operator= ( const DtGameControlInformation & )

template<class Archive >

void makVrv::DtGameControlInformation::serialize	(	Archive &	ar,
		const unsigned int	version
	)

inlineprotected

When the class Archive corresponds to an output archive, the & operator is defined similar to <<.

Likewise, when the class Archive is a type of input archive the & operator is defined similar to >>.

Friends And Related Function Documentation

friend class boost::serialization::access

friend

Member Data Documentation

GameControlEvents makVrv::DtGameControlInformation::myControllerEvents

protected

The documentation for this class was generated from the following file:

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-10-branch/include/joystickCore/gameControlInformation.h

Classes

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes