DtJoystickConfigurations is a collection of joystick settings, each contained within a configuration. More...

Public Types
typedef std::map< std::string, DtJoystickConfigurationSettings >	JoystickConfigurations

Public Member Functions
	DtJoystickConfigurations ()
	CTOR.
	DtJoystickConfigurations (const DtJoystickConfigurations &)
	~DtJoystickConfigurations ()
	DTOR.
DtUnicode	gameControllerName (const std::string &controller, const std::string &functionGroup, const std::string &function) const
	Returns the name of the game controller that is used to control the particular configuration, function group and function.
DtUnicode	gameControllerFunction (const std::string &configuration, const std::string &functionGroup, const std::string &function) const
	Returns the name of the game function descriptive text that is used to control the particular configuration, function group and function.
void	setJoystickSettingsForConfiguration (const std::string &s, const DtJoystickConfigurationSettings &c)
	Sets the settings for the particular configuration.
bool	joystickSettingsForConfiguration (const std::string &s, DtJoystickConfigurationSettings &c)
	Returns the joystick setting for a particular configuration.
std::vector< std::string >	configurations () const
	Returns the names of all the configurations.
virtual std::string	descriptionFor (const std::string &functionGroup, const std::string &function) const
	Returns the description for the given function group and function.
DtGameControlInformation	gameControlInformationFor (const std::string &configuration, const std::string &functionGroup, const std::string &function) const
	Returns game controller information for the given configuration, function group and function.
DtJoystickConfigurationSetting	addGameControlInformationFor (const std::string &configuration, const std::string &functionGroup, const std::string &function, const DtGameControlInformation &)
bool	removeGameControlInformationFor (const std::string &configuration, const std::string &functionGroup, const std::string &function)
	Removes game controller information for the given configuration, function group and function.
const JoystickConfigurations &	joystickConfiguration () const
const DtGameControllerFunctionGroups &	gameControllerFunctionGroups () const
DtJoystickConfigurationSettings::GameControlInformation	gameControlInformation (const std::string &configuration, const std::string &fg) const
	Will return only specified game control information for the configuration and function group.
DtJoystickConfigurationSettings::GameControlInformation	gameControlInformation (const std::string &configuration, const std::set< std::string > &fg) const
	Will return only specified game control information for the configuration and function groups.
bool	needsTransition (const std::string &functionalGroup, const std::string &function) const
	Returns true if the given code and group needs a transitional value (i.e the value is just not on or off) If it is non-transitional then only button values are accepted.
bool	cycle (const std::string &functionalGroup, const std::string &function) const
	Returns true if the given code and group is a cycle value. If it is then only button/keyboard/HAT values are accepted.
bool	toggle (const std::string &functionalGroup, const std::string &function) const
	Returns true if the given code and group is a toggle value. If it is then only button/keyboard/HAT values are accepted.
void	getFunctionMinMaxValues (const std::string &functionalGroup, const std::string &function, double &min, double &max) const
	Supplies the min/max values of the given functionGroup and function.
bool	addOrUpdateJoystickControl (const std::string &functionGroup, const std::string &function, const DtFunctionGroupInformation &)
	Adds (or updates) the joystick control in all configurations.
std::set< std::string >	availableFunctionGroups () const
	Returns a list of all the function groups.
std::vector< std::string >	functionsForFunctionGroup (const std::string &) const
	Returns all the functions in a particular function group.
std::set< std::string >	functionGroupsSimilarTo (const std::string &functionGroup) const
	Given the function group, return any function group that contains the same type of functions (not necessarily the same function names) as this group.
bool	renameConfiguration (const std::string &old, const std::string &renamed)
	Renames the configuration.
bool	switchControlActive (const std::string &configuration, const std::string &switchGroup) const
	Returns true if there is a switch between group of the given name with an active controller for this configuration.
bool	functionGroupSpecified (const std::string &configuration, const std::string &functionGroup, bool all=false) const
	Returns true if at least one function in the function group is specified. If all flag is true then all must be specified.
bool	hasAnyFunctionGroupAvailable (const std::string &configuration, bool all=false) const
	Returns true if any function group is available for this configuration.
bool	hasConfigurationName (const std::string &) const
	Returns true if the configuration name exists.
void	addConfiguration (const std::string &)
	Adds a new configuration.
bool	removeConfiguration (const std::string &)
	Removes the specified configuration.

void	setFavorite (const std::string &)
const std::string &	favorite () const

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 <<.

Protected Attributes
DtGameControllerFunctionGroups	myGameControllerFunctionGroups
JoystickConfigurations	myJoystickConfigurations
std::string	myFavorite

Friends
class	boost::serialization::access

Detailed Description

DtJoystickConfigurations is a collection of joystick settings, each contained within a configuration.

This will allow the user to create multiple control configuration (e.g. keyboard vs. joystick vs. gamepad) and choose which they want when taking control of an object

Member Typedef Documentation

typedef std::map<std::string, DtJoystickConfigurationSettings> makVrv::DtJoystickConfigurations::JoystickConfigurations

Constructor & Destructor Documentation

makVrv::DtJoystickConfigurations::DtJoystickConfigurations ( )

CTOR.

makVrv::DtJoystickConfigurations::DtJoystickConfigurations ( const DtJoystickConfigurations & )

makVrv::DtJoystickConfigurations::~DtJoystickConfigurations ( )

DTOR.

Member Function Documentation

DtUnicode makVrv::DtJoystickConfigurations::gameControllerName	(	const std::string &	controller,
		const std::string &	functionGroup,
		const std::string &	function
	)		const

Returns the name of the game controller that is used to control the particular configuration, function group and function.

DtUnicode makVrv::DtJoystickConfigurations::gameControllerFunction	(	const std::string &	configuration,
		const std::string &	functionGroup,
		const std::string &	function
	)		const

Returns the name of the game function descriptive text that is used to control the particular configuration, function group and function.

void makVrv::DtJoystickConfigurations::setJoystickSettingsForConfiguration	(	const std::string &	s,
		const DtJoystickConfigurationSettings &	c
	)

Sets the settings for the particular configuration.

bool makVrv::DtJoystickConfigurations::joystickSettingsForConfiguration	(	const std::string &	s,
		DtJoystickConfigurationSettings &	c
	)

Returns the joystick setting for a particular configuration.

std::vector<std::string> makVrv::DtJoystickConfigurations::configurations ( ) const

Returns the names of all the configurations.

virtual std::string makVrv::DtJoystickConfigurations::descriptionFor	(	const std::string &	functionGroup,
		const std::string &	function
	)		const

virtual

Returns the description for the given function group and function.

DtGameControlInformation makVrv::DtJoystickConfigurations::gameControlInformationFor	(	const std::string &	configuration,
		const std::string &	functionGroup,
		const std::string &	function
	)		const

Returns game controller information for the given configuration, function group and function.

DtJoystickConfigurationSetting makVrv::DtJoystickConfigurations::addGameControlInformationFor	(	const std::string &	configuration,
		const std::string &	functionGroup,
		const std::string &	function,
		const DtGameControlInformation &
	)

bool makVrv::DtJoystickConfigurations::removeGameControlInformationFor	(	const std::string &	configuration,
		const std::string &	functionGroup,
		const std::string &	function
	)

Removes game controller information for the given configuration, function group and function.

const JoystickConfigurations& makVrv::DtJoystickConfigurations::joystickConfiguration ( ) const

inline

const DtGameControllerFunctionGroups& makVrv::DtJoystickConfigurations::gameControllerFunctionGroups ( ) const

inline

DtJoystickConfigurationSettings::GameControlInformation makVrv::DtJoystickConfigurations::gameControlInformation	(	const std::string &	configuration,
		const std::string &	fg
	)		const

Will return only specified game control information for the configuration and function group.

DtJoystickConfigurationSettings::GameControlInformation makVrv::DtJoystickConfigurations::gameControlInformation	(	const std::string &	configuration,
		const std::set< std::string > &	fg
	)		const

Will return only specified game control information for the configuration and function groups.

bool makVrv::DtJoystickConfigurations::needsTransition	(	const std::string &	functionalGroup,
		const std::string &	function
	)		const

Returns true if the given code and group needs a transitional value (i.e the value is just not on or off) If it is non-transitional then only button values are accepted.

bool makVrv::DtJoystickConfigurations::cycle	(	const std::string &	functionalGroup,
		const std::string &	function
	)		const

Returns true if the given code and group is a cycle value. If it is then only button/keyboard/HAT values are accepted.

bool makVrv::DtJoystickConfigurations::toggle	(	const std::string &	functionalGroup,
		const std::string &	function
	)		const

Returns true if the given code and group is a toggle value. If it is then only button/keyboard/HAT values are accepted.

void makVrv::DtJoystickConfigurations::getFunctionMinMaxValues	(	const std::string &	functionalGroup,
		const std::string &	function,
		double &	min,
		double &	max
	)		const

Supplies the min/max values of the given functionGroup and function.

bool makVrv::DtJoystickConfigurations::addOrUpdateJoystickControl	(	const std::string &	functionGroup,
		const std::string &	function,
		const DtFunctionGroupInformation &
	)

Adds (or updates) the joystick control in all configurations.

Also adds to local game controller function group map. Returns true if this results in a change to any configuration

std::set<std::string> makVrv::DtJoystickConfigurations::availableFunctionGroups ( ) const

Returns a list of all the function groups.

std::vector<std::string> makVrv::DtJoystickConfigurations::functionsForFunctionGroup ( const std::string & ) const

Returns all the functions in a particular function group.

std::set<std::string> makVrv::DtJoystickConfigurations::functionGroupsSimilarTo ( const std::string & functionGroup ) const

Given the function group, return any function group that contains the same type of functions (not necessarily the same function names) as this group.

The functions must be specified in the same order of similarity

bool makVrv::DtJoystickConfigurations::renameConfiguration	(	const std::string &	old,
		const std::string &	renamed
	)

Renames the configuration.

bool makVrv::DtJoystickConfigurations::switchControlActive	(	const std::string &	configuration,
		const std::string &	switchGroup
	)		const

Returns true if there is a switch between group of the given name with an active controller for this configuration.

bool makVrv::DtJoystickConfigurations::functionGroupSpecified	(	const std::string &	configuration,
		const std::string &	functionGroup,
		bool	all = `false`
	)		const

Returns true if at least one function in the function group is specified. If all flag is true then all must be specified.

bool makVrv::DtJoystickConfigurations::hasAnyFunctionGroupAvailable	(	const std::string &	configuration,
		bool	all = `false`
	)		const

Returns true if any function group is available for this configuration.

If all is true all functions within any particular function group must be specified

bool makVrv::DtJoystickConfigurations::hasConfigurationName ( const std::string & ) const

Returns true if the configuration name exists.

void makVrv::DtJoystickConfigurations::addConfiguration ( const std::string & )

Adds a new configuration.

bool makVrv::DtJoystickConfigurations::removeConfiguration ( const std::string & )

Removes the specified configuration.

void makVrv::DtJoystickConfigurations::setFavorite ( const std::string & )

Get/set configuration favorite

const std::string& makVrv::DtJoystickConfigurations::favorite ( ) const

template<class Archive >

void makVrv::DtJoystickConfigurations::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

DtGameControllerFunctionGroups makVrv::DtJoystickConfigurations::myGameControllerFunctionGroups

protected

JoystickConfigurations makVrv::DtJoystickConfigurations::myJoystickConfigurations

protected

std::string makVrv::DtJoystickConfigurations::myFavorite

protected

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

/exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/joystickCore/joystickConfigurations.h

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation