A model-like object that draws a 2D text on screen. More...

Inheritance diagram for makVrv::DtWindowText:

Public Types
enum	TextAlignment { Left = 0, Center = 1, Right = 2, Justify = 3 }

Public Types inherited from makVrv::DtWindowObject
typedef std::list< DtUniqueID >	ChildList
	typedef list for holding the IDs of the children of this class More...

typedef DtVector2< double >	DtVector2d
	typedef 2D Vector More...

typedef DtMatrix3< double >	Transform
	typedef 3x3 Matrix for holding this object's transform More...

Public Member Functions
	DtWindowText (DtDe &de, DtUniqueID id)
	CTOR. More...

virtual	~DtWindowText ()
	DTOR. More...

virtual void	setTopLeftCorner (float x, float y)
	Set the Top left corner of the text in normalized screen coordinates (0..1) This position is relative to the position set in the base DtWindowObject::setPosition, if no position is set it defaults to (0.0,0.0) More...

virtual void	setVisible (bool isVisible)
	Set the text visible or invisible. More...

virtual void	setColor (float r, float g, float b, float a)
	Set the text's color. More...

virtual void	setText (const std::string &textString)
	Set the text to display. More...

virtual void	setFont (const std::string &fontFile, float sizeInPoints)
	Set the font file and size in points to display the text in. More...

virtual void	setTextBoxWidth (unsigned int widthInPixels)
	Set the width of the text box in pixels. More...

virtual void	setAlignment (unsigned int alignment)
	Set the alignment mode of the text. More...

virtual void	setInstance (DtWindowTextInstance *instance)
	Set or replace the text instance that implements the text graphically Transfers ownership. More...

virtual DtWindowTextInstance *	findInstance ()
	Get the text instance that implements the text graphically. More...

virtual void	setGroup (int groupId)
	Set this object's group ID for z order. More...

virtual void	setChannelOverlay (std::string displayName, std::string windowName, std::string channelName)
	By default window objects are placed on the RemoteDisplayWorldOverlay, which is rendered on all channels that have the "showRemoteGraphics" channel keyword. More...

Public Member Functions inherited from makVrv::DtWindowObject
	DtWindowObject (DtDe &de, DtUniqueID id)
	CTOR. More...

virtual	~DtWindowObject ()
	DTOR. More...

virtual bool	visible ()

virtual DtUniqueID	uniqueId ()
	Returns the unique ID of this object. More...

DtWindowObject *	getParent ()
	Get the parent windowObject. More...

virtual ChildList	childList ()
	Returns the child list. More...

virtual void	addChild (DtUniqueID id)
	Add a child to this objects child list. More...

virtual void	removeChild (DtUniqueID id)
	Remove a child from this objects child list. More...

virtual void	getColor (float &r, float &g, float &b, float &a)

virtual void	slot_postTick ()
	Slot for DtDe::signal_postTick, using when this object is flashing/blinking. More...

virtual Transform	windowTransform ()
	Get the window transform that is the total transform of this object and all it's parents. More...

virtual DtClipBox	clipBox ()
	Get this object's clip box specifications. More...

virtual void	setParentId (DtUniqueID parentId)
	Get / Set Parent IDs. More...

virtual DtUniqueID	getParentId ()

virtual void	setPosition (double x, double y)
	Set / Get the window position of this object. More...

virtual void	getPosition (double &x, double &y)

virtual void	setScale (double scale)
	Set / Get the scale of the x y components. More...

virtual void	setScale (double x, double y)

virtual void	getScale (double &x, double &y)

virtual void	setRotation (double rotation)
	Set / Get the rotation of the window object around it's set position, (0.0,0.0) if none is set. More...

virtual void	getRotation (double &rotation)

virtual void	setInheritColor (bool inheritColor)
	Set / Get whether this object inherits it's color from it's parent. More...

virtual bool	inheritColor ()

virtual int	group ()

virtual void	setFlashing (bool flashing, double interval)
	Set / Get this object to flash on and off at the given interval. More...

virtual void	getFlashing (bool &flashing, double &interval)

virtual void	getChannelOverlay (std::string &displayName, std::string &windowName, std::string &channelName)

Protected Member Functions
virtual void	update ()
	Called on signal_postUpdate; time to update render data. More...

virtual void	needsUpdate ()
	Called by all mutators to set up a postUpdate signal if not already connected. More...

Protected Attributes
DtWindowTextInstance *	myInstance

bool	myConnectedToPostUpdate

Protected Attributes inherited from makVrv::DtWindowObject
DtDe &	myDe

DtUniqueID	myUniqueId

DtUniqueID	myParentId

ChildList	myChildIdList

DtVector2d	myPosition

DtVector2d	myScale

DtVector2d	myWindowScale

double	myRotation

double	myFlashInterval

double	myLastFlashTime

double	myLastSimTime

bool	myVisible

bool	myLastVisibilityFlash

bool	myInheritColor

bool	myFlashing

float	myColorR

float	myColorG

float	myColorB

float	myColorA

Transform	myWindowTransform

DtClipBox	myClipBox

int	myGroup

std::string	myDisplayName

std::string	myWindowName

std::string	myChannelName

Detailed Description

A model-like object that draws a 2D text on screen.

This window text class inherits from DtWindowObject() which means it can be included in a parent/child relationship with other window objects, including surfaces, lines, polygons, and ellipses. Rotations are around the Top Left Corner that is set, the top left position is relative to the position set in the base class. Text is not currently clipped by each letter, clipping that occurs if this object is attached to a surface, is based on the top left position. If the object is clipped, it is clipped entirely. If this object is a child of another object, the position set is relative to the parent. Scale does not currently work for DtWindowText, please change the font size.

Member Enumeration Documentation

enum makVrv::DtWindowText::TextAlignment

Enumerator
Left
Center
Right
Justify

Constructor & Destructor Documentation

makVrv::DtWindowText::DtWindowText	(	DtDe &	de,
		DtUniqueID	id
	)

CTOR.

virtual makVrv::DtWindowText::~DtWindowText ( )

virtual

DTOR.

Member Function Documentation

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

virtual

Set the Top left corner of the text in normalized screen coordinates (0..1) This position is relative to the position set in the base DtWindowObject::setPosition, if no position is set it defaults to (0.0,0.0)

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

virtual

Set the text visible or invisible.

Reimplemented from makVrv::DtWindowObject.

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

virtual

Set the text's color.

Reimplemented from makVrv::DtWindowObject.

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

virtual

Set the text to display.

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

virtual

Set the font file and size in points to display the text in.

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

virtual

Set the width of the text box in pixels.

virtual void makVrv::DtWindowText::setAlignment ( unsigned int alignment )

virtual

Set the alignment mode of the text.

virtual void makVrv::DtWindowText::setInstance ( DtWindowTextInstance * instance )

virtual

Set or replace the text instance that implements the text graphically Transfers ownership.

virtual DtWindowTextInstance* makVrv::DtWindowText::findInstance ( )

virtual

Get the text instance that implements the text graphically.

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

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

Reimplemented from makVrv::DtWindowObject.

virtual void makVrv::DtWindowText::setChannelOverlay	(	std::string	displayName,
		std::string	windowName,
		std::string	channelName
	)

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.

Reimplemented from makVrv::DtWindowObject.

virtual void makVrv::DtWindowText::update ( )

protectedvirtual

Called on signal_postUpdate; time to update render data.

virtual void makVrv::DtWindowText::needsUpdate ( )

protectedvirtual

Called by all mutators to set up a postUpdate signal if not already connected.

Reimplemented from makVrv::DtWindowObject.

Member Data Documentation

DtWindowTextInstance* makVrv::DtWindowText::myInstance

protected

bool makVrv::DtWindowText::myConnectedToPostUpdate

protected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-10-branch/include/vrvCore/DtWindowText.h

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation