 |
VR-Link API Documentation for DIS
|
|
VR-Link API Documentation for DIS
|
class DtEntityStateUpdatePdu: More...
Inheritance diagram for DtEntityStateUpdatePdu: Collaboration diagram for DtEntityStateUpdatePdu:Public Member Functions | |
| DtEntityStateUpdatePdu (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER) | |
| Constructors. | |
| DtEntityStateUpdatePdu (const DtNetEntityStateUpdatePdu *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER) | |
| DtEntityStateUpdatePdu (const DtEntityStateUpdatePdu &orig) | |
| virtual | ~DtEntityStateUpdatePdu () |
| destructor | |
| DtEntityStateUpdatePdu & | operator= (const DtEntityStateUpdatePdu &orig) |
| Assignment operator. | |
| virtual void | setEntityID (const DtEntityIdentifier &id) |
| Set/Get entity ID. | |
| virtual const DtEntityIdentifier & | entityID () const |
| virtual DtU8 | numRecords () const |
| Get the number of articulation parameter records (this field is automatically set by the PDU when the articulated part list or attached part list is set). | |
| virtual void | setVelocity (const DtVector &velocity) |
| Set/Get velocity. | |
| virtual const DtVector & | velocity () const |
| virtual void | setLocation (const DtVector &coords) |
| Set/Get location. | |
| virtual const DtVector & | location () const |
| virtual void | setOrientation (const DtTaitBryan &orientation) |
| Set/Get orientation. | |
| virtual const DtTaitBryan & | orientation () const |
| virtual void | setAppearance (DtU32 app) |
| Set/Get appearance (as a 32 bit integer). | |
| virtual DtU32 | appearance () const |
| virtual void | setAppearanceAttribute (const DtAppearAttribute attr, const DtAppearAttrVal val) |
| Set/Get appearance by attribute. | |
| virtual DtAppearAttrVal | appearanceAttribute (const DtAppearAttribute attr) const |
| virtual bool | setArtPartParameters (const DtArticulatedPartCollection &partList) |
| The articulated parts and attached parts information are both optional. | |
| virtual bool | getArtPartParameters (DtArticulatedPartCollection &partList) const |
| virtual bool | setAttPartParameters (const DtAttachedPartCollection &partList) |
| Set/Get attached parts parameters. | |
| virtual bool | getAttPartParameters (DtAttachedPartCollection &partList) const |
| virtual void | printData () const |
| Print the data contained by this PDU. | |
| virtual void | printDataToStream (std::ostream &stream) const |
| Print the data to a stream. | |
Static Public Member Functions | |
| static DtPdu * | create (const DtNetPacket *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER) |
| Create a DtEntityStateUpdatePdu. | |
| static void | addCallback (DtExerciseConn *conn, DtEntityStateUpdatePduCb cb, void *usr) |
| Add (register)/Remove (deregister) function to be called when pdu is received. | |
| static void | removeCallback (DtExerciseConn *conn, DtEntityStateUpdatePduCb cb, void *usr) |
Protected Member Functions | |
| virtual DtPduKind | internalGetPduKind () const |
| Returns the internal PDU kind. | |
| virtual DtNetEntityStateUpdatePdu * | netPduStruct () const |
| Casts the netPdu element to our network struct. | |
| DtEntityStateUpdatePdu * | self () const |
| Casts the 'this' pointer for changing elements in a const function. | |
| virtual char * | var () const |
| Returns a pointer to the first byte of variable length data. | |
| virtual void | setNumRecords (DtU8 value) |
| Set number of records. | |
| virtual int | artParmOffset () const |
| Returns the offset (in bytes) of a field in the variable data region. | |
| virtual int | attParmOffset () const |
| virtual void | fillAttPartNetParams (const DtAttachedPartCollection &apList, DtNetAttachedPart *netRecords) |
| virtual void | fillAttPartCollection (DtAttachedPartCollection &apList, const DtNetAttachedPart *netRecords) const |
Protected Attributes | |
| int | myNumArtPartParams |
| Number of articulated part parameters for this PDU. | |
| int | myNumAttPartParams |
| Number of attached part parameters for this PDU. | |
| DtEntityIdentifier | myEntityID |
| Temporary objects for reference returns. | |
| DtVector | myVector |
| DtTaitBryan | myEulerAngles |
Static Protected Attributes | |
| static const int | theStaticSize |
| Size of PDU with zero parameter records. | |
class DtEntityStateUpdatePdu:
Instances of DtEntityStateUpdatePdu are used to send non-static information about a particular entity.
Constructors.
| DtEntityStateUpdatePdu::DtEntityStateUpdatePdu | ( | const DtNetEntityStateUpdatePdu * | initial, |
| DtBufferPtr | buffer = DtUSE_INTERNAL_BUFFER |
||
| ) |
| DtEntityStateUpdatePdu::DtEntityStateUpdatePdu | ( | const DtEntityStateUpdatePdu & | orig | ) |
| virtual DtEntityStateUpdatePdu::~DtEntityStateUpdatePdu | ( | ) | [virtual] |
destructor
| static void DtEntityStateUpdatePdu::addCallback | ( | DtExerciseConn * | conn, |
| DtEntityStateUpdatePduCb | cb, | ||
| void * | usr | ||
| ) | [static] |
Add (register)/Remove (deregister) function to be called when pdu is received.
| virtual DtU32 DtEntityStateUpdatePdu::appearance | ( | ) | const [virtual] |
| virtual DtAppearAttrVal DtEntityStateUpdatePdu::appearanceAttribute | ( | const DtAppearAttribute | attr | ) | const [virtual] |
| virtual int DtEntityStateUpdatePdu::artParmOffset | ( | ) | const [protected, virtual] |
Returns the offset (in bytes) of a field in the variable data region.
| virtual int DtEntityStateUpdatePdu::attParmOffset | ( | ) | const [protected, virtual] |
| static DtPdu* DtEntityStateUpdatePdu::create | ( | const DtNetPacket * | initial, |
| DtBufferPtr | buffer = DtUSE_INTERNAL_BUFFER |
||
| ) | [static] |
Create a DtEntityStateUpdatePdu.
Caller is responsible for deletion.
| virtual const DtEntityIdentifier& DtEntityStateUpdatePdu::entityID | ( | ) | const [virtual] |
| virtual void DtEntityStateUpdatePdu::fillAttPartCollection | ( | DtAttachedPartCollection & | apList, |
| const DtNetAttachedPart * | netRecords | ||
| ) | const [protected, virtual] |
| virtual void DtEntityStateUpdatePdu::fillAttPartNetParams | ( | const DtAttachedPartCollection & | apList, |
| DtNetAttachedPart * | netRecords | ||
| ) | [protected, virtual] |
| virtual bool DtEntityStateUpdatePdu::getArtPartParameters | ( | DtArticulatedPartCollection & | partList | ) | const [virtual] |
| virtual bool DtEntityStateUpdatePdu::getAttPartParameters | ( | DtAttachedPartCollection & | partList | ) | const [virtual] |
| virtual DtPduKind DtEntityStateUpdatePdu::internalGetPduKind | ( | ) | const [protected, virtual] |
Returns the internal PDU kind.
Implements DtPdu.
| virtual const DtVector& DtEntityStateUpdatePdu::location | ( | ) | const [virtual] |
| virtual DtNetEntityStateUpdatePdu* DtEntityStateUpdatePdu::netPduStruct | ( | ) | const [protected, virtual] |
Casts the netPdu element to our network struct.
| virtual DtU8 DtEntityStateUpdatePdu::numRecords | ( | ) | const [virtual] |
Get the number of articulation parameter records (this field is automatically set by the PDU when the articulated part list or attached part list is set).
| DtEntityStateUpdatePdu& DtEntityStateUpdatePdu::operator= | ( | const DtEntityStateUpdatePdu & | orig | ) |
Assignment operator.
| virtual const DtTaitBryan& DtEntityStateUpdatePdu::orientation | ( | ) | const [virtual] |
| virtual void DtEntityStateUpdatePdu::printData | ( | ) | const [virtual] |
Print the data contained by this PDU.
Reimplemented from DtPdu.
| virtual void DtEntityStateUpdatePdu::printDataToStream | ( | std::ostream & | stream | ) | const [virtual] |
Print the data to a stream.
Reimplemented from DtPdu.
| static void DtEntityStateUpdatePdu::removeCallback | ( | DtExerciseConn * | conn, |
| DtEntityStateUpdatePduCb | cb, | ||
| void * | usr | ||
| ) | [static] |
| DtEntityStateUpdatePdu* DtEntityStateUpdatePdu::self | ( | ) | const [protected] |
Casts the 'this' pointer for changing elements in a const function.
Non-virtual since you can't override based on return type.
| virtual void DtEntityStateUpdatePdu::setAppearance | ( | DtU32 | app | ) | [virtual] |
Set/Get appearance (as a 32 bit integer).
| virtual void DtEntityStateUpdatePdu::setAppearanceAttribute | ( | const DtAppearAttribute | attr, |
| const DtAppearAttrVal | val | ||
| ) | [virtual] |
Set/Get appearance by attribute.
| virtual bool DtEntityStateUpdatePdu::setArtPartParameters | ( | const DtArticulatedPartCollection & | partList | ) | [virtual] |
The articulated parts and attached parts information are both optional.
Either or both can be set. Set/Get articulated parts parameters. Parameters are passed in the form of an articulated parts list. Returns false if the operation could not be performed.
| virtual bool DtEntityStateUpdatePdu::setAttPartParameters | ( | const DtAttachedPartCollection & | partList | ) | [virtual] |
Set/Get attached parts parameters.
Parameters are passed in the form of an attached parts list. Returns false if the operation could not be performed.
| virtual void DtEntityStateUpdatePdu::setEntityID | ( | const DtEntityIdentifier & | id | ) | [virtual] |
Set/Get entity ID.
| virtual void DtEntityStateUpdatePdu::setLocation | ( | const DtVector & | coords | ) | [virtual] |
Set/Get location.
| virtual void DtEntityStateUpdatePdu::setNumRecords | ( | DtU8 | value | ) | [protected, virtual] |
Set number of records.
| virtual void DtEntityStateUpdatePdu::setOrientation | ( | const DtTaitBryan & | orientation | ) | [virtual] |
Set/Get orientation.
| virtual void DtEntityStateUpdatePdu::setVelocity | ( | const DtVector & | velocity | ) | [virtual] |
Set/Get velocity.
| virtual char* DtEntityStateUpdatePdu::var | ( | ) | const [protected, virtual] |
Returns a pointer to the first byte of variable length data.
| virtual const DtVector& DtEntityStateUpdatePdu::velocity | ( | ) | const [virtual] |
DtEntityIdentifier DtEntityStateUpdatePdu::myEntityID [protected] |
Temporary objects for reference returns.
DtTaitBryan DtEntityStateUpdatePdu::myEulerAngles [protected] |
int DtEntityStateUpdatePdu::myNumArtPartParams [protected] |
Number of articulated part parameters for this PDU.
int DtEntityStateUpdatePdu::myNumAttPartParams [protected] |
Number of attached part parameters for this PDU.
DtVector DtEntityStateUpdatePdu::myVector [protected] |
const int DtEntityStateUpdatePdu::theStaticSize [static, protected] |
Size of PDU with zero parameter records.
