CigiBaseEntityCtrl Class Reference

#include <CigiBaseEntityCtrl.h>

Inheritance diagram for CigiBaseEntityCtrl:

CigiBasePacket CigiEntityCtrlV1 CigiEntityCtrlV2 CigiEntityCtrlV3 CigiEntityCtrlV3_3 List of all members.

Public Types

 Standby = 0
 Active = 1
 Remove = 2
 Detach = 0
 Attach = 1
 Disable = 0
 Enable = 1
 NoInherit = 0
 Inherit = 1
 NoClamp = 0
 AltClamp = 1
 AltAttClamp = 2
 Forward = 0
 Backward = 1
 OneShot = 0
 Continuous = 1
 Stop = 0
 Pause = 1
 Play = 2
 Continue = 3
 NoAction = 4
 Load = 5
 LoadActivate = 6
 Activate = 7
 Deactivate = 8
 DeactivateUnload = 9
enum  EntityStateGrp { Standby = 0, Active = 1, Remove = 2 }
enum  AttachStateGrp { Detach = 0, Attach = 1 }
enum  CollisionDetectGrp { Disable = 0, Enable = 1 }
enum  InheritAlphaGrp { NoInherit = 0, Inherit = 1 }
enum  GrndClampGrp { NoClamp = 0, AltClamp = 1, AltAttClamp = 2 }
enum  AnimationDirGrp { Forward = 0, Backward = 1 }
enum  AnimationLoopModeGrp { OneShot = 0, Continuous = 1 }
enum  AnimationStateGrp {
  Stop = 0, Pause = 1, Play = 2, Continue = 3,
  NoAction = 4, Load = 5, LoadActivate = 6, Activate = 7,
  Deactivate = 8, DeactivateUnload = 9
}

Public Member Functions

 CigiBaseEntityCtrl ()
virtual ~CigiBaseEntityCtrl ()
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
int SetEntityType (const Cigi_uint16 EntityTypeIn, bool bndchk=true)
Cigi_uint16 GetEntityType (void) const
int SetAttachState (const AttachStateGrp AttachStateIn, bool bndchk=true)
AttachStateGrp GetAttachState (void) const
int SetCollisionDetectEn (const CollisionDetectGrp CollisionDetectEnIn, bool bndchk=true)
CollisionDetectGrp GetCollisionDetectEn (void) const
int SetParentID (const Cigi_uint16 ParentIDIn, bool bndchk=true)
Cigi_uint16 GetParentID (void) const
int SetPitch (const float PitchIn, bool bndchk=true)
float GetPitch (void) const
int SetRoll (const float RollIn, bool bndchk=true)
float GetRoll (void) const
int SetLat (const double Lat, bool bndchk=true)
double GetLat (void) const
int SetXoff (const double Xoff, bool bndchk=true)
double GetXoff (void) const
int SetLon (const double Lon, bool bndchk=true)
double GetLon (void) const
int SetYoff (const double Yoff, bool bndchk=true)
double GetYoff (void) const

Protected Attributes

Cigi_uint16 EntityID
Cigi_uint16 EntityType
Cigi_uint16 ParentID
Cigi_uint8 Alpha
float Opacity
float Temperature
float Roll
float Pitch
float Yaw
double LatOrXoff
double LonOrYoff
double AltOrZoff
EntityStateGrp EntityState
AttachStateGrp AttachState
CollisionDetectGrp CollisionDetectEn
InheritAlphaGrp InheritAlpha
GrndClampGrp GrndClamp
AnimationDirGrp AnimationDir
AnimationLoopModeGrp AnimationLoopMode
AnimationStateGrp AnimationState
AnimationStateGrp PastAnimationState
bool SmoothingEn

Static Protected Attributes

static const AnimationStateGrp ToV1 [10]
static const AnimationStateGrp ToV3 [10]

Friends

class CigiEntityCtrlV1
class CigiEntityCtrlV2
class CigiEntityCtrlV3
class CigiEntityCtrlV3_3

Detailed Description

The base class for the Entity Control packet

Definition at line 91 of file CigiBaseEntityCtrl.h.

Member Enumeration Documentation

enum CigiBaseEntityCtrl::AnimationDirGrp

The enumeration for the Animation Direction flag

Enumerator:
Forward 
Backward 

Definition at line 151 of file CigiBaseEntityCtrl.h.

00152    {
00153       Forward=0,
00154       Backward=1
00155    };

enum CigiBaseEntityCtrl::AnimationLoopModeGrp

The enumeration for the Animation Loop Mode flag

Enumerator:
OneShot 
Continuous 

Definition at line 160 of file CigiBaseEntityCtrl.h.

00161    {
00162       OneShot=0,
00163       Continuous=1
00164    };

enum CigiBaseEntityCtrl::AnimationStateGrp

The enumeration for the Animation State flag
This uses both V1 & V3 states to allow conversion.

Enumerator:
Stop 
Pause 
Play 
Continue 
NoAction 
Load 
LoadActivate 
Activate 
Deactivate 
DeactivateUnload 

Definition at line 170 of file CigiBaseEntityCtrl.h.

00171    {
00172       Stop=0,
00173       Pause=1,
00174       Play=2,
00175       Continue=3,
00176       NoAction=4,
00177       Load=5,
00178       LoadActivate=6,
00179       Activate=7,
00180       Deactivate=8,
00181       DeactivateUnload=9
00182    };

enum CigiBaseEntityCtrl::AttachStateGrp

The enumeration for the Attached/Not Attached flag

Enumerator:
Detach 
Attach 

Definition at line 114 of file CigiBaseEntityCtrl.h.

00115    {
00116       Detach=0,
00117       Attach=1
00118    };

enum CigiBaseEntityCtrl::CollisionDetectGrp

The enumeration for the Collision Detection Enable flag

Enumerator:
Disable 
Enable 

Definition at line 123 of file CigiBaseEntityCtrl.h.

00124    {
00125       Disable=0,
00126       Enable=1
00127    };

enum CigiBaseEntityCtrl::EntityStateGrp

The enumeration for the Entity State flag

Enumerator:
Standby 
Active 
Remove 

Definition at line 104 of file CigiBaseEntityCtrl.h.

00105    {
00106       Standby=0,
00107       Active=1,
00108       Remove=2
00109    };

enum CigiBaseEntityCtrl::GrndClampGrp

The enumeration for the Ground/Ocean Clamp flag

Enumerator:
NoClamp 
AltClamp 
AltAttClamp 

Definition at line 141 of file CigiBaseEntityCtrl.h.

00142    {
00143       NoClamp=0,
00144       AltClamp=1,
00145       AltAttClamp=2
00146    };

enum CigiBaseEntityCtrl::InheritAlphaGrp

The enumeration for the Inherit Alpha flag

Enumerator:
NoInherit 
Inherit 

Definition at line 132 of file CigiBaseEntityCtrl.h.

00133    {
00134       NoInherit=0,
00135       Inherit=1
00136    };

Constructor & Destructor Documentation

CigiBaseEntityCtrl::CigiBaseEntityCtrl (  ) 

General Constructor

Definition at line 88 of file CigiBaseEntityCtrl.cpp.

00089 {
00090 
00091 }

CigiBaseEntityCtrl::~CigiBaseEntityCtrl (  )  [virtual]

General Destructor

Definition at line 96 of file CigiBaseEntityCtrl.cpp.

00097 {
00098 
00099 }

Member Function Documentation

AttachStateGrp CigiBaseEntityCtrl::GetAttachState ( void   )  const [inline]

Gets the Attach State Flag value

Returns:
AttachState specifies whether this entity is independant or attached to a parent entity. 0 Detach 1 Attach

Definition at line 321 of file CigiBaseEntityCtrl.h.

References AttachState.

00321 { return(AttachState); }

int CigiBaseEntityCtrl::GetCnvt ( CigiVersionID &  CnvtVersion,
CigiCnvtInfoType::Type &  CnvtInfo 
) [virtual]

A virtual Conversion Information function. This function provides conversion information for this packet.

Parameters:
CnvtVersion - The CIGI version to which this packet is being converted.
CnvtInfo - The information needed for conversion
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Reimplemented from CigiBasePacket.

Definition at line 110 of file CigiBaseEntityCtrl.cpp.

References CIGI_ENTITY_CTRL_PACKET_ID_V3, CIGI_SUCCESS, CigiCnvtInfoType::CigiCnvtInfoStruct::CnvtPacketID, CigiProcessType::ProcEntity, and CigiCnvtInfoType::CigiCnvtInfoStruct::ProcID.

Referenced by CigiOutgoingMsg::operator<<().

00112 {
00113    CnvtInfo.ProcID = CigiProcessType::ProcEntity;
00114 
00115    // All versions of this packet have the same packet id number
00116    CnvtInfo.CnvtPacketID = CIGI_ENTITY_CTRL_PACKET_ID_V3;
00117 
00118    return(CIGI_SUCCESS);
00119 }

CollisionDetectGrp CigiBaseEntityCtrl::GetCollisionDetectEn ( void   )  const [inline]

Getting the Collision Detection Enable Flag value

Returns:
CollisionDetectEn specifies whether Collision Detection is enabled or not. 0 Disable 1 Enable

Definition at line 347 of file CigiBaseEntityCtrl.h.

References CollisionDetectEn.

00347 { return(CollisionDetectEn); }

Cigi_uint16 CigiBaseEntityCtrl::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

Definition at line 271 of file CigiBaseEntityCtrl.h.

References EntityID.

00271 { return(EntityID); }

Cigi_uint16 CigiBaseEntityCtrl::GetEntityType ( void   )  const [inline]

Gets the Entity Type value

Returns:
EntityType specifies the type of entity this is The entity types are specified by the using systems

Definition at line 296 of file CigiBaseEntityCtrl.h.

References EntityType.

00296 { return(EntityType); }

double CigiBaseEntityCtrl::GetLat ( void   )  const [inline]

Gets the Latitude value

Returns:
LatOrXoff specifies the Latitude of the entity (-90.0 to +90.0)

Definition at line 435 of file CigiBaseEntityCtrl.h.

References LatOrXoff.

00435 { return(LatOrXoff); }

double CigiBaseEntityCtrl::GetLon ( void   )  const [inline]

Getting the Longitude value

Returns:
LonOrYoff specifies the Longitude of the entity (-180.0 to +180.0)

Definition at line 481 of file CigiBaseEntityCtrl.h.

References LonOrYoff.

00481 { return(LonOrYoff); }

Cigi_uint16 CigiBaseEntityCtrl::GetParentID ( void   )  const [inline]

Gets the Parent ID value

Returns:
ParentID specifies to which entity this entity is attached, if this is an attached entity.

Definition at line 372 of file CigiBaseEntityCtrl.h.

References ParentID.

00372 { return(ParentID); }

float CigiBaseEntityCtrl::GetPitch ( void   )  const [inline]

Gets the Pitch value

Returns:
Pitch specifies the pitch of the entity (-90.0 to +90.0)

Definition at line 393 of file CigiBaseEntityCtrl.h.

References Pitch.

00393 { return(Pitch); }

float CigiBaseEntityCtrl::GetRoll ( void   )  const [inline]

Gets the Roll value

Returns:
Roll specifies the roll of the entity (-180.0 to +180.0)

Definition at line 414 of file CigiBaseEntityCtrl.h.

References Roll.

00414 { return(Roll); }

double CigiBaseEntityCtrl::GetXoff ( void   )  const [inline]

Gets the X Offset value

Returns:
LatOrXoff specifies the X axis Offset from the Parent entity's origin.

Definition at line 460 of file CigiBaseEntityCtrl.h.

References LatOrXoff.

00460 { return(LatOrXoff); }

double CigiBaseEntityCtrl::GetYoff ( void   )  const [inline]

Gets the Y Offset value

Returns:
LonOrYoff specifies the Y axis Offset from the Parent entity's origin.

Definition at line 506 of file CigiBaseEntityCtrl.h.

References LonOrYoff.

00506 { return(LonOrYoff); }

virtual int CigiBaseEntityCtrl::Pack ( CigiBasePacket *  Base,
Cigi_uint8 *  Buff,
void *  Spec 
) const [pure 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

Implements CigiBasePacket.

Implemented in CigiEntityCtrlV1, CigiEntityCtrlV2, CigiEntityCtrlV3, and CigiEntityCtrlV3_3.

int CigiBaseEntityCtrl::SetAttachState ( const AttachStateGrp  AttachStateIn,
bool  bndchk = true 
)

Sets the Attach State Flag with bound checking control

Parameters:
AttachStateIn - Specifies whether this entity is independant or attached to a parent entity. 0 Detach (independent) 1 Attach
bndchk - Enables (true) or disables (false) bounds checking
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 218 of file CigiBaseEntityCtrl.cpp.

References AttachState, CIGI_ERROR_VALUE_OUT_OF_RANGE, and CIGI_SUCCESS.

00219 {
00220 
00221 #ifndef CIGI_NO_BND_CHK
00222    if(bndchk && ((AttachStateIn < 0)||(AttachStateIn > 1)))
00223    {
00224 #ifndef CIGI_NO_EXCEPT
00225       throw CigiValueOutOfRangeException("AttachState",AttachStateIn,0,1);
00226 #endif
00227       return(CIGI_ERROR_VALUE_OUT_OF_RANGE);
00228    }
00229 #endif
00230 
00231    AttachState = AttachStateIn;
00232 
00233    return(CIGI_SUCCESS);
00234 
00235 }

int CigiBaseEntityCtrl::SetCollisionDetectEn ( const CollisionDetectGrp  CollisionDetectEnIn,
bool  bndchk = true 
)

Sets the Collision Detection Enable Flag with bound checking control

Parameters:
CollisionDetectEnIn - Specifies whether Collision Detection is enabled or not. 0 Disable 1 Enable
bndchk - Enables (true) or disables (false) bounds checking
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 240 of file CigiBaseEntityCtrl.cpp.

References CIGI_ERROR_VALUE_OUT_OF_RANGE, CIGI_SUCCESS, and CollisionDetectEn.

00241 {
00242 
00243 #ifndef CIGI_NO_BND_CHK
00244    if(bndchk && ((CollisionDetectEnIn < 0)||(CollisionDetectEnIn > 1)))
00245    {
00246 #ifndef CIGI_NO_EXCEPT
00247       throw CigiValueOutOfRangeException("CollisionDetectEn",CollisionDetectEnIn,0,1);
00248 #endif
00249       return(CIGI_ERROR_VALUE_OUT_OF_RANGE);
00250    }
00251 #endif
00252 
00253    CollisionDetectEn = CollisionDetectEnIn;
00254 
00255    return(CIGI_SUCCESS);
00256 
00257 }

int CigiBaseEntityCtrl::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

Definition at line 259 of file CigiBaseEntityCtrl.h.

References CIGI_SUCCESS, and EntityID.

00260    {
00261       EntityID = EntityIDIn;
00262       return(CIGI_SUCCESS);
00263    }

int CigiBaseEntityCtrl::SetEntityType ( const Cigi_uint16  EntityTypeIn,
bool  bndchk = true 
) [inline]

Sets the Entity Type with bound checking control

Parameters:
EntityTypeIn - Specifies the type of entity this is. The entity types are specified by the using systems
bndchk - Enables (true) or disables (false) bounds checking
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 285 of file CigiBaseEntityCtrl.h.

References CIGI_SUCCESS, and EntityType.

00286    {
00287       EntityType = EntityTypeIn;
00288       return(CIGI_SUCCESS);
00289    }

int CigiBaseEntityCtrl::SetLat ( const double  Lat,
bool  bndchk = true 
)

Sets the Latitude with bound checking control

Parameters:
Lat - Specifies the Latitude of the entity (-90.0 to +90.0)
bndchk - Enables (true) or disables (false) bounds checking
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 173 of file CigiBaseEntityCtrl.cpp.

References CIGI_ERROR_VALUE_OUT_OF_RANGE, CIGI_SUCCESS, and LatOrXoff.

00174 {
00175 
00176 #ifndef CIGI_NO_BND_CHK
00177    if(bndchk && ((Lat < -90.0f)||(Lat > 90.0f)))
00178    {
00179 #ifndef CIGI_NO_EXCEPT
00180       throw CigiValueOutOfRangeException("Lat",Lat,-90.0,90.0);
00181 #endif
00182       return(CIGI_ERROR_VALUE_OUT_OF_RANGE);
00183    }
00184 #endif
00185 
00186    LatOrXoff = Lat;
00187 
00188    return(CIGI_SUCCESS);
00189 
00190 }

int CigiBaseEntityCtrl::SetLon ( const double  Lon,
bool  bndchk = true 
)

Sets the Longitude with bound checking control

Parameters:
Lon - Specifies the Longitude of the entity (-180.0 to +180.0)
bndchk - Enables (true) or disables (false) bounds checking
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 195 of file CigiBaseEntityCtrl.cpp.

References CIGI_ERROR_VALUE_OUT_OF_RANGE, CIGI_SUCCESS, and LonOrYoff.

00196 {
00197 
00198 #ifndef CIGI_NO_BND_CHK
00199    if(bndchk && ((Lon < -180.0f)||(Lon > 180.0f)))
00200    {
00201 #ifndef CIGI_NO_EXCEPT
00202       throw CigiValueOutOfRangeException("Lon",Lon,-180.0,180.0);
00203 #endif
00204       return(CIGI_ERROR_VALUE_OUT_OF_RANGE);
00205    }
00206 #endif
00207 
00208    LonOrYoff = Lon;
00209 
00210    return(CIGI_SUCCESS);
00211 
00212 }

int CigiBaseEntityCtrl::SetParentID ( const Cigi_uint16  ParentIDIn,
bool  bndchk = true 
) [inline]

Sets the Parent ID with bound checking control

Parameters:
ParentIDIn - If this is an attached entity, this specifies to which entity this entity is attached.
bndchk - Enables (true) or disables (false) bounds checking
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 361 of file CigiBaseEntityCtrl.h.

References CIGI_SUCCESS, and ParentID.

00362    {
00363       ParentID = ParentIDIn;
00364       return(CIGI_SUCCESS);
00365    }

int CigiBaseEntityCtrl::SetPitch ( const float  PitchIn,
bool  bndchk = true 
)

Sets the Pitch with bound checking control

Parameters:
PitchIn - Specifies the pitch of the entity (-90.0 to +90.0)
bndchk - Enables (true) or disables (false) bounds checking
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 129 of file CigiBaseEntityCtrl.cpp.

References CIGI_ERROR_VALUE_OUT_OF_RANGE, CIGI_SUCCESS, and Pitch.

00130 {
00131 
00132 #ifndef CIGI_NO_BND_CHK
00133    if(bndchk && ((PitchIn < -90.0f)||(PitchIn > 90.0f)))
00134    {
00135 #ifndef CIGI_NO_EXCEPT
00136       throw CigiValueOutOfRangeException("Pitch",(double)PitchIn,-90.0,90.0);
00137 #endif
00138       return(CIGI_ERROR_VALUE_OUT_OF_RANGE);
00139    }
00140 #endif
00141 
00142    Pitch = PitchIn;
00143 
00144    return(CIGI_SUCCESS);
00145 
00146 }

int CigiBaseEntityCtrl::SetRoll ( const float  RollIn,
bool  bndchk = true 
)

Sets the Roll with bound checking control

Parameters:
RollIn - Specifies the roll of the entity (-180.0 to +180.0)
bndchk - Enables (true) or disables (false) bounds checking
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 151 of file CigiBaseEntityCtrl.cpp.

References CIGI_ERROR_VALUE_OUT_OF_RANGE, CIGI_SUCCESS, and Roll.

00152 {
00153 
00154 #ifndef CIGI_NO_BND_CHK
00155    if(bndchk && ((RollIn < -180.0f)||(RollIn > 180.0f)))
00156    {
00157 #ifndef CIGI_NO_EXCEPT
00158       throw CigiValueOutOfRangeException("Roll",(double)RollIn,-180.0,180.0);
00159 #endif
00160       return(CIGI_ERROR_VALUE_OUT_OF_RANGE);
00161    }
00162 #endif
00163 
00164    Roll = RollIn;
00165 
00166    return(CIGI_SUCCESS);
00167 
00168 }

int CigiBaseEntityCtrl::SetXoff ( const double  Xoff,
bool  bndchk = true 
) [inline]

Sets the X Offset with bound checking control

Parameters:
Xoff - Specifies the X axis Offset from the Parent entity's origin.
bndchk - Enables (true) or disables (false) bounds checking
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 449 of file CigiBaseEntityCtrl.h.

References CIGI_SUCCESS, and LatOrXoff.

00450    {
00451       LatOrXoff = Xoff;
00452       return(CIGI_SUCCESS);
00453    }

int CigiBaseEntityCtrl::SetYoff ( const double  Yoff,
bool  bndchk = true 
) [inline]

Sets the Y Offset with bound checking control

Parameters:
Yoff - Specifies the Y axis Offset from the Parent entity's origin.
bndchk - Enables (true) or disables (false) bounds checking
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 495 of file CigiBaseEntityCtrl.h.

References CIGI_SUCCESS, and LonOrYoff.

00496    {
00497       LonOrYoff = Yoff;
00498       return(CIGI_SUCCESS);
00499    }

virtual int CigiBaseEntityCtrl::Unpack ( Cigi_uint8 *  Buff,
bool  Swap,
void *  Spec 
) [pure 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

Implements CigiBasePacket.

Implemented in CigiEntityCtrlV1, CigiEntityCtrlV2, CigiEntityCtrlV3, and CigiEntityCtrlV3_3.

Friends And Related Function Documentation

friend class CigiEntityCtrlV1 [friend]

Definition at line 94 of file CigiBaseEntityCtrl.h.

friend class CigiEntityCtrlV2 [friend]

Definition at line 95 of file CigiBaseEntityCtrl.h.

friend class CigiEntityCtrlV3 [friend]

Definition at line 96 of file CigiBaseEntityCtrl.h.

friend class CigiEntityCtrlV3_3 [friend]

Definition at line 97 of file CigiBaseEntityCtrl.h.

Member Data Documentation

Cigi_uint8 CigiBaseEntityCtrl::Alpha [protected]

Alpha
Specifies the visibility/transparency of the entity.
0 - transparent : 255 - Fully visible

Definition at line 541 of file CigiBaseEntityCtrl.h.

Referenced by CigiEntityCtrlV1::CigiEntityCtrlV1(), CigiEntityCtrlV2::CigiEntityCtrlV2(), CigiEntityCtrlV3::CigiEntityCtrlV3(), CigiEntityCtrlV3_3::CigiEntityCtrlV3_3(), CigiEntityCtrlV3_3::Pack(), CigiEntityCtrlV3::Pack(), CigiEntityCtrlV2::SetOpacity(), CigiEntityCtrlV3_3::Unpack(), CigiEntityCtrlV3::Unpack(), CigiEntityCtrlV2::Unpack(), and CigiEntityCtrlV1::Unpack().

double CigiBaseEntityCtrl::AltOrZoff [protected]

Altitude or Z Offset from parent entity origin.
Specifies the longitude or Z Offset from parent entity origin
(no bounds)

Definition at line 597 of file CigiBaseEntityCtrl.h.

Referenced by CigiEntityCtrlV1::CigiEntityCtrlV1(), CigiEntityCtrlV2::CigiEntityCtrlV2(), CigiEntityCtrlV3::CigiEntityCtrlV3(), CigiEntityCtrlV3_3::CigiEntityCtrlV3_3(), CigiEntityCtrlV3_3::Pack(), CigiEntityCtrlV3::Pack(), CigiEntityCtrlV2::Pack(), CigiEntityCtrlV1::Pack(), CigiEntityCtrlV3_3::Unpack(), CigiEntityCtrlV3::Unpack(), CigiEntityCtrlV2::Unpack(), and CigiEntityCtrlV1::Unpack().

AnimationDirGrp CigiBaseEntityCtrl::AnimationDir [protected]

Animation Direction
0 Forward
1 Backward

Definition at line 650 of file CigiBaseEntityCtrl.h.

Referenced by CigiEntityCtrlV1::CigiEntityCtrlV1(), CigiEntityCtrlV2::CigiEntityCtrlV2(), CigiEntityCtrlV3::CigiEntityCtrlV3(), CigiEntityCtrlV3_3::CigiEntityCtrlV3_3(), CigiEntityCtrlV3_3::Pack(), CigiEntityCtrlV3::Pack(), CigiEntityCtrlV3_3::SetAnimationDir(), CigiEntityCtrlV3::SetAnimationDir(), CigiEntityCtrlV3_3::Unpack(), and CigiEntityCtrlV3::Unpack().

AnimationLoopModeGrp CigiBaseEntityCtrl::AnimationLoopMode [protected]

Animation Loop Mode
0 One-Shot
1 Continuous

Definition at line 657 of file CigiBaseEntityCtrl.h.

Referenced by CigiEntityCtrlV1::CigiEntityCtrlV1(), CigiEntityCtrlV2::CigiEntityCtrlV2(), CigiEntityCtrlV3::CigiEntityCtrlV3(), CigiEntityCtrlV3_3::CigiEntityCtrlV3_3(), CigiEntityCtrlV3_3::Pack(), CigiEntityCtrlV3::Pack(), CigiEntityCtrlV3_3::SetAnimationLoopMode(), CigiEntityCtrlV3::SetAnimationLoopMode(), CigiEntityCtrlV3_3::Unpack(), and CigiEntityCtrlV3::Unpack().

AnimationStateGrp CigiBaseEntityCtrl::AnimationState [protected]

Animation State
0 Stop
1 Pause
2 Play
3 Continue 4 NoAction
5 Load
6 LoadActivate
7 Activate
8 Deactivate
9 DeactivateUnload

Definition at line 672 of file CigiBaseEntityCtrl.h.

Referenced by CigiEntityCtrlV1::CigiEntityCtrlV1(), CigiEntityCtrlV2::CigiEntityCtrlV2(), CigiEntityCtrlV3::CigiEntityCtrlV3(), CigiEntityCtrlV3_3::CigiEntityCtrlV3_3(), CigiEntityCtrlV3_3::GetAnimationState(), CigiEntityCtrlV3::GetAnimationState(), CigiEntityCtrlV2::GetEffectState(), CigiEntityCtrlV1::GetEffectState(), CigiEntityCtrlV3_3::Pack(), CigiEntityCtrlV3::Pack(), CigiEntityCtrlV2::Pack(), CigiEntityCtrlV1::Pack(), CigiEntityCtrlV3_3::SetAnimationState(), CigiEntityCtrlV3::SetAnimationState(), CigiEntityCtrlV2::SetEffectState(), CigiEntityCtrlV1::SetEffectState(), CigiEntityCtrlV3_3::Unpack(), CigiEntityCtrlV3::Unpack(), CigiEntityCtrlV2::Unpack(), and CigiEntityCtrlV1::Unpack().

AttachStateGrp CigiBaseEntityCtrl::AttachState [protected]

Attach State
0 Detach
1 Attach

Definition at line 621 of file CigiBaseEntityCtrl.h.

Referenced by CigiEntityCtrlV1::CigiEntityCtrlV1(), CigiEntityCtrlV2::CigiEntityCtrlV2(), CigiEntityCtrlV3::CigiEntityCtrlV3(), CigiEntityCtrlV3_3::CigiEntityCtrlV3_3(), GetAttachState(), CigiEntityCtrlV3_3::Pack(), CigiEntityCtrlV3::Pack(), CigiEntityCtrlV2::Pack(), CigiEntityCtrlV1::Pack(), SetAttachState(), CigiEntityCtrlV3_3::Unpack(), CigiEntityCtrlV3::Unpack(), CigiEntityCtrlV2::Unpack(), and CigiEntityCtrlV1::Unpack().

CollisionDetectGrp CigiBaseEntityCtrl::CollisionDetectEn [protected]

Collision Detection Enable
0 Disable
1 Enable

Definition at line 628 of file CigiBaseEntityCtrl.h.

Referenced by CigiEntityCtrlV1::CigiEntityCtrlV1(), CigiEntityCtrlV2::CigiEntityCtrlV2(), CigiEntityCtrlV3::CigiEntityCtrlV3(), CigiEntityCtrlV3_3::CigiEntityCtrlV3_3(), GetCollisionDetectEn(), CigiEntityCtrlV3_3::Pack(), CigiEntityCtrlV3::Pack(), CigiEntityCtrlV2::Pack(), CigiEntityCtrlV1::Pack(), SetCollisionDetectEn(), CigiEntityCtrlV3_3::Unpack(), CigiEntityCtrlV3::Unpack(), CigiEntityCtrlV2::Unpack(), and CigiEntityCtrlV1::Unpack().

Cigi_uint16 CigiBaseEntityCtrl::EntityID [protected]

Entity ID
Uniquely identifies the specific entity
0 - The ownship
All other values - An Application defined entity

Definition at line 521 of file CigiBaseEntityCtrl.h.

Referenced by CigiEntityCtrlV1::CigiEntityCtrlV1(), CigiEntityCtrlV2::CigiEntityCtrlV2(), CigiEntityCtrlV3::CigiEntityCtrlV3(), CigiEntityCtrlV3_3::CigiEntityCtrlV3_3(), GetEntityID(), CigiEntityCtrlV3_3::Pack(), CigiEntityCtrlV3::Pack(), CigiEntityCtrlV2::Pack(), CigiEntityCtrlV1::Pack(), SetEntityID(), CigiEntityCtrlV3_3::Unpack(), CigiEntityCtrlV3::Unpack(), CigiEntityCtrlV2::Unpack(), and CigiEntityCtrlV1::Unpack().

EntityStateGrp CigiBaseEntityCtrl::EntityState [protected]

Entity State
0 Inactive/Standby
1 Active
2 Destroy

Definition at line 614 of file CigiBaseEntityCtrl.h.

Referenced by CigiEntityCtrlV1::CigiEntityCtrlV1(), CigiEntityCtrlV2::CigiEntityCtrlV2(), CigiEntityCtrlV3::CigiEntityCtrlV3(), CigiEntityCtrlV3_3::CigiEntityCtrlV3_3(), CigiEntityCtrlV1::GetEntityState(), CigiEntityCtrlV3_3::Pack(), CigiEntityCtrlV3::Pack(), CigiEntityCtrlV2::Pack(), CigiEntityCtrlV1::Pack(), CigiEntityCtrlV3_3::SetEntityState(), CigiEntityCtrlV3::SetEntityState(), CigiEntityCtrlV2::SetEntityState(), CigiEntityCtrlV1::SetEntityState(), CigiEntityCtrlV3_3::Unpack(), CigiEntityCtrlV3::Unpack(), and CigiEntityCtrlV2::Unpack().

Cigi_uint16 CigiBaseEntityCtrl::EntityType [protected]

Entity Type
Specifies the type of entity this is
The entity types are specified by the using systems

Definition at line 528 of file CigiBaseEntityCtrl.h.

Referenced by CigiEntityCtrlV1::CigiEntityCtrlV1(), CigiEntityCtrlV2::CigiEntityCtrlV2(), CigiEntityCtrlV3::CigiEntityCtrlV3(), CigiEntityCtrlV3_3::CigiEntityCtrlV3_3(), GetEntityType(), CigiEntityCtrlV3_3::Pack(), CigiEntityCtrlV3::Pack(), CigiEntityCtrlV2::Pack(), CigiEntityCtrlV1::Pack(), SetEntityType(), CigiEntityCtrlV3_3::Unpack(), CigiEntityCtrlV3::Unpack(), CigiEntityCtrlV2::Unpack(), and CigiEntityCtrlV1::Unpack().

GrndClampGrp CigiBaseEntityCtrl::GrndClamp [protected]

Ground/Ocean Clamp
0 Clamp
1 Altitude clamp
2 Altitude and Orientation clamp

Definition at line 643 of file CigiBaseEntityCtrl.h.

Referenced by CigiEntityCtrlV1::CigiEntityCtrlV1(), CigiEntityCtrlV2::CigiEntityCtrlV2(), CigiEntityCtrlV3::CigiEntityCtrlV3(), CigiEntityCtrlV3_3::CigiEntityCtrlV3_3(), CigiEntityCtrlV3_3::Pack(), CigiEntityCtrlV3::Pack(), CigiEntityCtrlV3_3::SetGrndClamp(), CigiEntityCtrlV3::SetGrndClamp(), CigiEntityCtrlV3_3::Unpack(), and CigiEntityCtrlV3::Unpack().

InheritAlphaGrp CigiBaseEntityCtrl::InheritAlpha [protected]

Inherit Alpha
0 No Inheritance
1 Inherit

Definition at line 635 of file CigiBaseEntityCtrl.h.

Referenced by CigiEntityCtrlV1::CigiEntityCtrlV1(), CigiEntityCtrlV2::CigiEntityCtrlV2(), CigiEntityCtrlV3::CigiEntityCtrlV3(), CigiEntityCtrlV3_3::CigiEntityCtrlV3_3(), CigiEntityCtrlV3_3::Pack(), CigiEntityCtrlV3::Pack(), CigiEntityCtrlV3_3::SetInheritAlpha(), CigiEntityCtrlV3::SetInheritAlpha(), CigiEntityCtrlV3_3::Unpack(), and CigiEntityCtrlV3::Unpack().

double CigiBaseEntityCtrl::LatOrXoff [protected]

Latitude or X Offset from parent entity origin
Specifies the latitude or X Offset from parent entity origin
(-90.0 to +90.0 if latitude)
no bounds if X Offset

Definition at line 582 of file CigiBaseEntityCtrl.h.

Referenced by CigiEntityCtrlV1::CigiEntityCtrlV1(), CigiEntityCtrlV2::CigiEntityCtrlV2(), CigiEntityCtrlV3::CigiEntityCtrlV3(), CigiEntityCtrlV3_3::CigiEntityCtrlV3_3(), GetLat(), GetXoff(), CigiEntityCtrlV3_3::Pack(), CigiEntityCtrlV3::Pack(), CigiEntityCtrlV2::Pack(), CigiEntityCtrlV1::Pack(), SetLat(), SetXoff(), CigiEntityCtrlV3_3::Unpack(), CigiEntityCtrlV3::Unpack(), CigiEntityCtrlV2::Unpack(), and CigiEntityCtrlV1::Unpack().

double CigiBaseEntityCtrl::LonOrYoff [protected]

Longitude or Y Offset from parent entity origin
Specifies the longitude or Y Offset from parent entity origin
(-180.0 to +180.0 if longitude)
no bounds if Y Offset

Definition at line 590 of file CigiBaseEntityCtrl.h.

Referenced by CigiEntityCtrlV1::CigiEntityCtrlV1(), CigiEntityCtrlV2::CigiEntityCtrlV2(), CigiEntityCtrlV3::CigiEntityCtrlV3(), CigiEntityCtrlV3_3::CigiEntityCtrlV3_3(), GetLon(), GetYoff(), CigiEntityCtrlV3_3::Pack(), CigiEntityCtrlV3::Pack(), CigiEntityCtrlV2::Pack(), CigiEntityCtrlV1::Pack(), SetLon(), SetYoff(), CigiEntityCtrlV3_3::Unpack(), CigiEntityCtrlV3::Unpack(), CigiEntityCtrlV2::Unpack(), and CigiEntityCtrlV1::Unpack().

float CigiBaseEntityCtrl::Opacity [protected]

Opacity
Specifies the visibility/transparency of the entity.
Percent visible: 0 - transparent : 100.0 - Fully visible

Definition at line 547 of file CigiBaseEntityCtrl.h.

Referenced by CigiEntityCtrlV1::CigiEntityCtrlV1(), CigiEntityCtrlV2::CigiEntityCtrlV2(), CigiEntityCtrlV3::CigiEntityCtrlV3(), CigiEntityCtrlV3_3::CigiEntityCtrlV3_3(), CigiEntityCtrlV2::Pack(), CigiEntityCtrlV2::SetOpacity(), CigiEntityCtrlV3_3::Unpack(), CigiEntityCtrlV3::Unpack(), CigiEntityCtrlV2::Unpack(), and CigiEntityCtrlV1::Unpack().

Cigi_uint16 CigiBaseEntityCtrl::ParentID [protected]

Parent ID
If this is an attached entity, this specifies to which entity this entity is attached.

Definition at line 535 of file CigiBaseEntityCtrl.h.

Referenced by CigiEntityCtrlV1::CigiEntityCtrlV1(), CigiEntityCtrlV2::CigiEntityCtrlV2(), CigiEntityCtrlV3::CigiEntityCtrlV3(), CigiEntityCtrlV3_3::CigiEntityCtrlV3_3(), GetParentID(), CigiEntityCtrlV3_3::Pack(), CigiEntityCtrlV3::Pack(), CigiEntityCtrlV2::Pack(), CigiEntityCtrlV1::Pack(), SetParentID(), CigiEntityCtrlV3_3::Unpack(), CigiEntityCtrlV3::Unpack(), CigiEntityCtrlV2::Unpack(), and CigiEntityCtrlV1::Unpack().

AnimationStateGrp CigiBaseEntityCtrl::PastAnimationState [protected]

Past Animation State
This is for V1 compatibility
0 Stop
1 Pause
2 Play
3 Continue
4 NoAction
5 Load
6 LoadActivate
7 Activate
8 Deactivate
9 DeactivateUnload

Definition at line 688 of file CigiBaseEntityCtrl.h.

Referenced by CigiEntityCtrlV1::CigiEntityCtrlV1(), CigiEntityCtrlV2::CigiEntityCtrlV2(), CigiEntityCtrlV3::CigiEntityCtrlV3(), CigiEntityCtrlV3_3::CigiEntityCtrlV3_3(), CigiEntityCtrlV3_3::GetAnimationState(), CigiEntityCtrlV3::GetAnimationState(), CigiEntityCtrlV2::GetEffectState(), CigiEntityCtrlV1::GetEffectState(), CigiEntityCtrlV3_3::Unpack(), CigiEntityCtrlV3::Unpack(), CigiEntityCtrlV2::Unpack(), and CigiEntityCtrlV1::Unpack().

float CigiBaseEntityCtrl::Pitch [protected]

Pitch Specifies the pitch of the entity
(-90.0 to +90.0)

Definition at line 568 of file CigiBaseEntityCtrl.h.

Referenced by CigiEntityCtrlV1::CigiEntityCtrlV1(), CigiEntityCtrlV2::CigiEntityCtrlV2(), CigiEntityCtrlV3::CigiEntityCtrlV3(), CigiEntityCtrlV3_3::CigiEntityCtrlV3_3(), GetPitch(), CigiEntityCtrlV3_3::Pack(), CigiEntityCtrlV3::Pack(), CigiEntityCtrlV2::Pack(), CigiEntityCtrlV1::Pack(), SetPitch(), CigiEntityCtrlV3_3::Unpack(), CigiEntityCtrlV3::Unpack(), CigiEntityCtrlV2::Unpack(), and CigiEntityCtrlV1::Unpack().

float CigiBaseEntityCtrl::Roll [protected]

Roll Specifies the roll of the entity
(-180.0 to +180.0)

Definition at line 561 of file CigiBaseEntityCtrl.h.

Referenced by CigiEntityCtrlV1::CigiEntityCtrlV1(), CigiEntityCtrlV2::CigiEntityCtrlV2(), CigiEntityCtrlV3::CigiEntityCtrlV3(), CigiEntityCtrlV3_3::CigiEntityCtrlV3_3(), GetRoll(), CigiEntityCtrlV3_3::Pack(), CigiEntityCtrlV3::Pack(), CigiEntityCtrlV2::Pack(), CigiEntityCtrlV1::Pack(), SetRoll(), CigiEntityCtrlV3_3::Unpack(), CigiEntityCtrlV3::Unpack(), CigiEntityCtrlV2::Unpack(), and CigiEntityCtrlV1::Unpack().

bool CigiBaseEntityCtrl::SmoothingEn [protected]

Smoothing Enabled
Enable or Disable Extrapolation or Interpolation motion smoothing. true - Smoothing is Enabled
false - Smoothing is Disabled.

Definition at line 697 of file CigiBaseEntityCtrl.h.

Referenced by CigiEntityCtrlV1::CigiEntityCtrlV1(), CigiEntityCtrlV2::CigiEntityCtrlV2(), CigiEntityCtrlV3::CigiEntityCtrlV3(), CigiEntityCtrlV3_3::CigiEntityCtrlV3_3(), CigiEntityCtrlV3_3::Pack(), and CigiEntityCtrlV3_3::Unpack().

float CigiBaseEntityCtrl::Temperature [protected]

Temperature
Specifies the internal temperature of the entity in degrees Celsius.

Definition at line 554 of file CigiBaseEntityCtrl.h.

Referenced by CigiEntityCtrlV1::CigiEntityCtrlV1(), CigiEntityCtrlV2::CigiEntityCtrlV2(), CigiEntityCtrlV3::CigiEntityCtrlV3(), CigiEntityCtrlV3_3::CigiEntityCtrlV3_3(), CigiEntityCtrlV2::Pack(), CigiEntityCtrlV1::Pack(), CigiEntityCtrlV2::Unpack(), and CigiEntityCtrlV1::Unpack().

const CigiBaseEntityCtrl::AnimationStateGrp CigiBaseEntityCtrl::ToV1 [static, protected]

Initial value:

{
   DeactivateUnload, 
   Deactivate,       
   LoadActivate,     
   Continue,         
   NoAction,         
   Load,             
   LoadActivate,     
   Activate,         
   Deactivate,       
   DeactivateUnload  
}

Definition at line 602 of file CigiBaseEntityCtrl.h.

Referenced by CigiEntityCtrlV1::GetEffectState(), and CigiEntityCtrlV1::Pack().

const CigiBaseEntityCtrl::AnimationStateGrp CigiBaseEntityCtrl::ToV3 [static, protected]

Initial value:

{
   Stop,      
   Pause,     
   Play,      
   Continue,  
   NoAction,  
   Stop,      
   Play,      
   Play,      
   Pause,     
   Stop       
}

Definition at line 603 of file CigiBaseEntityCtrl.h.

Referenced by CigiEntityCtrlV3_3::GetAnimationState(), CigiEntityCtrlV3::GetAnimationState(), CigiEntityCtrlV2::GetEffectState(), CigiEntityCtrlV3_3::Pack(), CigiEntityCtrlV3::Pack(), CigiEntityCtrlV2::Pack(), CigiEntityCtrlV1::Pack(), and CigiEntityCtrlV1::Unpack().

float CigiBaseEntityCtrl::Yaw [protected]

Yaw Specifies the Yaw or Heading of the entity
(0.0 to 360.0)

Definition at line 574 of file CigiBaseEntityCtrl.h.

Referenced by CigiEntityCtrlV1::CigiEntityCtrlV1(), CigiEntityCtrlV2::CigiEntityCtrlV2(), CigiEntityCtrlV3::CigiEntityCtrlV3(), CigiEntityCtrlV3_3::CigiEntityCtrlV3_3(), CigiEntityCtrlV3_3::Pack(), CigiEntityCtrlV3::Pack(), CigiEntityCtrlV2::Pack(), CigiEntityCtrlV1::Pack(), CigiEntityCtrlV2::SetHeading(), CigiEntityCtrlV1::SetHeading(), CigiEntityCtrlV3_3::SetYaw(), CigiEntityCtrlV3::SetYaw(), CigiEntityCtrlV3_3::Unpack(), CigiEntityCtrlV3::Unpack(), CigiEntityCtrlV2::Unpack(), and CigiEntityCtrlV1::Unpack().

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