VR-Forces 4.0.4 Class Documentation
Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Static Private Attributes
DtSdcEllipsoidCuboidBase Class Reference

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

Inheritance diagram for DtSdcEllipsoidCuboidBase:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual const DtSdc3DAttachPointattachment () const
 attachment accessor
virtual void setAttachment (const DtSdc3DAttachPoint &attachment)
 attachment mutator
virtual const DtVectoroffset () 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 DtSdcColorcolor () 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 setRemoteGraphicSet (const std::string &setName)

Protected Member Functions

 DtSdcEllipsoidCuboidBase (DtExerciseConn *exConn, unsigned id, const DtString &objName, const DtSdc3DAttachPoint &attachment, const DtVector &dimensions, const DtVector &enuOffset=DtVector::zero(), const DtTaitBryan &rotation=zeros, DtSdcColor color=DtSdcColor::DtSdcWhite, bool flashing=false)
 Construct the basis of an Ellipsoid or Cuboid Draw Control Object.
virtual ~DtSdcEllipsoidCuboidBase ()

Protected Attributes

DtSdc3DAttachPoint myAttachment
DtVector myDimensions
DtVector myOffset
DtSdcColor myColor
DtTaitBryan myRotation
bool myFlashing
Dt3DGraphicalObjectStateRecord myStateRecord

Private Member Functions

 DtSdcEllipsoidCuboidBase ()
 Default constructor.
 DtSdcEllipsoidCuboidBase (const DtSdcEllipsoidCuboidBase &orig)
 Copy constructor.
DtSdcEllipsoidCuboidBaseoperator= (const DtSdcEllipsoidCuboidBase &rhs)
 Assignment operator.
void initRecords ()

Static Private Attributes

static DtTaitBryan zeros

Detailed Description

A common base class for representing ellipsoids and cuboids.

DtSdcEllipsoidCuboidBase in inherited by both DtSdcEllipsoidObject and DtSdcCuboidObject. 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

DtSdcEllipsoidCuboidBase::DtSdcEllipsoidCuboidBase ( DtExerciseConn *  exConn,
unsigned  id,
const DtString objName,
const DtSdc3DAttachPoint attachment,
const DtVector dimensions,
const DtVector enuOffset = DtVector::zero(),
const DtTaitBryan &  rotation = zeros,
DtSdcColor  color = DtSdcColor::DtSdcWhite,
bool  flashing = false 
) [protected]

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

Parameters:
idPassed to DtSdcObject base (see)
attachmentDtSdc3DAttachPoint indicating how the object is positioned in 3D
dimensionsDimensions 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
enuOffseta 3D vector indicating an east/north/up offset (in meters) from the base attachment
rotationrotations to apply to the object, about the Geocentric Z, Y and X axes (DIS/HLA-RPR). Values go from 0 to 2 PI
colorThe color of the object
flashingA boolean parameter indicating whether or not the object should be flashing
virtual DtSdcEllipsoidCuboidBase::~DtSdcEllipsoidCuboidBase ( ) [protected, virtual]

Default constructor.

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

Copy constructor.

Private and unimplemented - not copyable.


Member Function Documentation

DtSdcEllipsoidCuboidBase& DtSdcEllipsoidCuboidBase::operator= ( const DtSdcEllipsoidCuboidBase rhs) [private]

Assignment operator.

Private and unimplemented - not copyable.

virtual const DtSdc3DAttachPoint& DtSdcEllipsoidCuboidBase::attachment ( ) const [virtual]

attachment accessor

Get the object's attachment information

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

Implements DtSdc3DPositionedObject.

virtual void DtSdcEllipsoidCuboidBase::setAttachment ( const DtSdc3DAttachPoint attachment) [virtual]

attachment mutator

Set the object's attachment information

Parameters:
attachment

Implements DtSdc3DPositionedObject.

Reimplemented in DtSdcEllipsoidObject, and DtSdcCuboidObject.

virtual const DtVector& DtSdcEllipsoidCuboidBase::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 DtSdcEllipsoidCuboidBase::setOffset ( const DtVector off) [virtual]

offset mutator

Set the object's offset from the attach point

Parameters:
offset[X, Y, Z]
virtual const DtTaitBryan& DtSdcEllipsoidCuboidBase::rotation ( ) const [virtual]

rotation accessor

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

Returns:
[psi, theta, phi] radians
virtual void DtSdcEllipsoidCuboidBase::setRotation ( const DtTaitBryan &  rotation) [virtual]

rotation mutator

Set the counter-clockwise rotations of the object about it's axes

Parameters:
rotation[psi, theta, phi] radians

Reimplemented in DtSdcEllipsoidObject, and DtSdcCuboidObject.

virtual const DtSdcColor& DtSdcEllipsoidCuboidBase::color ( ) const [virtual]

color accessor

Get the color assigned to this object

Returns:
Instance of DtSdcColor

Reimplemented from DtSdcObject.

virtual void DtSdcEllipsoidCuboidBase::setColor ( const DtSdcColor color) [virtual]

color mutator

Set the color to use when drawing this object

Parameters:
colorThe DtSdcColor to use

Reimplemented from DtSdcObject.

virtual bool DtSdcEllipsoidCuboidBase::flashing ( ) const [virtual]

flashing accessor

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

Returns:
true or false

Reimplemented from DtSdcObject.

virtual void DtSdcEllipsoidCuboidBase::setFlashing ( bool  flashing) [virtual]

flashing mutator

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

Parameters:
flashingtrue or false

Reimplemented from DtSdcObject.

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

Reimplemented from DtSdcObject.


Member Data Documentation

DtTaitBryan DtSdcEllipsoidCuboidBase::zeros [static, private]

Reimplemented in DtSdcEllipsoidObject, and DtSdcCuboidObject.

DtTaitBryan DtSdcEllipsoidCuboidBase::myRotation [protected]

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

Document ID: Generated on Fri Jun 29 16:33:32 EDT 2012 from SVN revision 116588
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)