VR-Forces 4.0.4 Class Documentation
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions
DtSdcAttachablePdu Class Reference
Inheritance diagram for DtSdcAttachablePdu:
Inheritance graph
[legend]

List of all members.

Public Types

enum  DtVcObjectAttachment {
  DtVcObjectNoAttach = 0, DtVcObjectNoAttachNoAttach = 1, DtVcObjectAttachedToEntity = 2, DtVcObjectAttachedToObject = 3,
  DtVcObjectAttachedToEntityNoAttach = 4, DtVcObjectAttachedToObjectNoAttach = 5, DtVcObjectAttachedToNoAttachEntity = 6, DtVcObjectAttachedToNoAttachObject = 7,
  DtVcObjectAttachedToEntityObject = 8, DtVcObjectAttachedToObjectEntity = 9, DtVcObjectAttachedToEntityEntity = 10, DtVcObjectAttachedToObjectObject = 11
}
enum  DtVcDrawingStyle { DtVcStyleNoFlashing = 0x00, DtVcStyleFlashing = 0x04, DtVcDrawingStyleEntry = 0x04 }

Public Member Functions

virtual const DtVcObjectAttachment attachmentType () const
 objects can be attach to 1 (text, sphere, cube, triangle, attribute group) or
virtual void attachTo (const DtNetInt8 pos[2])
 2D placement of single position objects; uses a screen coordinate system of
virtual void attachTo (const DtNetInt8 pos1[2], const DtNetInt8 pos2[2])
 2D placement of lines
virtual void attachTo (const DtVector &pos)
 3D placement of single position objects
virtual void attachTo (const DtNetU32 id)
virtual void attachTo (const DtGlobalObjectDesignator &id)
virtual void attachTo (const DtNetU32 id1, const DtNetU32 id2)
 3D placement of two position objects
virtual void attachTo (const DtGlobalObjectDesignator &id1, const DtGlobalObjectDesignator &id2)
virtual void attachTo (const DtVector &pos1, const DtVector &pos2)
virtual void attachTo (const DtGlobalObjectDesignator &id1, const DtNetU32 id2)
virtual void attachTo (const DtNetU32 id1, const DtGlobalObjectDesignator &id2)
virtual void attachTo (const DtGlobalObjectDesignator &id, const DtVector &pos)
virtual void attachTo (const DtVector &pos, const DtGlobalObjectDesignator &id)
virtual void attachTo (const DtNetU32 id, const DtVector &pos)
virtual void attachTo (const DtVector &pos, const DtNetU32 id)
virtual void setRelativeLocation (DtNetU8 percentage, int index=0)
 relative location along the parent object if there is not parent object or the parent object is puntual this value is discarded The value is a percentage (0 - 100) messure from start point to end point Because a line or cylinder has two attachments, each of which could be another line or cylinder, the interface needs to support 2 relative locations.
virtual const DtNetU8 relativeLocation (int index=0) const
virtual void setOffset (const DtVector &offsetVector)
 offset from final position.
virtual DtVector offset () const
virtual const
DtGlobalObjectDesignator 
attachEntityId (int index) const
virtual const DtNetU32 attachObjectId (int index) const
virtual DtVector position (int index) const
virtual void setColor (DtNetU8 color[4])
virtual const DtNetU8 * color () const
virtual void setFlashing (bool onOff)
virtual const bool flashing () const
virtual void setFromString (const char *)
virtual const char * string () const
virtual void printData () const

Static Public Member Functions

static const char * typeString (DtVcObjectAttachment param)

Protected Member Functions

virtual void setAttachmentType (DtVcObjectAttachment attachmentType)

Member Enumeration Documentation

Enumerator:
DtVcObjectNoAttach 
DtVcObjectNoAttachNoAttach 

Attach to single position (2D or 3D)

DtVcObjectAttachedToEntity 

Attach ends of a line to specified positions.

DtVcObjectAttachedToObject 

Attach to a single entity (3D only? ) test 2D text.

DtVcObjectAttachedToEntityNoAttach 

Attach text to a (3d) DrawControl Object.

DtVcObjectAttachedToObjectNoAttach 

Attach one end of a line to an entity and the other end to a specified position.

DtVcObjectAttachedToNoAttachEntity 

Attach one end of a line to a (3d) DrawControl Object and the other end to a specified position.

DtVcObjectAttachedToNoAttachObject 

Attach one end of a line to a specified position and the other end to an entity.

DtVcObjectAttachedToEntityObject 

Attach one end of a line to a specified position and the other end to a Draw Control Object.

DtVcObjectAttachedToObjectEntity 

Attach one end of a line to an entity and the other end to a Draw Control Object.

DtVcObjectAttachedToEntityEntity 

Attach one end of a line to a Draw Control Object and the other end to an entity.

DtVcObjectAttachedToObjectObject 

Attach ends of a line to specified entities.

Enumerator:
DtVcStyleNoFlashing 
DtVcStyleFlashing 
DtVcDrawingStyleEntry 

Member Function Documentation

virtual const DtVcObjectAttachment DtSdcAttachablePdu::attachmentType ( ) const [virtual]

objects can be attach to 1 (text, sphere, cube, triangle, attribute group) or

virtual void DtSdcAttachablePdu::attachTo ( const DtNetInt8  pos[2]) [virtual]

2D placement of single position objects; uses a screen coordinate system of

virtual void DtSdcAttachablePdu::attachTo ( const DtNetInt8  pos1[2],
const DtNetInt8  pos2[2] 
) [virtual]

2D placement of lines

virtual void DtSdcAttachablePdu::attachTo ( const DtVector pos) [virtual]

3D placement of single position objects

virtual void DtSdcAttachablePdu::attachTo ( const DtNetU32  id) [virtual]
virtual void DtSdcAttachablePdu::attachTo ( const DtGlobalObjectDesignator &  id) [virtual]
virtual void DtSdcAttachablePdu::attachTo ( const DtNetU32  id1,
const DtNetU32  id2 
) [virtual]

3D placement of two position objects

virtual void DtSdcAttachablePdu::attachTo ( const DtGlobalObjectDesignator &  id1,
const DtGlobalObjectDesignator &  id2 
) [virtual]
virtual void DtSdcAttachablePdu::attachTo ( const DtVector pos1,
const DtVector pos2 
) [virtual]
virtual void DtSdcAttachablePdu::attachTo ( const DtGlobalObjectDesignator &  id1,
const DtNetU32  id2 
) [virtual]
virtual void DtSdcAttachablePdu::attachTo ( const DtNetU32  id1,
const DtGlobalObjectDesignator &  id2 
) [virtual]
virtual void DtSdcAttachablePdu::attachTo ( const DtGlobalObjectDesignator &  id,
const DtVector pos 
) [virtual]
virtual void DtSdcAttachablePdu::attachTo ( const DtVector pos,
const DtGlobalObjectDesignator &  id 
) [virtual]
virtual void DtSdcAttachablePdu::attachTo ( const DtNetU32  id,
const DtVector pos 
) [virtual]
virtual void DtSdcAttachablePdu::attachTo ( const DtVector pos,
const DtNetU32  id 
) [virtual]
virtual void DtSdcAttachablePdu::setRelativeLocation ( DtNetU8  percentage,
int  index = 0 
) [virtual]

relative location along the parent object if there is not parent object or the parent object is puntual this value is discarded The value is a percentage (0 - 100) messure from start point to end point Because a line or cylinder has two attachments, each of which could be another line or cylinder, the interface needs to support 2 relative locations.

Note that Version 0 did NOT. Only one percentage could be specified, and it was used for both attachments when that case arose. The default values are left for backwards compatibility

virtual const DtNetU8 DtSdcAttachablePdu::relativeLocation ( int  index = 0) const [virtual]
virtual void DtSdcAttachablePdu::setOffset ( const DtVector offsetVector) [virtual]

offset from final position.

virtual DtVector DtSdcAttachablePdu::offset ( ) const [virtual]
virtual const DtGlobalObjectDesignator DtSdcAttachablePdu::attachEntityId ( int  index) const [virtual]
virtual const DtNetU32 DtSdcAttachablePdu::attachObjectId ( int  index) const [virtual]
virtual DtVector DtSdcAttachablePdu::position ( int  index) const [virtual]
virtual void DtSdcAttachablePdu::setColor ( DtNetU8  color[4]) [virtual]

Reimplemented in DtSdcLinePdu.

virtual const DtNetU8* DtSdcAttachablePdu::color ( ) const [virtual]

Reimplemented in DtSdcLinePdu.

virtual void DtSdcAttachablePdu::setFlashing ( bool  onOff) [virtual]
virtual const bool DtSdcAttachablePdu::flashing ( ) const [virtual]
virtual void DtSdcAttachablePdu::setFromString ( const char *  ) [virtual]
virtual const char* DtSdcAttachablePdu::string ( ) const [virtual]
virtual void DtSdcAttachablePdu::printData ( ) const [virtual]
static const char* DtSdcAttachablePdu::typeString ( DtVcObjectAttachment  param) [static]
virtual void DtSdcAttachablePdu::setAttachmentType ( DtVcObjectAttachment  attachmentType) [protected, virtual]

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)