This is the original DiGuy control packet for V3. It is maintained for backward compatibility, but is deprecated. New users should use DtCigiDiGuyCtrlExt for V3.x and DtCigiDiGuyCtrlExtV4 for V4.

Inheritance diagram for makCigiExt::DtCigiDiGuyCtrl:

[legend]

Public Types
enum	AnimationStateGrp { Unpaused =0, Paused =1 }

enum	WeaponStateGrp { Stowed =0, Deployed =1 }

enum	PostureGrp { Standing =0, Sitting =1, Crouched =2, Prone =3 }

enum	HealthStateGrp { Alive =0, Dead =1 }

Public Member Functions
	DtCigiDiGuyCtrl (void)

virtual	~DtCigiDiGuyCtrl (void)

	DtCigiDiGuyCtrl (const DtCigiDiGuyCtrl &BaseIn)

DtCigiDiGuyCtrl &	operator= (const DtCigiDiGuyCtrl &BaseIn)

virtual int	Pack (CigiBasePacket Base, Cigi_uint8 Buff, void *Spec) const

virtual int	Unpack (Cigi_uint8 Buff, bool Swap, void Spec)

virtual int	GetTruePacketSize (CigiBaseVariableSizePckt &refPacket)

int	SetEntityID (const Cigi_uint16 EntityIDIn, bool bndchk=true)

Cigi_uint16	GetEntityID (void) const

int	SetPostureEn (const bool PostureEnIn, bool bndchk=true)

bool	GetPostureEn (void) const

int	SetPosture (const PostureGrp PostureIn, bool bndchk=true)

PostureGrp	GetPosture (void) const

int	SetWeaponStateEn (const bool WeaponStateEnIn, bool bndchk=true)

bool	GetWeaponStateEn (void) const

int	SetWeaponState (const WeaponStateGrp WeaponStateIn, bool bndchk=true)

WeaponStateGrp	GetWeaponState (void) const

int	SetAnimationStateEn (const bool AnimationStateEnIn, bool bndchk=true)

bool	GetAnimationStateEn (void) const

int	SetAnimationState (const AnimationStateGrp AnimationStateIn, bool bndchk=true)

AnimationStateGrp	GetAnimationState (void) const

int	SetHealthStateEn (const bool HealthStateEnIn, bool bndchk=true)

bool	GetHealthStateEn (void) const

int	SetHealthState (const HealthStateGrp HealthStateIn, bool bndchk=true)

HealthStateGrp	GetHealthState (void) const

int	SetAnimationSpeedEn (const bool AnimationSpeedEnIn, bool bndchk=true)

bool	GetAnimationSpeedEn (void) const

int	SetAnimationSpeed (const double AnimationSpeedIn, bool bndchk=true)

double	GetAnimationSpeed (void) const

int	SetAnimation (const std::string &AnimationIn, bool bndchk=true)

int	GetAnimationSize (void) const

const std::string &	GetAnimation (void) const

Protected Attributes
Cigi_uint16	myEntityID

PostureGrp	myPosture

WeaponStateGrp	myWeaponState

std::string	myAnimation

double	myAnimationSpeed

AnimationStateGrp	myAnimationState

HealthStateGrp	myHealthState

bool	myPostureEn

bool	myWeaponStateEn

bool	myAnimationStateEn

bool	myAnimationSpeedEn

bool	myHealthStateEn

Static Protected Attributes
static const int	MaxCharCnt = 224

Member Enumeration Documentation

enum makCigiExt::DtCigiDiGuyCtrl::AnimationStateGrp

The enumeration for the Animation Paused/Not Paused flag.

Enumerator
Unpaused
Paused

enum makCigiExt::DtCigiDiGuyCtrl::WeaponStateGrp

The enumeration for the Weapon State flag.

Enumerator
Stowed
Deployed

enum makCigiExt::DtCigiDiGuyCtrl::PostureGrp

The enumeration for the Posture flags.

Enumerator
Standing
Sitting
Crouched
Prone

enum makCigiExt::DtCigiDiGuyCtrl::HealthStateGrp

The enumeration for the Health flag.

Enumerator
Alive
Dead

Constructor & Destructor Documentation

makCigiExt::DtCigiDiGuyCtrl::DtCigiDiGuyCtrl ( void )

General Constructor.

virtual makCigiExt::DtCigiDiGuyCtrl::~DtCigiDiGuyCtrl ( void )

virtual

General Destructor.

makCigiExt::DtCigiDiGuyCtrl::DtCigiDiGuyCtrl ( const DtCigiDiGuyCtrl & BaseIn )

Copy Constructor.

Member Function Documentation

DtCigiDiGuyCtrl& makCigiExt::DtCigiDiGuyCtrl::operator= ( const DtCigiDiGuyCtrl & BaseIn )

Assignment operator.

virtual int makCigiExt::DtCigiDiGuyCtrl::Pack	(	CigiBasePacket *	Base,
		Cigi_uint8 *	Buff,
		void *	Spec
	)		const

virtual

A pure virtual Pack function. This function is not implemented in this class.

Parameters

Base	- A pointer to the instance of the packet to be packed. (Downcast to CigiBasePacket)
Buff	- A pointer to the current pack point.
Spec	- A pointer to special data.

Returns: This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

virtual int makCigiExt::DtCigiDiGuyCtrl::Unpack	(	Cigi_uint8 *	Buff,
		bool	Swap,
		void *	Spec
	)

virtual

A pure virtual Unpack function. This function is not implemented in this class.

Parameters

Buff	- A pointer to the current pack point.
Swap	- N/A for V1 & V2
Spec	- A pointer to special data.

Returns: This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

virtual int makCigiExt::DtCigiDiGuyCtrl::GetTruePacketSize ( CigiBaseVariableSizePckt & refPacket )

inlinevirtual

A virtual function to determine the size that the packet will take up when packed.

Parameters

refPacket - A pointer to the packet being checked.

Returns: The size that the packet will take up when packed

int makCigiExt::DtCigiDiGuyCtrl::SetEntityID	(	const Cigi_uint16	EntityIDIn,
		bool	bndchk = `true`
	)

inline

Sets the Entity ID with bound checking control.

Parameters

EntityIDIn	- Uniquely identifies the specific entity 0 - The ownship All other values - An Application defined entity
bndchk	- Enables (true) or disables (false) bounds checking

Returns: This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Cigi_uint16 makCigiExt::DtCigiDiGuyCtrl::GetEntityID ( void ) const

inline

Gets the Entity ID value.

Returns: EntityID uniquely identifies the specific entity 0 - The ownship All other values - An Application defined entity

int makCigiExt::DtCigiDiGuyCtrl::SetPostureEn	(	const bool	PostureEnIn,
		bool	bndchk = `true`
	)

inline

Sets the PostureEn with bound checking control.

Parameters

PostureEnIn	- Specifies if the posture data is valid and to be used.
bndchk	- Enables (true) or disables (false) bounds checking.

Returns: This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

bool makCigiExt::DtCigiDiGuyCtrl::GetPostureEn ( void ) const

inline

Gets the PostureEn value.

Returns: the current PostureEn.

int makCigiExt::DtCigiDiGuyCtrl::SetPosture	(	const PostureGrp	PostureIn,
		bool	bndchk = `true`
	)

Sets the Posture with bound checking control.

Parameters

PostureIn	- Specifies the DiGuy's posture 0 Standing 1 Sitting 2 Crouched 3 Prone
bndchk	- Enables (true) or disables (false) bounds checking

Returns: This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

PostureGrp makCigiExt::DtCigiDiGuyCtrl::GetPosture ( void ) const

inline

Gets the Posture value.

Returns: Posture specifies the DIGuy's posture 0 Standing 1 Sitting 2 Crouched 3 Prone

int makCigiExt::DtCigiDiGuyCtrl::SetWeaponStateEn	(	const bool	WeaponStateEnIn,
		bool	bndchk = `true`
	)

inline

Sets the WeaponStateEn with bound checking control.

Parameters

WeaponStateEnIn	- Specifies if the weaponState data is valid and to be used.
bndchk	- Enables (true) or disables (false) bounds checking.

Returns: This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

bool makCigiExt::DtCigiDiGuyCtrl::GetWeaponStateEn ( void ) const

inline

Gets the WeaponStateEn value.

Returns: the current WeaponStateEn.

int makCigiExt::DtCigiDiGuyCtrl::SetWeaponState	(	const WeaponStateGrp	WeaponStateIn,
		bool	bndchk = `true`
	)

Sets the WeaponState with bound checking control.

Parameters

WeaponStateIn	- Specifies the DiGuy's weaponState 0 Stowed 1 Deployed
bndchk	- Enables (true) or disables (false) bounds checking

Returns: This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

WeaponStateGrp makCigiExt::DtCigiDiGuyCtrl::GetWeaponState ( void ) const

inline

Gets the WeaponState value.

Returns: WeaponState specifies the DIGuy's weaponState 0 Stowed 1 Deployed

int makCigiExt::DtCigiDiGuyCtrl::SetAnimationStateEn	(	const bool	AnimationStateEnIn,
		bool	bndchk = `true`
	)

inline

Sets the AnimationStateEn with bound checking control.

Parameters

AnimationStateEnIn	- Specifies if the animationState data is valid and to be used.
bndchk	- Enables (true) or disables (false) bounds checking.

Returns: This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

bool makCigiExt::DtCigiDiGuyCtrl::GetAnimationStateEn ( void ) const

inline

Gets the AnimationStateEn value.

Returns: the current AnimationStateEn.

int makCigiExt::DtCigiDiGuyCtrl::SetAnimationState	(	const AnimationStateGrp	AnimationStateIn,
		bool	bndchk = `true`
	)

Sets the AnimationState with bound checking control.

Parameters

AnimationStateIn	- Specifies the DiGuy's animation state 0 Unpaused 1 Paused
bndchk	- Enables (true) or disables (false) bounds checking

Returns: This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

AnimationStateGrp makCigiExt::DtCigiDiGuyCtrl::GetAnimationState ( void ) const

inline

Gets the AnimationState value.

Returns: AnimationState specifies the DIGuy's animation state 0 Unpaused 1 Paused

int makCigiExt::DtCigiDiGuyCtrl::SetHealthStateEn	(	const bool	HealthStateEnIn,
		bool	bndchk = `true`
	)

inline

Sets the HealthStateEn with bound checking control.

Parameters

HealthStateEnIn	- Specifies if the healthState data is valid and to be used.
bndchk	- Enables (true) or disables (false) bounds checking.

Returns: This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

bool makCigiExt::DtCigiDiGuyCtrl::GetHealthStateEn ( void ) const

inline

Gets the HealthStateEn value.

Returns: the current HealthStateEn.

int makCigiExt::DtCigiDiGuyCtrl::SetHealthState	(	const HealthStateGrp	HealthStateIn,
		bool	bndchk = `true`
	)

Sets the HealthState with bound checking control.

Parameters

HealthStateIn	- Specifies the DiGuy's health state 0 Alive 1 Dead
bndchk	- Enables (true) or disables (false) bounds checking

Returns: This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

HealthStateGrp makCigiExt::DtCigiDiGuyCtrl::GetHealthState ( void ) const

inline

Gets the HealthState value.

Returns: HealthState specifies the DIGuy's health state 0 Alive 1 Dead

int makCigiExt::DtCigiDiGuyCtrl::SetAnimationSpeedEn	(	const bool	AnimationSpeedEnIn,
		bool	bndchk = `true`
	)

inline

Sets the AnimationSpeedEn with bound checking control.

Parameters

AnimationSpeedEnIn	- Specifies if the animationSpeed data is valid and to be used.
bndchk	- Enables (true) or disables (false) bounds checking.

Returns: This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

bool makCigiExt::DtCigiDiGuyCtrl::GetAnimationSpeedEn ( void ) const

inline

Gets the AnimationSpeedEn value.

Returns: the current AnimationSpeedEn.

int makCigiExt::DtCigiDiGuyCtrl::SetAnimationSpeed	(	const double	AnimationSpeedIn,
		bool	bndchk = `true`
	)

Sets the AnimationSpeed.

Parameters

AnimationSpeedIn - Specifies the animation speed If 0., DI-Guy picks the speed (which is the recommended usage)

Returns: This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

double makCigiExt::DtCigiDiGuyCtrl::GetAnimationSpeed ( void ) const

inline

Gets the AnimationSpeed.

Returns: The speed of the Di-Guy action animation

int makCigiExt::DtCigiDiGuyCtrl::SetAnimation	(	const std::string &	AnimationIn,
		bool	bndchk = `true`
	)

Returns: This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

int makCigiExt::DtCigiDiGuyCtrl::GetAnimationSize ( void ) const

inline

Returns: The current size of the animation string.

const std::string& makCigiExt::DtCigiDiGuyCtrl::GetAnimation ( void ) const

inline

Gets the Animation (Action) string.

Returns: The current animation

Member Data Documentation

Cigi_uint16 makCigiExt::DtCigiDiGuyCtrl::myEntityID

protected

PostureGrp makCigiExt::DtCigiDiGuyCtrl::myPosture

protected

WeaponStateGrp makCigiExt::DtCigiDiGuyCtrl::myWeaponState

protected

std::string makCigiExt::DtCigiDiGuyCtrl::myAnimation

protected

double makCigiExt::DtCigiDiGuyCtrl::myAnimationSpeed

protected

AnimationStateGrp makCigiExt::DtCigiDiGuyCtrl::myAnimationState

protected

HealthStateGrp makCigiExt::DtCigiDiGuyCtrl::myHealthState

protected

bool makCigiExt::DtCigiDiGuyCtrl::myPostureEn

protected

bool makCigiExt::DtCigiDiGuyCtrl::myWeaponStateEn

protected

bool makCigiExt::DtCigiDiGuyCtrl::myAnimationStateEn

protected

bool makCigiExt::DtCigiDiGuyCtrl::myAnimationSpeedEn

protected

bool makCigiExt::DtCigiDiGuyCtrl::myHealthStateEn

protected

const int makCigiExt::DtCigiDiGuyCtrl::MaxCharCnt = 224

staticprotected

MaxCharCnt
The maximum number of bytes not including NULLs for the animation(action) string.

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/makCigiExtensions/DtCigiDiGuyCtrl.h

Public Types

Public Member Functions

Protected Attributes

Static Protected Attributes

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation