SurgSim::Graphics::OsgMeshRepresentation Class Reference

Implementation of a MeshRepresentation for rendering under osg. More...

`#include <SurgSim/Graphics/OsgMeshRepresentation.h>`

Inheritance diagram for SurgSim::Graphics::OsgMeshRepresentation:

## Public Member Functions

| OsgMeshRepresentation (const std::string &name)
| Constructor. More...
| ~OsgMeshRepresentation ()
| Destructor. More...
| SURGSIM_CLASSNAME (SurgSim::Graphics::OsgMeshRepresentation)
std::shared_ptr< Mesh > | getMesh () override
| Gets the mesh. More...
void | setMesh (std::shared_ptr< SurgSim::Framework::Asset > mesh) override
| Sets the mesh. More...
void | loadMesh (const std::string &fileName) override
| Convenience function to trigger the load of the mesh with the given filename. More...
void | setShape (std::shared_ptr< SurgSim::Math::Shape > shape) override
| Sets the shape of the representation param shape the shape of this representation. More...
void | setUpdateOptions (int val) override
| Sets the structures that are expected to change during the lifetime of the mesh, these will be updated every frame, independent of a structural change in the mesh. More...
int | getUpdateOptions () const override
| Gets update options for this mesh. More...
osg::ref_ptr< osg::Geometry > | getOsgGeometry () const
void | updateMesh (const SurgSim::Graphics::Mesh &mesh) override
Public Member Functions inherited from SurgSim::Graphics::OsgRepresentation
| OsgRepresentation (const std::string &name)
| Constructor. More...
virtual | ~OsgRepresentation ()
| Destructor. More...
osg::ref_ptr< osg::Node > | getOsgNode () const
| Returns the root OSG Node for this representations portion of the scene graph. More...
bool | setMaterial (std::shared_ptr< SurgSim::Framework::Component > material) override
| Sets the material that defines the visual appearance of the representation. More...
std::shared_ptr< Material > | getMaterial () const override
| Gets the material that defines the visual appearance of the representation. More...
void | clearMaterial () override
| Removes the material from the representation. More...
void | setDrawAsWireFrame (bool val) override
| Sets the representation to render as a wire frame. More...
bool | getDrawAsWireFrame () const override
| Return if the representation is rendered as a wire frame. More...
void | setGenerateTangents (bool value) override
| Enable the generation of tangents When enabled it is up to the subclasses responsibility to react to changes and trigger the regeneration of Tangents. More...
bool | isGeneratingTangents () const override
void | update (double dt) override
| Updates the representation. More...
void | addUniform (std::shared_ptr< SurgSim::Graphics::UniformBase > uniform)
| Adds a uniform to this representation. More...
void | addUniform (const std::string &type, const std::string &name, const boost::any &value)
| Adds and a uniform to this representation and set its value. More...
Public Member Functions inherited from SurgSim::Graphics::Representation
| Representation (const std::string &name)
| Constructor. More...
virtual | ~Representation ()
| Destructor. 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. 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...
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. 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 | 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. More...
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. More...
| ~Accessible ()
| Destructor. More...
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...
template<>
boost::any | getValue (const std::string &name) const
Public Member Functions inherited from SurgSim::Graphics::MeshRepresentation
| MeshRepresentation (const std::string &name)
| Constructor. More...
virtual | ~MeshRepresentation ()
| Destructor. More...

## Protected Member Functions

void | doUpdate (double dt) override
bool | doInitialize () override
void | privateUpdateMesh (const SurgSim::Graphics::Mesh &mesh)
Protected Member Functions inherited from SurgSim::Graphics::OsgRepresentation
void | setVisible (bool val)
| Set the visibility of this representation. More...
void | updateTangents ()
| Causes the tangents to be recalculated if tangent generation is enabled Subclasses should call this whenever the state changes in a way that need tangents to be recalculated. More...
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...

## Private Member Functions

int | updateOsgArrays (const Mesh &mesh, osg::Geometry *geometry)
| Updates the internal arrays in accordance to the sizes given in the mesh. More...
void | updateVertices (const Mesh &mesh, osg::Geometry *geometry, int updateOptions)
| Copies the attributes for each mesh vertex in the appropriate osg structure, this will only be done for the data as is indicated by updateOptions. More...
void | updateNormals (osg::Geometry *geometry)
| Updates the normals. More...
void | updateTriangles (const Mesh &mesh, osg::Geometry *geometry)
| Updates the triangles. More...
osg::Object::DataVariance | getDataVariance (int updateOption)
| Gets data variance for a given update option. More...
void | buildGeometry ()
| Create the appropriate geometry nodes. More...

## Private Attributes

int | m_updateOptions
| Indicates which elements of the mesh should be updated on every frame. More...
std::shared_ptr< Mesh > | m_mesh
| The mesh. More...
std::string | m_filename
| File name of the external file which contains the mesh to be used by this class. More...
size_t | m_updateCount
| Cache for the update count pull from the mesh. More...
Framework::LockedContainer< Mesh > | m_writeBuffer
osg::ref_ptr< osg::Switch > | m_meshSwitch
osg::ref_ptr< osg::Geometry > | m_geometry

## 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
Public Types inherited from SurgSim::Graphics::MeshRepresentation
enum | UpdateOption { UPDATE_OPTION_NONE = 0, UPDATE_OPTION_VERTICES = 0x01, UPDATE_OPTION_COLORS = 0x02, UPDATE_OPTION_TEXTURES = 0x04, UPDATE_OPTION_TRIANGLES = 0x08, UPDATE_OPTION_ALL }
Static Public Member Functions inherited from SurgSim::Framework::FactoryBase1< Component, std::string >
static FactoryType & | getFactory ()
Static Public Attributes inherited from SurgSim::Graphics::Representation
static const std::string | DefaultGroupName = "__OssDefault__"
static const std::string | DefaultHudGroupName = "__OssDefaulHud__"
Protected Attributes inherited from SurgSim::Graphics::OsgRepresentation
osg::ref_ptr< osg::Switch > | m_switch
| Switch used to toggle the visibility of the representation. More...
osg::ref_ptr< osg::PositionAttitudeTransform > | m_transform
| Transform used to pose the representation. More...
osg::ref_ptr< osg::Group > | m_materialProxy
| Holder for attributes coming from OsgMaterial. More...
std::shared_ptr< OsgMaterial > | m_material
| Material defining the visual appearance of the representation. More...
osg::ref_ptr< TangentSpaceGenerator > | m_tangentGenerator
| Visitor to generate tangents. More...
bool | m_drawAsWireFrame
| Indicates if the representation is rendered as a wireframe. More...
std::shared_ptr< OsgUniform< SurgSim::Math::Matrix44f > > | m_modelMatrixUniform

## Detailed Description

Implementation of a MeshRepresentation for rendering under osg.

## Constructor & Destructor Documentation

## OsgMeshRepresentation()

SurgSim::Graphics::OsgMeshRepresentation::OsgMeshRepresentation | ( | const std::string & | name | ) |

explicit

Constructor.

Parameters

  name | The name.

## ~OsgMeshRepresentation()

SurgSim::Graphics::OsgMeshRepresentation::~OsgMeshRepresentation | ( |  | ) |

Destructor.

## Member Function Documentation

## buildGeometry()

void SurgSim::Graphics::OsgMeshRepresentation::buildGeometry | ( |  | ) |

private

Create the appropriate geometry nodes.

## doInitialize()

bool SurgSim::Graphics::OsgMeshRepresentation::doInitialize | ( |  | ) |

override protected virtual

Note
  If m_filename is set, m_mesh will be overwritten with the mesh loaded from the external file.

Reimplemented from SurgSim::Framework::Representation.

## doUpdate()

void SurgSim::Graphics::OsgMeshRepresentation::doUpdate | ( | double | dt | ) |

override protected virtual

Reimplemented from SurgSim::Graphics::OsgRepresentation.

## getDataVariance()

osg::Object::DataVariance SurgSim::Graphics::OsgMeshRepresentation::getDataVariance | ( | int | updateOption | ) |

private

Gets data variance for a given update option.

Parameters

  updateOption | The update option.

Returns
  The data variance.

## getMesh()

std::shared_ptr< Mesh > SurgSim::Graphics::OsgMeshRepresentation::getMesh | ( |  | ) |

override virtual

Gets the mesh.

Returns
  The mesh.

Implements SurgSim::Graphics::MeshRepresentation.

## getOsgGeometry()

osg::ref_ptr< osg::Geometry > SurgSim::Graphics::OsgMeshRepresentation::getOsgGeometry | ( |  | ) | const

## getUpdateOptions()

int SurgSim::Graphics::OsgMeshRepresentation::getUpdateOptions | ( |  | ) | const

override virtual

Gets update options for this mesh.

Returns
  The update options.

Implements SurgSim::Graphics::MeshRepresentation.

## loadMesh()

void SurgSim::Graphics::OsgMeshRepresentation::loadMesh | ( | const std::string & | fileName | ) |

override virtual

Convenience function to trigger the load of the mesh with the given filename.

Parameters

  fileName | name of the file to be loaded

Implements SurgSim::Graphics::MeshRepresentation.

## privateUpdateMesh()

void SurgSim::Graphics::OsgMeshRepresentation::privateUpdateMesh | ( | const SurgSim::Graphics::Mesh & | mesh | ) |

protected

## setMesh()

void SurgSim::Graphics::OsgMeshRepresentation::setMesh | ( | std::shared_ptr< SurgSim::Framework::Asset > | mesh | ) |

override virtual

Sets the mesh.

Parameters

  mesh | the graphics mesh to be used

Implements SurgSim::Graphics::MeshRepresentation.

## setShape()

void SurgSim::Graphics::OsgMeshRepresentation::setShape | ( | std::shared_ptr< SurgSim::Math::Shape > | shape | ) |

override virtual

Sets the shape of the representation param shape the shape of this representation.

Note
  only shapes of type MeshShape are supported

Implements SurgSim::Graphics::MeshRepresentation.

## setUpdateOptions()

void SurgSim::Graphics::OsgMeshRepresentation::setUpdateOptions | ( | int | val | ) |

override virtual

Sets the structures that are expected to change during the lifetime of the mesh, these will be updated every frame, independent of a structural change in the mesh.

UPDATE_OPTION_VERTICES is set in the constructor as a default value.

Parameters

  val | Boolean or expression of UpdateOption enum.

Implements SurgSim::Graphics::MeshRepresentation.

## SURGSIM_CLASSNAME()

SurgSim::Graphics::OsgMeshRepresentation::SURGSIM_CLASSNAME | ( | SurgSim::Graphics::OsgMeshRepresentation |  | ) |

## updateMesh()

void SurgSim::Graphics::OsgMeshRepresentation::updateMesh | ( | const SurgSim::Graphics::Mesh & | mesh | ) |

override virtual

Implements SurgSim::Graphics::MeshRepresentation.

## updateNormals()

void SurgSim::Graphics::OsgMeshRepresentation::updateNormals | ( | osg::Geometry * | geometry | ) |

private

Updates the normals.

Parameters

  geometry | [out] The geometry that carries the data

## updateOsgArrays()

int SurgSim::Graphics::OsgMeshRepresentation::updateOsgArrays | ( | const Mesh & | mesh,
|  | osg::Geometry * | geometry
| ) |  |

private

Updates the internal arrays in accordance to the sizes given in the mesh.

Parameters

  mesh | The mesh used to update
  geometry | [out] The geometry that carries the data

Returns
  updateOptions value that indicates which of the structures where updated in size and will have to be updated independent of the value set in setUpdateOptions()

## updateTriangles()

void SurgSim::Graphics::OsgMeshRepresentation::updateTriangles | ( | const Mesh & | mesh,
|  | osg::Geometry * | geometry
| ) |  |

private

Updates the triangles.

Parameters

  mesh | The mesh used to update
  geometry | [out] The geometry that carries the data

## updateVertices()

void SurgSim::Graphics::OsgMeshRepresentation::updateVertices | ( | const Mesh & | mesh,
|  | osg::Geometry * | geometry,
|  | int | updateOptions
| ) |  |

private

Copies the attributes for each mesh vertex in the appropriate osg structure, this will only be done for the data as is indicated by updateOptions.

Parameters

  mesh | The mesh used to update
  geometry | [out] The geometry that carries the data
  updateOptions | Set of flags indicating whether a specific vertex attribute should be updated

## Member Data Documentation

## m_filename

std::string SurgSim::Graphics::OsgMeshRepresentation::m_filename

private

File name of the external file which contains the mesh to be used by this class.

## m_geometry

osg::ref_ptr<osg::Geometry> SurgSim::Graphics::OsgMeshRepresentation::m_geometry

private

Osg structures

## m_mesh

std::shared_ptr<Mesh> SurgSim::Graphics::OsgMeshRepresentation::m_mesh

private

The mesh.

## m_meshSwitch

osg::ref_ptr<osg::Switch> SurgSim::Graphics::OsgMeshRepresentation::m_meshSwitch

private

Osg structures

## m_updateCount

size_t SurgSim::Graphics::OsgMeshRepresentation::m_updateCount

private

Cache for the update count pull from the mesh.

## m_updateOptions

int SurgSim::Graphics::OsgMeshRepresentation::m_updateOptions

private

Indicates which elements of the mesh should be updated on every frame.

## m_writeBuffer

Framework::LockedContainer<Mesh> SurgSim::Graphics::OsgMeshRepresentation::m_writeBuffer

private

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

- SurgSim/Graphics/OsgMeshRepresentation.h
- SurgSim/Graphics/OsgMeshRepresentation.cpp