Public Member Functions | Private Attributes | List of all members
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:
SurgSim::Graphics::VectorFieldRepresentation SurgSim::Graphics::OsgRepresentation SurgSim::Graphics::Representation SurgSim::Graphics::Representation SurgSim::Framework::Representation SurgSim::Framework::Representation SurgSim::Framework::Component SurgSim::Framework::Component SurgSim::Framework::Accessible SurgSim::Framework::Accessible

Public Member Functions

 OsgVectorFieldRepresentation (const std::string &name)
 Constructor. More...
 
 ~OsgVectorFieldRepresentation ()
 Destructor. More...
 
virtual std::shared_ptr< SurgSim::Graphics::VectorFieldgetVectorField () const override
 Gets the vector field. More...
 
virtual void setLineWidth (double width) override
 Sets vector line width. More...
 
virtual double getLineWidth () const override
 Gets line width. More...
 
virtual void setScale (double scale) override
 Sets the scale to be applied to all vectors. More...
 
virtual 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...
 
virtual void doUpdate (double dt) override
 Executes the update operation. 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 void setLocalActive (bool val) override
 Set the component's active state. 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::stringgetGroupReferences ()
 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...
 
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 setScene (std::weak_ptr< Scene > scene)
 Sets the scene. More...
 
std::shared_ptr< ScenegetScene ()
 Gets the scene. More...
 
void setSceneElement (std::weak_ptr< SceneElement > sceneElement)
 Sets the scene element. More...
 
std::shared_ptr< SceneElementgetSceneElement ()
 Gets the scene element. More...
 
std::shared_ptr< const SceneElementgetSceneElement () const
 Gets the scene element, constant version. More...
 
std::shared_ptr< RuntimegetRuntime () 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< ComponentgetSharedPtr ()
 Gets a shared pointer to this component. More...
 
bool isActive () const
 
bool isLocalActive () const
 
- Public Member Functions inherited from SurgSim::Framework::Accessible
 Accessible ()
 Default Constructor. More...
 
 ~Accessible ()
 Destructor. More...
 
template<class 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...
 
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...
 
virtual void setVisible (bool visible) override
 Sets whether the representation is currently visible. More...
 
virtual bool isVisible () const override
 Gets whether the representation is currently visible. More...
 
virtual bool setMaterial (std::shared_ptr< Material > material) override
 Sets the material that defines the visual appearance of the representation. More...
 
virtual std::shared_ptr< MaterialgetMaterial () const override
 Gets the material that defines the visual appearance of the representation. More...
 
virtual void clearMaterial () override
 Removes the material from the representation. More...
 
virtual void setDrawAsWireFrame (bool val) override
 Sets the representation to render as a wire frame. More...
 
virtual bool getDrawAsWireFrame () const override
 Return if the representation is rendered as a wire frame. More...
 
virtual void update (double dt) override
 Updates the representation. More...
 

Private Attributes

std::shared_ptr< SurgSim::Graphics::VectorFieldm_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...
 
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::Component
typedef SurgSim::Framework::ObjectFactory1< SurgSim::Framework::Component, std::stringFactoryType
 
- 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
 
- Static Public Member Functions inherited from SurgSim::Framework::Component
static FactoryTypegetFactory ()
 
- 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< PoseComponentgetPoseComponent ()
 Get the PoseComponent for this component. More...
 
virtual std::shared_ptr< const PoseComponentgetPoseComponent () const
 Get the PoseComponent for this component, constant access. More...
 
- Protected Attributes inherited from SurgSim::Graphics::Representation
bool m_isVisible
 
- 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...
 
std::shared_ptr< OsgMaterialm_material
 Material defining the visual appearance of the representation. More...
 
bool m_drawAsWireFrame
 Indicates if the representation is rendered as a wireframe. More...
 

Detailed Description

OSG vector field representation, implements a VectorFieldRepresenation using OSG.

Constructor & Destructor Documentation

SurgSim::Graphics::OsgVectorFieldRepresentation::OsgVectorFieldRepresentation ( const std::string name)
explicit

Constructor.

Parameters
nameName of OsgVectorFieldRepresentation
SurgSim::Graphics::OsgVectorFieldRepresentation::~OsgVectorFieldRepresentation ( )

Destructor.

Member Function Documentation

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

Executes the update operation.

Parameters
dtThe time step

Reimplemented from SurgSim::Graphics::OsgRepresentation.

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

Gets line width.

Returns
The line width

Implements SurgSim::Graphics::VectorFieldRepresentation.

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.

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

Gets the scale applied to all vectors.

Returns
The scale

Implements SurgSim::Graphics::VectorFieldRepresentation.

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

Gets the vector field.

Returns
The vector field

Implements SurgSim::Graphics::VectorFieldRepresentation.

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

Sets vector line width.

Parameters
widthWidth of vector line

Implements SurgSim::Graphics::VectorFieldRepresentation.

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

Sets the size of point indicating the starting of vector.

Parameters
sizeSize of starting point of a vector

Implements SurgSim::Graphics::VectorFieldRepresentation.

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

Sets the scale to be applied to all vectors.

Parameters
scaleThe scale

Implements SurgSim::Graphics::VectorFieldRepresentation.

Member Data Documentation

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

OSG::Vec4Array to hold color for each vector.

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

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

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

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

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

OSG::LineWidth for representing vector.

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

OSG::Geometry node holding OSG representation of vectors.

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

OSG::Point for representing vector starting point.

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

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

double SurgSim::Graphics::OsgVectorFieldRepresentation::m_scale
private

A scale to scale the length of vector.

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.

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

OSG vertex data structure.


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