vrvControlToolkit::DtVdc3DAttachPoint Class Reference

DtVdc3DAttachPoint represents the 3 methods for attaching a 3D draw control object in 3-space.

DtVdc3DAttachPoint defines the interface and storage for a class that functions as a discriminated union representing the 3 methods for attaching a 3D draw control object in 3-space. Objects can be placed in the scene by specifying 3D geocentric coordinates; an HLA/DIS entity id (DtGlobalObjectDesignator); or the id of another draw control object.

Public Types
enum	DtVdc3DAttachmentType { attachmentTypeUndefined = 0, attachmentTypeScene = 1, attachmentTypeEntity = 2, attachmentTypeDrawObject = 3 }

Public Member Functions
	DtVdc3DAttachPoint (const DtVector &location)
	DtVdc3DAttachPoint (const DtGlobalObjectDesignator &entityId)
	DtVdc3DAttachPoint (const DtGlobalObjectDesignator &drawObjectId, double relativePosition)
	DtVdc3DAttachPoint (const DtVdc3DAttachPoint &orig)
DtVdc3DAttachPoint &	operator= (const DtVdc3DAttachPoint &rhs)
virtual	~DtVdc3DAttachPoint ()
	DtVdc3DAttachPoint ()
virtual DtVdc3DAttachmentType	attachmentType () const
virtual DtVector	location () const
virtual DtVector &	location ()
virtual void	setLocation (DtVector location)
virtual const DtGlobalObjectDesignator &	drawObjectId () const
virtual void	setDrawObjectId (const DtGlobalObjectDesignator &drawObjectId)
virtual double	relativePosition () const
virtual void	setRelativePosition (double relativePosition)
virtual DtGlobalObjectDesignator	entityId () const
virtual void	setEntityId (const DtGlobalObjectDesignator &entityId)
virtual bool	isAttached () const
virtual const DtGlobalObjectDesignator &	attachedId () const

Protected Attributes
DtVector	myLocation
DtGlobalObjectDesignator	myAttachedId
double	myRelativePosition
DtVdc3DAttachmentType	myAttachmentType

Member Enumeration Documentation

enum vrvControlToolkit::DtVdc3DAttachPoint::DtVdc3DAttachmentType

Enumerator
attachmentTypeUndefined
attachmentTypeScene
attachmentTypeEntity
attachmentTypeDrawObject

Constructor & Destructor Documentation

vrvControlToolkit::DtVdc3DAttachPoint::DtVdc3DAttachPoint

(

const DtVector &

location

)

Geocentric coordinates constructor.

Parameters

location

Geocentric location in the scene at which to place this object

vrvControlToolkit::DtVdc3DAttachPoint::DtVdc3DAttachPoint

(

const DtGlobalObjectDesignator &

entityId

)

HLA/DIS object id constructor.

Parameters

entityId

HLA/DIS global object designator of entity to attach to

vrvControlToolkit::DtVdc3DAttachPoint::DtVdc3DAttachPoint	(	const DtGlobalObjectDesignator &	drawObjectId,
		double	relativePosition
	)

HLA/DIS object id constructor.

Parameters

drawObjectId	id of draw object to attach to
relativePosition	If the attachment is to a draw control object that has 2 ends (line or cylinder) then a relative position can be specified that indicates the position between those two end points. 0. to 100. percent (default 0.)

vrvControlToolkit::DtVdc3DAttachPoint::DtVdc3DAttachPoint

(

const DtVdc3DAttachPoint &

orig

)

Copy constructor.

virtual vrvControlToolkit::DtVdc3DAttachPoint::~DtVdc3DAttachPoint ( )

virtual

Virtual destructor.

vrvControlToolkit::DtVdc3DAttachPoint::DtVdc3DAttachPoint

(

)

Default constructor.

Member Function Documentation

DtVdc3DAttachPoint& vrvControlToolkit::DtVdc3DAttachPoint::operator=

(

const DtVdc3DAttachPoint &

rhs

)

Assignment operator.

virtual DtVdc3DAttachmentType vrvControlToolkit::DtVdc3DAttachPoint::attachmentType ( ) const

virtual

Attachment Type accessor.

Get the type of attachment that this attach point represents

Returns

One of the DtSdc3DAttachmentType enumerations

virtual DtVector vrvControlToolkit::DtVdc3DAttachPoint::location ( ) const

virtual

Location accessor.

Get the geocentric location to attached to

Returns

Geocentric location of object if attachment type is attachmentTypeScene; [0.0, 0.0, 0.0] otherwise

virtual DtVector& vrvControlToolkit::DtVdc3DAttachPoint::location ( )

virtual

virtual void vrvControlToolkit::DtVdc3DAttachPoint::setLocation ( DtVector  location )

virtual

Location mutator.

Set the geocentric location to attached to. This also sets the attachment type to attachmentTypeScene as a side effect

Parameters

location

Geocentric location to attach to

virtual const DtGlobalObjectDesignator& vrvControlToolkit::DtVdc3DAttachPoint::drawObjectId ( ) const

virtual

Draw Object ID accessor.

Get the ID of the draw object to attach to

Returns

Draw Object ID if attachment type is attachmentTypeDrawObject; 0 otherwise

virtual void vrvControlToolkit::DtVdc3DAttachPoint::setDrawObjectId ( const DtGlobalObjectDesignator &  drawObjectId )

virtual

Draw Object Id mutator.

Set the draw object to attached to. This also sets the attachment type to attachmentTypeDrawObject as a side effect

Parameters

drawObjectId

ID of draw object to attach to

virtual double vrvControlToolkit::DtVdc3DAttachPoint::relativePosition ( ) const

virtual

Draw Object relative position accessor; draw object attached only.

Returns

Relative position as a percentage (0. to 100.)

virtual void vrvControlToolkit::DtVdc3DAttachPoint::setRelativePosition ( double  relativePosition )

virtual

Draw Object relative position mutator.

Parameters

relativePosition

0. to 100. (percent)

virtual DtGlobalObjectDesignator vrvControlToolkit::DtVdc3DAttachPoint::entityId ( ) const

virtual

Entity ID accessor.

Get the Global Object Designator of the entity to attach to

Returns

Global Object Designator if attachment type is attachmentTypeDrawEntity; GlobalObjectDesignator::nullId() (in HLA) or GlobalObjectDesignator::nullString() (in DIS) otherwise

virtual void vrvControlToolkit::DtVdc3DAttachPoint::setEntityId ( const DtGlobalObjectDesignator &  entityId )

virtual

Entity Id mutator.

Set the entity to attached to. This also sets the attachment type to attachmentTypeEntity as a side effect

Parameters

entityId

Global Object Designator of entity to attach to

virtual bool vrvControlToolkit::DtVdc3DAttachPoint::isAttached ( ) const

virtual

virtual const DtGlobalObjectDesignator& vrvControlToolkit::DtVdc3DAttachPoint::attachedId ( ) const

virtual

Member Data Documentation

DtVector vrvControlToolkit::DtVdc3DAttachPoint::myLocation

protected

DtGlobalObjectDesignator vrvControlToolkit::DtVdc3DAttachPoint::myAttachedId

protected

double vrvControlToolkit::DtVdc3DAttachPoint::myRelativePosition

protected

DtVdc3DAttachmentType vrvControlToolkit::DtVdc3DAttachPoint::myAttachmentType

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrvDrawControl/DtVdc3DAttachPoint.h