All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Static Public Attributes | Protected Attributes | Private Member Functions | Private Attributes | List of all members
SurgSim::Graphics::Representation Class Referenceabstract

Base graphics representation class, which defines the interface that all graphics representations must implement. More...

#include <SurgSim/Graphics/Representation.h>

Inheritance diagram for SurgSim::Graphics::Representation:
Inheritance graph
[legend]
Collaboration diagram for SurgSim::Graphics::Representation:
Collaboration graph
[legend]

Public Member Functions

 Representation (const std::string &name)
 Constructor. More...
 
virtual ~Representation ()
 Destructor. More...
 
virtual void setVisible (bool visible)=0
 Sets whether the representation is currently visible. More...
 
virtual bool isVisible () const =0
 Gets whether the representation is currently visible. More...
 
virtual void setLocalActive (bool val) override
 Set the component's active state. More...
 
virtual bool setMaterial (std::shared_ptr< Material > material)=0
 Sets the material that defines the visual appearance of the representation. More...
 
virtual std::shared_ptr< MaterialgetMaterial () const =0
 Gets the material that defines the visual appearance of the representation. More...
 
virtual void clearMaterial ()=0
 Removes the material from the representation. More...
 
virtual void setDrawAsWireFrame (bool val)=0
 Sets the representation to render as a wire frame. More...
 
virtual bool getDrawAsWireFrame () const =0
 Return if the representation is rendered as a wire frame. More...
 
virtual void update (double dt)=0
 Updates the representation. More...
 
virtual bool addGroupReference (const std::string &name)
 Add a reference to a group, this will eventual add this representation to the group with the the same name. More...
 
void addGroupReferences (const std::vector< std::string > &groups)
 Adds a list of group references. More...
 
void setGroupReferences (const std::vector< std::string > &groups)
 Sets the list of group references. More...
 
void setGroupReference (const std::string &group)
 Helper functions, this clears all the references and sets, only the reference given in the parameter. More...
 
std::vector< std::string > getGroupReferences ()
 Gets group references. More...
 
bool removeGroupReference (const std::string &group)
 Function to remove an unwanted reference. More...
 
void clearGroupReferences ()
 Clear all the Group references. More...
 
- Public Member Functions inherited from SurgSim::Framework::Representation
 Representation (const std::string &name)
 Constructor. 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...
 
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
 
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
 

Static Public Attributes

static const std::string DefaultGroupName = "__OssDefault__"
 
static const std::string DefaultHudGroupName = "__OssDefaulHud__"
 

Protected Attributes

bool m_isVisible
 

Private Member Functions

bool checkAwake (const std::string &functionName)
 Check if the representation is awake and print a warning message if it is. More...
 

Private Attributes

std::unordered_set< std::string > m_groups
 List of groups that this representation would like to be added. 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

Base graphics representation class, which defines the interface that all graphics representations must implement.

A Graphics::Representation is the visual Framework::Representation of a Framework::SceneElement in the Framework::Scene. Graphical representations can request to be assigned to groups, groups are used to select certain elements for rendering in various special effects.

Constructor & Destructor Documentation

SurgSim::Graphics::Representation::Representation ( const std::string &  name)
explicit

Constructor.

Parameters
nameName of the representation
SurgSim::Graphics::Representation::~Representation ( )
virtual

Destructor.

Reimplemented from SurgSim::Framework::Representation.

Member Function Documentation

bool SurgSim::Graphics::Representation::addGroupReference ( const std::string &  name)
virtual

Add a reference to a group, this will eventual add this representation to the group with the the same name.

Parameters
nameThe name of the group.
Returns
true if it succeeds, false if the group reference already exists.

Reimplemented in SurgSim::Graphics::Camera.

void SurgSim::Graphics::Representation::addGroupReferences ( const std::vector< std::string > &  groups)

Adds a list of group references.

Parameters
groupsThe references.
bool SurgSim::Graphics::Representation::checkAwake ( const std::string &  functionName)
private

Check if the representation is awake and print a warning message if it is.

Parameters
functionNamethe name of the calling function to be used in the error message
Returns
the value of isAwake()
void SurgSim::Graphics::Representation::clearGroupReferences ( )

Clear all the Group references.

virtual void SurgSim::Graphics::Representation::clearMaterial ( )
pure virtual

Removes the material from the representation.

Implemented in SurgSim::Graphics::OsgCamera, and SurgSim::Graphics::OsgRepresentation.

virtual bool SurgSim::Graphics::Representation::getDrawAsWireFrame ( ) const
pure virtual

Return if the representation is rendered as a wire frame.

Returns
True if this representation is rendered as a wireframe; false if not.

Implemented in SurgSim::Graphics::OsgRepresentation.

std::vector< std::string > SurgSim::Graphics::Representation::getGroupReferences ( )

Gets group references.

Returns
The group references.
virtual std::shared_ptr<Material> SurgSim::Graphics::Representation::getMaterial ( ) const
pure virtual

Gets the material that defines the visual appearance of the representation.

Returns
Graphics material

Implemented in SurgSim::Graphics::OsgCamera, and SurgSim::Graphics::OsgRepresentation.

virtual bool SurgSim::Graphics::Representation::isVisible ( ) const
pure virtual

Gets whether the representation is currently visible.

Returns
visible True for visible, false for invisible

Implemented in SurgSim::Graphics::OsgCamera, and SurgSim::Graphics::OsgRepresentation.

bool SurgSim::Graphics::Representation::removeGroupReference ( const std::string &  group)

Function to remove an unwanted reference.

Parameters
groupThe name of the reference that should be removed
Returns
true If the reference was found and removed
virtual void SurgSim::Graphics::Representation::setDrawAsWireFrame ( bool  val)
pure virtual

Sets the representation to render as a wire frame.

Parameters
valtrue if this representation should be rendered as a wireframe.

Implemented in SurgSim::Graphics::OsgRepresentation.

void SurgSim::Graphics::Representation::setGroupReference ( const std::string &  group)

Helper functions, this clears all the references and sets, only the reference given in the parameter.

Parameters
groupThe reference to be used for this representation
void SurgSim::Graphics::Representation::setGroupReferences ( const std::vector< std::string > &  groups)

Sets the list of group references.

Clearing all the old references

Parameters
groupsThe references.
void SurgSim::Graphics::Representation::setLocalActive ( bool  val)
overridevirtual

Set the component's active state.

Parameters
valIf true component is active, inactive if false.

Reimplemented from SurgSim::Framework::Component.

virtual bool SurgSim::Graphics::Representation::setMaterial ( std::shared_ptr< Material material)
pure virtual

Sets the material that defines the visual appearance of the representation.

Parameters
materialGraphics material
Returns
True if set successfully, otherwise false

Implemented in SurgSim::Graphics::OsgCamera, and SurgSim::Graphics::OsgRepresentation.

virtual void SurgSim::Graphics::Representation::setVisible ( bool  visible)
pure virtual

Sets whether the representation is currently visible.

Note
If the representation is inactive, this method has no visible effect.
Parameters
visibleTrue for visible, false for invisible

Implemented in SurgSim::Graphics::OsgCamera, and SurgSim::Graphics::OsgRepresentation.

virtual void SurgSim::Graphics::Representation::update ( double  dt)
pure virtual

Updates the representation.

Parameters
dtThe time in seconds of the preceding timestep.

Implemented in SurgSim::Graphics::OsgCamera, and SurgSim::Graphics::OsgRepresentation.

Member Data Documentation

const std::string SurgSim::Graphics::Representation::DefaultGroupName = "__OssDefault__"
static
const std::string SurgSim::Graphics::Representation::DefaultHudGroupName = "__OssDefaulHud__"
static
std::unordered_set<std::string> SurgSim::Graphics::Representation::m_groups
private

List of groups that this representation would like to be added.

bool SurgSim::Graphics::Representation::m_isVisible
protected

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