This implements a graphical object to draw an interpolated curve, it accepts a series of control points, the number of segments in the curve will depend on the number of control points and the value returned from getSubdivisions(). More...

#include <CurveRepresentation.h>

Inheritance diagram for SurgSim::Graphics::CurveRepresentation:

Public Member Functions
	CurveRepresentation (const std::string &name)
	Constructor. More...

virtual void	setSubdivisions (size_t num)=0
	Sets the number of intermediate points the get generated between each two control points. More...

virtual size_t	getSubdivisions () const =0

virtual void	setTension (double tension)=0
	Sets the tension (tau) parameter of the Catmull Rom interpolation, needs to be between 0.0 and 1.0. More...

virtual double	getTension () const =0

virtual void	setColor (const SurgSim::Math::Vector4d &color)=0
	Sets the color for the curve. More...

virtual Math::Vector4d	getColor () const =0

virtual void	setWidth (double width)=0
	Sets the line width to be used for drawing this curve. More...

virtual double	getWidth () const =0

virtual void	setAntiAliasing (bool val)=0
	Sets up whether to use anti aliasing on the curve or not. More...

virtual bool	isAntiAliasing () const =0

void	updateControlPoints (const DataStructures::VerticesPlain &vertices)
	Updates the control points for this class, this will cause a new curve to be generated on the next update. More...

void	updateControlPoints (DataStructures::VerticesPlain &&vertices)
	Updates the control points for this class, this will cause a new curve to be generated on the next update move support. More...

Public Member Functions inherited from SurgSim::Graphics::Representation
	Representation (const std::string &name)
	Constructor. More...

virtual	~Representation ()
	Destructor.

virtual bool	setMaterial (std::shared_ptr< SurgSim::Framework::Component > material)=0
	Sets the material that defines the visual appearance of the representation. More...

virtual std::shared_ptr< Material >	getMaterial () const =0
	Gets the material that defines the visual appearance of the representation. More...

void	setMaterialReference (const std::string &materialName)

std::string	getMaterialReference () const

virtual void	clearMaterial ()=0
	Removes the material from the representation.

virtual void	setDrawAsWireFrame (bool val)=0
	Sets the representation to render as a wire frame. More...

virtual bool	getDrawAsWireFrame () const =0
	Return if the representation is rendered as a wire frame. More...

virtual void	setGenerateTangents (bool value)=0
	Enable or disable the generation of tangents. More...

virtual bool	isGeneratingTangents () const =0

virtual void	update (double dt)=0
	Updates the representation. 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.

virtual void	addUniform (std::shared_ptr< UniformBase > uniform)=0
	Adds a uniform to this representation. More...

virtual void	addUniform (const std::string &type, const std::string &name, const boost::any &value)=0
	Adds and a uniform to this representation and set its value. More...

virtual void	setUniforms (const std::vector< std::shared_ptr< UniformBase >> &uniforms)=0
	Sets a set of uniforms for this representation. More...

virtual std::vector< std::shared_ptr< UniformBase > >	getUniforms () const =0

bool	doWakeUp () override
	Interface to be implemented by derived classes. 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.

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.

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.

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.

	~Accessible ()
	Destructor.

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

std::vector< std::string >	getProperties ()

template<>
boost::any	getValue (const std::string &name) const

Protected Attributes
Framework::LockedContainer< DataStructures::VerticesPlain >	m_locker
	Container control points, threadsafe access when updating.

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 = "__OssDefaultHud__"

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

Detailed Description

This implements a graphical object to draw an interpolated curve, it accepts a series of control points, the number of segments in the curve will depend on the number of control points and the value returned from getSubdivisions().

This class also provides the ad-hoc "Vertices" property, this means it can receive a

See also: DataStructures::VerticesPlain structure as a property via setValue()

Constructor & Destructor Documentation

§ CurveRepresentation()

SurgSim::Graphics::CurveRepresentation::CurveRepresentation ( const std::string & name )

explicit

Constructor.

Parameters

name	the name of the representation

Member Function Documentation

§ getColor()

virtual Math::Vector4d SurgSim::Graphics::CurveRepresentation::getColor ( ) const

pure virtual

Returns: the current color for this curve

Implemented in SurgSim::Graphics::OsgCurveRepresentation.

§ getSubdivisions()

virtual size_t SurgSim::Graphics::CurveRepresentation::getSubdivisions ( ) const

pure virtual

Returns: the number of interpolated points between control points

Implemented in SurgSim::Graphics::OsgCurveRepresentation.

§ getTension()

virtual double SurgSim::Graphics::CurveRepresentation::getTension ( ) const

pure virtual

Returns: the tension currently used

Implemented in SurgSim::Graphics::OsgCurveRepresentation.

§ getWidth()

virtual double SurgSim::Graphics::CurveRepresentation::getWidth ( ) const

pure virtual

Returns: the current width

Implemented in SurgSim::Graphics::OsgCurveRepresentation.

§ isAntiAliasing()

virtual bool SurgSim::Graphics::CurveRepresentation::isAntiAliasing ( ) const

pure virtual

Returns: whether the curve is currently being drawn with anti aliasing

Implemented in SurgSim::Graphics::OsgCurveRepresentation.

§ setAntiAliasing()

virtual void SurgSim::Graphics::CurveRepresentation::setAntiAliasing ( bool val )

pure virtual

Sets up whether to use anti aliasing on the curve or not.

Parameters

val	if true anti aliasing will be turned on

Implemented in SurgSim::Graphics::OsgCurveRepresentation.

§ setColor()

virtual void SurgSim::Graphics::CurveRepresentation::setColor ( const SurgSim::Math::Vector4d & color )

pure virtual

Sets the color for the curve.

Parameters

color the new color to be used

Implemented in SurgSim::Graphics::OsgCurveRepresentation.

§ setSubdivisions()

virtual void SurgSim::Graphics::CurveRepresentation::setSubdivisions ( size_t num )

pure virtual

Sets the number of intermediate points the get generated between each two control points.

Parameters

num	number of interpolated points

Implemented in SurgSim::Graphics::OsgCurveRepresentation.

§ setTension()

virtual void SurgSim::Graphics::CurveRepresentation::setTension ( double tension )

pure virtual

Sets the tension (tau) parameter of the Catmull Rom interpolation, needs to be between 0.0 and 1.0.

Parameters

tension the tension

Implemented in SurgSim::Graphics::OsgCurveRepresentation.

§ setWidth()

virtual void SurgSim::Graphics::CurveRepresentation::setWidth ( double width )

pure virtual

Sets the line width to be used for drawing this curve.

Parameters

width the new width to be used

Implemented in SurgSim::Graphics::OsgCurveRepresentation.

§ updateControlPoints() [1/2]

void SurgSim::Graphics::CurveRepresentation::updateControlPoints ( const DataStructures::VerticesPlain & vertices )

Updates the control points for this class, this will cause a new curve to be generated on the next update.

Note: this method is threadsafe

Exceptions

if	the number of control points is < 2

Parameters

vertices new vertices to be used as control points

§ updateControlPoints() [2/2]

void SurgSim::Graphics::CurveRepresentation::updateControlPoints ( DataStructures::VerticesPlain && vertices )

Updates the control points for this class, this will cause a new curve to be generated on the next update move support.

Note: this method is threadsafe

Exceptions

if	the number of control points is < 2

Parameters

vertices new vertices to be used as control points

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

SurgSim/Graphics/CurveRepresentation.h
SurgSim/Graphics/CurveRepresentation.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

§ CurveRepresentation()

Member Function Documentation

§ getColor()

§ getSubdivisions()

§ getTension()

§ getWidth()

§ isAntiAliasing()

§ setAntiAliasing()

§ setColor()

§ setSubdivisions()

§ setTension()

§ setWidth()

§ updateControlPoints() [1/2]

§ updateControlPoints() [2/2]