VR-Link API Documentation for HLA 1.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Member Functions | Static Public Member Functions | Static Protected Member Functions
DtDIGuyObjectEncoder Class Reference

Instances of DtDIGuyObjectEncoder encode data from DtDIGuyObjectStateRepository objects to the net structures to be sent to the network. More...

+ Inheritance diagram for DtDIGuyObjectEncoder:
+ Collaboration diagram for DtDIGuyObjectEncoder:

Public Member Functions

 DtDIGuyObjectEncoder (DtExerciseConn *exConn, DtObjClassDesc *classDesc)
 Default constructor. More...
 
virtual ~DtDIGuyObjectEncoder ()
 Destructor. More...
 
 DtDIGuyObjectEncoder (const DtDIGuyObjectEncoder &orig)
 Copy constructor. More...
 
DtDIGuyObjectEncoderoperator= (const DtDIGuyObjectEncoder &orig)
 Assignment operator. More...
 
- Public Member Functions inherited from DtHlaStateEncoder
 DtHlaStateEncoder (DtExerciseConn *exConn, DtObjClassDesc *classDesc)
 constructor More...
 
virtual ~DtHlaStateEncoder ()
 destructor More...
 
 DtHlaStateEncoder (const DtHlaStateEncoder &orig)
 copy constructor More...
 
DtHlaStateEncoderoperator= (const DtHlaStateEncoder &orig)
 assignment operator More...
 
DtAttributeEncoder addEncoder (RTI::AttributeHandle hand, DtAttributeEncoder func)
 Add/Remove an encoding function for the attribute specified by handle. More...
 
DtAttributeEncoder removeEncoder (RTI::AttributeHandle hand)
 
DtAttributeEncoder addEncoder (char *name, DtAttributeEncoder func, bool complain=true)
 Add/Remove an encoding function for the attribute specified by name. More...
 
DtAttributeEncoder removeEncoder (char *name, bool complain=true)
 
DtAttributeChecker addChecker (RTI::AttributeHandle hand, DtAttributeChecker func)
 Add/Remove a checker function for the attribute specified by handle. More...
 
DtAttributeChecker removeChecker (RTI::AttributeHandle hand)
 
DtAttributeChecker addChecker (char *name, DtAttributeChecker func, bool complain=true)
 Add/Remove a checker function for the attribute specified by name. More...
 
DtAttributeChecker removeChecker (char *name, bool complain=true)
 
DtAttributeEncoder encoder (const RTI::AttributeHandle &handle)
 Get the attribute encoder for the specified handle. More...
 
DtAttributeChecker checker (const RTI::AttributeHandle &handle)
 Get the attribute checker for the specified handle. More...
 
virtual void encode (const DtStateRepository &stateRep, const DtStateRepository &asSeenByRemote, const RTI::AttributeHandleSet &neededAttrs, const RTI::AttributeHandleSet &includeThese, DtStateMsg *msg)
 Encode necessary values from the state repository. More...
 
virtual RTI::ObjectClassHandle objectClassHandle ()
 Get the object's class handle. More...
 
virtual DtHlaStateEncoderclone (DtObjClassDesc *classDesc) const
 Returns a new-ed clone of this object which corresponds to the class description classDesc. More...
 
virtual DtHlaStateEncoderclone () const
 Returns a new-ed clone of this object. More...
 
virtual void preCalculateEligible (const RTI::AttributeHandleSet &neededAttrs)
 

Static Public Member Functions

static DtHlaStateEncodercreate (DtExerciseConn *exConn, DtObjClassDesc *classDesc)
 Function that creates a DtDIGuyObjectEncoder. More...
 
- Static Public Member Functions inherited from DtHlaStateEncoder
static bool trueChecker (const DtStateRepository &stateRep, const DtStateRepository &asSeenByRemote)
 A checker function that always returns 1, meaning that the attribute for which it is being used will be deemed necessary to send on every tick. More...
 
static bool falseChecker (const DtStateRepository &stateRep, const DtStateRepository &asSeenByRemote)
 A checker function that always returns 0, meaning that the attribute for which it is being used will never be deemed necessary to send. More...
 
static void wideStringToHlaUnicodeString (const std::wstring &wideString, RTI::AttributeHandleValuePairSet *avList, RTI::AttributeHandle attrHandle)
 Puts a unicode widestring into a buffer of the appropriate size and adds it to the attribute value list with it's attribute handle. More...
 

Static Protected Member Functions

static bool needEntityIdentifier (const DtDIGuyObjectStateRepository &stateRep, const DtDIGuyObjectStateRepository &asSeenByRemote)
 Return true if EntityIdentifier needs to be sent to the network, false otherwise. More...
 
static void encodeEntityIdentifier (const DtDIGuyObjectStateRepository &rep, RTI::AttributeHandleValuePairSet *attrs, RTI::AttributeHandle attrHandle)
 Encodes EntityIdentifier from rep into attrs. More...
 
static bool needObjectIdentifier (const DtDIGuyObjectStateRepository &stateRep, const DtDIGuyObjectStateRepository &asSeenByRemote)
 Return true if ObjectIdentifier needs to be sent to the network, false otherwise. More...
 
static void encodeObjectIdentifier (const DtDIGuyObjectStateRepository &rep, RTI::AttributeHandleValuePairSet *attrs, RTI::AttributeHandle attrHandle)
 Encodes ObjectIdentifier from rep into attrs. More...
 
static bool needDIGuyType (const DtDIGuyObjectStateRepository &stateRep, const DtDIGuyObjectStateRepository &asSeenByRemote)
 Return true if DIGuyType needs to be sent to the network, false otherwise. More...
 
static void encodeDIGuyType (const DtDIGuyObjectStateRepository &rep, RTI::AttributeHandleValuePairSet *attrs, RTI::AttributeHandle attrHandle)
 Encodes DIGuyType from rep into attrs. More...
 
static bool needDIGuyAppearance (const DtDIGuyObjectStateRepository &stateRep, const DtDIGuyObjectStateRepository &asSeenByRemote)
 Return true if Appearance needs to be sent to the network, false otherwise. More...
 
static void encodeDIGuyAppearance (const DtDIGuyObjectStateRepository &rep, RTI::AttributeHandleValuePairSet *attrs, RTI::AttributeHandle attrHandle)
 Encodes Appearance from rep into attrs. More...
 
static bool needDIGuyAction (const DtDIGuyObjectStateRepository &stateRep, const DtDIGuyObjectStateRepository &asSeenByRemote)
 Return true if Action needs to be sent to the network, false otherwise. More...
 
static void encodeDIGuyAction (const DtDIGuyObjectStateRepository &rep, RTI::AttributeHandleValuePairSet *attrs, RTI::AttributeHandle attrHandle)
 Encodes Action from rep into attrs. More...
 
static bool needDIGuyVisible (const DtDIGuyObjectStateRepository &stateRep, const DtDIGuyObjectStateRepository &asSeenByRemote)
 Return true if Visible needs to be sent to the network, false otherwise. More...
 
static void encodeDIGuyVisible (const DtDIGuyObjectStateRepository &rep, RTI::AttributeHandleValuePairSet *attrs, RTI::AttributeHandle attrHandle)
 Encodes Visible from rep into attrs. More...
 
static bool needDIGuyShapeVariation (const DtDIGuyObjectStateRepository &stateRep, const DtDIGuyObjectStateRepository &asSeenByRemote)
 Return true if ShapeVariation needs to be sent to the network, false otherwise. More...
 
static void encodeDIGuyShapeVariation (const DtDIGuyObjectStateRepository &rep, RTI::AttributeHandleValuePairSet *attrs, RTI::AttributeHandle attrHandle)
 Encodes ShapeVariation from rep into attrs. More...
 
static bool needDIGuyCharacterScale (const DtDIGuyObjectStateRepository &stateRep, const DtDIGuyObjectStateRepository &asSeenByRemote)
 Return true if CharacterScale needs to be sent to the network, false otherwise. More...
 
static void encodeDIGuyCharacterScale (const DtDIGuyObjectStateRepository &rep, RTI::AttributeHandleValuePairSet *attrs, RTI::AttributeHandle attrHandle)
 Encodes CharacterScale from rep into attrs. More...
 
static bool needDIGuyBodyWeight (const DtDIGuyObjectStateRepository &stateRep, const DtDIGuyObjectStateRepository &asSeenByRemote)
 Return true if BodyWeight needs to be sent to the network, false otherwise. More...
 
static void encodeDIGuyBodyWeight (const DtDIGuyObjectStateRepository &rep, RTI::AttributeHandleValuePairSet *attrs, RTI::AttributeHandle attrHandle)
 Encodes CharacterScale from rep into attrs. More...
 
static void encodeDIGuyPatches (const DtDIGuyObjectStateRepository &stateRep, RTI::AttributeHandleValuePairSet *avList, RTI::AttributeHandle handle)
 Encodes DiGuyPatches from rep into attrs. More...
 
static bool needDIGuyPatches (const DtDIGuyObjectStateRepository &stateRep, const DtDIGuyObjectStateRepository &asSeenByRemote)
 Return true if DIGuyPatches needs to be sent to the network, false otherwise. More...
 

Additional Inherited Members

- Public Types inherited from DtHlaStateEncoder
typedef void(* DtAttributeEncoder )(const DtStateRepository &stateRep, RTI::AttributeHandleValuePairSet *avList, RTI::AttributeHandle handle)
 Attribute encoding function declaration. More...
 
typedef bool(* DtAttributeChecker )(const DtStateRepository &stateRep, const DtStateRepository &asSeenByRemote)
 Attribute checking function declaration. More...
 
typedef bool(* DtAttributeCheckerWithHandle )(const DtStateRepository &stateRep, const DtStateRepository &asSeenByRemote, RTI::AttributeHandle handle)
 Attribute checking function declaration that takes a handle and checks the specific attribute pointed to by that handle. More...
 
- Protected Attributes inherited from DtHlaStateEncoder
DtExerciseConnmyExConn
 
DtObjClassDescmyClassDesc
 
RTI::ObjectClassHandle myHandle
 
std::map< RTI::AttributeHandle,
DtAttributeEncoder
myEncoderList
 myEncoderList and myCheckerList are arrays of classDesc->maxAttrHandle() items. More...
 
std::map< RTI::AttributeHandle,
DtAttributeChecker
myCheckerList
 
std::vector< DtAttributeCheckermyCheckerCache
 This is a helper variable that pre-lookups decoder functions in order to avoid making map calls on every update. More...
 
const RTI::AttributeHandleSet * myCachedSet
 
std::map< RTI::AttributeHandle,
bool
myReportedWarning
 myReportedWarning is an array for keeping track of which warnings have already been reported More...
 

Detailed Description

Instances of DtDIGuyObjectEncoder encode data from DtDIGuyObjectStateRepository objects to the net structures to be sent to the network.

Constructor & Destructor Documentation

DtDIGuyObjectEncoder::DtDIGuyObjectEncoder ( DtExerciseConn exConn,
DtObjClassDesc classDesc 
)

Default constructor.

virtual DtDIGuyObjectEncoder::~DtDIGuyObjectEncoder ( )
virtual

Destructor.

DtDIGuyObjectEncoder::DtDIGuyObjectEncoder ( const DtDIGuyObjectEncoder orig)

Copy constructor.

Member Function Documentation

static DtHlaStateEncoder* DtDIGuyObjectEncoder::create ( DtExerciseConn exConn,
DtObjClassDesc classDesc 
)
static

Function that creates a DtDIGuyObjectEncoder.

static void DtDIGuyObjectEncoder::encodeDIGuyAction ( const DtDIGuyObjectStateRepository rep,
RTI::AttributeHandleValuePairSet *  attrs,
RTI::AttributeHandle  attrHandle 
)
staticprotected

Encodes Action from rep into attrs.

static void DtDIGuyObjectEncoder::encodeDIGuyAppearance ( const DtDIGuyObjectStateRepository rep,
RTI::AttributeHandleValuePairSet *  attrs,
RTI::AttributeHandle  attrHandle 
)
staticprotected

Encodes Appearance from rep into attrs.

static void DtDIGuyObjectEncoder::encodeDIGuyBodyWeight ( const DtDIGuyObjectStateRepository rep,
RTI::AttributeHandleValuePairSet *  attrs,
RTI::AttributeHandle  attrHandle 
)
staticprotected

Encodes CharacterScale from rep into attrs.

static void DtDIGuyObjectEncoder::encodeDIGuyCharacterScale ( const DtDIGuyObjectStateRepository rep,
RTI::AttributeHandleValuePairSet *  attrs,
RTI::AttributeHandle  attrHandle 
)
staticprotected

Encodes CharacterScale from rep into attrs.

static void DtDIGuyObjectEncoder::encodeDIGuyPatches ( const DtDIGuyObjectStateRepository stateRep,
RTI::AttributeHandleValuePairSet *  avList,
RTI::AttributeHandle  handle 
)
staticprotected

Encodes DiGuyPatches from rep into attrs.

static void DtDIGuyObjectEncoder::encodeDIGuyShapeVariation ( const DtDIGuyObjectStateRepository rep,
RTI::AttributeHandleValuePairSet *  attrs,
RTI::AttributeHandle  attrHandle 
)
staticprotected

Encodes ShapeVariation from rep into attrs.

static void DtDIGuyObjectEncoder::encodeDIGuyType ( const DtDIGuyObjectStateRepository rep,
RTI::AttributeHandleValuePairSet *  attrs,
RTI::AttributeHandle  attrHandle 
)
staticprotected

Encodes DIGuyType from rep into attrs.

static void DtDIGuyObjectEncoder::encodeDIGuyVisible ( const DtDIGuyObjectStateRepository rep,
RTI::AttributeHandleValuePairSet *  attrs,
RTI::AttributeHandle  attrHandle 
)
staticprotected

Encodes Visible from rep into attrs.

static void DtDIGuyObjectEncoder::encodeEntityIdentifier ( const DtDIGuyObjectStateRepository rep,
RTI::AttributeHandleValuePairSet *  attrs,
RTI::AttributeHandle  attrHandle 
)
staticprotected

Encodes EntityIdentifier from rep into attrs.

static void DtDIGuyObjectEncoder::encodeObjectIdentifier ( const DtDIGuyObjectStateRepository rep,
RTI::AttributeHandleValuePairSet *  attrs,
RTI::AttributeHandle  attrHandle 
)
staticprotected

Encodes ObjectIdentifier from rep into attrs.

static bool DtDIGuyObjectEncoder::needDIGuyAction ( const DtDIGuyObjectStateRepository stateRep,
const DtDIGuyObjectStateRepository asSeenByRemote 
)
staticprotected

Return true if Action needs to be sent to the network, false otherwise.

static bool DtDIGuyObjectEncoder::needDIGuyAppearance ( const DtDIGuyObjectStateRepository stateRep,
const DtDIGuyObjectStateRepository asSeenByRemote 
)
staticprotected

Return true if Appearance needs to be sent to the network, false otherwise.

static bool DtDIGuyObjectEncoder::needDIGuyBodyWeight ( const DtDIGuyObjectStateRepository stateRep,
const DtDIGuyObjectStateRepository asSeenByRemote 
)
staticprotected

Return true if BodyWeight needs to be sent to the network, false otherwise.

static bool DtDIGuyObjectEncoder::needDIGuyCharacterScale ( const DtDIGuyObjectStateRepository stateRep,
const DtDIGuyObjectStateRepository asSeenByRemote 
)
staticprotected

Return true if CharacterScale needs to be sent to the network, false otherwise.

static bool DtDIGuyObjectEncoder::needDIGuyPatches ( const DtDIGuyObjectStateRepository stateRep,
const DtDIGuyObjectStateRepository asSeenByRemote 
)
staticprotected

Return true if DIGuyPatches needs to be sent to the network, false otherwise.

static bool DtDIGuyObjectEncoder::needDIGuyShapeVariation ( const DtDIGuyObjectStateRepository stateRep,
const DtDIGuyObjectStateRepository asSeenByRemote 
)
staticprotected

Return true if ShapeVariation needs to be sent to the network, false otherwise.

static bool DtDIGuyObjectEncoder::needDIGuyType ( const DtDIGuyObjectStateRepository stateRep,
const DtDIGuyObjectStateRepository asSeenByRemote 
)
staticprotected

Return true if DIGuyType needs to be sent to the network, false otherwise.

static bool DtDIGuyObjectEncoder::needDIGuyVisible ( const DtDIGuyObjectStateRepository stateRep,
const DtDIGuyObjectStateRepository asSeenByRemote 
)
staticprotected

Return true if Visible needs to be sent to the network, false otherwise.

static bool DtDIGuyObjectEncoder::needEntityIdentifier ( const DtDIGuyObjectStateRepository stateRep,
const DtDIGuyObjectStateRepository asSeenByRemote 
)
staticprotected

Return true if EntityIdentifier needs to be sent to the network, false otherwise.

static bool DtDIGuyObjectEncoder::needObjectIdentifier ( const DtDIGuyObjectStateRepository stateRep,
const DtDIGuyObjectStateRepository asSeenByRemote 
)
staticprotected

Return true if ObjectIdentifier needs to be sent to the network, false otherwise.

DtDIGuyObjectEncoder& DtDIGuyObjectEncoder::operator= ( const DtDIGuyObjectEncoder orig)

Assignment operator.


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

Document ID: Generated on Thu Oct 16 00:12:25 EDT 2025 from SVN revision 280738
Copyright © 1992-2025 MAK Technologies. All Rights Reserved (www.mak.com)