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

#include <Representation.h>

Inheritance diagram for SurgSim::Graphics::Representation:

Public Member Functions
	Representation (const std::string &name)
	Constructor. More...

virtual	~Representation ()
	Destructor.

virtual bool	setMaterial (std::shared_ptr< SurgSim::Framework::Component > material)=0
	Sets the material that defines the visual appearance of the representation. More...

virtual std::shared_ptr< Material >	getMaterial () const =0
	Gets the material that defines the visual appearance of the representation. More...

void	setMaterialReference (const std::string &materialName)

std::string	getMaterialReference () const

virtual void	clearMaterial ()=0
	Removes the material from the representation.

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	setGenerateTangents (bool value)=0
	Enable or disable the generation of tangents. More...

virtual bool	isGeneratingTangents () const =0

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 () const
	Gets group references. More...

bool	removeGroupReference (const std::string &group)
	Function to remove an unwanted reference. More...

void	clearGroupReferences ()
	Clear all the Group references.

virtual void	addUniform (std::shared_ptr< UniformBase > uniform)=0
	Adds a uniform to this representation. More...

virtual void	addUniform (const std::string &type, const std::string &name, const boost::any &value)=0
	Adds and a uniform to this representation and set its value. More...

virtual void	setUniforms (const std::vector< std::shared_ptr< UniformBase >> &uniforms)=0
	Sets a set of uniforms for this representation. More...

virtual std::vector< std::shared_ptr< UniformBase > >	getUniforms () const =0

bool	doWakeUp () override
	Interface to be implemented by derived classes. 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.

std::string	getName () const
	Gets component name. More...

std::string	getFullName () const
	Gets a string containing the name of the Component and (if it has one) its SceneElement. More...

void	setName (const std::string &name)
	Sets the name of component. More...

boost::uuids::uuid	getUuid () const
	Gets the id of the component.

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	retire ()
	Retire this component, this will be called when the component is removed from the ComponentManager that is responsible for handling this component. More...

void	setScene (std::weak_ptr< Scene > scene)
	Sets the scene. More...

std::shared_ptr< Scene >	getScene ()
	Gets the scene. More...

void	setSceneElement (std::weak_ptr< SceneElement > sceneElement)
	Sets the scene element. More...

std::shared_ptr< SceneElement >	getSceneElement ()
	Gets the scene element. More...

std::shared_ptr< const SceneElement >	getSceneElement () const
	Gets the scene element, constant version. More...

std::shared_ptr< Runtime >	getRuntime () 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< Component >	getSharedPtr ()
	Gets a shared pointer to this component. More...

virtual void	doRetire ()
	Interface to be implemented by derived classes Has a default implementation, does nothing.

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.

	~Accessible ()
	Destructor.

template<class T >
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...

void	setDecoder (const std::string &name, DecoderType decoder)
	Sets the functions used to convert data from a YAML::Node. More...

YAML::Node	encode () const
	Encode this Accessible to a YAML::Node. More...

void	decode (const YAML::Node &node, const std::vector< std::string > &ignoredProperties=std::vector< std::string >())
	Decode this Accessible from a YAML::Node, will throw an exception if the data type cannot be converted. More...

std::vector< std::string >	getProperties ()

template<>
boost::any	getValue (const std::string &name) const

Static Public Attributes
static const std::string	DefaultGroupName = "__OssDefault__"

static const std::string	DefaultHudGroupName = "__OssDefaultHud__"

Additional Inherited Members
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

Public Types inherited from SurgSim::Framework::FactoryBase1< Component, std::string >
typedef ObjectFactory1< Component, std::string >	FactoryType

Static Public Member Functions inherited from SurgSim::Framework::FactoryBase1< Component, std::string >
static FactoryType &	getFactory ()

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

§ Representation()

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

explicit

Constructor.

Parameters

name	Name of the representation

Member Function Documentation

§ addGroupReference()

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

name	The name of the group.

Returns: true if it succeeds, false if the group reference already exists.

Reimplemented in SurgSim::Graphics::Camera.

§ addGroupReferences()

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

Adds a list of group references.

Parameters

groups The references.

§ addUniform() [1/2]

virtual void SurgSim::Graphics::Representation::addUniform ( std::shared_ptr< UniformBase > uniform )

pure virtual

Adds a uniform to this representation.

Parameters

uniform Uniform to add.

Implemented in MockCamera, MockRepresentation, and SurgSim::Graphics::OsgRepresentation.

§ addUniform() [2/2]

virtual void SurgSim::Graphics::Representation::addUniform	(	const std::string &	type,
		const std::string &	name,
		const boost::any &	value
	)

pure virtual

Adds and a uniform to this representation and set its value.

Parameters

type	the type of the uniform
name	Name used in shader code to access this uniform
value	The value for this uniform

Implemented in MockCamera, MockRepresentation, and SurgSim::Graphics::OsgRepresentation.

§ doWakeUp()

bool SurgSim::Graphics::Representation::doWakeUp ( )

overridevirtual

Interface to be implemented by derived classes.

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

Reimplemented from SurgSim::Framework::Representation.

§ getDrawAsWireFrame()

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 MockCamera, MockRepresentation, and SurgSim::Graphics::OsgRepresentation.

§ getGroupReferences()

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

Gets group references.

Returns: The group references.

§ getMaterial()

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 MockCamera, MockRepresentation, SurgSim::Graphics::OsgCamera, and SurgSim::Graphics::OsgRepresentation.

§ getUniforms()

virtual std::vector<std::shared_ptr<UniformBase> > SurgSim::Graphics::Representation::getUniforms ( ) const

pure virtual

Returns: the uniforms used for this representation

Implemented in MockCamera, MockRepresentation, and SurgSim::Graphics::OsgRepresentation.

§ isGeneratingTangents()

virtual bool SurgSim::Graphics::Representation::isGeneratingTangents ( ) const

pure virtual

Returns: whether tangent generation is on or off

Implemented in MockCamera, MockRepresentation, and SurgSim::Graphics::OsgRepresentation.

§ removeGroupReference()

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

Function to remove an unwanted reference.

Parameters

group The name of the reference that should be removed

Returns: true If the reference was found and removed

§ setDrawAsWireFrame()

virtual void SurgSim::Graphics::Representation::setDrawAsWireFrame ( bool val )

pure virtual

Sets the representation to render as a wire frame.

Parameters

val	true if this representation should be rendered as a wireframe.

Implemented in MockCamera, MockRepresentation, and SurgSim::Graphics::OsgRepresentation.

§ setGenerateTangents()

virtual void SurgSim::Graphics::Representation::setGenerateTangents ( bool value )

pure virtual

Enable or disable the generation of tangents.

Parameters

value true enables tangent generation, false otherwise

Implemented in MockCamera, MockRepresentation, SurgSim::Graphics::OsgCamera, SurgSim::Graphics::OsgRepresentation, and SurgSim::Graphics::OsgSceneryRepresentation.

§ setGroupReference()

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

group The reference to be used for this representation

§ setGroupReferences()

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

Sets the list of group references.

Clearing all the old references

Parameters

groups The references.

§ setMaterial()

virtual bool SurgSim::Graphics::Representation::setMaterial ( std::shared_ptr< SurgSim::Framework::Component > material )

pure virtual

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

Parameters

material Graphics material

Returns: True if set successfully, otherwise false

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

§ setUniforms()

virtual void SurgSim::Graphics::Representation::setUniforms ( const std::vector< std::shared_ptr< UniformBase >> & uniforms )

pure virtual

Sets a set of uniforms for this representation.

Parameters

uniforms the uniforms to be used in this representation

Implemented in MockCamera, MockRepresentation, and SurgSim::Graphics::OsgRepresentation.

§ update()

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

pure virtual

Updates the representation.

Parameters

dt	The time in seconds of the preceding timestep.

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

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

SurgSim/Graphics/Representation.h
SurgSim/Graphics/Representation.cpp

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

§ Representation()

Member Function Documentation

§ addGroupReference()

§ addGroupReferences()

§ addUniform() [1/2]

§ addUniform() [2/2]

§ doWakeUp()

§ getDrawAsWireFrame()

§ getGroupReferences()

§ getMaterial()

§ getUniforms()

§ isGeneratingTangents()

§ removeGroupReference()

§ setDrawAsWireFrame()

§ setGenerateTangents()

§ setGroupReference()

§ setGroupReferences()

§ setMaterial()

§ setUniforms()

§ update()