SurgSim::Graphics::OsgVectorFieldRepresentation Class Reference

OSG vector field representation, implements a VectorFieldRepresenation using OSG. More...

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

Inheritance diagram for SurgSim::Graphics::OsgVectorFieldRepresentation:

## Public Member Functions

| OsgVectorFieldRepresentation (const std::string &name)
| Constructor. More...
| ~OsgVectorFieldRepresentation ()
| Destructor. More...
| SURGSIM_CLASSNAME (SurgSim::Graphics::OsgVectorFieldRepresentation)
std::shared_ptr< VectorField > | getVectorField () const override
| Gets the vector field. More...
void | setLineWidth (double width) override
| Sets vector line width. More...
double | getLineWidth () const override
| Gets line width. More...
void | setScale (double scale) override
| Sets the scale to be applied to all vectors. More...
double | getScale () const override
| Gets the scale applied to all vectors. More...
virtual void | setPointSize (double size)
| Sets the size of point indicating the starting of vector. More...
virtual double | getPointSize () const
| Gets the size of starting point of a vector. More...
void | doUpdate (double dt) override
void | updateVectorField (const VectorField &vectorfield) override
| Updates the vector field in a threadsafe manner. More...
Public Member Functions inherited from SurgSim::Graphics::VectorFieldRepresentation
| VectorFieldRepresentation (const std::string &name)
| Constructor. More...
virtual | ~VectorFieldRepresentation ()
| Destructor. 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::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...

## Private Member Functions

void | privateUpdate (const std::vector< DataStructures::Vertex< VectorFieldData >> &vertices)

## Private Attributes

std::shared_ptr< SurgSim::Graphics::VectorField > | m_vectorField
| Vector Field holds a list of vertices/points (X,Y,Z) in 3D space Each point is associated with a vector and an optional color. More...
SurgSim::Framework::LockedContainer< VectorField > | m_writeBuffer
osg::ref_ptr< osg::Vec3Array > | m_vertexData
| OSG vertex data structure. More...
osg::ref_ptr< osg::Geometry > | m_lineGeometry
| OSG::Geometry node holding OSG representation of vectors. More...
osg::ref_ptr< osg::Geometry > | m_pointGeometry
| OSG::Geometry node holding OSG representation of vector starting points. More...
osg::ref_ptr< osg::DrawArrays > | m_drawArrays
| An OSG::DrawArrays object specifying how vectors will be drawn. More...
osg::ref_ptr< osg::DrawElementsUInt > | m_drawPoints
| An OSG::DrawElementUInt object specifying how vector starting points will be drawn. More...
osg::ref_ptr< osg::LineWidth > | m_line
| OSG::LineWidth for representing vector. More...
osg::ref_ptr< osg::Point > | m_point
| OSG::Point for representing vector starting point. More...
osg::ref_ptr< osg::Vec4Array > | m_colors
| OSG::Vec4Array to hold color for each vector. More...
double | m_scale
| A scale to scale the length of vector. 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::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 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 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 vector field representation, implements a VectorFieldRepresenation using OSG.

## Constructor & Destructor Documentation

## OsgVectorFieldRepresentation()

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

explicit

Constructor.

Parameters

  name | Name of OsgVectorFieldRepresentation

## ~OsgVectorFieldRepresentation()

SurgSim::Graphics::OsgVectorFieldRepresentation::~OsgVectorFieldRepresentation | ( |  | ) |

Destructor.

## Member Function Documentation

## doUpdate()

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

override virtual

Reimplemented from SurgSim::Graphics::OsgRepresentation.

## getLineWidth()

double SurgSim::Graphics::OsgVectorFieldRepresentation::getLineWidth | ( |  | ) | const

override virtual

Gets line width.

Returns
  The line width

Implements SurgSim::Graphics::VectorFieldRepresentation.

## getPointSize()

double SurgSim::Graphics::OsgVectorFieldRepresentation::getPointSize | ( |  | ) | const

virtual

Gets the size of starting point of a vector.

Returns
  The size of starting point of a vector

Implements SurgSim::Graphics::VectorFieldRepresentation.

## getScale()

double SurgSim::Graphics::OsgVectorFieldRepresentation::getScale | ( |  | ) | const

override virtual

Gets the scale applied to all vectors.

Returns
  The scale

Implements SurgSim::Graphics::VectorFieldRepresentation.

## getVectorField()

std::shared_ptr< VectorField > SurgSim::Graphics::OsgVectorFieldRepresentation::getVectorField | ( |  | ) | const

override virtual

Gets the vector field.

Returns
  The vector field

Implements SurgSim::Graphics::VectorFieldRepresentation.

## privateUpdate()

void SurgSim::Graphics::OsgVectorFieldRepresentation::privateUpdate | ( | const std::vector< DataStructures::Vertex< VectorFieldData >> & | vertices | ) |

private

## setLineWidth()

void SurgSim::Graphics::OsgVectorFieldRepresentation::setLineWidth | ( | double | width | ) |

override virtual

Sets vector line width.

Parameters

  width | Width of vector line

Implements SurgSim::Graphics::VectorFieldRepresentation.

## setPointSize()

void SurgSim::Graphics::OsgVectorFieldRepresentation::setPointSize | ( | double | size | ) |

virtual

Sets the size of point indicating the starting of vector.

Parameters

  size | Size of starting point of a vector

Implements SurgSim::Graphics::VectorFieldRepresentation.

## setScale()

void SurgSim::Graphics::OsgVectorFieldRepresentation::setScale | ( | double | scale | ) |

override virtual

Sets the scale to be applied to all vectors.

Parameters

  scale | The scale

Implements SurgSim::Graphics::VectorFieldRepresentation.

## SURGSIM_CLASSNAME()

SurgSim::Graphics::OsgVectorFieldRepresentation::SURGSIM_CLASSNAME | ( | SurgSim::Graphics::OsgVectorFieldRepresentation |  | ) |

## updateVectorField()

void SurgSim::Graphics::OsgVectorFieldRepresentation::updateVectorField | ( | const VectorField & | vectorfield | ) |

override virtual

Updates the vector field in a threadsafe manner.

Parameters

  vectorfield | the new data

Implements SurgSim::Graphics::VectorFieldRepresentation.

## Member Data Documentation

## m_colors

osg::ref_ptr<osg::Vec4Array> SurgSim::Graphics::OsgVectorFieldRepresentation::m_colors

private

OSG::Vec4Array to hold color for each vector.

## m_drawArrays

osg::ref_ptr<osg::DrawArrays> SurgSim::Graphics::OsgVectorFieldRepresentation::m_drawArrays

private

An OSG::DrawArrays object specifying how vectors will be drawn.

## m_drawPoints

osg::ref_ptr<osg::DrawElementsUInt> SurgSim::Graphics::OsgVectorFieldRepresentation::m_drawPoints

private

An OSG::DrawElementUInt object specifying how vector starting points will be drawn.

## m_line

osg::ref_ptr<osg::LineWidth> SurgSim::Graphics::OsgVectorFieldRepresentation::m_line

private

OSG::LineWidth for representing vector.

## m_lineGeometry

osg::ref_ptr<osg::Geometry> SurgSim::Graphics::OsgVectorFieldRepresentation::m_lineGeometry

private

OSG::Geometry node holding OSG representation of vectors.

## m_point

osg::ref_ptr<osg::Point> SurgSim::Graphics::OsgVectorFieldRepresentation::m_point

private

OSG::Point for representing vector starting point.

## m_pointGeometry

osg::ref_ptr<osg::Geometry> SurgSim::Graphics::OsgVectorFieldRepresentation::m_pointGeometry

private

OSG::Geometry node holding OSG representation of vector starting points.

## m_scale

double SurgSim::Graphics::OsgVectorFieldRepresentation::m_scale

private

A scale to scale the length of vector.

## m_vectorField

std::shared_ptr<SurgSim::Graphics::VectorField> SurgSim::Graphics::OsgVectorFieldRepresentation::m_vectorField

private

Vector Field holds a list of vertices/points (X,Y,Z) in 3D space Each point is associated with a vector and an optional color.

## m_vertexData

osg::ref_ptr<osg::Vec3Array> SurgSim::Graphics::OsgVectorFieldRepresentation::m_vertexData

private

OSG vertex data structure.

## m_writeBuffer

SurgSim::Framework::LockedContainer<VectorField> SurgSim::Graphics::OsgVectorFieldRepresentation::m_writeBuffer

private

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

- SurgSim/Graphics/OsgVectorFieldRepresentation.h
- SurgSim/Graphics/OsgVectorFieldRepresentation.cpp