Simple concrete implementation of a scene element that does not have any higher logic. More...
#include <BasicSceneElement.h>
Inheritance diagram for SurgSim::Framework::BasicSceneElement:
Name of the scene element | |
| BasicSceneElement (const std::string &name) | |
| virtual | ~BasicSceneElement () |
| Destructor. | |
| SURGSIM_CLASSNAME (SurgSim::Framework::BasicSceneElement) | |
| 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. | |
| 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... | |
| void | removeComponents () |
| Removes all components. | |
| std::shared_ptr< Component > | getComponent (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... | |
| template<class T > | |
| T | getValue (const std::string &component, const std::string &property) const |
| Retrieves the property value from a component. More... | |
| boost::any | getValue (const std::string &component, const std::string &property) const |
| Retrieves the property value from a component. More... | |
| template<class T > | |
| bool | getValue (const std::string &component, const std::string &property, T *value) const |
| Retrieves the property value from a component, and convertis it to the type of the output parameter. More... | |
| void | setValue (const std::string &component, const std::string &property, const boost::any &value) |
| Sets the property value of a component. More... | |
| void | addToGroup (const std::string &group) |
| Add this scene element to the given group. More... | |
| void | removeFromGroup (const std::string &group) |
| Remove this scene element from the given group. More... | |
| void | setGroups (const std::vector< std::string > &groups) |
| Set the groups of this scene element. More... | |
| std::vector< std::string > | getGroups () const |
| bool | inGroup (const std::string &name) |
| Test whether this SceneElement is in a specific group. 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::RigidTransform3d & | getPose () const |
| Get the pose of this SceneElement. More... | |
| std::shared_ptr< PoseComponent > | getPoseComponent () |
| 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< Scene > | getScene () |
| Gets the Scene. More... | |
| void | setRuntime (std::weak_ptr< Runtime > runtime) |
| Sets the Runtime. More... | |
| std::shared_ptr< Runtime > | getRuntime () |
| 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< SceneElement > | getSharedPtr () |
| 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.
Member Function Documentation
§ doInitialize()
|
overrideprotectedvirtual |
Initializes the scene element.
- Returns
- True if succeeds, false if fails
Implements SurgSim::Framework::SceneElement.
Reimplemented in SurgSim::Graphics::ViewElement.
The documentation for this class was generated from the following files:
- SurgSim/Framework/BasicSceneElement.h
- SurgSim/Framework/BasicSceneElement.cpp
