VR-Forces 4.0.4 Class Documentation
Public Member Functions | Protected Attributes | Private Member Functions | Static Private Attributes
vrvControlToolkit::DtCuboidObject Class Reference

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

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

List of all members.

Public Member Functions

 DtCuboidObject (DtExerciseConn *exConn, unsigned id, const DtVdc3DAttachPoint &attachment, double length, double width, double height, const DtVector &enuOffset=DtVector::zero(), const DtTaitBryan &rotation=zeros, DtVdcColor color=DtVdcColor::DtVdcWhite, bool flashing=false)
 Construct an Cuboid Draw Control Object.
virtual ~DtCuboidObject ()
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 DtVdc3DAttachPoint &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

 DtCuboidObject ()
 Default constructor.
 DtCuboidObject (const DtCuboidObject &orig)
 Copy constructor.
DtCuboidObjectoperator= (const DtCuboidObject &rhs)
 Assignment operator.
void initCuboidRecords ()

Static Private Attributes

static DtTaitBryan zeros

Detailed Description

A 3D cuboidal Stealth Draw Control Object.

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


Constructor & Destructor Documentation

vrvControlToolkit::DtCuboidObject::DtCuboidObject ( DtExerciseConn *  exConn,
unsigned  id,
const DtVdc3DAttachPoint attachment,
double  length,
double  width,
double  height,
const DtVector enuOffset = DtVector::zero(),
const DtTaitBryan &  rotation = zeros,
DtVdcColor  color = DtVdcColor::DtVdcWhite,
bool  flashing = false 
)

Construct an Cuboid Draw Control Object.

Parameters:
idPassed to DtDrawControlObject base (see)
attachmentDtVdc3DAttachPoint 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

Default constructor.

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

Copy constructor.

Private and unimplemented - not copyable.


Member Function Documentation

virtual double vrvControlToolkit::DtCuboidObject::length ( ) const [virtual]

length accessor

Get the object's length

Returns:
length in meters
virtual void vrvControlToolkit::DtCuboidObject::setLength ( double  length) [virtual]

length mutator

Set the object's length

Parameters:
lengthlength in meters
virtual double vrvControlToolkit::DtCuboidObject::width ( ) const [virtual]

width accessor

Get the object's width

Returns:
width in meters
virtual void vrvControlToolkit::DtCuboidObject::setWidth ( double  width) [virtual]

width mutator

Set the object's width

Parameters:
widthwidth in meters
virtual double vrvControlToolkit::DtCuboidObject::height ( ) const [virtual]

height accessor

Get the object's height

Returns:
height in meters
virtual void vrvControlToolkit::DtCuboidObject::setHeight ( double  height) [virtual]

height mutator

Set the object's height

Parameters:
heightheight in meters
virtual void vrvControlToolkit::DtCuboidObject::setAttachment ( const DtVdc3DAttachPoint attachment) [virtual]

attachment mutator

Set the object's attachment information

Parameters:
attachment

Reimplemented from vrvControlToolkit::DtEllipsoidCuboidBase.

virtual void vrvControlToolkit::DtCuboidObject::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 from vrvControlToolkit::DtEllipsoidCuboidBase.

virtual void vrvControlToolkit::DtCuboidObject::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 vrvControlToolkit::DtDrawControlObject.

DtCuboidObject& vrvControlToolkit::DtCuboidObject::operator= ( const DtCuboidObject rhs) [private]

Assignment operator.

Private and unimplemented - not copyable.


Member Data Documentation

DtEnvironmentalRectangularVolumeRecord vrvControlToolkit::DtCuboidObject::myCuboidRecord [protected]
DtTaitBryan vrvControlToolkit::DtCuboidObject::zeros [static, private]

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)