VR-Vantage 2.2 API Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions
DtSdcAttachablePdu Class Reference
Inheritance diagram for DtSdcAttachablePdu:
Inheritance graph
[legend]

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
- Public Member Functions inherited from DtStealthDrawControlPdu
virtual const DtNetU32 objectId () const
virtual void setObjectId (DtNetU32 lid)
virtual void setType (DtNetU32 type)
virtual DtNetU32 type () const
virtual DtU32 paramVersion () const
- Public Member Functions inherited from DtStealthControlPdu
const DtGlobalObjectDesignator & viewerId () const
const DtGlobalObjectDesignator & senderId () const
DtViewerCommand viewerCommand () const
unsigned long ignoreFlags () const
bool statusCommand () const
void setViewerId (const DtGlobalObjectDesignator &id)
void setSenderId (const DtGlobalObjectDesignator &id)
void setIgnoreFlags (unsigned long flags)
void setStatusCommand (bool b)

Static Public Member Functions

static const char * typeString (DtVcObjectAttachment param)
- Static Public Member Functions inherited from DtStealthDrawControlPdu
static const char * typeString (int param)
- Static Public Member Functions inherited from DtStealthControlPdu
static DtPdu * create (const DtNetPacket *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER, DtPduFactory *pduFactory=0)
static DtPdu * createFromNet (const DtNetPacket *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER, DtPduFactory *pduFactory=0)
static DtU32 drawControlParamVersion (const DtNetViewControlPdu *vc)

Protected Member Functions

virtual void setAttachmentType (DtVcObjectAttachment attachmentType)
- Protected Member Functions inherited from DtStealthDrawControlPdu
virtual int setInternalText (DtString str, size_t structSize)
virtual const DtString internalText (int size, size_t structSize) const
virtual void setParamVersion (DtU32 paramVersion)
- Protected Member Functions inherited from DtStealthControlPdu
bool isNumber (const char *str)
DtPduKind internalGetPduKind () const
void setViewerCommand (DtViewerCommand com)
 DtStealthControlPdu ()

Additional Inherited Members

- Static Protected Member Functions inherited from DtStealthControlPdu
static DtStealthControlPdu * createViewControl (DtNetViewControlPdu *vc, DtBufferPtr buffer, DtPduFactory *)
static DtStealthControlPdu * createDrawControl (DtNetViewControlPdu *vc, DtBufferPtr buffer, DtPduFactory *)
static DtStealthControlPdu * createDrawControlV0 (DtNetViewControlPdu *vc, DtBufferPtr buffer, DtPduFactory *)
static DtStealthControlPdu * createDrawControlCurrent (DtNetViewControlPdu *vc, DtBufferPtr buffer, DtPduFactory *)
- Protected Attributes inherited from DtStealthDrawControlPdu
DtString myTemporalText

Member Enumeration Documentation

enum DtSdcAttachablePdu::DtVcObjectAttachment
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.

enum DtSdcAttachablePdu::DtVcDrawingStyle
Enumerator:
DtVcStyleNoFlashing 
DtVcStyleFlashing 
DtVcDrawingStyleEntry 

Member Function Documentation

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

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

References attParams, attParamsV0, DtCURRENT_DRAW_CONTROL_VERSION, and DtStealthDrawControlPdu::paramVersion().

Referenced by printData(), setAttachmentType(), and string().

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

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

References attParams, attParamsV0, DtCURRENT_DRAW_CONTROL_VERSION, DtVcObjectNoAttach, and DtStealthDrawControlPdu::paramVersion().

Referenced by setFromString().

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

2D placement of lines

References attParams, attParamsV0, DtCURRENT_DRAW_CONTROL_VERSION, DtVcObjectNoAttachNoAttach, and DtStealthDrawControlPdu::paramVersion().

void DtSdcAttachablePdu::attachTo ( const DtVector &  pos)
virtual

3D placement of single position objects

References attParams, attParamsV0, DtCURRENT_DRAW_CONTROL_VERSION, DtVcObjectNoAttach, and DtStealthDrawControlPdu::paramVersion().

void DtSdcAttachablePdu::attachTo ( const DtNetU32  id)
virtual

References attParams, attParamsV0, DtCURRENT_DRAW_CONTROL_VERSION, DtVcObjectAttachedToObject, and DtStealthDrawControlPdu::paramVersion().

void DtSdcAttachablePdu::attachTo ( const DtGlobalObjectDesignator &  id)
virtual

References attParams, attParamsV0, DtCURRENT_DRAW_CONTROL_VERSION, DtVcObjectAttachedToEntity, and DtStealthDrawControlPdu::paramVersion().

void DtSdcAttachablePdu::attachTo ( const DtNetU32  id1,
const DtNetU32  id2 
)
virtual

3D placement of two position objects

References attParams, attParamsV0, DtCURRENT_DRAW_CONTROL_VERSION, DtVcObjectAttachedToObjectObject, and DtStealthDrawControlPdu::paramVersion().

void DtSdcAttachablePdu::attachTo ( const DtGlobalObjectDesignator &  id1,
const DtGlobalObjectDesignator &  id2 
)
virtual

References attParams, attParamsV0, DtCURRENT_DRAW_CONTROL_VERSION, DtVcObjectAttachedToEntityEntity, and DtStealthDrawControlPdu::paramVersion().

void DtSdcAttachablePdu::attachTo ( const DtVector &  pos1,
const DtVector &  pos2 
)
virtual

References attParams, attParamsV0, DtCURRENT_DRAW_CONTROL_VERSION, DtVcObjectNoAttachNoAttach, and DtStealthDrawControlPdu::paramVersion().

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

References attParams, attParamsV0, DtCURRENT_DRAW_CONTROL_VERSION, DtVcObjectAttachedToEntityObject, and DtStealthDrawControlPdu::paramVersion().

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

References attParams, attParamsV0, DtCURRENT_DRAW_CONTROL_VERSION, DtVcObjectAttachedToObjectEntity, and DtStealthDrawControlPdu::paramVersion().

void DtSdcAttachablePdu::attachTo ( const DtGlobalObjectDesignator &  id,
const DtVector &  pos 
)
virtual

References attParams, attParamsV0, DtCURRENT_DRAW_CONTROL_VERSION, DtVcObjectAttachedToEntityNoAttach, and DtStealthDrawControlPdu::paramVersion().

void DtSdcAttachablePdu::attachTo ( const DtVector &  pos,
const DtGlobalObjectDesignator &  id 
)
virtual

References attParams, attParamsV0, DtCURRENT_DRAW_CONTROL_VERSION, DtVcObjectAttachedToNoAttachEntity, and DtStealthDrawControlPdu::paramVersion().

void DtSdcAttachablePdu::attachTo ( const DtNetU32  id,
const DtVector &  pos 
)
virtual

References attParams, attParamsV0, DtCURRENT_DRAW_CONTROL_VERSION, DtVcObjectAttachedToObjectNoAttach, and DtStealthDrawControlPdu::paramVersion().

void DtSdcAttachablePdu::attachTo ( const DtVector &  pos,
const DtNetU32  id 
)
virtual

References attParams, attParamsV0, DtCURRENT_DRAW_CONTROL_VERSION, DtVcObjectAttachedToNoAttachObject, and DtStealthDrawControlPdu::paramVersion().

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

References attParams, attParamsV0, DtCURRENT_DRAW_CONTROL_VERSION, and DtStealthDrawControlPdu::paramVersion().

const DtNetU8 DtSdcAttachablePdu::relativeLocation ( int  index = 0) const
virtual

References attParams, attParamsV0, DtCURRENT_DRAW_CONTROL_VERSION, and DtStealthDrawControlPdu::paramVersion().

Referenced by printData(), and string().

void DtSdcAttachablePdu::setOffset ( const DtVector &  offsetVector)
virtual

offset from final position.

References attParams, attParamsV0, DtCURRENT_DRAW_CONTROL_VERSION, and DtStealthDrawControlPdu::paramVersion().

DtVector DtSdcAttachablePdu::offset ( ) const
virtual

References attParams, attParamsV0, DtCURRENT_DRAW_CONTROL_VERSION, and DtStealthDrawControlPdu::paramVersion().

Referenced by printData().

const DtGlobalObjectDesignator DtSdcAttachablePdu::attachEntityId ( int  index) const
virtual

References attParams, attParamsV0, DtCURRENT_DRAW_CONTROL_VERSION, and DtStealthDrawControlPdu::paramVersion().

Referenced by printData(), and string().

const DtNetU32 DtSdcAttachablePdu::attachObjectId ( int  index) const
virtual

References attParams, attParamsV0, DtCURRENT_DRAW_CONTROL_VERSION, and DtStealthDrawControlPdu::paramVersion().

Referenced by printData(), and string().

DtVector DtSdcAttachablePdu::position ( int  index) const
virtual

References attParams, attParamsV0, DtCURRENT_DRAW_CONTROL_VERSION, and DtStealthDrawControlPdu::paramVersion().

Referenced by printData(), and string().

void DtSdcAttachablePdu::setColor ( DtNetU8  color[4])
virtual

Reimplemented in DtSdcLinePdu.

References attParams, attParamsV0, DtCURRENT_DRAW_CONTROL_VERSION, and DtStealthDrawControlPdu::paramVersion().

Referenced by setFromString().

const DtNetU8 * DtSdcAttachablePdu::color ( void  ) const
virtual

Reimplemented in DtSdcLinePdu.

References attParams, attParamsV0, DtCURRENT_DRAW_CONTROL_VERSION, and DtStealthDrawControlPdu::paramVersion().

Referenced by printData(), and string().

void DtSdcAttachablePdu::setFlashing ( bool  onOff)
virtual

References attParams, attParamsV0, DtCURRENT_DRAW_CONTROL_VERSION, DtVcDrawingStyleEntry, DtVcStyleFlashing, DtVcStyleNoFlashing, and DtStealthDrawControlPdu::paramVersion().

Referenced by setFromString().

const bool DtSdcAttachablePdu::flashing ( ) const
virtual

References attParams, attParamsV0, DtCURRENT_DRAW_CONTROL_VERSION, DtVcStyleFlashing, and DtStealthDrawControlPdu::paramVersion().

Referenced by printData(), and string().

void DtSdcAttachablePdu::setFromString ( const char *  str)
virtual

Reimplemented from DtStealthControlPdu.

Reimplemented in DtSdcAreaPduBase, DtSdcTrianglePduBase, DtSdcTextPduBase, DtSdcPolyObjectPduBase, and DtSdcAttributePduBase.

References attachTo(), setAttachmentType(), setColor(), setFlashing(), DtStealthDrawControlPdu::setObjectId(), DtStealthDrawControlPdu::setType(), and DtStealthDrawControlPdu::type().

const char * DtSdcAttachablePdu::string ( ) const
virtual

Reimplemented from DtStealthControlPdu.

Reimplemented in DtSdcAreaPduBase, DtSdcTrianglePduBase, DtSdcTextPduBase, DtSdcPolyObjectPduBase, and DtSdcAttributePduBase.

References attachEntityId(), attachmentType(), attachObjectId(), color(), flashing(), DtStealthDrawControlPdu::objectId(), position(), relativeLocation(), DtStealthDrawControlPdu::type(), and DtStealthControlPdu::vcStr.

void DtSdcAttachablePdu::printData ( ) const
virtual

Reimplemented from DtStealthDrawControlPdu.

Reimplemented in DtSdcAreaPduBase, DtSdcTrianglePduBase, DtSdcTextPduBase, DtSdcPolyObjectPduBase, DtSdcLinePdu, and DtSdcAttributePduBase.

References attachEntityId(), attachmentType(), attachObjectId(), color(), flashing(), offset(), position(), relativeLocation(), and typeString().

const char * DtSdcAttachablePdu::typeString ( DtVcObjectAttachment  param)
static

References CASE_EVCSTRING, DtVcObjectAttachedToEntity, DtVcObjectAttachedToEntityEntity, DtVcObjectAttachedToEntityNoAttach, DtVcObjectAttachedToEntityObject, DtVcObjectAttachedToNoAttachEntity, DtVcObjectAttachedToNoAttachObject, DtVcObjectAttachedToObject, DtVcObjectAttachedToObjectEntity, DtVcObjectAttachedToObjectNoAttach, DtVcObjectAttachedToObjectObject, DtVcObjectNoAttach, and DtVcObjectNoAttachNoAttach.

Referenced by printData().

void DtSdcAttachablePdu::setAttachmentType ( DtVcObjectAttachment  attachmentType)
protectedvirtual

References attachmentType(), attParams, attParamsV0, DtCURRENT_DRAW_CONTROL_VERSION, and DtStealthDrawControlPdu::paramVersion().

Referenced by setFromString().

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

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