Interface for a DtWindowTextInstance An object that draws a 2D text.

Inheritance diagram for makVrv::DtWindowTextInstance:

Public Member Functions
virtual	~DtWindowTextInstance ()

virtual void	setVisible (bool isVisible)=0

virtual void	setTopLeftCorner (float x, float y)=0

virtual void	setColor (float r, float g, float b, float a)=0

virtual void	setText (const std::string &textString)=0

virtual void	setFont (const std::string &fontFile, float sizeInPoints)=0

virtual void	setTextBoxWidth (unsigned int widthInPixels)=0

virtual void	setAlignment (DtWindowText::TextAlignment alignment)=0

virtual void	setTransform (DtMatrix3< double > transform)=0

virtual void	update ()=0

virtual void	setClipBox (DtVector2< double > bottomLeftLocation, DtVector2< double > topRightLocation)=0

virtual void	setGroup (int groupId)=0

virtual void	setChannelOverlay (const std::string &displayName, const std::string &windowName, const std::string &channelName)=0

Public Member Functions inherited from makVrv::DtSetVisibilityInterface
virtual	~DtSetVisibilityInterface ()

Constructor & Destructor Documentation

virtual makVrv::DtWindowTextInstance::~DtWindowTextInstance ( )

virtual

DTOR.

Member Function Documentation

virtual void makVrv::DtWindowTextInstance::setVisible ( bool isVisible )

pure virtual

Set the text visible or invisible.

Implements makVrv::DtSetVisibilityInterface.

Implemented in makVrv::DtOsgWindowTextInstance.

virtual void makVrv::DtWindowTextInstance::setTopLeftCorner	(	float	x,
		float	y
	)

pure virtual

Set the Top left corner of the text in normalized screen coordinates (0..1)

Implemented in makVrv::DtOsgWindowTextInstance.

virtual void makVrv::DtWindowTextInstance::setColor	(	float	r,
		float	g,
		float	b,
		float	a
	)

pure virtual

Set the text's color.

Implemented in makVrv::DtOsgWindowTextInstance.

virtual void makVrv::DtWindowTextInstance::setText ( const std::string & textString )

pure virtual

Set the text to display.

Implemented in makVrv::DtOsgWindowTextInstance.

virtual void makVrv::DtWindowTextInstance::setFont	(	const std::string &	fontFile,
		float	sizeInPoints
	)

pure virtual

Set the font file path and size in points to display the text in The fontFilePath provided can make use of VRV Path Macros, e.g. the fontFilePath could be: /Fonts/arial.ttf.

See Also: DtDePathConfiguration

Implemented in makVrv::DtOsgWindowTextInstance.

virtual void makVrv::DtWindowTextInstance::setTextBoxWidth ( unsigned int widthInPixels )

pure virtual

Set the width of the text box in pixels.

Implemented in makVrv::DtOsgWindowTextInstance.

virtual void makVrv::DtWindowTextInstance::setAlignment ( DtWindowText::TextAlignment alignment )

pure virtual

Set the alignment mode of the text.

Implemented in makVrv::DtOsgWindowTextInstance.

virtual void makVrv::DtWindowTextInstance::setTransform ( DtMatrix3< double > transform )

pure virtual

Sets the text box's transform matrix, used to update the position and clockwise rotation of the vertices.

Implemented in makVrv::DtOsgWindowTextInstance.

virtual void makVrv::DtWindowTextInstance::update ( )

pure virtual

Called on signal_postUpdate; time to update render data.

Implemented in makVrv::DtOsgWindowTextInstance.

virtual void makVrv::DtWindowTextInstance::setClipBox	(	DtVector2< double >	bottomLeftLocation,
		DtVector2< double >	topRightLocation
	)

pure virtual

Set this objects clip box bounds.

Implemented in makVrv::DtOsgWindowTextInstance.

virtual void makVrv::DtWindowTextInstance::setGroup ( int groupId )

pure virtual

Set this object's group ID for z order. The higher the Z order the "closer" the element will be drawn to the eye point.

Implemented in makVrv::DtOsgWindowTextInstance.

virtual void makVrv::DtWindowTextInstance::setChannelOverlay	(	const std::string &	displayName,
		const std::string &	windowName,
		const std::string &	channelName
	)

pure virtual

By default window objects are placed on the RemoteDisplayWorldOverlay, which is rendered on all channels that have the "showRemoteGraphics" channel keyword. If a user wishes to draw a specific window object on a specific channel, use this method. This does not work for remote displays.

Implemented in makVrv::DtOsgWindowTextInstance.

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrvCore/DtWindowTextInstance.h

Public Member Functions

Constructor & Destructor Documentation

Member Function Documentation