SurgSim::Graphics::OsgSceneryRepresentation Class Reference

A OsgSceneryRepresentation is used to load osg object/node from file. More...

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

Inheritance diagram for SurgSim::Graphics::OsgSceneryRepresentation:

## Public Member Functions

| OsgSceneryRepresentation (const std::string &name)
| Constructor. More...
| SURGSIM_CLASSNAME (SurgSim::Graphics::OsgSceneryRepresentation)
void | loadModel (const std::string &fileName) override
| Convenience function to trigger the load of the model with the given filename, if successful, this will replace the old model. More...
void | setModel (std::shared_ptr< SurgSim::Framework::Asset > model) override
| Set the current model to the model passed. More...
std::shared_ptr< Model > | getModel () const override
osg::ref_ptr< osg::Node > | getModelNode () const
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...
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...
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::SceneryRepresentation
| SceneryRepresentation (const std::string &name)
| Constructor. More...

## Private Member Functions

bool | doInitialize () override
| Interface to be implemented by derived classes. More...

## Private Attributes

osg::ref_ptr< osg::Node > | m_osgNode
| A osg::Node to hold the objet loaded from file. More...
std::shared_ptr< Model > | m_model
std::string | m_fileName
| Name of the object file to be loaded. More...

## Friends

class | OsgSceneryRepresentationTest

## 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 ()
Static Public Attributes inherited from SurgSim::Graphics::Representation
static const std::string | DefaultGroupName = "__OssDefault__"
static const std::string | DefaultHudGroupName = "__OssDefaulHud__"
Protected Member Functions inherited from SurgSim::Graphics::OsgRepresentation
virtual void | doUpdate (double dt)
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...
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

A OsgSceneryRepresentation is used to load osg object/node from file.

## Constructor & Destructor Documentation

## OsgSceneryRepresentation()

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

explicit

Constructor.

Parameters

  name | Name of OsgSceneryRepresentation

## Member Function Documentation

## doInitialize()

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

override private virtual

Interface to be implemented by derived classes.

Returns
  True if component is initialized successfully; otherwise, false.

Reimplemented from SurgSim::Framework::Representation.

## getModel()

std::shared_ptr< Model > SurgSim::Graphics::OsgSceneryRepresentation::getModel | ( |  | ) | const

override virtual

Returns
  the current model.

Implements SurgSim::Graphics::SceneryRepresentation.

## getModelNode()

osg::ref_ptr< osg::Node > SurgSim::Graphics::OsgSceneryRepresentation::getModelNode | ( |  | ) | const

Returns
  the osg node that carries the information of the loaded model

## loadModel()

void SurgSim::Graphics::OsgSceneryRepresentation::loadModel | ( | const std::string & | fileName | ) |

override virtual

Convenience function to trigger the load of the model with the given filename, if successful, this will replace the old model.

Parameters

  fileName | Name of the file to be loaded

Implements SurgSim::Graphics::SceneryRepresentation.

## setGenerateTangents()

void SurgSim::Graphics::OsgSceneryRepresentation::setGenerateTangents | ( | bool | value | ) |

override virtual

Enable the generation of tangents When enabled it is up to the subclasses responsibility to react to changes and trigger the regeneration of Tangents.

Tangents will be stored for every geometry node that contains a vertex, normal and texture array.

Note
  the

See also
  TangentSpaceGenerator is used to create the appropriate vertex attribute arrays. These are stored as vertex attribute arrays at the indices indicated by TANGENT_ARRAY_ATTRIBUTE_ID, and BITANGENT_ARRAY_ATTRIBUTE_ID with the format osg::ArrayVec4. The tangents will be made orthonormal by default. tangents via
  updateTangents()

Reimplemented from SurgSim::Graphics::OsgRepresentation.

## setModel()

void SurgSim::Graphics::OsgSceneryRepresentation::setModel | ( | std::shared_ptr< SurgSim::Framework::Asset > | model | ) |

override virtual

Set the current model to the model passed.

Parameters

  model | to be used for this scenery representation, this will replace the old model

Implements SurgSim::Graphics::SceneryRepresentation.

## SURGSIM_CLASSNAME()

SurgSim::Graphics::OsgSceneryRepresentation::SURGSIM_CLASSNAME | ( | SurgSim::Graphics::OsgSceneryRepresentation |  | ) |

## Friends And Related Function Documentation

## OsgSceneryRepresentationTest

friend class OsgSceneryRepresentationTest

friend

## Member Data Documentation

## m_fileName

std::string SurgSim::Graphics::OsgSceneryRepresentation::m_fileName

private

Name of the object file to be loaded.

## m_model

std::shared_ptr<Model> SurgSim::Graphics::OsgSceneryRepresentation::m_model

private

## m_osgNode

osg::ref_ptr<osg::Node> SurgSim::Graphics::OsgSceneryRepresentation::m_osgNode

private

A osg::Node to hold the objet loaded from file.

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

- SurgSim/Graphics/OsgSceneryRepresentation.h
- SurgSim/Graphics/OsgSceneryRepresentation.cpp