Public Member Functions | Protected Member Functions | Private Attributes | List of all members
SurgSim::Blocks::SphereElement Class Reference

#include <SurgSim/Blocks/SphereElement.h>

Inheritance diagram for SurgSim::Blocks::SphereElement:
SurgSim::Framework::SceneElement

Public Member Functions

 SphereElement (const std::string &name)
 
 ~SphereElement ()
 
- Public Member Functions inherited from SurgSim::Framework::SceneElement
 SceneElement (const std::string &name)
 Constructor. More...
 
virtual ~SceneElement ()
 Destructor. More...
 
virtual std::string getClassName () const
 
bool addComponent (std::shared_ptr< Component > component)
 Adds a component, calls initialize() on the component, if SceneElement::isInitialized() is true. More...
 
bool removeComponent (std::shared_ptr< Component > component)
 Removes a given component. More...
 
bool removeComponent (const std::string &name)
 Removes the component described by name. More...
 
std::shared_ptr< ComponentgetComponent (const std::string &name) const
 Gets the component identified by name. More...
 
std::vector< std::shared_ptr< Component > > getComponents () const
 Gets all the components of this SceneElement. More...
 
template<class T >
std::vector< std::shared_ptr< T > > getComponents () const
 Template version of getComponents method to get all the components with type T. More...
 
bool initialize ()
 Executes the initialize operation. More...
 
std::string getName () const
 Return the name of this SceneElement. More...
 
void setPose (const SurgSim::Math::RigidTransform3d &pose)
 Set the pose of this SceneElement. More...
 
const SurgSim::Math::RigidTransform3dgetPose () const
 Get the pose of this SceneElement. More...
 
std::shared_ptr< PoseComponentgetPoseComponent ()
 Get the PoseComponent that controls the pose all Representations in this SceneElement. More...
 
void setScene (std::weak_ptr< Scene > scene)
 Sets the Scene. More...
 
std::shared_ptr< ScenegetScene ()
 Gets the Scene. More...
 
void setRuntime (std::weak_ptr< Runtime > runtime)
 Sets the Runtime. More...
 
std::shared_ptr< RuntimegetRuntime ()
 Gets the runtime. More...
 
bool isInitialized () const
 Return if this SceneElement is initialized. More...
 
void setActive (bool val)
 Set this SceneElement's status (active/inactive) More...
 
bool isActive () const
 
std::shared_ptr< SceneElementgetSharedPtr ()
 Gets a shared pointer to this SceneElement. More...
 
virtual YAML::Node encode (bool standalone) const
 Convert to a YAML::Node. More...
 
virtual bool decode (const YAML::Node &node)
 Pull data from a YAML::Node. More...
 

Protected Member Functions

virtual bool doInitialize ()
 Method to initialize this SceneElement. More...
 
virtual bool doWakeUp ()
 

Private Attributes

std::string m_name
 

Constructor & Destructor Documentation

SphereElement::SphereElement ( const std::string &  name)
explicit
SphereElement::~SphereElement ( )

Member Function Documentation

bool SphereElement::doInitialize ( )
protectedvirtual

Method to initialize this SceneElement.

To be overridden by derived class(es).

Returns
True if initialization is successful; Otherwise, false.

Implements SurgSim::Framework::SceneElement.

bool SphereElement::doWakeUp ( )
protectedvirtual

Member Data Documentation

std::string SurgSim::Blocks::SphereElement::m_name
private

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