The DtGameControllerFunctionGroups contains a list of all function groups, functions and their values that can be assigned in the system.
More...
Public Member Functions |
| | DtGameControllerFunctionGroups () |
| | DtGameControllerFunctionGroups (const DtGameControllerFunctionGroups &) |
| virtual | ~DtGameControllerFunctionGroups () |
| DtGameControllerFunctionGroups & | operator= (const DtGameControllerFunctionGroups &) |
| std::string | descriptionFor (const std::string &functionGroup, const std::string &function) const |
| | Returns the description for the given function group and function.
|
| 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 | 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 | addOrUpdateFunctionGroupInformation (const std::string &functionGroup, const std::string &function, const DtFunctionGroupInformation &) |
| | Returns true if this function was added or updated.
|
| DtJoystickConfigurationSettings | createNewSettings () const |
| | Creates new settings based on function group and function informaton.
|
| std::vector< std::string > | functionsForFunctionGroup (const std::string &) const |
| const FunctionGroups & | functionGroups () 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 <<.
|
Detailed Description
The DtGameControllerFunctionGroups contains a list of all function groups, functions and their values that can be assigned in the system.
Member Typedef Documentation
Constructor & Destructor Documentation
| makVrv::DtGameControllerFunctionGroups::DtGameControllerFunctionGroups |
( |
| ) |
|
| virtual makVrv::DtGameControllerFunctionGroups::~DtGameControllerFunctionGroups |
( |
| ) |
|
|
virtual |
Member Function Documentation
| std::string makVrv::DtGameControllerFunctionGroups::descriptionFor |
( |
const std::string & |
functionGroup, |
|
|
const std::string & |
function |
|
) |
| const |
Returns the description for the given function group and function.
| std::set<std::string> makVrv::DtGameControllerFunctionGroups::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::DtGameControllerFunctionGroups::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::DtGameControllerFunctionGroups::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::DtGameControllerFunctionGroups::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::DtGameControllerFunctionGroups::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::DtGameControllerFunctionGroups::addOrUpdateFunctionGroupInformation |
( |
const std::string & |
functionGroup, |
|
|
const std::string & |
function, |
|
|
const DtFunctionGroupInformation & |
|
|
) |
| |
Returns true if this function was added or updated.
Creates new settings based on function group and function informaton.
| std::vector<std::string> makVrv::DtGameControllerFunctionGroups::functionsForFunctionGroup |
( |
const std::string & |
| ) |
const |
| const FunctionGroups& makVrv::DtGameControllerFunctionGroups::functionGroups |
( |
| ) |
const |
|
inline |
template<class Archive >
| void makVrv::DtGameControllerFunctionGroups::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
| FunctionGroups makVrv::DtGameControllerFunctionGroups::myFunctionGroups |
|
protected |
The documentation for this class was generated from the following file:
