SurgSim::Framework::Representation Class Reference

Representations are manifestations of a SceneElement. More...

`#include <SurgSim/Framework/Representation.h>`

Inheritance diagram for SurgSim::Framework::Representation:

## Public Member Functions

| Representation (const std::string &name)
| Constructor. More...
virtual | ~Representation ()
| Destructor. More...
virtual void | setLocalPose (const SurgSim::Math::RigidTransform3d &pose)
| Set the pose of the representation with respect to the Scene Element. More...
virtual SurgSim::Math::RigidTransform3d | getLocalPose () const
| Get the pose of the representation with respect to the Scene Element. More...
virtual SurgSim::Math::RigidTransform3d | getPose () const
| Get the pose of the representation in world coordinates. 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

## Private Member Functions

bool | doInitialize () override
| Interface to be implemented by derived classes. More...
bool | doWakeUp () override
| Interface to be implemented by derived classes. More...

## Private Attributes

SurgSim::Math::RigidTransform3d | m_localPose
| Local Pose of the Representation with respect to the SceneElement. More...

## 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
Static Public Member Functions inherited from SurgSim::Framework::FactoryBase1< Component, std::string >
static FactoryType & | getFactory ()
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...

## Detailed Description

Representations are manifestations of a SceneElement.

For example, a SceneElement can be represented in graphics, physics, etc. Each of these representation will be derived from this class.

## Constructor & Destructor Documentation

## Representation()

SurgSim::Framework::Representation::Representation | ( | const std::string & | name | ) |

explicit

Constructor.

Parameters

  name | Name of the representation

## ~Representation()

SurgSim::Framework::Representation::~Representation | ( |  | ) |

virtual

Destructor.

Reimplemented in SurgSim::Collision::Representation, SurgSim::Physics::Representation, SurgSim::Graphics::Representation, and SurgSim::Particles::Representation.

## Member Function Documentation

## doInitialize()

bool SurgSim::Framework::Representation::doInitialize | ( |  | ) |

override private virtual

Interface to be implemented by derived classes.

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

Implements SurgSim::Framework::Component.

Reimplemented in SurgSim::Graphics::Camera, SurgSim::Physics::FemRepresentation, SurgSim::Physics::DeformableRepresentation, SurgSim::Particles::SphRepresentation, SurgSim::Physics::MassSpringRepresentation, SurgSim::Physics::RigidRepresentation, SurgSim::Physics::RigidRepresentationBase, SurgSim::Graphics::OsgTextRepresentation, SurgSim::Graphics::OsgScreenSpaceQuadRepresentation, SurgSim::Particles::Representation, SurgSim::Physics::Fem3DRepresentation, SurgSim::Graphics::OsgSkeletonRepresentation, SurgSim::Physics::Fem1DRepresentation, SurgSim::Physics::Fem2DRepresentation, SurgSim::Graphics::OsgMeshRepresentation, SurgSim::Particles::ParticlesCollisionRepresentation, SurgSim::Physics::DeformableCollisionRepresentation, SurgSim::Graphics::OsgSceneryRepresentation, SurgSim::Input::InputComponent, SurgSim::Input::OutputComponent, and SurgSim::Graphics::OsgCurveRepresentation.

## doWakeUp()

bool SurgSim::Framework::Representation::doWakeUp | ( |  | ) |

override private 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::Physics::DeformableRepresentation, SurgSim::Physics::RigidRepresentationBase, SurgSim::Physics::Fem3DRepresentation, SurgSim::Particles::ParticlesCollisionRepresentation, SurgSim::Physics::DeformableCollisionRepresentation, SurgSim::Input::OutputComponent, SurgSim::Input::InputComponent, and SurgSim::Graphics::OsgCurveRepresentation.

## getLocalPose()

SurgSim::Math::RigidTransform3d SurgSim::Framework::Representation::getLocalPose | ( |  | ) | const

virtual

Get the pose of the representation with respect to the Scene Element.

Returns
  The pose of this representation

## getPose()

SurgSim::Math::RigidTransform3d SurgSim::Framework::Representation::getPose | ( |  | ) | const

virtual

Get the pose of the representation in world coordinates.

Returns
  The pose of this representation

Reimplemented in SurgSim::Graphics::ScreenSpaceQuadRepresentation, and SurgSim::Physics::RigidCollisionRepresentation.

## setLocalPose()

void SurgSim::Framework::Representation::setLocalPose | ( | const SurgSim::Math::RigidTransform3d & | pose | ) |

virtual

Set the pose of the representation with respect to the Scene Element.

Parameters

  pose | The pose to set the representation to

Reimplemented in SurgSim::Physics::DeformableRepresentation, and SurgSim::Collision::ShapeCollisionRepresentation.

## Member Data Documentation

## m_localPose

SurgSim::Math::RigidTransform3d SurgSim::Framework::Representation::m_localPose

private

Local Pose of the Representation with respect to the SceneElement.

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

- SurgSim/Framework/Representation.h
- SurgSim/Framework/Representation.cpp