CigiBaseCollDetSegDef Class Reference

#include <CigiBaseCollDetSegDef.h>

Inheritance diagram for CigiBaseCollDetSegDef:

CigiBasePacket CigiCollDetSegDefV1 CigiCollDetSegDefV2 CigiCollDetSegDefV3 List of all members.

Public Member Functions

 CigiBaseCollDetSegDef ()
virtual ~CigiBaseCollDetSegDef ()
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 SetSegmentEn (const bool SegmentEnIn, bool bndchk=true)
bool GetSegmentEn (void) const
int SetX1 (const float X1In, bool bndchk=true)
float GetX1 (void) const
int SetY1 (const float Y1In, bool bndchk=true)
float GetY1 (void) const
int SetZ1 (const float Z1In, bool bndchk=true)
float GetZ1 (void) const
int SetX2 (const float X2In, bool bndchk=true)
float GetX2 (void) const
int SetY2 (const float Y2In, bool bndchk=true)
float GetY2 (void) const
int SetZ2 (const float Z2In, bool bndchk=true)
float GetZ2 (void) const
int SetMask (const Cigi_uint32 MaskIn, bool bndchk=true)
Cigi_uint32 GetMask (void) const

Protected Attributes

Cigi_uint16 EntityID
Cigi_uint8 SegmentID
bool SegmentEn
float X1
float Y1
float Z1
float X2
float Y2
float Z2
Cigi_uint32 Mask

Friends

class CigiCollDetSegDefV1
class CigiCollDetSegDefV2
class CigiCollDetSegDefV3

Detailed Description

Definition at line 79 of file CigiBaseCollDetSegDef.h.

Constructor & Destructor Documentation

CigiBaseCollDetSegDef::CigiBaseCollDetSegDef (  )  [inline]

General Constructor

Definition at line 93 of file CigiBaseCollDetSegDef.h.

00093 { };

virtual CigiBaseCollDetSegDef::~CigiBaseCollDetSegDef (  )  [inline, virtual]

General Destructor

Definition at line 98 of file CigiBaseCollDetSegDef.h.

00098 { };

Member Function Documentation

virtual int CigiBaseCollDetSegDef::GetCnvt ( CigiVersionID &  CnvtVersion,
CigiCnvtInfoType::Type &  CnvtInfo 
) [inline, 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 140 of file CigiBaseCollDetSegDef.h.

References CIGI_COLL_DET_SEG_DEF_PACKET_ID_V2, CIGI_COLL_DET_SEG_DEF_PACKET_ID_V3, CIGI_SUCCESS, CigiVersionID::CigiMajorVersion, CigiCnvtInfoType::CigiCnvtInfoStruct::CnvtPacketID, CigiCnvtInfoType::CigiCnvtInfoStruct::ProcID, and CigiProcessType::ProcStd.

00142    {
00143       CnvtInfo.ProcID = CigiProcessType::ProcStd;
00144 
00145       // Note: V1 & V2 are the same
00146       if(CnvtVersion.CigiMajorVersion < 3)
00147          CnvtInfo.CnvtPacketID = CIGI_COLL_DET_SEG_DEF_PACKET_ID_V2;
00148       else
00149          CnvtInfo.CnvtPacketID = CIGI_COLL_DET_SEG_DEF_PACKET_ID_V3;
00150 
00151       return(CIGI_SUCCESS);
00152    }

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

Gets the EntityID value.

Returns:
the current EntityID.

Definition at line 176 of file CigiBaseCollDetSegDef.h.

References EntityID.

00176 { return(EntityID); }

Cigi_uint32 CigiBaseCollDetSegDef::GetMask ( void   )  const [inline]

Gets the Mask value.

Returns:
the current Mask.

Definition at line 345 of file CigiBaseCollDetSegDef.h.

References Mask.

00345 { return(Mask); }

bool CigiBaseCollDetSegDef::GetSegmentEn ( void   )  const [inline]

Gets the SegmentEn value.

Returns:
the current SegmentEn.

Definition at line 197 of file CigiBaseCollDetSegDef.h.

References SegmentEn.

00197 { return(SegmentEn); }

float CigiBaseCollDetSegDef::GetX1 ( void   )  const [inline]

Gets the X1 value.

Returns:
the current X1.

Definition at line 218 of file CigiBaseCollDetSegDef.h.

References X1.

00218 { return(X1); }

float CigiBaseCollDetSegDef::GetX2 ( void   )  const [inline]

Gets the X2 value.

Returns:
the current X2.

Definition at line 281 of file CigiBaseCollDetSegDef.h.

References X2.

00281 { return(X2); }

float CigiBaseCollDetSegDef::GetY1 ( void   )  const [inline]

Gets the Y1 value.

Returns:
the current Y1.

Definition at line 239 of file CigiBaseCollDetSegDef.h.

References Y1.

00239 { return(Y1); }

float CigiBaseCollDetSegDef::GetY2 ( void   )  const [inline]

Gets the Y2 value.

Returns:
the current Y2.

Definition at line 302 of file CigiBaseCollDetSegDef.h.

References Y2.

00302 { return(Y2); }

float CigiBaseCollDetSegDef::GetZ1 ( void   )  const [inline]

Gets the Z1 value.

Returns:
the current Z1.

Definition at line 260 of file CigiBaseCollDetSegDef.h.

References Z1.

00260 { return(Z1); }

float CigiBaseCollDetSegDef::GetZ2 ( void   )  const [inline]

Gets the Z2 value.

Returns:
the current Z2.

Definition at line 323 of file CigiBaseCollDetSegDef.h.

References Z2.

00323 { return(Z2); }

virtual int CigiBaseCollDetSegDef::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 CigiCollDetSegDefV1, CigiCollDetSegDefV2, and CigiCollDetSegDefV3.

int CigiBaseCollDetSegDef::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 167 of file CigiBaseCollDetSegDef.h.

References CIGI_SUCCESS, and EntityID.

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

int CigiBaseCollDetSegDef::SetMask ( const Cigi_uint32  MaskIn,
bool  bndchk = true 
) [inline]

Sets the Mask with bound checking control

Parameters:
MaskIn - Mask specifying which materials will result in a report if 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 336 of file CigiBaseCollDetSegDef.h.

References CIGI_SUCCESS, and Mask.

00337    {
00338       Mask = MaskIn;
00339       return(CIGI_SUCCESS);
00340    }

int CigiBaseCollDetSegDef::SetSegmentEn ( const bool  SegmentEnIn,
bool  bndchk = true 
) [inline]

Sets the SegmentEn with bound checking control

Parameters:
SegmentEnIn - Segment 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 188 of file CigiBaseCollDetSegDef.h.

References CIGI_SUCCESS, and SegmentEn.

00189    {
00190       SegmentEn = SegmentEnIn;
00191       return(CIGI_SUCCESS);
00192    }

int CigiBaseCollDetSegDef::SetX1 ( const float  X1In,
bool  bndchk = true 
) [inline]

Sets the X1 with bound checking control

Parameters:
X1In - Segment starting position along the X axis.
bndchk - Enables (true) or disables (false) bounds checking.
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 209 of file CigiBaseCollDetSegDef.h.

References CIGI_SUCCESS, and X1.

00210    {
00211       X1 = X1In;
00212       return(CIGI_SUCCESS);
00213    }

int CigiBaseCollDetSegDef::SetX2 ( const float  X2In,
bool  bndchk = true 
) [inline]

Sets the X2 with bound checking control

Parameters:
X2In - Segment ending position along the X axis.
bndchk - Enables (true) or disables (false) bounds checking.
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 272 of file CigiBaseCollDetSegDef.h.

References CIGI_SUCCESS, and X2.

00273    {
00274       X2 = X2In;
00275       return(CIGI_SUCCESS);
00276    }

int CigiBaseCollDetSegDef::SetY1 ( const float  Y1In,
bool  bndchk = true 
) [inline]

Sets the Y1 with bound checking control

Parameters:
Y1In - Segment starting position along the Y axis.
bndchk - Enables (true) or disables (false) bounds checking.
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 230 of file CigiBaseCollDetSegDef.h.

References CIGI_SUCCESS, and Y1.

00231    {
00232       Y1 = Y1In;
00233       return(CIGI_SUCCESS);
00234    }

int CigiBaseCollDetSegDef::SetY2 ( const float  Y2In,
bool  bndchk = true 
) [inline]

Sets the Y2 with bound checking control

Parameters:
Y2In - Segment ending position along the Y axis.
bndchk - Enables (true) or disables (false) bounds checking.
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 293 of file CigiBaseCollDetSegDef.h.

References CIGI_SUCCESS, and Y2.

00294    {
00295       Y2 = Y2In;
00296       return(CIGI_SUCCESS);
00297    }

int CigiBaseCollDetSegDef::SetZ1 ( const float  Z1In,
bool  bndchk = true 
) [inline]

Sets the Z1 with bound checking control

Parameters:
Z1In - Segment starting position along the Z axis.
bndchk - Enables (true) or disables (false) bounds checking.
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 251 of file CigiBaseCollDetSegDef.h.

References CIGI_SUCCESS, and Z1.

00252    {
00253       Z1 = Z1In;
00254       return(CIGI_SUCCESS);
00255    }

int CigiBaseCollDetSegDef::SetZ2 ( const float  Z2In,
bool  bndchk = true 
) [inline]

Sets the Z2 with bound checking control

Parameters:
Z2In - Segment ending position along the Z axis.
bndchk - Enables (true) or disables (false) bounds checking.
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 314 of file CigiBaseCollDetSegDef.h.

References CIGI_SUCCESS, and Z2.

00315    {
00316       Z2 = Z2In;
00317       return(CIGI_SUCCESS);
00318    }

virtual int CigiBaseCollDetSegDef::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 CigiCollDetSegDefV1, CigiCollDetSegDefV2, and CigiCollDetSegDefV3.

Friends And Related Function Documentation

friend class CigiCollDetSegDefV1 [friend]

Definition at line 82 of file CigiBaseCollDetSegDef.h.

friend class CigiCollDetSegDefV2 [friend]

Definition at line 83 of file CigiBaseCollDetSegDef.h.

friend class CigiCollDetSegDefV3 [friend]

Definition at line 84 of file CigiBaseCollDetSegDef.h.

Member Data Documentation

Cigi_uint16 CigiBaseCollDetSegDef::EntityID [protected]

EntityID
Entity ID

Definition at line 357 of file CigiBaseCollDetSegDef.h.

Referenced by CigiCollDetSegDefV1::CigiCollDetSegDefV1(), CigiCollDetSegDefV2::CigiCollDetSegDefV2(), CigiCollDetSegDefV3::CigiCollDetSegDefV3(), GetEntityID(), CigiCollDetSegDefV3::Pack(), CigiCollDetSegDefV2::Pack(), CigiCollDetSegDefV1::Pack(), SetEntityID(), CigiCollDetSegDefV3::Unpack(), CigiCollDetSegDefV2::Unpack(), and CigiCollDetSegDefV1::Unpack().

Cigi_uint32 CigiBaseCollDetSegDef::Mask [protected]

Mask
A mask specifying collisions with which materials will result in a response.

Definition at line 418 of file CigiBaseCollDetSegDef.h.

Referenced by CigiCollDetSegDefV1::CigiCollDetSegDefV1(), CigiCollDetSegDefV2::CigiCollDetSegDefV2(), CigiCollDetSegDefV3::CigiCollDetSegDefV3(), GetMask(), CigiCollDetSegDefV3::Pack(), CigiCollDetSegDefV2::Pack(), CigiCollDetSegDefV1::Pack(), SetMask(), CigiCollDetSegDefV3::Unpack(), CigiCollDetSegDefV2::Unpack(), and CigiCollDetSegDefV1::Unpack().

bool CigiBaseCollDetSegDef::SegmentEn [protected]

SegmentEn
Segment Enable

Definition at line 369 of file CigiBaseCollDetSegDef.h.

Referenced by CigiCollDetSegDefV1::CigiCollDetSegDefV1(), CigiCollDetSegDefV2::CigiCollDetSegDefV2(), CigiCollDetSegDefV3::CigiCollDetSegDefV3(), GetSegmentEn(), CigiCollDetSegDefV3::Pack(), CigiCollDetSegDefV2::Pack(), CigiCollDetSegDefV1::Pack(), SetSegmentEn(), CigiCollDetSegDefV3::Unpack(), CigiCollDetSegDefV2::Unpack(), and CigiCollDetSegDefV1::Unpack().

Cigi_uint8 CigiBaseCollDetSegDef::SegmentID [protected]

SegmentID
Segment ID

Definition at line 363 of file CigiBaseCollDetSegDef.h.

Referenced by CigiCollDetSegDefV1::CigiCollDetSegDefV1(), CigiCollDetSegDefV2::CigiCollDetSegDefV2(), CigiCollDetSegDefV3::CigiCollDetSegDefV3(), CigiCollDetSegDefV3::Pack(), CigiCollDetSegDefV2::Pack(), CigiCollDetSegDefV1::Pack(), CigiCollDetSegDefV2::SetSegmentID(), CigiCollDetSegDefV1::SetSegmentID(), CigiCollDetSegDefV3::Unpack(), CigiCollDetSegDefV2::Unpack(), and CigiCollDetSegDefV1::Unpack().

float CigiBaseCollDetSegDef::X1 [protected]

X1
Segment Starting position along the X axis offset from the entity's origin.

Definition at line 376 of file CigiBaseCollDetSegDef.h.

Referenced by CigiCollDetSegDefV1::CigiCollDetSegDefV1(), CigiCollDetSegDefV2::CigiCollDetSegDefV2(), CigiCollDetSegDefV3::CigiCollDetSegDefV3(), GetX1(), CigiCollDetSegDefV3::Pack(), CigiCollDetSegDefV2::Pack(), CigiCollDetSegDefV1::Pack(), SetX1(), CigiCollDetSegDefV3::Unpack(), CigiCollDetSegDefV2::Unpack(), and CigiCollDetSegDefV1::Unpack().

float CigiBaseCollDetSegDef::X2 [protected]

X2
Segment ending position along the X axis offset from the entity's origin.

Definition at line 397 of file CigiBaseCollDetSegDef.h.

Referenced by CigiCollDetSegDefV1::CigiCollDetSegDefV1(), CigiCollDetSegDefV2::CigiCollDetSegDefV2(), CigiCollDetSegDefV3::CigiCollDetSegDefV3(), GetX2(), CigiCollDetSegDefV3::Pack(), CigiCollDetSegDefV2::Pack(), CigiCollDetSegDefV1::Pack(), SetX2(), CigiCollDetSegDefV3::Unpack(), CigiCollDetSegDefV2::Unpack(), and CigiCollDetSegDefV1::Unpack().

float CigiBaseCollDetSegDef::Y1 [protected]

Y1
Segment starting position along the Y axis offset from the entity's origin.

Definition at line 383 of file CigiBaseCollDetSegDef.h.

Referenced by CigiCollDetSegDefV1::CigiCollDetSegDefV1(), CigiCollDetSegDefV2::CigiCollDetSegDefV2(), CigiCollDetSegDefV3::CigiCollDetSegDefV3(), GetY1(), CigiCollDetSegDefV3::Pack(), CigiCollDetSegDefV2::Pack(), CigiCollDetSegDefV1::Pack(), SetY1(), CigiCollDetSegDefV3::Unpack(), CigiCollDetSegDefV2::Unpack(), and CigiCollDetSegDefV1::Unpack().

float CigiBaseCollDetSegDef::Y2 [protected]

Y2
Segment ending position along the Y axis offset from the entity's origin.

Definition at line 404 of file CigiBaseCollDetSegDef.h.

Referenced by CigiCollDetSegDefV1::CigiCollDetSegDefV1(), CigiCollDetSegDefV2::CigiCollDetSegDefV2(), CigiCollDetSegDefV3::CigiCollDetSegDefV3(), GetY2(), CigiCollDetSegDefV3::Pack(), CigiCollDetSegDefV2::Pack(), CigiCollDetSegDefV1::Pack(), SetY2(), CigiCollDetSegDefV3::Unpack(), CigiCollDetSegDefV2::Unpack(), and CigiCollDetSegDefV1::Unpack().

float CigiBaseCollDetSegDef::Z1 [protected]

Z1
Segment starting position along the Z axis offset from the entity's origin.

Definition at line 390 of file CigiBaseCollDetSegDef.h.

Referenced by CigiCollDetSegDefV1::CigiCollDetSegDefV1(), CigiCollDetSegDefV2::CigiCollDetSegDefV2(), CigiCollDetSegDefV3::CigiCollDetSegDefV3(), GetZ1(), CigiCollDetSegDefV3::Pack(), CigiCollDetSegDefV2::Pack(), CigiCollDetSegDefV1::Pack(), SetZ1(), CigiCollDetSegDefV3::Unpack(), CigiCollDetSegDefV2::Unpack(), and CigiCollDetSegDefV1::Unpack().

float CigiBaseCollDetSegDef::Z2 [protected]

Z2
Segment ending position along the Z axis offset from the entity's origin.

Definition at line 411 of file CigiBaseCollDetSegDef.h.

Referenced by CigiCollDetSegDefV1::CigiCollDetSegDefV1(), CigiCollDetSegDefV2::CigiCollDetSegDefV2(), CigiCollDetSegDefV3::CigiCollDetSegDefV3(), GetZ2(), CigiCollDetSegDefV3::Pack(), CigiCollDetSegDefV2::Pack(), CigiCollDetSegDefV1::Pack(), SetZ2(), CigiCollDetSegDefV3::Unpack(), CigiCollDetSegDefV2::Unpack(), and CigiCollDetSegDefV1::Unpack().

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