A text to be displayed on the screen in screen space coordinates, use setPose() to set the position but x,y are presumed to be in screen space with 0|0 being in the lower left corner, has a default font but can also received a separate font. More...

#include <TextRepresentation.h>

Inheritance diagram for SurgSim::Graphics::TextRepresentation:

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

virtual	~TextRepresentation ()
	Destructor.

virtual void	loadFont (const std::string &fileName)=0
	Load the font with the given file name, this will overwrite the current font. More...

virtual void	setFont (std::shared_ptr< SurgSim::Framework::Asset > font)=0
	Replace the current font with the one passed. More...

virtual std::shared_ptr< Font >	getFont () const =0

virtual void	setLocation (double x, double y)=0
	Sets the location in screen space. More...

virtual void	getLocation (double x, double y) const =0
	Gets the location in screen space. More...

virtual void	setText (const std::string &text)=0
	Sets the text to be shown on the screen. More...

virtual std::string	getText () const =0

virtual void	setMaximumWidth (double width)=0
	Sets a maximum width to the text display, the text should be broken up into multiple lines if the it is longer than width, if no value is given, or values <= 0 are used the width is assumed to be unlimited. More...

virtual double	getMaximumWidth ()=0

virtual void	setFontSize (double size)=0
	Set the vertical size of the font. More...

virtual double	getFontSize () const =0

virtual void	setColor (SurgSim::Math::Vector4d color)=0
	Set the color for the text. More...

virtual SurgSim::Math::Vector4d	getColor () const =0

virtual void	setUseScreenSpace (bool value)=0
	If set to true all the coordinate values are in screen-space coordinates (i.e. More...

virtual bool	isUsingScreenSpace () const =0

virtual void	setDrawBackground (bool value)=0
	Draw a filled background behind the text. More...

virtual bool	isDrawingBackground () const =0

virtual void	setBackgroundColor (Math::Vector4d color)=0
	Set the color of the background (if drawn) More...

virtual Math::Vector4d	getBackgroundColor ()=0

virtual void	setBackgroundMargin (double margin)=0
	Set the margin between background and text. More...

virtual double	getBackgroundMargin () const =0

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 Member Functions
virtual void	setOptionalMaximumWidth (SurgSim::DataStructures::OptionalValue< double > width)=0
	Optionally sets a maximum width to the text display, the text should be broken up into multiple lines if the it is longer than width, if no value is given, or values <= 0 are used the width is assumed to be unlimited. More...

virtual SurgSim::DataStructures::OptionalValue< double >	getOptionalMaximumWidth ()=0
	Get the current status of the width. 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...

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__"

Detailed Description

A text to be displayed on the screen in screen space coordinates, use setPose() to set the position but x,y are presumed to be in screen space with 0|0 being in the lower left corner, has a default font but can also received a separate font.

Constructor & Destructor Documentation

§ TextRepresentation()

SurgSim::Graphics::TextRepresentation::TextRepresentation ( const std::string name )

explicit

Constructor.

Parameters

name The name.

Member Function Documentation

§ getBackgroundColor()

virtual Math::Vector4d SurgSim::Graphics::TextRepresentation::getBackgroundColor ( )

pure virtual

Returns: the color that the background uses

Implemented in SurgSim::Graphics::OsgTextRepresentation.

§ getBackgroundMargin()

virtual double SurgSim::Graphics::TextRepresentation::getBackgroundMargin ( ) const

pure virtual

Returns: the margin between the background and the text

Implemented in SurgSim::Graphics::OsgTextRepresentation.

§ getColor()

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

pure virtual

Returns: the current text color

Implemented in SurgSim::Graphics::OsgTextRepresentation.

§ getFont()

virtual std::shared_ptr<Font> SurgSim::Graphics::TextRepresentation::getFont ( ) const

pure virtual

Returns: the current font

Implemented in SurgSim::Graphics::OsgTextRepresentation.

§ getFontSize()

virtual double SurgSim::Graphics::TextRepresentation::getFontSize ( ) const

pure virtual

Returns: the current font size

Implemented in SurgSim::Graphics::OsgTextRepresentation.

§ getLocation()

virtual void SurgSim::Graphics::TextRepresentation::getLocation	(	double *	x,
		double *	y
	)		const

pure virtual

Gets the location in screen space.

Parameters

[out] x,y If non-null the x and y coordinates, may throw if null is passed.

Implemented in SurgSim::Graphics::OsgTextRepresentation.

§ getMaximumWidth()

virtual double SurgSim::Graphics::TextRepresentation::getMaximumWidth ( )

pure virtual

Returns: the maximum width to be used if <=0 then the width is considered unlimited

Implemented in SurgSim::Graphics::OsgTextRepresentation.

§ getOptionalMaximumWidth()

virtual SurgSim::DataStructures::OptionalValue<double> SurgSim::Graphics::TextRepresentation::getOptionalMaximumWidth ( )

protectedpure virtual

Get the current status of the width.

Returns: the current maximum width, if there is no value the width is unlimited

Implemented in SurgSim::Graphics::OsgTextRepresentation.

§ getText()

virtual std::string SurgSim::Graphics::TextRepresentation::getText ( ) const

pure virtual

Returns: the current text

Implemented in SurgSim::Graphics::OsgTextRepresentation.

§ isDrawingBackground()

virtual bool SurgSim::Graphics::TextRepresentation::isDrawingBackground ( ) const

pure virtual

Returns: whether the background is being drawn or not

Implemented in SurgSim::Graphics::OsgTextRepresentation.

§ isUsingScreenSpace()

virtual bool SurgSim::Graphics::TextRepresentation::isUsingScreenSpace ( ) const

pure virtual

Returns: whether using screen space coordinates

Implemented in SurgSim::Graphics::OsgTextRepresentation.

§ loadFont()

virtual void SurgSim::Graphics::TextRepresentation::loadFont ( const std::string & fileName )

pure virtual

Load the font with the given file name, this will overwrite the current font.

Parameters

fileName the file that should be used to load the font

Implemented in SurgSim::Graphics::OsgTextRepresentation.

§ setBackgroundColor()

virtual void SurgSim::Graphics::TextRepresentation::setBackgroundColor ( Math::Vector4d color )

pure virtual

Set the color of the background (if drawn)

Parameters

color The color to use.

Implemented in SurgSim::Graphics::OsgTextRepresentation.

§ setBackgroundMargin()

virtual void SurgSim::Graphics::TextRepresentation::setBackgroundMargin ( double margin )

pure virtual

Set the margin between background and text.

Note: If world coordinates is being used, this is also world coordinates and should be appropriately small, if set too big, the background will filled the whole screen

Parameters

margin the margin between text and background.

Implemented in SurgSim::Graphics::OsgTextRepresentation.

§ setColor()

virtual void SurgSim::Graphics::TextRepresentation::setColor ( SurgSim::Math::Vector4d color )

pure virtual

Set the color for the text.

Parameters

color the color to be used.

Implemented in SurgSim::Graphics::OsgTextRepresentation.

§ setDrawBackground()

virtual void SurgSim::Graphics::TextRepresentation::setDrawBackground ( bool value )

pure virtual

Draw a filled background behind the text.

Parameters

value whether to fill the background behind the text

Implemented in SurgSim::Graphics::OsgTextRepresentation.

§ setFont()

virtual void SurgSim::Graphics::TextRepresentation::setFont ( std::shared_ptr< SurgSim::Framework::Asset > font )

pure virtual

Replace the current font with the one passed.

Parameters

font	the new font to be used

Implemented in SurgSim::Graphics::OsgTextRepresentation.

§ setFontSize()

virtual void SurgSim::Graphics::TextRepresentation::setFontSize ( double size )

pure virtual

Set the vertical size of the font.

Parameters

size	of the font

Implemented in SurgSim::Graphics::OsgTextRepresentation.

§ setLocation()

virtual void SurgSim::Graphics::TextRepresentation::setLocation	(	double	x,
		double	y
	)

pure virtual

Sets the location in screen space.

Parameters

x,y	The x and y coordinates.

Implemented in SurgSim::Graphics::OsgTextRepresentation.

§ setMaximumWidth()

virtual void SurgSim::Graphics::TextRepresentation::setMaximumWidth ( double width )

pure virtual

Sets a maximum width to the text display, the text should be broken up into multiple lines if the it is longer than width, if no value is given, or values <= 0 are used the width is assumed to be unlimited.

Parameters

width the value to be used.

Implemented in SurgSim::Graphics::OsgTextRepresentation.

§ setOptionalMaximumWidth()

virtual void SurgSim::Graphics::TextRepresentation::setOptionalMaximumWidth ( SurgSim::DataStructures::OptionalValue< double > width )

protectedpure virtual

Optionally sets a maximum width to the text display, the text should be broken up into multiple lines if the it is longer than width, if no value is given, or values <= 0 are used the width is assumed to be unlimited.

Parameters

width The width to be used, if width has no value, the maximum width is assumed to be unlimited

Implemented in SurgSim::Graphics::OsgTextRepresentation.

§ setText()

virtual void SurgSim::Graphics::TextRepresentation::setText ( const std::string & text )

pure virtual

Sets the text to be shown on the screen.

Parameters

text	the text to be used.

Implemented in SurgSim::Graphics::OsgTextRepresentation.

§ setUseScreenSpace()

virtual void SurgSim::Graphics::TextRepresentation::setUseScreenSpace ( bool value )

pure virtual

If set to true all the coordinate values are in screen-space coordinates (i.e.

pixels), world spaces otherwise

Note: ScreeenSpace is default, when using world coordinates the font size has to be adjusted to an appropriately small value (e.g. 0.01m)

Parameters

value whether to use screen space or world space coordinates

Implemented in SurgSim::Graphics::OsgTextRepresentation.

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

SurgSim/Graphics/TextRepresentation.h
SurgSim/Graphics/TextRepresentation.cpp

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

§ TextRepresentation()

Member Function Documentation

§ getBackgroundColor()

§ getBackgroundMargin()

§ getColor()

§ getFont()

§ getFontSize()

§ getLocation()

§ getMaximumWidth()

§ getOptionalMaximumWidth()

§ getText()

§ isDrawingBackground()

§ isUsingScreenSpace()

§ loadFont()

§ setBackgroundColor()

§ setBackgroundMargin()

§ setColor()

§ setDrawBackground()

§ setFont()

§ setFontSize()

§ setLocation()

§ setMaximumWidth()

§ setOptionalMaximumWidth()

§ setText()

§ setUseScreenSpace()