SurgSim::Graphics::OsgBoxRepresentation Class Reference

OSG implementation of a graphics box representation. More...

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

Inheritance diagram for SurgSim::Graphics::OsgBoxRepresentation:

## Public Member Functions

| OsgBoxRepresentation (const std::string &name)
| Constructor. More...
| SURGSIM_CLASSNAME (SurgSim::Graphics::OsgBoxRepresentation)
void | setSizeX (double sizeX) override
| Sets the size along X-axis of the box. More...
double | getSizeX () const override
| Returns the size along X-axis of the box. More...
void | setSizeY (double sizeY) override
| Sets the size along Y-axis of the box. More...
double | getSizeY () const override
| Returns the size along Y-axis of the box. More...
void | setSizeZ (double sizeZ) override
| Sets the size along Z-axis of the box. More...
double | getSizeZ () const override
| Returns the size along Z-axis of the box. More...
virtual void | setSizeXYZ (double sizeX, double sizeY, double sizeZ)
| Sets the size of the box. More...
virtual void | getSizeXYZ (double *sizeX, double *sizeY, double *sizeZ) const
| Gets the size of the box. More...
void | setSize (const SurgSim::Math::Vector3d &size) override
| Sets the size of the box. More...
SurgSim::Math::Vector3d | getSize () const override
| Returns the extents of the box. 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...
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::BoxRepresentation
| BoxRepresentation (const std::string &name)
| Constructor. More...

## Static Private Member Functions

static std::shared_ptr< OsgUnitBox > | getSharedUnitBox ()
| Returns the shared unit box. More...

## Private Attributes

osg::Vec3d | m_scale
| The OSG box shape is a unit box and this transform scales it to the size set. More...
std::shared_ptr< OsgUnitBox > | m_sharedUnitBox
| Shared unit box, so that the geometry can be instanced rather than having multiple copies. More...

## 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

OSG implementation of a graphics box representation.

## Constructor & Destructor Documentation

## OsgBoxRepresentation()

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

explicit

Constructor.

Parameters

  name | Name of the representation

## Member Function Documentation

## getSharedUnitBox()

std::shared_ptr< OsgUnitBox > SurgSim::Graphics::OsgBoxRepresentation::getSharedUnitBox | ( |  | ) |

static private

Returns the shared unit box.

## getSize()

SurgSim::Math::Vector3d SurgSim::Graphics::OsgBoxRepresentation::getSize | ( |  | ) | const

override virtual

Returns the extents of the box.

Returns
  Size of the box

Implements SurgSim::Graphics::BoxRepresentation.

## getSizeX()

double SurgSim::Graphics::OsgBoxRepresentation::getSizeX | ( |  | ) | const

override virtual

Returns the size along X-axis of the box.

Returns
  Size along X-axis of the box

Implements SurgSim::Graphics::BoxRepresentation.

## getSizeXYZ()

void SurgSim::Graphics::OsgBoxRepresentation::getSizeXYZ | ( | double * | sizeX,
|  | double * | sizeY,
|  | double * | sizeZ
| ) |  | const

virtual

Gets the size of the box.

Parameters

  sizeX | Reference to store the size along X-axis of the box
  sizeY | Reference to store the size along Y-axis of the box
  sizeZ | Reference to store the size along Z-axis of the box

Implements SurgSim::Graphics::BoxRepresentation.

## getSizeY()

double SurgSim::Graphics::OsgBoxRepresentation::getSizeY | ( |  | ) | const

override virtual

Returns the size along Y-axis of the box.

Returns
  Size along Y-axis of the box

Implements SurgSim::Graphics::BoxRepresentation.

## getSizeZ()

double SurgSim::Graphics::OsgBoxRepresentation::getSizeZ | ( |  | ) | const

override virtual

Returns the size along Z-axis of the box.

Returns
  Size along Z-axis of the box

Implements SurgSim::Graphics::BoxRepresentation.

## setSize()

void SurgSim::Graphics::OsgBoxRepresentation::setSize | ( | const SurgSim::Math::Vector3d & | size | ) |

override virtual

Sets the size of the box.

Parameters

  size | Size of the box

Implements SurgSim::Graphics::BoxRepresentation.

## setSizeX()

void SurgSim::Graphics::OsgBoxRepresentation::setSizeX | ( | double | sizeX | ) |

override virtual

Sets the size along X-axis of the box.

Parameters

  sizeX | Size along X-axis of the box

Implements SurgSim::Graphics::BoxRepresentation.

## setSizeXYZ()

void SurgSim::Graphics::OsgBoxRepresentation::setSizeXYZ | ( | double | sizeX,
|  | double | sizeY,
|  | double | sizeZ
| ) |  |

virtual

Sets the size of the box.

Parameters

  sizeX | Size along X-axis of the box
  sizeY | Size along Y-axis of the box
  sizeZ | Size along Z-axis of the box

Implements SurgSim::Graphics::BoxRepresentation.

## setSizeY()

void SurgSim::Graphics::OsgBoxRepresentation::setSizeY | ( | double | sizeY | ) |

override virtual

Sets the size along Y-axis of the box.

Parameters

  sizeY | Size along Y-axis of the box

Implements SurgSim::Graphics::BoxRepresentation.

## setSizeZ()

void SurgSim::Graphics::OsgBoxRepresentation::setSizeZ | ( | double | sizeZ | ) |

override virtual

Sets the size along Z-axis of the box.

Parameters

  sizeZ | Size along Z-axis of the box

Implements SurgSim::Graphics::BoxRepresentation.

## SURGSIM_CLASSNAME()

SurgSim::Graphics::OsgBoxRepresentation::SURGSIM_CLASSNAME | ( | SurgSim::Graphics::OsgBoxRepresentation |  | ) |

## Member Data Documentation

## m_scale

osg::Vec3d SurgSim::Graphics::OsgBoxRepresentation::m_scale

private

The OSG box shape is a unit box and this transform scales it to the size set.

## m_sharedUnitBox

std::shared_ptr<OsgUnitBox> SurgSim::Graphics::OsgBoxRepresentation::m_sharedUnitBox

private

Shared unit box, so that the geometry can be instanced rather than having multiple copies.

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

- SurgSim/Graphics/OsgBoxRepresentation.h
- SurgSim/Graphics/OsgBoxRepresentation.cpp