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

Inheritance diagram for DtSdcText2DObject:

Public Member Functions
	DtSdcText2DObject (DtExerciseConn *exConn, unsigned id, const DtString &text, const DtSdcVector2D &position, DtSdcColor color=DtSdcColor::DtSdcWhite, bool flashing=false)
	Construct the text Draw Control Object.
virtual	~DtSdcText2DObject ()
virtual DtString	text () const
	text accessor
virtual void	setText (const DtString &text)
	text mutator
virtual DtSdcVector2D	position () const
	position accessor
virtual void	setPosition (const DtSdcVector2D &position)
	position mutator
virtual const DtSdcColor &	color () const
	color accessor
virtual void	setColor (const DtSdcColor &color)
	color mutator
virtual bool	flashing () const
	flashing accessor
virtual void	setFlashing (bool flashing)
	flashing mutator
virtual void	setFont (const char *fontFile, float size)
	font mutator
virtual void	setRemoteGraphicSet (const std::string &setName)
virtual void	update ()
	update the internal pdu
Public Member Functions inherited from DtSdcObject
	DtSdcObject (DtExerciseConn *exConn, unsigned id, const DtString &objName)
	Parameterized constructor.
virtual	~DtSdcObject ()
	Virtual destructor.
virtual unsigned	id () const
	id accessor
virtual void	setId (unsigned id)
	id mutator
virtual const DtGlobalObjectDesignator &	globalId () const
virtual void	setVisible (bool yesNo)
virtual bool	visible () const

Protected Attributes
DtSdcVector2D	myPosition
DtSdcColor	myColor
bool	myFlashing
DtString	myText
Dt2DGraphicalObjectTextStateRecord *	myStateRecord
Protected Attributes inherited from DtSdcObject
unsigned	myId
DtEnvironmentProcessPublisher	myPublisher
bool	myVisible
DtSdcColor	myEmptyColor

Private Member Functions
	DtSdcText2DObject ()
	Default constructor.

Detailed Description

A 2D Text Stealth Draw Control Object.

DtSdcText2DObject represents text that can be positioned and displayed on the screen. A color can be specified; and the text can flash, if desired.

Constructor & Destructor Documentation

DtSdcText2DObject::DtSdcText2DObject	(	DtExerciseConn *	exConn,
		unsigned	id,
		const DtString &	text,
		const DtSdcVector2D &	position,
		DtSdcColor	color = `DtSdcColor::DtSdcWhite`,
		bool	flashing = `false`
	)

Construct the text Draw Control Object.

Parameters

id	Passed to DtSdcObject base (see)
text	The text to draw
position	X,Y position of bottom-left corner of text on the screen - values go from [0.,0.] (left,bottom) to [1.,1.] (right, top)
color	The color of the text
flashing	A boolean parameter indicating whether or not the text should be flashing

References Dt2DGraphicalObjectCategoryText, Dt2DGraphicalObjectKind, DtEnv2DGraphicalObjectTextStateRecordType, DtSdcObject::id(), myColor, myFlashing, myPosition, DtSdcObject::myPublisher, myStateRecord, myText, setColor(), setFlashing(), setFont(), Dt2DGraphicalObjectStateRecord::setNumberOfVertices(), setPosition(), and setText().

DtSdcText2DObject::~DtSdcText2DObject ( )

virtual

DtSdcText2DObject::DtSdcText2DObject ( )

private

Default constructor.

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

Member Function Documentation

DtString DtSdcText2DObject::text ( ) const

virtual

text accessor

Get the actual text to draw

Returns: Text

References myText.

Referenced by setText().

void DtSdcText2DObject::setText ( const DtString & text )

virtual

text mutator

Set the text to be drawn

Parameters

text	The actual text to draw

References myStateRecord, myText, Dt2DGraphicalObjectStateRecord::setUserData(), and text().

Referenced by DtSdcText2DObject().

DtSdcVector2D DtSdcText2DObject::position ( ) const

virtual

position accessor

Get the text's bottom-left corner position

Returns: [0.,0] (left, bottom) to [1.,1.] (right, top)

References myPosition.

Referenced by setPosition().

void DtSdcText2DObject::setPosition ( const DtSdcVector2D & position )

virtual

position mutator

Set the text's bottom-left corner position

Parameters

position [0.,0] (left, bottom) to [1.,1.] (right, top)

References myPosition, myStateRecord, position(), Dt2DGraphicalObjectStateRecord::setVertex(), and DtSdcVector2D::vector3D().

Referenced by DtSdcText2DObject().

const DtSdcColor & DtSdcText2DObject::color ( ) const

virtual

color accessor

Get the color assigned to the text

Returns: Instance of DtSdcColor

Reimplemented from DtSdcObject.

References myColor.

Referenced by setColor().

void DtSdcText2DObject::setColor ( const DtSdcColor & color )

virtual

color mutator

Set the color to use when drawing the text

Parameters

color The DtSdcColor to use

Reimplemented from DtSdcObject.

References DtSdcColor::alpha(), DtSdcColor::blue(), color(), DtSdcColor::green(), myColor, myStateRecord, DtSdcColor::red(), and Dt2DGraphicalObjectStateRecord::setColor().

Referenced by DtSdcText2DObject().

bool DtSdcText2DObject::flashing ( ) const

virtual

flashing accessor

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

Returns: true or false

Reimplemented from DtSdcObject.

References myFlashing.

Referenced by setFlashing().

void DtSdcText2DObject::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 DtSdcObject.

References flashing(), myFlashing, myStateRecord, and Dt2DGraphicalObjectStateRecord::setFlashing().

Referenced by DtSdcText2DObject().

void DtSdcText2DObject::setFont	(	const char *	fontFile,
		float	size
	)

virtual

font mutator

Set the font

References myStateRecord, Dt2DGraphicalObjectTextStateRecord::setFontName(), and Dt2DGraphicalObjectTextStateRecord::setFontSize().

Referenced by DtSdcText2DObject().

void DtSdcText2DObject::setRemoteGraphicSet ( const std::string & setName )

virtual

Reimplemented from DtSdcObject.

References myStateRecord, Dt2DGraphicalObjectStateRecord::setNumberOfParentOverlays(), and Dt2DGraphicalObjectStateRecord::setParentOverlay().

void DtSdcText2DObject::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 DtSdcObject.

References DtSdcObject::myPublisher, and myStateRecord.