orxonox::Button Class Reference

#include <src/core/input/Button.h>

Inheritance diagram for orxonox::Button:

orxonox::HalfAxis

List of all members.

Public Member Functions

virtual bool addParamCommand (ParamCommand *command)
 Button ()
virtual void clear ()
bool execute (KeybindMode::Value mode, float abs=1.0f, float rel=1.0f)
void parse ()
void readConfigValue (ConfigFileType configFile)
virtual ~Button ()

Public Attributes

bool bButtonThresholdUser_
std::string bindingString_
 The configured string value.
float buttonThreshold_
BaseCommand ** commands_ [3]
 Basic commands for OnPress, OnHold and OnRelease.
ConfigValueContainerconfigContainer_
 Container to allow for better configValue support.
std::string groupName_
 Name of the group of input triggers.
std::string name_
 Name of the trigger as strings.
unsigned int nCommands_ [3]
 Number of basic commands.
std::vector
< BufferedParamCommand * > * 
paramCommandBuffer_
 Pointer to the list of parametrised commands.

Private Member Functions

void parseError (std::string message, bool serious)


Constructor & Destructor Documentation

orxonox::Button::Button (  ) 

Note:
bButtonThresholdUser_: We set it to true so that setConfigValues in KeyBinder sets the value correctly the first time. It is then set to false first and changed later in Button::parse().

References clear(), configContainer_, and nCommands_.

orxonox::Button::~Button (  )  [virtual]

References clear(), and configContainer_.


Member Function Documentation

virtual bool orxonox::Button::addParamCommand ( ParamCommand command  )  [inline, virtual]

Reimplemented in orxonox::HalfAxis.

Referenced by parse().

void orxonox::Button::clear (  )  [virtual]

Reimplemented in orxonox::HalfAxis.

References commands_, and nCommands_.

Referenced by Button(), orxonox::HalfAxis::clear(), parse(), and ~Button().

bool orxonox::Button::execute ( KeybindMode::Value  mode,
float  abs = 1.0f,
float  rel = 1.0f 
) [inline]

void orxonox::Button::parse (  ) 

void orxonox::Button::parseError ( std::string  message,
bool  serious 
) [inline, private]

References COUT, and name_.

Referenced by parse().

void orxonox::Button::readConfigValue ( ConfigFileType  configFile  ) 


Member Data Documentation

Referenced by parse().

The configured string value.

Referenced by parse(), and readConfigValue().

Says how much it takes for an analog axis to trigger a button Note: This variable is here to have only one parse() function.

Referenced by parse(), and orxonox::KeyBinder::tickHalfAxis().

Basic commands for OnPress, OnHold and OnRelease.

Referenced by clear(), execute(), and parse().

Container to allow for better configValue support.

Referenced by Button(), readConfigValue(), and ~Button().

Name of the group of input triggers.

Referenced by orxonox::KeyBinder::KeyBinder(), and readConfigValue().

unsigned int orxonox::Button::nCommands_[3]

Number of basic commands.

Referenced by Button(), clear(), execute(), parse(), and orxonox::KeyBinder::tickHalfAxis().

Pointer to the list of parametrised commands.

Referenced by orxonox::KeyBinder::KeyBinder(), and parse().


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

Generated on Tue Jul 28 16:22:22 2009 for Orxonox by  doxygen 1.5.6