VR-Vantage 1.4.1 API Class Documentation
Public Member Functions | Protected Attributes | Private Member Functions | Static Private Attributes
DtSdcCuboidObject Class Reference

A 3D cuboidal Stealth Draw Control Object. More...

Inheritance diagram for DtSdcCuboidObject:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 DtSdcCuboidObject (DtExerciseConn *exConn, unsigned id, const DtSdc3DAttachPoint &attachment, double length, double width, double height, const DtVector &enuOffset=DtVector::zero(), const DtTaitBryan &rotation=zeros, DtSdcColor color=DtSdcColor::DtSdcWhite, bool flashing=false)
 Construct an Cuboid Draw Control Object.
virtual ~DtSdcCuboidObject ()
virtual double length () const
 length accessor
virtual void setLength (double length)
 length mutator
virtual double width () const
 width accessor
virtual void setWidth (double width)
 width mutator
virtual double height () const
 height accessor
virtual void setHeight (double height)
 height mutator
virtual void setAttachment (const DtSdc3DAttachPoint &attachment)
 attachment mutator
virtual void setRotation (const DtTaitBryan &rotation)
 rotation mutator
virtual void update ()
 update the internal publisher and tick

Protected Attributes

DtEnvironmentalRectangularVolumeRecord myCuboidRecord

Private Member Functions

 DtSdcCuboidObject ()
 Default constructor.
 DtSdcCuboidObject (const DtSdcCuboidObject &orig)
 Copy constructor.
DtSdcCuboidObjectoperator= (const DtSdcCuboidObject &rhs)
 Assignment operator.
void initCuboidRecords ()

Static Private Attributes

static DtTaitBryan zeros = DtTaitBryan(0., 0., 0.)

Detailed Description

A 3D cuboidal Stealth Draw Control Object.

DtSdcCuboidObject represents an Cuboidal Draw Control Object that can be sent to a MAK Stealth to be drawn on it's main view. The class inherits DtSdcEllipsoidCuboidBase; it only needs to set the appropriate object type in it's constructor.


Constructor & Destructor Documentation

DtSdcCuboidObject::DtSdcCuboidObject ( DtExerciseConn *  exConn,
unsigned  id,
const DtSdc3DAttachPoint attachment,
double  length,
double  width,
double  height,
const DtVector &  enuOffset = DtVector::zero(),
const DtTaitBryan &  rotation = zeros,
DtSdcColor  color = DtSdcColor::DtSdcWhite,
bool  flashing = false 
)

Construct an Cuboid Draw Control Object.

Parameters:
idPassed to DtSdcObject base (see)
attachmentDtSdc3DAttachPoint indicating how the center of the object is positioned in 3D
lengthLength of object (along the X axis, before rotation) in meters
widthWidth of object (along the Y axis, before rotation) in meters
heightHeight of object (along the Z axis, before rotation) in meters
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

References Dt3DGraphicalObjectCategoryCuboid, Dt3DGraphicalObjectKind, DtSdcObject::id(), initCuboidRecords(), and DtSdcObject::myPublisher.

DtSdcCuboidObject::~DtSdcCuboidObject ( ) [virtual]
DtSdcCuboidObject::DtSdcCuboidObject ( ) [private]

Default constructor.

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

DtSdcCuboidObject::DtSdcCuboidObject ( const DtSdcCuboidObject orig) [private]

Copy constructor.

Private and unimplemented - not copyable.


Member Function Documentation

double DtSdcCuboidObject::length ( ) const [virtual]

length accessor

Get the object's length

Returns:
length in meters

References DtSdcEllipsoidCuboidBase::myDimensions.

Referenced by setLength().

void DtSdcCuboidObject::setLength ( double  length) [virtual]

length mutator

Set the object's length

Parameters:
lengthlength in meters

References length(), myCuboidRecord, and DtSdcEllipsoidCuboidBase::myDimensions.

double DtSdcCuboidObject::width ( ) const [virtual]

width accessor

Get the object's width

Returns:
width in meters

References DtSdcEllipsoidCuboidBase::myDimensions.

Referenced by setWidth().

void DtSdcCuboidObject::setWidth ( double  width) [virtual]

width mutator

Set the object's width

Parameters:
widthwidth in meters

References myCuboidRecord, DtSdcEllipsoidCuboidBase::myDimensions, and width().

double DtSdcCuboidObject::height ( ) const [virtual]

height accessor

Get the object's height

Returns:
height in meters

References DtSdcEllipsoidCuboidBase::myDimensions.

Referenced by setHeight().

void DtSdcCuboidObject::setHeight ( double  height) [virtual]

height mutator

Set the object's height

Parameters:
heightheight in meters

References height(), myCuboidRecord, and DtSdcEllipsoidCuboidBase::myDimensions.

void DtSdcCuboidObject::setAttachment ( const DtSdc3DAttachPoint attachment) [virtual]
void DtSdcCuboidObject::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 from DtSdcEllipsoidCuboidBase.

References myCuboidRecord.

void DtSdcCuboidObject::update ( ) [virtual]

update the internal publisher and tick

Pure virtual function used to force any changes to the draw control objects to be sent to the network.

Implements DtSdcObject.

References myCuboidRecord, DtSdcObject::myPublisher, and DtSdcEllipsoidCuboidBase::myStateRecord.

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

Assignment operator.

Private and unimplemented - not copyable.

void DtSdcCuboidObject::initCuboidRecords ( ) [private]

Member Data Documentation

DtEnvironmentalRectangularVolumeRecord DtSdcCuboidObject::myCuboidRecord [protected]
DtTaitBryan DtSdcCuboidObject::zeros = DtTaitBryan(0., 0., 0.) [static, private]

Reimplemented from DtSdcEllipsoidCuboidBase.


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


Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)