CigiAnimationStopV3 Class Reference

#include <CigiAnimationStopV3.h>

Inheritance diagram for CigiAnimationStopV3:

CigiBaseAnimationStop CigiBasePacket List of all members.

Public Member Functions

 CigiAnimationStopV3 ()
virtual ~CigiAnimationStopV3 ()
virtual int Pack (CigiBasePacket *Base, Cigi_uint8 *Buff, void *Spec) const
virtual int Unpack (Cigi_uint8 *Buff, bool Swap, void *Spec)

Detailed Description

Definition at line 57 of file CigiAnimationStopV3.h.


Constructor & Destructor Documentation

CigiAnimationStopV3::CigiAnimationStopV3 (  ) 

General Constructor

Definition at line 67 of file CigiAnimationStopV3.cpp.

References CIGI_ANIMATION_STOP_PACKET_ID_V3, CIGI_ANIMATION_STOP_PACKET_SIZE_V3, CigiBaseAnimationStop::EntityID, CigiBasePacket::MinorVersion, CigiBasePacket::PacketID, CigiBasePacket::PacketSize, and CigiBasePacket::Version.

00068 {
00069 
00070    PacketID = CIGI_ANIMATION_STOP_PACKET_ID_V3;
00071    PacketSize = CIGI_ANIMATION_STOP_PACKET_SIZE_V3;
00072    Version = 3;
00073    MinorVersion = 0;
00074 
00075    EntityID = 0;
00076 
00077 }

CigiAnimationStopV3::~CigiAnimationStopV3 (  )  [virtual]

General Destructor

Definition at line 82 of file CigiAnimationStopV3.cpp.

00083 {
00084 
00085 }


Member Function Documentation

int CigiAnimationStopV3::Pack ( CigiBasePacket Base,
Cigi_uint8 Buff,
void *  Spec 
) const [virtual]

The virtual Pack function for CIGI 3

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 - This is not used in this class.
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Implements CigiBaseAnimationStop.

Definition at line 94 of file CigiAnimationStopV3.cpp.

References PackPointerUnion::c, CigiBaseAnimationStop::EntityID, PackPointerUnion::l, CigiBasePacket::PacketID, CigiBasePacket::PacketSize, and PackPointerUnion::s.

00095 {
00096    PackPointer CDta;
00097 
00098    CigiBaseAnimationStop * Data = ( CigiBaseAnimationStop *)Base;
00099 
00100    CDta.c = Buff;
00101 
00102    *CDta.c++ = PacketID;
00103    *CDta.c++ = PacketSize;
00104 
00105    *CDta.s++ = Data->EntityID;
00106 
00107    *CDta.l++ = 0;
00108 
00109    return(PacketSize);
00110 
00111 }

int CigiAnimationStopV3::Unpack ( Cigi_uint8 Buff,
bool  Swap,
void *  Spec 
) [virtual]

The virtual Unpack function for CIGI 3

Parameters:
Buff - A pointer to the current pack point.
Swap - N/A for V1 & V2
Spec - A pointer to special data - This is not used in this class.
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Implements CigiBaseAnimationStop.

Definition at line 116 of file CigiAnimationStopV3.cpp.

References PackPointerUnion::c, CigiSwap2(), CigiBaseAnimationStop::EntityID, CigiBasePacket::PacketSize, and PackPointerUnion::s.

00117 {
00118    PackPointer CDta;
00119 
00120    CDta.c = Buff;
00121 
00122    CDta.c += 2;  // Step over packet id and size
00123 
00124    if(!Swap)
00125       EntityID = *CDta.s++;
00126    else
00127       CigiSwap2(&EntityID, CDta.s++);
00128 
00129    return(PacketSize);
00130 
00131 }


The documentation for this class was generated from the following files:
Generated on Wed Apr 29 09:00:04 2009 for CCL by  doxygen 1.4.7