VR-Forces 4.10 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Private Member Functions
vrvControlToolkit::DtRectangleObject Class Reference

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

Inheritance diagram for vrvControlToolkit::DtRectangleObject:
Inheritance graph
[legend]

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. More...
 
virtual ~DtRectangleObject ()
 
- Public Member Functions inherited from vrvControlToolkit::DtEllipseRectangleBase
virtual DtVdcVector2D position () const
 position accessor More...
 
virtual void setPosition (const DtVdcVector2D &position)
 position mutator More...
 
virtual DtVdcVector2D size () const
 size accessor More...
 
virtual void setSize (const DtVdcVector2D &size)
 size mutator More...
 
virtual double rotation () const
 rotation accessor More...
 
virtual void setRotation (double rotation)
 rotation mutator More...
 
virtual const DtVdcColorcolor () const
 color accessor More...
 
virtual void setColor (const DtVdcColor &color)
 color mutator More...
 
virtual bool fill () const
 fill accessor More...
 
virtual void setFill (bool fill)
 fill mutator More...
 
virtual unsigned pattern () const
 pattern accessor More...
 
virtual void setPattern (unsigned pattern)
 pattern mutator More...
 
virtual bool flashing () const
 flashing accessor More...
 
virtual void setFlashing (bool flashing)
 flashing mutator More...
 
virtual double scale () const
 scale accessor More...
 
virtual void setScale (double scale)
 scale mutator More...
 
virtual void setRemoteGraphicSet (const std::string &setName)
 
virtual void update ()
 update the internal pdu More...
 
- 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. More...
 
virtual ~DtDrawControlObject ()
 Virtual destructor. More...
 
virtual unsigned id () const
 id accessor More...
 
virtual void setId (unsigned id)
 id mutator More...
 
virtual const
DtGlobalObjectDesignator
globalId () const
 
virtual void setVisible (bool yesNo)
 
virtual bool visible () const
 

Private Member Functions

 DtRectangleObject ()
 Default constructor. More...
 

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. More...
 
virtual ~DtEllipseRectangleBase ()
 
- Protected Attributes inherited from vrvControlToolkit::DtEllipseRectangleBase
DtVdcVector2D myPosition
 
DtVdcVector2D mySize
 
DtVdcColor myColor
 
unsigned myPattern
 
bool myFill
 
double myRotation
 
bool myFlashing
 
double myScale
 
Dt2DGraphicalObjectStateRecordmyStateRecord
 
- Protected Attributes inherited from vrvControlToolkit::DtDrawControlObject
unsigned myId
 
DtEnvironmentProcessPublishermyPublisher
 
bool myVisible
 
DtVdcColor myEmptyColor
 
- 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
idPassed 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)
sizeSize 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
rotationA counter-clockwise rotation to apply to the rectangle = values go from 0 to 2 PI
colorThe color of the rectangle outline (and fill, if filled)
fillA boolean parameter indicating whether or not the rectangle should be filled
patternA pattern used when filling the rectangle - values go from 0x00000000 (no fill) to 0xFFFFFF (solid)
flashingA 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:

Document ID: Generated on Tue Sep 21 17:42:52 EDT 2021 from SVN revision 234861
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)