List of all members
SurgSim::Framework::BasicSceneElement Class Reference

Simple concrete implementation of a scene element that does not have any higher logic. More...

#include <SurgSim/Framework/BasicSceneElement.h>

Inheritance diagram for SurgSim::Framework::BasicSceneElement:
SurgSim::Framework::SceneElement SurgSim::Graphics::ViewElement SurgSim::Graphics::OsgViewElement

Name of the scene element

Constructor

 BasicSceneElement (const std::string &name)
 Destructor. More...
 
virtual ~BasicSceneElement ()
 Destructor. More...
 
 SURGSIM_CLASSNAME (SurgSim::Framework::BasicSceneElement)
 Destructor. More...
 
virtual bool doInitialize () override
 Initializes the scene element. More...
 

Additional Inherited Members

- 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...
 

Detailed Description

Simple concrete implementation of a scene element that does not have any higher logic.

Constructor & Destructor Documentation

SurgSim::Framework::BasicSceneElement::BasicSceneElement ( const std::string name)
explicit

Destructor.

SurgSim::Framework::BasicSceneElement::~BasicSceneElement ( )
virtual

Destructor.

Member Function Documentation

bool SurgSim::Framework::BasicSceneElement::doInitialize ( )
overrideprotectedvirtual

Initializes the scene element.

Returns
True if succeeds, false if fails

Implements SurgSim::Framework::SceneElement.

Reimplemented in SurgSim::Graphics::ViewElement.

SurgSim::Framework::BasicSceneElement::SURGSIM_CLASSNAME ( SurgSim::Framework::BasicSceneElement  )

Destructor.


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