A 3D Text Stealth Draw Control Object. More...

Inheritance diagram for vrvControlToolkit::DtText3DObject:

Public Member Functions
	DtText3DObject (DtExerciseConn *exConn, unsigned id, const DtString &text, const DtVdc3DAttachPoint &attachment, const DtVector &enuOffset=DtVector::zero(), DtVdcColor color=DtVdcColor::DtVdcWhite, bool flashing=false)
	Construct the text Draw Control Object.
virtual	~DtText3DObject ()
virtual const DtString &	text () const
	text accessor
virtual void	setText (const DtString &text)
	text mutator
virtual const DtVdc3DAttachPoint &	attachment () const
	attachment accessor
virtual void	setAttachment (const DtVdc3DAttachPoint &attachment)
	attachment mutator
virtual const DtVector &	offset () const
	offset accessor
virtual void	setOffset (const DtVector &off)
	offset mutator
virtual const DtVdcColor &	color () const
	color accessor
virtual void	setColor (const DtVdcColor &color)
	color mutator
virtual bool	flashing () const
	flashing accessor
virtual void	setFlashing (bool flashing)
	flashing mutator
virtual void	setRemoteGraphicSet (const std::string &setName)
virtual void	update ()
	update the internal pdu
Protected Member Functions
void	initRecords ()
Protected Attributes
DtVdc3DAttachPoint	myAttachment
DtVector	myOffset
DtVdcColor	myColor
bool	myFlashing
DtString	myText
DtEnvironmentalPointRecord	myPointRecord
Dt3DGraphicalObjectStateRecord	myStateRecord
Private Member Functions
	DtText3DObject ()
	Default constructor.
	DtText3DObject (const DtText3DObject &orig)
	Copy constructor.
DtText3DObject &	operator= (const DtText3DObject &rhs)
	Assignment operator.

Detailed Description

A 3D Text Stealth Draw Control Object.

DtText3DObject represents text that can be positioned and displayed in the 3D scene. A color can be specified; and the text can flash, if desired.

Constructor & Destructor Documentation

vrvControlToolkit::DtText3DObject::DtText3DObject	(	DtExerciseConn *	exConn,
		unsigned	id,
		const DtString &	text,
		const DtVdc3DAttachPoint &	attachment,
		const DtVector &	enuOffset = `DtVector::zero()`,
		DtVdcColor	color = `DtVdcColor::DtVdcWhite`,
		bool	flashing = `false`
	)

Construct the text Draw Control Object.

Parameters:

id	Passed to DtDrawControlObject base (see)
text	The text to draw
attachment	DtVdc3DAttachPoint indicating how the text object is positioned in 3D
enuOffset	a 3D vector indicating an east/north/up offset (in meters) from the base attachment
color	The color of the text
flashing	A boolean parameter indicating whether or not the text should be flashing

virtual vrvControlToolkit::DtText3DObject::~DtText3DObject ( ) [virtual]

vrvControlToolkit::DtText3DObject::DtText3DObject ( ) [private]

Default constructor.

Private and not implemented - you must supply an id and basic geometric parameters to construct the ellipse or rectangle

vrvControlToolkit::DtText3DObject::DtText3DObject ( const DtText3DObject & orig ) [private]

Copy constructor.

Private and unimplemented - not copyable.

Member Function Documentation

DtText3DObject& vrvControlToolkit::DtText3DObject::operator= ( const DtText3DObject & rhs ) [private]

Assignment operator.

Private and unimplemented - not copyable.

virtual const DtString& vrvControlToolkit::DtText3DObject::text ( ) const [virtual]

text accessor

Get the actual text to draw

Returns:: Text

virtual void vrvControlToolkit::DtText3DObject::setText ( const DtString & text ) [virtual]

text mutator

Set the text to be drawn

Parameters:

text	The actual text to draw

virtual const DtVdc3DAttachPoint& vrvControlToolkit::DtText3DObject::attachment ( ) const [virtual]

attachment accessor

Get the text's attachment information

Returns:: DtVdc3DAttachPoint, which contains the attachment type and associated data

Implements vrvControlToolkit::Dt3DPositionedObject.

virtual void vrvControlToolkit::DtText3DObject::setAttachment ( const DtVdc3DAttachPoint & attachment ) [virtual]

attachment mutator

Set the text's attachment information

Parameters:

attachment

Implements vrvControlToolkit::Dt3DPositionedObject.

virtual const DtVector& vrvControlToolkit::DtText3DObject::offset ( ) const [virtual]

offset accessor

Get the object's offset from the attach point, in entity coordinates if attached, geocentric otherwise

Returns:: [X, Y, Z] enuOffset

virtual void vrvControlToolkit::DtText3DObject::setOffset ( const DtVector & off ) [virtual]

offset mutator

Set the object's offset from the attach point, in entity coordinates if attached, geocentric otherwise

Parameters:

enuOffset [X, Y, Z]

virtual const DtVdcColor& vrvControlToolkit::DtText3DObject::color ( ) const [virtual]

color accessor

Get the color assigned to the text

Returns:: Instance of DtVdcColor

Reimplemented from vrvControlToolkit::DtDrawControlObject.

virtual void vrvControlToolkit::DtText3DObject::setColor ( const DtVdcColor & color ) [virtual]

color mutator

Set the color to use when drawing the text

Parameters:

color The DtVdcColor to use

Reimplemented from vrvControlToolkit::DtDrawControlObject.

virtual bool vrvControlToolkit::DtText3DObject::flashing ( ) const [virtual]

flashing accessor

Get the boolean that indicates whether or not the text should flash

Returns:: true or false

Reimplemented from vrvControlToolkit::DtDrawControlObject.

virtual void vrvControlToolkit::DtText3DObject::setFlashing ( bool flashing ) [virtual]

flashing mutator

Set the boolean that indicates whether or not the text should flash

Parameters:

flashing true or false

Reimplemented from vrvControlToolkit::DtDrawControlObject.

virtual void vrvControlToolkit::DtText3DObject::setRemoteGraphicSet ( const std::string & setName ) [virtual]

Reimplemented from vrvControlToolkit::DtDrawControlObject.

virtual void vrvControlToolkit::DtText3DObject::update ( ) [virtual]

update the internal pdu

Make sure the internal pdu reflects the actual state of the draw control object's members. This is necessary because some members can be modified directly (which make the interface easier to use). DtStealthRemoteDrawer::update() calls this, so the user doesn't need to; but if the user is accessing the pdu directly (via the pdu() accessor) this should be called before using the pdu.

Implements vrvControlToolkit::DtDrawControlObject.

void vrvControlToolkit::DtText3DObject::initRecords ( ) [protected]