vrvControlToolkit::DtEllipsoidCuboidBase Class Reference

A common base class for representing ellipsoids and cuboids. More...

Inheritance diagram for vrvControlToolkit::DtEllipsoidCuboidBase:

List of all members.

Public Member Functions
virtual const DtVdc3DAttachPoint &	attachment () const
	attachment accessor
virtual void	setAttachment (const DtVdc3DAttachPoint &attachment)
	attachment mutator
virtual const DtVector &	offset () const
	enuOffset accessor
virtual void	setOffset (const DtVector &off)
	offset mutator
virtual const DtTaitBryan &	rotation () const
	rotation accessor
virtual void	setRotation (const DtTaitBryan &rotation)
	rotation 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)
Protected Member Functions
	DtEllipsoidCuboidBase (DtExerciseConn *exConn, unsigned id, const DtString &objName, const DtVdc3DAttachPoint &attachment, const DtVector &dimensions, const DtVector &enuOffset=DtVector::zero(), const DtTaitBryan &rotation=zeros, DtVdcColor color=DtVdcColor::DtVdcWhite, bool flashing=false)
	Construct the basis of an Ellipsoid or Cuboid Draw Control Object.
virtual	~DtEllipsoidCuboidBase ()
Protected Attributes
DtVdc3DAttachPoint	myAttachment
DtVector	myDimensions
DtVector	myOffset
DtVdcColor	myColor
DtTaitBryan	myRotation
bool	myFlashing
Dt3DGraphicalObjectStateRecord	myStateRecord
Private Member Functions
	DtEllipsoidCuboidBase ()
	Default constructor.
	DtEllipsoidCuboidBase (const DtEllipsoidCuboidBase &orig)
	Copy constructor.
DtEllipsoidCuboidBase &	operator= (const DtEllipsoidCuboidBase &rhs)
	Assignment operator.
void	initRecords ()
Static Private Attributes
static DtTaitBryan	zeros

---

Detailed Description

A common base class for representing ellipsoids and cuboids.

DtEllipsoidCuboidBase in inherited by both DtEllipsoidObject and DtCuboidObject. Ellipsoids and cuboids are represented in the exact same way on the network, except for a type field which indicates which should be drawn. This base class provides mutators that allow the user to specify the attachment, shape, rotation, and color of the ellipsoid or cuboid on the Stealth screen; and optionally, make the object flash. This class shuold not be instantiated on its own (and its constructors are protected to prevent that).

---

Constructor & Destructor Documentation

vrvControlToolkit::DtEllipsoidCuboidBase::DtEllipsoidCuboidBase	(	DtExerciseConn *	exConn,
		unsigned	id,
		const DtString &	objName,
		const DtVdc3DAttachPoint &	attachment,
		const DtVector &	dimensions,
		const DtVector &	enuOffset = DtVector::zero(),
		const DtTaitBryan &	rotation = zeros,
		DtVdcColor	color = DtVdcColor::DtVdcWhite,
		bool	flashing = false
	)		[protected]

Construct the basis of an Ellipsoid or Cuboid Draw Control Object.

Parameters:

id	Passed to DtDrawControlObject base (see)
attachment	DtVdc3DAttachPoint indicating how the object is positioned in 3D
dimensions	Dimensions of object along the X, Y and Z axes (before rotation) in meters. These are the radii for ellipsoids; length, width, and height for cuboids
enuOffset	a 3D vector indicating an east/north/up offset (in meters) from the base attachment
rotation	rotations to apply to the object, about the Geocentric Z, Y and X axes (DIS/HLA-RPR). Values go from 0 to 2 PI
color	The color of the object
flashing	A boolean parameter indicating whether or not the object should be flashing

virtual vrvControlToolkit::DtEllipsoidCuboidBase::~DtEllipsoidCuboidBase

(

)

[protected, virtual]

vrvControlToolkit::DtEllipsoidCuboidBase::DtEllipsoidCuboidBase

(

)

[private]

Default constructor.

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

vrvControlToolkit::DtEllipsoidCuboidBase::DtEllipsoidCuboidBase

(

const DtEllipsoidCuboidBase &

orig

)

[private]

Copy constructor.

Private and unimplemented - not copyable.

---

Member Function Documentation

DtEllipsoidCuboidBase& vrvControlToolkit::DtEllipsoidCuboidBase::operator=

(

const DtEllipsoidCuboidBase &

rhs

)

[private]

Assignment operator.

Private and unimplemented - not copyable.

virtual const DtVdc3DAttachPoint& vrvControlToolkit::DtEllipsoidCuboidBase::attachment

(

)

const [virtual]

attachment accessor

Get the object's attachment information

Returns:

DtVdc3DAttachPoint, which contains the attachment type and associated data

Implements vrvControlToolkit::Dt3DPositionedObject.

virtual void vrvControlToolkit::DtEllipsoidCuboidBase::setAttachment

(

const DtVdc3DAttachPoint &

attachment

)

[virtual]

attachment mutator

Set the object's attachment information

Parameters:

attachment

Implements vrvControlToolkit::Dt3DPositionedObject.

Reimplemented in vrvControlToolkit::DtCuboidObject, and vrvControlToolkit::DtEllipsoidObject.

virtual const DtVector& vrvControlToolkit::DtEllipsoidCuboidBase::offset

(

)

const [virtual]

enuOffset accessor

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

Returns:

[X, Y, Z] offset

virtual void vrvControlToolkit::DtEllipsoidCuboidBase::setOffset

(

const DtVector &

off

)

[virtual]

offset mutator

Set the object's offset from the attach point

Parameters:

offset

[X, Y, Z]

virtual const DtTaitBryan& vrvControlToolkit::DtEllipsoidCuboidBase::rotation

(

)

const [virtual]

rotation accessor

Get the counter-clockwise rotation of the object about its axes

Returns:

[psi, theta, phi] radians

virtual void vrvControlToolkit::DtEllipsoidCuboidBase::setRotation

(

const DtTaitBryan &

rotation

)

[virtual]

rotation mutator

Set the counter-clockwise rotations of the object about its axes

Parameters:

rotation

[psi, theta, phi] radians

Reimplemented in vrvControlToolkit::DtCuboidObject, and vrvControlToolkit::DtEllipsoidObject.

virtual const DtVdcColor& vrvControlToolkit::DtEllipsoidCuboidBase::color

(

)

const [virtual]

color accessor

Get the color assigned to this object

Returns:

Instance of DtVdcColor

Reimplemented from vrvControlToolkit::DtDrawControlObject.

virtual void vrvControlToolkit::DtEllipsoidCuboidBase::setColor

(

const DtVdcColor &

color

)

[virtual]

color mutator

Set the color to use when drawing this object

Parameters:

color

The DtVdcColor to use

Reimplemented from vrvControlToolkit::DtDrawControlObject.

virtual bool vrvControlToolkit::DtEllipsoidCuboidBase::flashing

(

)

const [virtual]

flashing accessor

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

Returns:

true or false

Reimplemented from vrvControlToolkit::DtDrawControlObject.

virtual void vrvControlToolkit::DtEllipsoidCuboidBase::setFlashing

(

bool

flashing

)

[virtual]

flashing mutator

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

Parameters:

flashing

true or false

Reimplemented from vrvControlToolkit::DtDrawControlObject.

virtual void vrvControlToolkit::DtEllipsoidCuboidBase::setRemoteGraphicSet

(

const std::string &

setName

)

[virtual]

Reimplemented from vrvControlToolkit::DtDrawControlObject.

void vrvControlToolkit::DtEllipsoidCuboidBase::initRecords

(

)

[private]

---

Member Data Documentation

DtTaitBryan vrvControlToolkit::DtEllipsoidCuboidBase::zeros [static, private]

Reimplemented in vrvControlToolkit::DtCuboidObject, and vrvControlToolkit::DtEllipsoidObject.

DtVdc3DAttachPoint vrvControlToolkit::DtEllipsoidCuboidBase::myAttachment [protected]

DtVector vrvControlToolkit::DtEllipsoidCuboidBase::myDimensions [protected]

DtVector vrvControlToolkit::DtEllipsoidCuboidBase::myOffset [protected]

DtVdcColor vrvControlToolkit::DtEllipsoidCuboidBase::myColor [protected]

DtTaitBryan vrvControlToolkit::DtEllipsoidCuboidBase::myRotation [protected]

bool vrvControlToolkit::DtEllipsoidCuboidBase::myFlashing [protected]

Dt3DGraphicalObjectStateRecord vrvControlToolkit::DtEllipsoidCuboidBase::myStateRecord [protected]

---

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

• include/vrvDrawControl/DtEllipsoidCuboidBase.h