dtHLAGM::ArticulatedParameter Class Reference

A DIS/RPR-FOM articulated parameter. More...

#include <distypes.h>

List of all members.

Public Member Functions
	ArticulatedParameter (unsigned char articulatedParameterChange=0, unsigned short partAttachedTo=0)
	Constructor.
	ArticulatedParameter (unsigned char articulatedParameterChange, unsigned short partAttachedTo, const ParameterValue &parameterValue)
	Constructor.
size_t	EncodedLength () const
	Returns the encoded length of this object.
void	Encode (char *buf) const
	Encodes this object into the specified buffer.
void	Decode (const char *buf)
	Decodes the values contained in the specified buffer.
void	SetArticulatedParameterChange (unsigned char articulatedParameterChange)
	Sets the articulated parameter change.
unsigned char	GetArticulatedParameterChange () const
	Returns the articulated parameter change.
void	SetPartAttachedTo (unsigned short partAttachedTo)
	Sets the part attached to.
unsigned short	GetPartAttachedTo () const
	Returns the part attached to.
void	SetParameterValue (const ParameterValue &parameterValue)
	Sets the parameter value.
ParameterValue &	GetParameterValue ()
	Returns the parameter value.
const ParameterValue &	GetParameterValue () const
bool	IsEqual (const ArticulatedParameter &other) const
	Returns true this equals another ArticulatedParameter object.

---

Detailed Description

A DIS/RPR-FOM articulated parameter.

---

Constructor & Destructor Documentation

dtHLAGM::ArticulatedParameter::ArticulatedParameter	(	unsigned char	articulatedParameterChange = 0,
		unsigned short	partAttachedTo = 0
	)

Constructor.

Parameters:

	articulatedParameterChange	the articulated parameter change
	partAttachedTo	the part attached to

dtHLAGM::ArticulatedParameter::ArticulatedParameter	(	unsigned char	articulatedParameterChange,
		unsigned short	partAttachedTo,
		const ParameterValue &	parameterValue
	)

Constructor.

Parameters:

	articulatedParameterChange	the articulated parameter change
	partAttachedTo	the part attached to
	parameterValue	the parameter value

---

Member Function Documentation

size_t dtHLAGM::ArticulatedParameter::EncodedLength

(

)

const

Returns the encoded length of this object.

Returns:

the encoded length of this object, in bytes

void dtHLAGM::ArticulatedParameter::Encode

(

char *

buf

)

const

Encodes this object into the specified buffer.

Parameters:

buf

the buffer to contain the encoded object

void dtHLAGM::ArticulatedParameter::Decode

(

const char *

buf

)

Decodes the values contained in the specified buffer.

Parameters:

buf

the buffer containing the encoded object

void dtHLAGM::ArticulatedParameter::SetArticulatedParameterChange

(

unsigned char

articulatedParameterChange

)

Sets the articulated parameter change.

Parameters:

articulatedParameterChange

the articulated parameter change

unsigned char dtHLAGM::ArticulatedParameter::GetArticulatedParameterChange

(

)

const

Returns the articulated parameter change.

Returns:

the articulated parameter change

void dtHLAGM::ArticulatedParameter::SetPartAttachedTo

(

unsigned short

partAttachedTo

)

Sets the part attached to.

Parameters:

partAttachedTo

the part attached to

unsigned short dtHLAGM::ArticulatedParameter::GetPartAttachedTo

(

)

const

Returns the part attached to.

Returns:

the part attached to

void dtHLAGM::ArticulatedParameter::SetParameterValue

(

const ParameterValue &

parameterValue

)

Sets the parameter value.

Parameters:

parameterValue

the parameter value to copy

ParameterValue & dtHLAGM::ArticulatedParameter::GetParameterValue

(

)

Returns the parameter value.

Returns:

the parameter value

const ParameterValue & dtHLAGM::ArticulatedParameter::GetParameterValue

(

)

const

bool dtHLAGM::ArticulatedParameter::IsEqual

(

const ArticulatedParameter &

other

)

const

Returns true this equals another ArticulatedParameter object.

This will handle the complexity of comparing all contained objects.

Returns:

true if this is equal to other

---