SurgSim::Blocks::KeyBehavior Class Referenceabstract

Behavior to abstract the functionality of keyboard driven behaviors, can be programmed to react to a single keystroke. More...

`#include <SurgSim/Blocks/KeyBehavior.h>`

Inheritance diagram for SurgSim::Blocks::KeyBehavior:

## Public Member Functions

| KeyBehavior (const std::string &name)
| Constructor. More...
| ~KeyBehavior ()
| Destructor. More...
void | update (double dt) override
| Update the behavior. More...
bool | doInitialize () override
| Interface to be implemented by derived classes. More...
bool | doWakeUp () override
| Interface to be implemented by derived classes. More...
void | setInputComponent (std::shared_ptr< Framework::Component > inputComponent)
| Set the input component from which pressed key comes. More...
std::shared_ptr< Input::InputComponent > | getInputComponent () const
| Get the input component of this behavior, from which the pressed key comes. More...
Public Member Functions inherited from SurgSim::Framework::Behavior
| Behavior (const std::string &name)
virtual | ~Behavior ()
virtual int | getTargetManagerType () const
| Specifies which manger will handle this behavior. More...
Public Member Functions inherited from SurgSim::Framework::Component
| Component (const std::string &name)
| Constructor. More...
virtual | ~Component ()
| Destructor. More...
std::string | getName () const
| Gets component name. More...
std::string | getFullName () const
| Gets a string containing the name of the Component and (if it has one) its SceneElement. More...
void | setName (const std::string &name)
| Sets the name of component. More...
boost::uuids::uuid | getUuid () const
| Gets the id of the component. More...
bool | isInitialized () const
bool | initialize (const std::weak_ptr< Runtime > &runtime)
| Initialize this component, this needs to be called before wakeUp() can be called. More...
bool | isAwake () const
bool | wakeUp ()
| Wakeup this component, this will be called when the component is inserted into the ComponentManager that is responsible for handling this component. More...
void | retire ()
| Retire this component, this will be called when the component is removed from the ComponentManager that is responsible for handling this component. More...
void | setScene (std::weak_ptr< Scene > scene)
| Sets the scene. More...
std::shared_ptr< Scene > | getScene ()
| Gets the scene. More...
void | setSceneElement (std::weak_ptr< SceneElement > sceneElement)
| Sets the scene element. More...
std::shared_ptr< SceneElement > | getSceneElement ()
| Gets the scene element. More...
std::shared_ptr< const SceneElement > | getSceneElement () const
| Gets the scene element, constant version. More...
std::shared_ptr< Runtime > | getRuntime () const
| Get the runtime which contains this component. More...
virtual std::string | getClassName () const
| The class name for this class, this being the base class it should return SurgSim::Framework::Component but this would make missing implemenentations of this hard to catch, therefore this calls SURGSIM_FAILURE. More...
std::shared_ptr< Component > | getSharedPtr ()
| Gets a shared pointer to this component. More...
virtual void | doRetire ()
| Interface to be implemented by derived classes Has a default implementation, does nothing. More...
bool | isActive () const
virtual void | setLocalActive (bool val)
| Set the component's active state. More...
bool | isLocalActive () const
Public Member Functions inherited from SurgSim::Framework::Accessible
| Accessible ()
| Default Constructor. More...
| ~Accessible ()
| Destructor. More...
template<class T >
T | getValue (const std::string &name) const
| Retrieves the value with the name by executing the getter if it is found and tries to convert it to the given type. More...
boost::any | getValue (const std::string &name) const
| Retrieves the value with the name by executing the getter if it is found. More...
template<class T >
bool | getValue (const std::string &name, T *value) const
| Retrieves the value with the name by executing the getter if it is found, and converts it to the type of the output parameter. More...
void | setValue (const std::string &name, const boost::any &value)
| Sets a value of a property that has setter. More...
bool | isReadable (const std::string &name) const
| Check whether a property is readable. More...
bool | isWriteable (const std::string &name) const
| Check whether a property is writable. More...
void | setGetter (const std::string &name, GetterType func)
| Sets a getter for a given property. More...
void | setSetter (const std::string &name, SetterType func)
| Sets a setter for a given property. More...
void | setAccessors (const std::string &name, GetterType getter, SetterType setter)
| Sets the accessors getter and setter in one function. More...
void | removeAccessors (const std::string &name)
| Removes all the accessors (getter and setter) for a given property. More...
void | forwardProperty (const std::string &name, const Accessible &target, const std::string &targetProperty)
| Adds a property with the given name that uses the targets accessors, in effect forwarding the value to the target. More...
void | setSerializable (const std::string &name, EncoderType encoder, DecoderType decoder)
| Sets the functions used to convert data from and to a YAML::Node. More...
void | setDecoder (const std::string &name, DecoderType decoder)
| Sets the functions used to convert data from a YAML::Node. More...
YAML::Node | encode () const
| Encode this Accessible to a YAML::Node. More...
void | decode (const YAML::Node &node, const std::vector< std::string > &ignoredProperties=std::vector< std::string >())
| Decode this Accessible from a YAML::Node, will throw an exception if the data type cannot be converted. More...
template<>
boost::any | getValue (const std::string &name) const

## Static Public Member Functions

static bool | registerKey (int keycode, const std::string &description)
| Register the key, this let's the system keep track of keys used in the application. More...
static bool | unregisterKey (int keycode)
| Remove a key from the registry. More...
static void | logMap ()
| Write the keymap out to the logger. More...
Static Public Member Functions inherited from SurgSim::Framework::FactoryBase1< Component, std::string >
static FactoryType & | getFactory ()

## Protected Member Functions

virtual void | onKeyDown (int key)=0
| Implement to execute functionality on key press. More...
virtual void | onKeyUp (int key)=0
| Implement to execute functionality on key release. More...
Protected Member Functions inherited from SurgSim::Framework::Component
virtual std::shared_ptr< PoseComponent > | getPoseComponent ()
| Get the PoseComponent for this component. More...
virtual std::shared_ptr< const PoseComponent > | getPoseComponent () const
| Get the PoseComponent for this component, constant access. More...

## Protected Attributes

std::shared_ptr< Input::InputComponent > | m_inputComponent
| Input component needs to provide key. More...
int | m_lastKey
| Keep track if the key was pressed the last time around. More...

## Static Protected Attributes

static boost::mutex | m_keyMapMutex
static std::unordered_map< int, std::string > | m_keyMap

## Additional Inherited Members

Public Types inherited from SurgSim::Framework::Accessible
typedef std::function< boost::any(void)> | GetterType
typedef std::function< void(boost::any)> | SetterType
typedef std::function< YAML::Node(void)> | EncoderType
typedef std::function< void(const YAML::Node *)> | DecoderType
Public Types inherited from SurgSim::Framework::FactoryBase1< Component, std::string >
typedef ObjectFactory1< Component, std::string > | FactoryType

## Detailed Description

Behavior to abstract the functionality of keyboard driven behaviors, can be programmed to react to a single keystroke.

## Constructor & Destructor Documentation

## KeyBehavior()

SurgSim::Blocks::KeyBehavior::KeyBehavior | ( | const std::string & | name | ) |

explicit

Constructor.

## ~KeyBehavior()

SurgSim::Blocks::KeyBehavior::~KeyBehavior | ( |  | ) |

Destructor.

## Member Function Documentation

## doInitialize()

bool SurgSim::Blocks::KeyBehavior::doInitialize | ( |  | ) |

override virtual

Interface to be implemented by derived classes.

Returns
  True if component is initialized successfully; otherwise, false.

Implements SurgSim::Framework::Component.

## doWakeUp()

bool SurgSim::Blocks::KeyBehavior::doWakeUp | ( |  | ) |

override virtual

Interface to be implemented by derived classes.

Returns
  True if component is woken up successfully; otherwise, false.

Implements SurgSim::Framework::Component.

Reimplemented in SurgSim::Blocks::SingleKeyBehavior.

## getInputComponent()

std::shared_ptr< SurgSim::Input::InputComponent > SurgSim::Blocks::KeyBehavior::getInputComponent | ( |  | ) | const

Get the input component of this behavior, from which the pressed key comes.

Returns
  The input component which sends key press to this behavior.

## logMap()

void SurgSim::Blocks::KeyBehavior::logMap | ( |  | ) |

static

Write the keymap out to the logger.

## onKeyDown()

virtual void SurgSim::Blocks::KeyBehavior::onKeyDown | ( | int | key | ) |

protected pure virtual

Implement to execute functionality on key press.

Parameters

  key | the value of the key hit

Implemented in SurgSim::Blocks::SingleKeyBehavior.

## onKeyUp()

virtual void SurgSim::Blocks::KeyBehavior::onKeyUp | ( | int | key | ) |

protected pure virtual

Implement to execute functionality on key release.

Parameters

  key | the value of the key hit

Implemented in SurgSim::Blocks::SingleKeyBehavior.

## registerKey()

bool SurgSim::Blocks::KeyBehavior::registerKey | ( | int | keycode,
|  | const std::string & | description
| ) |  |

static

Register the key, this let's the system keep track of keys used in the application.

Parameters

  keycode | the key that is being used
  description | description of functionality that the key triggers

Returns
  true if the key is available, false if another key has already been register

## setInputComponent()

void SurgSim::Blocks::KeyBehavior::setInputComponent | ( | std::shared_ptr< Framework::Component > | inputComponent | ) |

Set the input component from which pressed key comes.

Parameters

  inputComponent | The input component which contains the pressed key(s).

## unregisterKey()

bool SurgSim::Blocks::KeyBehavior::unregisterKey | ( | int | keycode | ) |

static

Remove a key from the registry.

Parameters

  keycode | the key to be removed

Returns
  true if the key was actually removed

## update()

void SurgSim::Blocks::KeyBehavior::update | ( | double | dt | ) |

override virtual

Update the behavior.

Parameters

  dt | The length of time (seconds) between update calls.

Implements SurgSim::Framework::Behavior.

## Member Data Documentation

## m_inputComponent

std::shared_ptr<Input::InputComponent> SurgSim::Blocks::KeyBehavior::m_inputComponent

protected

Input component needs to provide key.

## m_keyMap

std::unordered_map< int, std::string > SurgSim::Blocks::KeyBehavior::m_keyMap

static protected

Handle the key map

## m_keyMapMutex

boost::mutex SurgSim::Blocks::KeyBehavior::m_keyMapMutex

static protected

Handle the key map

## m_lastKey

int SurgSim::Blocks::KeyBehavior::m_lastKey

protected

Keep track if the key was pressed the last time around.

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

- SurgSim/Blocks/KeyBehavior.h
- SurgSim/Blocks/KeyBehavior.cpp