All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | Protected Member Functions | Private Attributes | List of all members
SurgSim::Blocks::KeyboardTogglesComponentBehavior Class Reference

This behavior is used to control the visibility of registered graphical representation(s) More...

#include <SurgSim/Blocks/KeyboardTogglesComponentBehavior.h>

Inheritance diagram for SurgSim::Blocks::KeyboardTogglesComponentBehavior:
Inheritance graph
[legend]
Collaboration diagram for SurgSim::Blocks::KeyboardTogglesComponentBehavior:
Collaboration graph
[legend]

Public Types

typedef std::unordered_map
< int, std::unordered_set
< std::shared_ptr
< SurgSim::Framework::Component > > > 
KeyboardRegistryType
 
- Public Types inherited from SurgSim::Framework::Component
typedef
SurgSim::Framework::ObjectFactory1
< SurgSim::Framework::Component,
std::string > 
FactoryType
 
- 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 Member Functions

 KeyboardTogglesComponentBehavior (const std::string &name)
 Constructor. More...
 
 SURGSIM_CLASSNAME (SurgSim::Blocks::KeyboardTogglesComponentBehavior)
 
void setInputComponent (std::shared_ptr< SurgSim::Framework::Component > inputComponent)
 Set the input component from which pressed keys come. More...
 
std::shared_ptr
< SurgSim::Input::InputComponent
getInputComponent () const
 Get the input component of this behavior. More...
 
void registerKey (SurgSim::Device::KeyCode key, std::shared_ptr< SurgSim::Framework::Component > component)
 Register a key with a component in this behavior. More...
 
void setKeyboardRegistry (const KeyboardRegistryType &map)
 Set the register map of this behavior. More...
 
const KeyboardRegistryTypegetKeyboardRegistry () const
 Get the register map of this behavior. More...
 
virtual void update (double dt) override
 Update the behavior. 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...
 
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 setScene (std::weak_ptr< Scene > scene)
 Sets the scene. More...
 
std::shared_ptr< ScenegetScene ()
 Gets the scene. More...
 
void setSceneElement (std::weak_ptr< SceneElement > sceneElement)
 Sets the scene element. More...
 
std::shared_ptr< SceneElementgetSceneElement ()
 Gets the scene element. More...
 
std::shared_ptr< const
SceneElement
getSceneElement () const
 Gets the scene element, constant version. More...
 
std::shared_ptr< RuntimegetRuntime () 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< ComponentgetSharedPtr ()
 Gets a shared pointer to this component. 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 >
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...
 
YAML::Node encode () const
 Encode this Accessible to a YAML::Node. More...
 
void decode (const YAML::Node &node)
 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
 

Protected Member Functions

virtual bool doInitialize () override
 Initialize this behavior. More...
 
virtual bool doWakeUp () override
 Wakeup this behavior. 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...
 

Private Attributes

bool m_keyPressedLastUpdate
 Record if any key is pressed in last update() call. More...
 
std::shared_ptr
< SurgSim::Input::InputComponent
m_inputComponent
 Input component from which pressed keys come. More...
 
KeyboardRegistryType m_registry
 A mapping between key and the graphical representation(s) it controls. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from SurgSim::Framework::Component
static FactoryTypegetFactory ()
 

Detailed Description

This behavior is used to control the visibility of registered graphical representation(s)

Member Typedef Documentation

typedef std::unordered_map<int, std::unordered_set<std::shared_ptr<SurgSim::Framework::Component> > > SurgSim::Blocks::KeyboardTogglesComponentBehavior::KeyboardRegistryType

Constructor & Destructor Documentation

SurgSim::Blocks::KeyboardTogglesComponentBehavior::KeyboardTogglesComponentBehavior ( const std::string &  name)
explicit

Constructor.

Parameters
nameName of the behavior

Member Function Documentation

bool SurgSim::Blocks::KeyboardTogglesComponentBehavior::doInitialize ( )
overrideprotectedvirtual

Initialize this behavior.

Returns
True on success, otherwise false.
Note
In current implementation, this method always returns "true".

Implements SurgSim::Framework::Component.

bool SurgSim::Blocks::KeyboardTogglesComponentBehavior::doWakeUp ( )
overrideprotectedvirtual

Wakeup this behavior.

Returns
True on success, otherwise false.
Note
In current implementation, this method always returns "true".

Implements SurgSim::Framework::Component.

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

Get the input component of this behavior.

Returns
The input component which sends signals to this behavior.
const KeyboardTogglesComponentBehavior::KeyboardRegistryType & SurgSim::Blocks::KeyboardTogglesComponentBehavior::getKeyboardRegistry ( ) const

Get the register map of this behavior.

Returns
The register map of this behavior
void SurgSim::Blocks::KeyboardTogglesComponentBehavior::registerKey ( SurgSim::Device::KeyCode  key,
std::shared_ptr< SurgSim::Framework::Component component 
)

Register a key with a component in this behavior.

Parameters
keyA key used to control the component.
componentThe component being controlled by the key.
Note
A key can be registered several times, so can a component.
void SurgSim::Blocks::KeyboardTogglesComponentBehavior::setInputComponent ( std::shared_ptr< SurgSim::Framework::Component inputComponent)

Set the input component from which pressed keys come.

Parameters
inputComponentThe input component which contains the pressed key(s).
void SurgSim::Blocks::KeyboardTogglesComponentBehavior::setKeyboardRegistry ( const KeyboardRegistryType map)

Set the register map of this behavior.

Parameters
mapThe register map.
SurgSim::Blocks::KeyboardTogglesComponentBehavior::SURGSIM_CLASSNAME ( SurgSim::Blocks::KeyboardTogglesComponentBehavior  )
void SurgSim::Blocks::KeyboardTogglesComponentBehavior::update ( double  dt)
overridevirtual

Update the behavior.

Parameters
dtThe length of time (seconds) between update calls.

Implements SurgSim::Framework::Behavior.

Member Data Documentation

std::shared_ptr<SurgSim::Input::InputComponent> SurgSim::Blocks::KeyboardTogglesComponentBehavior::m_inputComponent
private

Input component from which pressed keys come.

bool SurgSim::Blocks::KeyboardTogglesComponentBehavior::m_keyPressedLastUpdate
private

Record if any key is pressed in last update() call.

KeyboardRegistryType SurgSim::Blocks::KeyboardTogglesComponentBehavior::m_registry
private

A mapping between key and the graphical representation(s) it controls.


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