vrvControlToolkit::DtRectangleObject Class Reference

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

Inheritance diagram for vrvControlToolkit::DtRectangleObject:

Public Member Functions
	DtRectangleObject (DtExerciseConn *exConn, unsigned id, const DtVdcVector2D &position, const DtVdcVector2D &size, double rotation=0.0, double scale=1.0, DtVdcColor color=DtVdcColor::DtVdcWhite, bool fill=false, unsigned pattern=0xffffffff, bool flashing=false)
	Construct an Rectangle Draw Control Object.
virtual	~DtRectangleObject ()
Public Member Functions inherited from vrvControlToolkit::DtEllipseRectangleBase
virtual DtVdcVector2D	position () const
	position accessor
virtual void	setPosition (const DtVdcVector2D &position)
	position mutator
virtual DtVdcVector2D	size () const
	size accessor
virtual void	setSize (const DtVdcVector2D &size)
	size mutator
virtual double	rotation () const
	rotation accessor
virtual void	setRotation (double rotation)
	rotation mutator
virtual const DtVdcColor &	color () const
	color accessor
virtual void	setColor (const DtVdcColor &color)
	color mutator
virtual bool	fill () const
	fill accessor
virtual void	setFill (bool fill)
	fill mutator
virtual unsigned	pattern () const
	pattern accessor
virtual void	setPattern (unsigned pattern)
	pattern mutator
virtual bool	flashing () const
	flashing accessor
virtual void	setFlashing (bool flashing)
	flashing mutator
virtual double	scale () const
	scale accessor
virtual void	setScale (double scale)
	scale mutator
virtual void	setRemoteGraphicSet (const std::string &setName)
virtual void	update ()
	update the internal pdu
Public Member Functions inherited from vrvControlToolkit::Dt2DPositionedObject
	Dt2DPositionedObject (DtExerciseConn *exConn, unsigned id, const DtString &objName)
virtual	~Dt2DPositionedObject ()
Public Member Functions inherited from vrvControlToolkit::DtDrawControlObject
	DtDrawControlObject (DtExerciseConn *exConn, unsigned id, const DtString &objName)
	Parameterized constructor.
virtual	~DtDrawControlObject ()
	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

Private Member Functions
	DtRectangleObject ()
	Default constructor.

Additional Inherited Members
Static Public Member Functions inherited from vrvControlToolkit::DtDrawControlObject
static void	setPublisherCreator (DtEnvironmentProcessPublisherCreator *creator)
Protected Member Functions inherited from vrvControlToolkit::DtEllipseRectangleBase
	DtEllipseRectangleBase (DtExerciseConn *exConn, unsigned id, const DtString &objName, const DtVdcVector2D &position, const DtVdcVector2D &size, double rotation=0.0, double scale=1.0, DtVdcColor color=DtVdcColor::DtVdcWhite, bool fill=false, unsigned pattern=0xffffffff, bool flashing=false)
	Construct the basis of an Ellipse or Rectangle Draw Control Object.
virtual	~DtEllipseRectangleBase ()
Protected Attributes inherited from vrvControlToolkit::DtEllipseRectangleBase
DtVdcVector2D	myPosition
DtVdcVector2D	mySize
DtVdcColor	myColor
unsigned	myPattern
bool	myFill
double	myRotation
bool	myFlashing
double	myScale
Dt2DGraphicalObjectStateRecord *	myStateRecord
Static Protected Attributes inherited from vrvControlToolkit::DtDrawControlObject
static DtEnvironmentProcessPublisherCreator *	thePublisherCreator

Detailed Description

A 2D rectangular Stealth Draw Control Object.

DtRectangleObject represents an Rectangular Draw Control Object that can be sent to a MAK Stealth to be drawn on its main view. The class inherits DtEllipseRectangleBase; it only needs to set the appropriate object type in its constructor.

Constructor & Destructor Documentation

vrvControlToolkit::DtRectangleObject::DtRectangleObject	(	DtExerciseConn *	exConn,
		unsigned	id,
		const DtVdcVector2D &	position,
		const DtVdcVector2D &	size,
		double	rotation = 0.0,
		double	scale = 1.0,
		DtVdcColor	color = DtVdcColor::DtVdcWhite,
		bool	fill = false,
		unsigned	pattern = 0xffffffff,
		bool	flashing = false
	)

Construct an Rectangle Draw Control Object.

Parameters

id	Passed to DtDrawControlObject base (see) Position of the left-bottom corner on the screen - values go from [0.,0.] (left, bottom) to [1.,1.] (right, top)
size	Size of object along the X and Y axes (before rotation) = values go from [0.,0.] to [1.,.1] (the entire screen) These are the dimensions of the rectangle
rotation	A counter-clockwise rotation to apply to the rectangle = values go from 0 to 2 PI
color	The color of the rectangle outline (and fill, if filled)
fill	A boolean parameter indicating whether or not the rectangle should be filled
pattern	A pattern used when filling the rectangle - values go from 0x00000000 (no fill) to 0xFFFFFF (solid)
flashing	A boolean parameter indicating whether or not the rectangle should be flashing

virtual vrvControlToolkit::DtRectangleObject::~DtRectangleObject ( )

virtual

vrvControlToolkit::DtRectangleObject::DtRectangleObject ( )

private

Default constructor.

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

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-6-branch/include/vrvDrawControl/DtRectangleObject.h