#include <CigiBaseAnimationStop.h>
Inheritance diagram for CigiBaseAnimationStop:
Public Member Functions | |
| CigiBaseAnimationStop () | |
| virtual | ~CigiBaseAnimationStop () |
| virtual int | Pack (CigiBasePacket *Base, Cigi_uint8 *Buff, void *Spec) const =0 |
| virtual int | Unpack (Cigi_uint8 *Buff, bool Swap, void *Spec)=0 |
| virtual int | GetCnvt (CigiVersionID &CnvtVersion, CigiCnvtInfoType::Type &CnvtInfo) |
| int | SetEntityID (const Cigi_uint16 EntityIDIn, bool bndchk=true) |
| Cigi_uint16 | GetEntityID (void) const |
Protected Attributes | |
| Cigi_uint16 | EntityID |
Friends | |
| class | CigiAnimationStopV3 |
Definition at line 71 of file CigiBaseAnimationStop.h.
| CigiBaseAnimationStop::CigiBaseAnimationStop | ( | ) | [inline] |
| virtual CigiBaseAnimationStop::~CigiBaseAnimationStop | ( | ) | [inline, virtual] |
| virtual int CigiBaseAnimationStop::GetCnvt | ( | CigiVersionID & | CnvtVersion, | |
| CigiCnvtInfoType::Type & | CnvtInfo | |||
| ) | [inline, virtual] |
A virtual Conversion Information function. This function provides conversion information for this packet.
| CnvtVersion | - The CIGI version to which this packet is being converted. | |
| CnvtInfo | - The information needed for conversion |
Reimplemented from CigiBasePacket.
Definition at line 130 of file CigiBaseAnimationStop.h.
References CIGI_ANIMATION_STOP_PACKET_ID_V3, CIGI_SUCCESS, CigiVersionID::CigiMajorVersion, CigiCnvtInfoType::CigiCnvtInfoStruct::CnvtPacketID, CigiCnvtInfoType::CigiCnvtInfoStruct::ProcID, CigiProcessType::ProcNone, and CigiProcessType::ProcStd.
00132 { 00133 if(CnvtVersion.CigiMajorVersion < 3) 00134 { 00135 CnvtInfo.ProcID = CigiProcessType::ProcNone; 00136 CnvtInfo.CnvtPacketID = 0; 00137 } 00138 else 00139 { 00140 CnvtInfo.ProcID = CigiProcessType::ProcStd; 00141 CnvtInfo.CnvtPacketID = CIGI_ANIMATION_STOP_PACKET_ID_V3; 00142 } 00143 00144 return(CIGI_SUCCESS); 00145 }
| Cigi_uint16 CigiBaseAnimationStop::GetEntityID | ( | void | ) | const [inline] |
Gets the EntityID value.
Definition at line 169 of file CigiBaseAnimationStop.h.
References EntityID.
00169 { return(EntityID); }
| virtual int CigiBaseAnimationStop::Pack | ( | CigiBasePacket * | Base, | |
| Cigi_uint8 * | Buff, | |||
| void * | Spec | |||
| ) | const [pure virtual] |
A pure virtual Pack function. This function is not implemented in this class.
| 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. |
Implements CigiBasePacket.
Implemented in CigiAnimationStopV3.
| int CigiBaseAnimationStop::SetEntityID | ( | const Cigi_uint16 | EntityIDIn, | |
| bool | bndchk = true | |||
| ) | [inline] |
Sets the EntityID with bound checking control
| EntityIDIn | - Entity ID | |
| bndchk | - Enables (true) or disables (false) bounds checking. |
Definition at line 160 of file CigiBaseAnimationStop.h.
References CIGI_SUCCESS, and EntityID.
00161 { 00162 EntityID = EntityIDIn; 00163 return(CIGI_SUCCESS); 00164 }
| virtual int CigiBaseAnimationStop::Unpack | ( | Cigi_uint8 * | Buff, | |
| bool | Swap, | |||
| void * | Spec | |||
| ) | [pure virtual] |
A pure virtual Unpack function. This function is not implemented in this class.
| Buff | - A pointer to the current pack point. | |
| Swap | - N/A for V1 & V2 | |
| Spec | - A pointer to special data. |
Implements CigiBasePacket.
Implemented in CigiAnimationStopV3.
friend class CigiAnimationStopV3 [friend] |
Definition at line 74 of file CigiBaseAnimationStop.h.
Cigi_uint16 CigiBaseAnimationStop::EntityID [protected] |
EntityID
Entity ID
Definition at line 181 of file CigiBaseAnimationStop.h.
Referenced by CigiAnimationStopV3::CigiAnimationStopV3(), GetEntityID(), CigiAnimationStopV3::Pack(), SetEntityID(), and CigiAnimationStopV3::Unpack().
1.4.7