CigiBaseCollDetSegResp Class Reference

#include <CigiBaseCollDetSegResp.h>

Inheritance diagram for CigiBaseCollDetSegResp:

CigiBasePacket CigiCollDetSegRespV1 CigiCollDetSegRespV2 CigiCollDetSegRespV3 List of all members.

Public Types

 NonEntity = 0
 Entity = 1
enum  CollTypeGrp { NonEntity = 0, Entity = 1 }

Public Member Functions

 CigiBaseCollDetSegResp ()
virtual ~CigiBaseCollDetSegResp ()
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 SetMaterial (const Cigi_uint32 MaterialIn, bool bndchk=true)
Cigi_uint32 GetMaterial (void) const
int SetIsValidV1or2 (const bool IsValidV1or2In, bool bndchk=true)
bool GetIsValidV1or2 (void) const

Protected Attributes

Cigi_uint16 EntityID
Cigi_uint8 SegID
CollTypeGrp CollType
Cigi_uint16 CollEntityID
Cigi_uint32 Material
float IntersectDist
float X
float Y
float Z
bool IsValidV1or2

Friends

class CigiCollDetSegRespV1
class CigiCollDetSegRespV2
class CigiCollDetSegRespV3

Detailed Description

Definition at line 79 of file CigiBaseCollDetSegResp.h.

Member Enumeration Documentation

enum CigiBaseCollDetSegResp::CollTypeGrp

The enumeration for the CigiBaseCollDetSegResp Group

Enumerator:
NonEntity 
Entity 

Definition at line 91 of file CigiBaseCollDetSegResp.h.

00092    {
00093       NonEntity=0,
00094       Entity=1
00095    };

Constructor & Destructor Documentation

CigiBaseCollDetSegResp::CigiBaseCollDetSegResp (  ) 

General Constructor

Definition at line 60 of file CigiBaseCollDetSegResp.cpp.

00061 {
00062 
00063 }

CigiBaseCollDetSegResp::~CigiBaseCollDetSegResp (  )  [virtual]

General Destructor

Definition at line 70 of file CigiBaseCollDetSegResp.cpp.

00071 {
00072 
00073 }

Member Function Documentation

int CigiBaseCollDetSegResp::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 83 of file CigiBaseCollDetSegResp.cpp.

References CIGI_COLL_DET_SEG_RESP_PACKET_ID_V2, CIGI_COLL_DET_SEG_RESP_PACKET_ID_V3, CIGI_SUCCESS, CigiVersionID::CigiMajorVersion, CigiCnvtInfoType::CigiCnvtInfoStruct::CnvtPacketID, CigiCnvtInfoType::CigiCnvtInfoStruct::ProcID, and CigiProcessType::ProcStd.

00085 {
00086    CnvtInfo.ProcID = CigiProcessType::ProcStd;
00087 
00088    // Note: V1 & V2 are the same
00089    if(CnvtVersion.CigiMajorVersion < 3)
00090       CnvtInfo.CnvtPacketID = CIGI_COLL_DET_SEG_RESP_PACKET_ID_V2;
00091    else
00092       CnvtInfo.CnvtPacketID = CIGI_COLL_DET_SEG_RESP_PACKET_ID_V3;
00093 
00094    return(CIGI_SUCCESS);
00095 }

Cigi_uint16 CigiBaseCollDetSegResp::GetEntityID ( void   )  const [inline]

Gets the EntityID value.

Returns:
the current EntityID.

Definition at line 177 of file CigiBaseCollDetSegResp.h.

References EntityID.

00177 { return(EntityID); }

bool CigiBaseCollDetSegResp::GetIsValidV1or2 ( void   )  const [inline]

Gets the IsValidV1or2 value.

Returns:
the current IsValidV1or2.

Definition at line 219 of file CigiBaseCollDetSegResp.h.

References IsValidV1or2.

00219 { return(IsValidV1or2); }

Cigi_uint32 CigiBaseCollDetSegResp::GetMaterial ( void   )  const [inline]

Gets the Material value.

Returns:
the current Material.

Definition at line 198 of file CigiBaseCollDetSegResp.h.

References Material.

00198 { return(Material); }

virtual int CigiBaseCollDetSegResp::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 CigiCollDetSegRespV1, CigiCollDetSegRespV2, and CigiCollDetSegRespV3.

int CigiBaseCollDetSegResp::SetEntityID ( const Cigi_uint16  EntityIDIn,
bool  bndchk = true 
) [inline]

Sets the EntityID with bound checking control

Parameters:
EntityIDIn - Entity ID
bndchk - Enables (true) or disables (false) bounds checking.
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 168 of file CigiBaseCollDetSegResp.h.

References CIGI_SUCCESS, and EntityID.

00169    {
00170       EntityID = EntityIDIn;
00171       return(CIGI_SUCCESS);
00172    }

int CigiBaseCollDetSegResp::SetIsValidV1or2 ( const bool  IsValidV1or2In,
bool  bndchk = true 
) [inline]

Sets the IsValidV1or2 with bound checking control

Parameters:
IsValidV1or2In - The data is valid with CIGI 1 and 2
bndchk - Enables (true) or disables (false) bounds checking.
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 210 of file CigiBaseCollDetSegResp.h.

References CIGI_SUCCESS, and IsValidV1or2.

00211    {
00212       IsValidV1or2 = IsValidV1or2In;
00213       return(CIGI_SUCCESS);
00214    }

int CigiBaseCollDetSegResp::SetMaterial ( const Cigi_uint32  MaterialIn,
bool  bndchk = true 
) [inline]

Sets the Material with bound checking control

Parameters:
MaterialIn - Material of the polygon collided with
bndchk - Enables (true) or disables (false) bounds checking.
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 189 of file CigiBaseCollDetSegResp.h.

References CIGI_SUCCESS, and Material.

00190    {
00191       Material = MaterialIn;
00192       return(CIGI_SUCCESS);
00193    }

virtual int CigiBaseCollDetSegResp::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 CigiCollDetSegRespV1, CigiCollDetSegRespV2, and CigiCollDetSegRespV3.

Friends And Related Function Documentation

friend class CigiCollDetSegRespV1 [friend]

Definition at line 82 of file CigiBaseCollDetSegResp.h.

friend class CigiCollDetSegRespV2 [friend]

Definition at line 83 of file CigiBaseCollDetSegResp.h.

friend class CigiCollDetSegRespV3 [friend]

Definition at line 84 of file CigiBaseCollDetSegResp.h.

Member Data Documentation

Cigi_uint16 CigiBaseCollDetSegResp::CollEntityID [protected]

CollEntityID
The Entity ID of the entity collided with

Definition at line 252 of file CigiBaseCollDetSegResp.h.

Referenced by CigiCollDetSegRespV1::CigiCollDetSegRespV1(), CigiCollDetSegRespV2::CigiCollDetSegRespV2(), CigiCollDetSegRespV3::CigiCollDetSegRespV3(), CigiCollDetSegRespV3::Pack(), CigiCollDetSegRespV2::Pack(), CigiCollDetSegRespV3::Unpack(), and CigiCollDetSegRespV2::Unpack().

CollTypeGrp CigiBaseCollDetSegResp::CollType [protected]

CollType
Collision with a non-entity or an entity
0-NonEntity
1-Entity

Definition at line 246 of file CigiBaseCollDetSegResp.h.

Referenced by CigiCollDetSegRespV1::CigiCollDetSegRespV1(), CigiCollDetSegRespV2::CigiCollDetSegRespV2(), CigiCollDetSegRespV3::CigiCollDetSegRespV3(), CigiCollDetSegRespV3::Pack(), CigiCollDetSegRespV2::Pack(), CigiCollDetSegRespV3::SetCollType(), CigiCollDetSegRespV2::SetCollType(), CigiCollDetSegRespV3::Unpack(), and CigiCollDetSegRespV2::Unpack().

Cigi_uint16 CigiBaseCollDetSegResp::EntityID [protected]

EntityID
Entity ID

Definition at line 231 of file CigiBaseCollDetSegResp.h.

Referenced by CigiCollDetSegRespV1::CigiCollDetSegRespV1(), CigiCollDetSegRespV2::CigiCollDetSegRespV2(), CigiCollDetSegRespV3::CigiCollDetSegRespV3(), GetEntityID(), CigiCollDetSegRespV3::Pack(), CigiCollDetSegRespV2::Pack(), CigiCollDetSegRespV1::Pack(), SetEntityID(), CigiCollDetSegRespV3::Unpack(), CigiCollDetSegRespV2::Unpack(), and CigiCollDetSegRespV1::Unpack().

float CigiBaseCollDetSegResp::IntersectDist [protected]

IntersectDist
The distance along the segment from the starting or source point where the collision occured.

Definition at line 265 of file CigiBaseCollDetSegResp.h.

Referenced by CigiCollDetSegRespV1::CigiCollDetSegRespV1(), CigiCollDetSegRespV2::CigiCollDetSegRespV2(), CigiCollDetSegRespV3::CigiCollDetSegRespV3(), CigiCollDetSegRespV3::Pack(), and CigiCollDetSegRespV3::Unpack().

bool CigiBaseCollDetSegResp::IsValidV1or2 [protected]

IsValidV1or2
The data is Valid CIGI 1 or CIGI 2 data - true
OR the data is Valid CIGI 3 data - false.

Definition at line 293 of file CigiBaseCollDetSegResp.h.

Referenced by CigiCollDetSegRespV1::CigiCollDetSegRespV1(), CigiCollDetSegRespV2::CigiCollDetSegRespV2(), CigiCollDetSegRespV3::CigiCollDetSegRespV3(), GetIsValidV1or2(), CigiCollDetSegRespV3::Pack(), CigiCollDetSegRespV2::Pack(), CigiCollDetSegRespV1::Pack(), SetIsValidV1or2(), CigiCollDetSegRespV3::Unpack(), CigiCollDetSegRespV2::Unpack(), and CigiCollDetSegRespV1::Unpack().

Cigi_uint32 CigiBaseCollDetSegResp::Material [protected]

Material
The material code of the polygon collided with

Definition at line 258 of file CigiBaseCollDetSegResp.h.

Referenced by CigiCollDetSegRespV1::CigiCollDetSegRespV1(), CigiCollDetSegRespV2::CigiCollDetSegRespV2(), CigiCollDetSegRespV3::CigiCollDetSegRespV3(), GetMaterial(), CigiCollDetSegRespV3::Pack(), CigiCollDetSegRespV2::Pack(), CigiCollDetSegRespV1::Pack(), SetMaterial(), CigiCollDetSegRespV3::Unpack(), CigiCollDetSegRespV2::Unpack(), and CigiCollDetSegRespV1::Unpack().

Cigi_uint8 CigiBaseCollDetSegResp::SegID [protected]

SegID
Segment ID

Definition at line 237 of file CigiBaseCollDetSegResp.h.

Referenced by CigiCollDetSegRespV1::CigiCollDetSegRespV1(), CigiCollDetSegRespV2::CigiCollDetSegRespV2(), CigiCollDetSegRespV3::CigiCollDetSegRespV3(), CigiCollDetSegRespV3::Pack(), CigiCollDetSegRespV2::Pack(), CigiCollDetSegRespV1::Pack(), CigiCollDetSegRespV2::SetSegID(), CigiCollDetSegRespV1::SetSegID(), CigiCollDetSegRespV3::Unpack(), CigiCollDetSegRespV2::Unpack(), and CigiCollDetSegRespV1::Unpack().

float CigiBaseCollDetSegResp::X [protected]

X
The position of the collision along the X axis of the defining entity's coordinate system.

Definition at line 272 of file CigiBaseCollDetSegResp.h.

Referenced by CigiCollDetSegRespV1::CigiCollDetSegRespV1(), CigiCollDetSegRespV2::CigiCollDetSegRespV2(), CigiCollDetSegRespV3::CigiCollDetSegRespV3(), CigiCollDetSegRespV2::Pack(), CigiCollDetSegRespV1::Pack(), CigiCollDetSegRespV2::Unpack(), and CigiCollDetSegRespV1::Unpack().

float CigiBaseCollDetSegResp::Y [protected]

Y
The position of the collision along the Y axis of the defining entity's coordinate system.

Definition at line 279 of file CigiBaseCollDetSegResp.h.

Referenced by CigiCollDetSegRespV1::CigiCollDetSegRespV1(), CigiCollDetSegRespV2::CigiCollDetSegRespV2(), CigiCollDetSegRespV3::CigiCollDetSegRespV3(), CigiCollDetSegRespV2::Pack(), CigiCollDetSegRespV1::Pack(), CigiCollDetSegRespV2::Unpack(), and CigiCollDetSegRespV1::Unpack().

float CigiBaseCollDetSegResp::Z [protected]

Z
The position of the collision along the Z axis of the defining entity's coordinate system.

Definition at line 286 of file CigiBaseCollDetSegResp.h.

Referenced by CigiCollDetSegRespV1::CigiCollDetSegRespV1(), CigiCollDetSegRespV2::CigiCollDetSegRespV2(), CigiCollDetSegRespV3::CigiCollDetSegRespV3(), CigiCollDetSegRespV2::Pack(), CigiCollDetSegRespV1::Pack(), CigiCollDetSegRespV2::Unpack(), and CigiCollDetSegRespV1::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