Osg implementation of the TextRepresentation, to be used with OsgFont assets. More...

#include <OsgTextRepresentation.h>

Inheritance diagram for SurgSim::Graphics::OsgTextRepresentation:

Public Types
enum	Anchor { ANCHOR_TOP_LEFT, ANCHOR_CENTER }

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

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

	~OsgTextRepresentation ()
	Destructor.

	SURGSIM_CLASSNAME (SurgSim::Graphics::OsgTextRepresentation)

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

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

void	setMaximumWidth (double width) override
	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...

double	getMaximumWidth () override

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

std::string	getText () const override

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

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

std::shared_ptr< Font >	getFont () const override

void	setColor (SurgSim::Math::Vector4d color) override
	Set the color for the text. More...

SurgSim::Math::Vector4d	getColor () const override

void	setFontSize (double size) override
	Set the vertical size of the font. More...

double	getFontSize () const override

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

bool	isUsingScreenSpace () const override

void	setAnchor (int anchor)

int	getAnchor () const

void	setDrawBackground (bool value) override
	Draw a filled background behind the text. More...

bool	isDrawingBackground () const override

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

Math::Vector4d	getBackgroundColor () override

void	setBackgroundMargin (double margin) override
	Set the margin between background and text. More...

double	getBackgroundMargin () const override

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

virtual	~OsgRepresentation ()
	Destructor.

osg::ref_ptr< osg::Node >	getOsgNode () const
	Returns the root OSG Node for this representations portion of the scene graph.

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.

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< UniformBase > uniform) override
	Adds a uniform to this representation. More...

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

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

std::vector< std::shared_ptr< UniformBase > >	getUniforms () const override

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

virtual	~Representation ()
	Destructor.

void	setMaterialReference (const std::string &materialName)

std::string	getMaterialReference () const

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.

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

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

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

virtual	~TextRepresentation ()
	Destructor.

Static Public Member Functions
static std::shared_ptr< OsgMaterial >	getDefaultMaterial ()

Static Public Member Functions inherited from SurgSim::Framework::FactoryBase1< Component, std::string >
static FactoryType &	getFactory ()

Protected Member Functions
void	doUpdate (double dt) override

bool	doInitialize () override
	Interface to be implemented by derived classes. More...

void	setOptionalMaximumWidth (SurgSim::DataStructures::OptionalValue< double > maximum) override
	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...

SurgSim::DataStructures::OptionalValue< double >	getOptionalMaximumWidth () override
	Get the current status of the width. More...

Protected Member Functions inherited from SurgSim::Graphics::OsgRepresentation
void	doRetire () override
	Interface to be implemented by derived classes Has a default implementation, does nothing.

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.

void	setOsgUniforms (const std::vector< std::shared_ptr< Graphics::OsgUniformBase >> &uniforms)
	Typed setter for uniforms. More...

std::vector< std::shared_ptr< Graphics::OsgUniformBase > >	getOsgUniforms () const

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

Friends
class	OsgTextRepresentationTests_MaximumWidth_Test

Additional Inherited Members
Static Public Attributes inherited from SurgSim::Graphics::Representation
static const std::string	DefaultGroupName = "__OssDefault__"

static const std::string	DefaultHudGroupName = "__OssDefaultHud__"

Protected Attributes inherited from SurgSim::Graphics::OsgRepresentation
osg::ref_ptr< osg::Switch >	m_switch
	Switch used to toggle the visibility of the representation.

osg::ref_ptr< osg::PositionAttitudeTransform >	m_transform
	Transform used to pose the representation.

osg::ref_ptr< osg::Group >	m_materialProxy
	Holder for attributes coming from OsgMaterial.

std::shared_ptr< OsgMaterial >	m_material
	Material defining the visual appearance of the representation.

osg::ref_ptr< TangentSpaceGenerator >	m_tangentGenerator
	Visitor to generate tangents.

bool	m_drawAsWireFrame
	Indicates if the representation is rendered as a wireframe.

std::shared_ptr< OsgUniform< SurgSim::Math::Matrix44f > >	m_modelMatrixUniform

std::vector< std::shared_ptr< OsgUniformBase > >	m_uniforms

Detailed Description

Osg implementation of the TextRepresentation, to be used with OsgFont assets.

Constructor & Destructor Documentation

§ OsgTextRepresentation()

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

explicit

Constructor.

Parameters

name	Name of this OsgInfo

Member Function Documentation

§ doInitialize()

bool SurgSim::Graphics::OsgTextRepresentation::doInitialize ( )

overrideprotectedvirtual

Interface to be implemented by derived classes.

Returns: True if component is initialized successfully; otherwise, false.

Reimplemented from SurgSim::Framework::Representation.

§ getBackgroundColor()

Math::Vector4d SurgSim::Graphics::OsgTextRepresentation::getBackgroundColor ( )

overridevirtual

Returns: the color that the background uses

Implements SurgSim::Graphics::TextRepresentation.

§ getBackgroundMargin()

double SurgSim::Graphics::OsgTextRepresentation::getBackgroundMargin ( ) const

overridevirtual

Returns: the margin between the background and the text

Implements SurgSim::Graphics::TextRepresentation.

§ getColor()

SurgSim::Math::Vector4d SurgSim::Graphics::OsgTextRepresentation::getColor ( ) const

overridevirtual

Returns: the current text color

Implements SurgSim::Graphics::TextRepresentation.

§ getFont()

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

overridevirtual

Returns: the current font

Implements SurgSim::Graphics::TextRepresentation.

§ getFontSize()

double SurgSim::Graphics::OsgTextRepresentation::getFontSize ( ) const

overridevirtual

Returns: the current font size

Implements SurgSim::Graphics::TextRepresentation.

§ getLocation()

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

overridevirtual

Gets the location in screen space.

Parameters

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

Implements SurgSim::Graphics::TextRepresentation.

§ getMaximumWidth()

double SurgSim::Graphics::OsgTextRepresentation::getMaximumWidth ( )

overridevirtual

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

Implements SurgSim::Graphics::TextRepresentation.

§ getOptionalMaximumWidth()

SurgSim::DataStructures::OptionalValue< double > SurgSim::Graphics::OsgTextRepresentation::getOptionalMaximumWidth ( )

overrideprotectedvirtual

Get the current status of the width.

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

Implements SurgSim::Graphics::TextRepresentation.

§ getText()

std::string SurgSim::Graphics::OsgTextRepresentation::getText ( ) const

overridevirtual

Returns: the current text

Implements SurgSim::Graphics::TextRepresentation.

§ isDrawingBackground()

bool SurgSim::Graphics::OsgTextRepresentation::isDrawingBackground ( ) const

overridevirtual

Returns: whether the background is being drawn or not

Implements SurgSim::Graphics::TextRepresentation.

§ isUsingScreenSpace()

bool SurgSim::Graphics::OsgTextRepresentation::isUsingScreenSpace ( ) const

overridevirtual

Returns: whether using screen space coordinates

Implements SurgSim::Graphics::TextRepresentation.

§ loadFont()

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

overridevirtual

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

Implements SurgSim::Graphics::TextRepresentation.

§ setBackgroundColor()

void SurgSim::Graphics::OsgTextRepresentation::setBackgroundColor ( Math::Vector4d color )

overridevirtual

Set the color of the background (if drawn)

Parameters

color The color to use.

Implements SurgSim::Graphics::TextRepresentation.

§ setBackgroundMargin()

void SurgSim::Graphics::OsgTextRepresentation::setBackgroundMargin ( double margin )

overridevirtual

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.

Implements SurgSim::Graphics::TextRepresentation.

§ setColor()

void SurgSim::Graphics::OsgTextRepresentation::setColor ( SurgSim::Math::Vector4d color )

overridevirtual

Set the color for the text.

Parameters

color the color to be used.

Implements SurgSim::Graphics::TextRepresentation.

§ setDrawBackground()

void SurgSim::Graphics::OsgTextRepresentation::setDrawBackground ( bool value )

overridevirtual

Draw a filled background behind the text.

Parameters

value whether to fill the background behind the text

Implements SurgSim::Graphics::TextRepresentation.

§ setFont()

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

overridevirtual

Replace the current font with the one passed.

Parameters

font	the new font to be used

Implements SurgSim::Graphics::TextRepresentation.

§ setFontSize()

void SurgSim::Graphics::OsgTextRepresentation::setFontSize ( double size )

overridevirtual

Set the vertical size of the font.

Parameters

size	of the font

Implements SurgSim::Graphics::TextRepresentation.

§ setLocation()

void SurgSim::Graphics::OsgTextRepresentation::setLocation	(	double	x,
		double	y
	)

overridevirtual

Sets the location in screen space.

Parameters

x,y	The x and y coordinates.

Implements SurgSim::Graphics::TextRepresentation.

§ setMaximumWidth()

void SurgSim::Graphics::OsgTextRepresentation::setMaximumWidth ( double width )

overridevirtual

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.

Implements SurgSim::Graphics::TextRepresentation.

§ setOptionalMaximumWidth()

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

overrideprotectedvirtual

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

Implements SurgSim::Graphics::TextRepresentation.

§ setText()

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

overridevirtual

Sets the text to be shown on the screen.

Parameters

text	the text to be used.

Implements SurgSim::Graphics::TextRepresentation.

§ setUseScreenSpace()

void SurgSim::Graphics::OsgTextRepresentation::setUseScreenSpace ( bool value )

overridevirtual

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

Implements SurgSim::Graphics::TextRepresentation.

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

SurgSim/Graphics/OsgTextRepresentation.h
SurgSim/Graphics/OsgTextRepresentation.cpp

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

§ OsgTextRepresentation()

Member Function Documentation

§ doInitialize()

§ getBackgroundColor()

§ getBackgroundMargin()

§ getColor()

§ getFont()

§ getFontSize()

§ getLocation()

§ getMaximumWidth()

§ getOptionalMaximumWidth()

§ getText()

§ isDrawingBackground()

§ isUsingScreenSpace()

§ loadFont()

§ setBackgroundColor()

§ setBackgroundMargin()

§ setColor()

§ setDrawBackground()

§ setFont()

§ setFontSize()

§ setLocation()

§ setMaximumWidth()

§ setOptionalMaximumWidth()

§ setText()

§ setUseScreenSpace()