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

Behavior to copy positions of a PhysicsRepresentation to a GraphicsMesh. More...

#include <SurgSim/Blocks/TransferPhysicsToGraphicsMeshBehavior.h>

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

Public Member Functions

 TransferPhysicsToGraphicsMeshBehavior (const std::string &name)
 Constructor. More...
 
 SURGSIM_CLASSNAME (SurgSim::Blocks::TransferPhysicsToGraphicsMeshBehavior)
 
void setSource (const std::shared_ptr< SurgSim::Framework::Component > &source)
 Set the representation from which the positions are from. More...
 
void setTarget (const std::shared_ptr< SurgSim::Framework::Component > &target)
 Set the representation which will receive the positions. More...
 
std::shared_ptr
< SurgSim::Physics::DeformableRepresentation
getSource () const
 Get the Physics representation which sends the positions. More...
 
std::shared_ptr
< SurgSim::Graphics::MeshRepresentation
getTarget () const
 Get the Graphics representation which receives the positions. 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
 

Private Member Functions

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

Private Attributes

std::shared_ptr
< SurgSim::Physics::DeformableRepresentation
m_source
 The DeformableRepresentation from which the Ode state comes. More...
 
std::shared_ptr
< SurgSim::Graphics::MeshRepresentation
m_target
 The Graphics Mesh Representation to which the vertices' positions are set. More...
 

Additional Inherited Members

- 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
 
- Static Public Member Functions inherited from SurgSim::Framework::Component
static FactoryTypegetFactory ()
 
- 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

Behavior to copy positions of a PhysicsRepresentation to a GraphicsMesh.

Constructor & Destructor Documentation

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

Constructor.

Parameters
nameName of the behavior

Member Function Documentation

bool SurgSim::Blocks::TransferPhysicsToGraphicsMeshBehavior::doInitialize ( )
overrideprivatevirtual

Interface to be implemented by derived classes.

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

Implements SurgSim::Framework::Component.

bool SurgSim::Blocks::TransferPhysicsToGraphicsMeshBehavior::doWakeUp ( )
overrideprivatevirtual

Interface to be implemented by derived classes.

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

Implements SurgSim::Framework::Component.

std::shared_ptr< SurgSim::Physics::DeformableRepresentation > SurgSim::Blocks::TransferPhysicsToGraphicsMeshBehavior::getSource ( ) const

Get the Physics representation which sends the positions.

Returns
The Physics representation which produces positions.
std::shared_ptr< SurgSim::Graphics::MeshRepresentation > SurgSim::Blocks::TransferPhysicsToGraphicsMeshBehavior::getTarget ( ) const

Get the Graphics representation which receives the positions.

Returns
The Graphics Mesh representation which receives positions.
void SurgSim::Blocks::TransferPhysicsToGraphicsMeshBehavior::setSource ( const std::shared_ptr< SurgSim::Framework::Component > &  source)

Set the representation from which the positions are from.

Parameters
sourceThe physics representation
void SurgSim::Blocks::TransferPhysicsToGraphicsMeshBehavior::setTarget ( const std::shared_ptr< SurgSim::Framework::Component > &  target)

Set the representation which will receive the positions.

Parameters
targetThe Graphics Mesh representation
SurgSim::Blocks::TransferPhysicsToGraphicsMeshBehavior::SURGSIM_CLASSNAME ( SurgSim::Blocks::TransferPhysicsToGraphicsMeshBehavior  )
void SurgSim::Blocks::TransferPhysicsToGraphicsMeshBehavior::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::Physics::DeformableRepresentation> SurgSim::Blocks::TransferPhysicsToGraphicsMeshBehavior::m_source
private

The DeformableRepresentation from which the Ode state comes.

std::shared_ptr<SurgSim::Graphics::MeshRepresentation> SurgSim::Blocks::TransferPhysicsToGraphicsMeshBehavior::m_target
private

The Graphics Mesh Representation to which the vertices' positions are set.


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