CigiBaseSpecEffDef Class Reference

#include <CigiBaseSpecEffDef.h>

Inheritance diagram for CigiBaseSpecEffDef:


Public Types
	Forward = 0
	Backward = 1
enum	SeqDirGrp { Forward = 0, Backward = 1 }
Public Member Functions
	CigiBaseSpecEffDef ()
virtual	~CigiBaseSpecEffDef ()
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	SetSeqDir (const SeqDirGrp SeqDirIn, bool bndchk=true)
SeqDirGrp	GetSeqDir (void) const
int	SetColorEn (const bool ColorEnIn, bool bndchk=true)
bool	GetColorEn (void) const
int	SetRed (const Cigi_uint8 RedIn, bool bndchk=true)
Cigi_uint8	GetRed (void) const
int	SetGreen (const Cigi_uint8 GreenIn, bool bndchk=true)
Cigi_uint8	GetGreen (void) const
int	SetBlue (const Cigi_uint8 BlueIn, bool bndchk=true)
Cigi_uint8	GetBlue (void) const
int	SetXScale (const float XScaleIn, bool bndchk=true)
float	GetXScale (void) const
int	SetYScale (const float YScaleIn, bool bndchk=true)
float	GetYScale (void) const
int	SetZScale (const float ZScaleIn, bool bndchk=true)
float	GetZScale (void) const
int	SetTimeScale (const float TimeScaleIn, bool bndchk=true)
float	GetTimeScale (void) const
int	SetEffectCnt (const Cigi_uint16 EffectCntIn, bool bndchk=true)
Cigi_uint16	GetEffectCnt (void) const
int	SetSeparation (const float SeparationIn, bool bndchk=true)
float	GetSeparation (void) const
int	SetBurstRate (const float BurstRateIn, bool bndchk=true)
float	GetBurstRate (void) const
int	SetDuration (const float DurationIn, bool bndchk=true)
float	GetDuration (void) const
Protected Attributes
Cigi_uint16	EntityID
SeqDirGrp	SeqDir
bool	ColorEn
Cigi_uint8	Red
Cigi_uint8	Green
Cigi_uint8	Blue
float	XScale
float	YScale
float	ZScale
float	TimeScale
Cigi_uint16	EffectCnt
float	Separation
float	BurstRate
float	Duration
Friends
class	CigiSpecEffDefV1
class	CigiSpecEffDefV2

Detailed Description

Definition at line 75 of file CigiBaseSpecEffDef.h.

Member Enumeration Documentation

enum CigiBaseSpecEffDef::SeqDirGrp

The enumeration for the CigiBaseSpecEffDef Group

Enumerator:

Forward
Backward

Definition at line 86 of file CigiBaseSpecEffDef.h.

00087    {
00088       Forward=0,
00089       Backward=1
00090    };

Constructor & Destructor Documentation

CigiBaseSpecEffDef::CigiBaseSpecEffDef ( )

General Constructor

Definition at line 60 of file CigiBaseSpecEffDef.cpp.

00061 {
00062 
00063 }

CigiBaseSpecEffDef::~CigiBaseSpecEffDef ( ) [virtual]

General Destructor

Definition at line 70 of file CigiBaseSpecEffDef.cpp.

00071 {
00072 
00073 }

Member Function Documentation

Cigi_uint8 CigiBaseSpecEffDef::GetBlue ( void ) const [inline]

Gets the Blue value.

Returns:: the current Blue.

Definition at line 275 of file CigiBaseSpecEffDef.h.

References Blue.

00275 { return(Blue); }

float CigiBaseSpecEffDef::GetBurstRate ( void ) const [inline]

Gets the BurstRate value.

Returns:: the current BurstRate.

Definition at line 406 of file CigiBaseSpecEffDef.h.

References BurstRate.

00406 { return(BurstRate); }

int CigiBaseSpecEffDef::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 84 of file CigiBaseSpecEffDef.cpp.

References CIGI_SPEC_EFF_DEF_PACKET_ID_V2, CIGI_SUCCESS, CigiVersionID::CigiMajorVersion, CigiCnvtInfoType::CigiCnvtInfoStruct::CnvtPacketID, CigiCnvtInfoType::CigiCnvtInfoStruct::ProcID, CigiProcessType::ProcNone, and CigiProcessType::ProcStd.

00086 {
00087    // V1 & V2 use the same packet id number
00088    if(CnvtVersion.CigiMajorVersion > 2)
00089    {
00090       CnvtInfo.ProcID = CigiProcessType::ProcNone;
00091       CnvtInfo.CnvtPacketID = 0;
00092    }
00093    else
00094    {
00095       CnvtInfo.ProcID = CigiProcessType::ProcStd;
00096       CnvtInfo.CnvtPacketID = CIGI_SPEC_EFF_DEF_PACKET_ID_V2;
00097    }
00098 
00099    return(CIGI_SUCCESS);
00100 }

bool CigiBaseSpecEffDef::GetColorEn ( void ) const [inline]

Gets the ColorEn value.

Returns:: the current ColorEn.

Definition at line 212 of file CigiBaseSpecEffDef.h.

References ColorEn.

00212 { return(ColorEn); }

float CigiBaseSpecEffDef::GetDuration ( void ) const [inline]

Gets the Duration value.

Returns:: the current Duration.

Definition at line 427 of file CigiBaseSpecEffDef.h.

References Duration.

00427 { return(Duration); }

Cigi_uint16 CigiBaseSpecEffDef::GetEffectCnt ( void ) const [inline]

Gets the EffectCnt value.

Returns:: the current EffectCnt.

Definition at line 364 of file CigiBaseSpecEffDef.h.

References EffectCnt.

00364 { return(EffectCnt); }

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

Gets the EntityID value.

Returns:: the current EntityID.

Definition at line 172 of file CigiBaseSpecEffDef.h.

References EntityID.

00172 { return(EntityID); }

Cigi_uint8 CigiBaseSpecEffDef::GetGreen ( void ) const [inline]

Gets the Green value.

Returns:: the current Green.

Definition at line 254 of file CigiBaseSpecEffDef.h.

References Green.

00254 { return(Green); }

Cigi_uint8 CigiBaseSpecEffDef::GetRed ( void ) const [inline]

Gets the Red value.

Returns:: the current Red.

Definition at line 233 of file CigiBaseSpecEffDef.h.

References Red.

00233 { return(Red); }

float CigiBaseSpecEffDef::GetSeparation ( void ) const [inline]

Gets the Separation value.

Returns:: the current Separation.

Definition at line 385 of file CigiBaseSpecEffDef.h.

References Separation.

00385 { return(Separation); }

SeqDirGrp CigiBaseSpecEffDef::GetSeqDir ( void ) const [inline]

Gets the SeqDir value.

Returns:: the current SeqDir.

Definition at line 191 of file CigiBaseSpecEffDef.h.

References SeqDir.

00191 { return(SeqDir); }

float CigiBaseSpecEffDef::GetTimeScale ( void ) const [inline]

Gets the TimeScale value.

Returns:: the current TimeScale.

Definition at line 343 of file CigiBaseSpecEffDef.h.

References TimeScale.

00343 { return(TimeScale); }

float CigiBaseSpecEffDef::GetXScale ( void ) const [inline]

Gets the XScale value.

Returns:: the current XScale.

Definition at line 292 of file CigiBaseSpecEffDef.h.

References XScale.

00292 { return(XScale); }

float CigiBaseSpecEffDef::GetYScale ( void ) const [inline]

Gets the YScale value.

Returns:: the current YScale.

Definition at line 309 of file CigiBaseSpecEffDef.h.

References YScale.

00309 { return(YScale); }

float CigiBaseSpecEffDef::GetZScale ( void ) const [inline]

Gets the ZScale value.

Returns:: the current ZScale.

Definition at line 326 of file CigiBaseSpecEffDef.h.

References ZScale.

00326 { return(ZScale); }

virtual int CigiBaseSpecEffDef::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 CigiSpecEffDefV1, and CigiSpecEffDefV2.

int CigiBaseSpecEffDef::SetBlue	(	const Cigi_uint8	BlueIn,
		bool	bndchk = `true`
	)			`[inline]`

Sets the Blue with bound checking control

Parameters:

	BlueIn	- Blue color component
	bndchk	- Enables (true) or disables (false) bounds checking.

Returns:: This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 266 of file CigiBaseSpecEffDef.h.

References Blue, and CIGI_SUCCESS.

00267    {
00268       Blue = BlueIn;
00269       return(CIGI_SUCCESS);
00270    }

int CigiBaseSpecEffDef::SetBurstRate	(	const float	BurstRateIn,
		bool	bndchk = `true`
	)			`[inline]`

Sets the BurstRate with bound checking control

Parameters:

	BurstRateIn	- The Rate at which the effects occur
	bndchk	- Enables (true) or disables (false) bounds checking.

Returns:: This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 397 of file CigiBaseSpecEffDef.h.

References BurstRate, and CIGI_SUCCESS.

00398    {
00399       BurstRate = BurstRateIn;
00400       return(CIGI_SUCCESS);
00401    }

int CigiBaseSpecEffDef::SetColorEn	(	const bool	ColorEnIn,
		bool	bndchk = `true`
	)			`[inline]`

Sets the ColorEn with bound checking control

Parameters:

	ColorEnIn	- Color 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 203 of file CigiBaseSpecEffDef.h.

References CIGI_SUCCESS, and ColorEn.

00204    {
00205       ColorEn = ColorEnIn;
00206       return(CIGI_SUCCESS);
00207    }

int CigiBaseSpecEffDef::SetDuration	(	const float	DurationIn,
		bool	bndchk = `true`
	)			`[inline]`

Sets the Duration with bound checking control

Parameters:

	DurationIn	- Duration of the effect
	bndchk	- Enables (true) or disables (false) bounds checking.

Returns:: This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 418 of file CigiBaseSpecEffDef.h.

References CIGI_SUCCESS, and Duration.

00419    {
00420       Duration = DurationIn;
00421       return(CIGI_SUCCESS);
00422    }

int CigiBaseSpecEffDef::SetEffectCnt	(	const Cigi_uint16	EffectCntIn,
		bool	bndchk = `true`
	)			`[inline]`

Sets the EffectCnt with bound checking control

Parameters:

	EffectCntIn	- Number of effects to control
	bndchk	- Enables (true) or disables (false) bounds checking.

Returns:: This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 355 of file CigiBaseSpecEffDef.h.

References CIGI_SUCCESS, and EffectCnt.

00356    {
00357       EffectCnt = EffectCntIn;
00358       return(CIGI_SUCCESS);
00359    }

int CigiBaseSpecEffDef::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 163 of file CigiBaseSpecEffDef.h.

References CIGI_SUCCESS, and EntityID.

00164    {
00165       EntityID = EntityIDIn;
00166       return(CIGI_SUCCESS);
00167    }

int CigiBaseSpecEffDef::SetGreen	(	const Cigi_uint8	GreenIn,
		bool	bndchk = `true`
	)			`[inline]`

Sets the Green with bound checking control

Parameters:

	GreenIn	- Green color component
	bndchk	- Enables (true) or disables (false) bounds checking.

Returns:: This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 245 of file CigiBaseSpecEffDef.h.

References CIGI_SUCCESS, and Green.

00246    {
00247       Green = GreenIn;
00248       return(CIGI_SUCCESS);
00249    }

int CigiBaseSpecEffDef::SetRed	(	const Cigi_uint8	RedIn,
		bool	bndchk = `true`
	)			`[inline]`

Sets the Red with bound checking control

Parameters:

	RedIn	- Red color component
	bndchk	- Enables (true) or disables (false) bounds checking.

Returns:: This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 224 of file CigiBaseSpecEffDef.h.

References CIGI_SUCCESS, and Red.

00225    {
00226       Red = RedIn;
00227       return(CIGI_SUCCESS);
00228    }

int CigiBaseSpecEffDef::SetSeparation	(	const float	SeparationIn,
		bool	bndchk = `true`
	)			`[inline]`

Sets the Separation with bound checking control

Parameters:

	SeparationIn	- Distance between effects
	bndchk	- Enables (true) or disables (false) bounds checking.

Returns:: This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 376 of file CigiBaseSpecEffDef.h.

References CIGI_SUCCESS, and Separation.

00377    {
00378       Separation = SeparationIn;
00379       return(CIGI_SUCCESS);
00380    }

int CigiBaseSpecEffDef::SetSeqDir	(	const SeqDirGrp	SeqDirIn,
		bool	bndchk = `true`
	)

Sets the SeqDir with bound checking control

Parameters:

	SeqDirIn	- Special Effect Sequence direction Forward=0 Backward=1
	bndchk	- Enables (true) or disables (false) bounds checking.

Returns:: This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 111 of file CigiBaseSpecEffDef.cpp.

References CIGI_ERROR_VALUE_OUT_OF_RANGE, CIGI_SUCCESS, and SeqDir.

00112 {
00113 
00114 #ifndef CIGI_NO_BND_CHK
00115    if(bndchk && ((SeqDirIn < 0)||(SeqDirIn > 1)))
00116    {
00117 #ifndef CIGI_NO_EXCEPT
00118       throw CigiValueOutOfRangeException("SeqDir",(SeqDirGrp)SeqDirIn,0,1);
00119 #endif
00120       return(CIGI_ERROR_VALUE_OUT_OF_RANGE);
00121    }
00122 #endif
00123 
00124    SeqDir = SeqDirIn;
00125    return(CIGI_SUCCESS);
00126 
00127 }

int CigiBaseSpecEffDef::SetTimeScale	(	const float	TimeScaleIn,
		bool	bndchk = `true`
	)

Sets the TimeScale with bound checking control

Parameters:

	TimeScaleIn	- Scaling factor for the effect's time of play.
	bndchk	- Enables (true) or disables (false) bounds checking.

Returns:: This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 199 of file CigiBaseSpecEffDef.cpp.

References CIGI_ERROR_VALUE_OUT_OF_RANGE, CIGI_SUCCESS, and TimeScale.

00200 {
00201 
00202 #ifndef CIGI_NO_BND_CHK
00203    if(bndchk && ((TimeScaleIn < 0.0)||(TimeScaleIn > 512.0)))
00204    {
00205 #ifndef CIGI_NO_EXCEPT
00206       throw CigiValueOutOfRangeException("TimeScale",(float)TimeScaleIn,0.0,512.0);
00207 #endif
00208       return(CIGI_ERROR_VALUE_OUT_OF_RANGE);
00209    }
00210 #endif
00211 
00212    TimeScale = TimeScaleIn;
00213    return(CIGI_SUCCESS);
00214 
00215 }

int CigiBaseSpecEffDef::SetXScale	(	const float	XScaleIn,
		bool	bndchk = `true`
	)

Sets the XScale with bound checking control

Parameters:

	XScaleIn	- Scaling factor along the X axis for the effect.
	bndchk	- Enables (true) or disables (false) bounds checking.

Returns:: This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 133 of file CigiBaseSpecEffDef.cpp.

References CIGI_ERROR_VALUE_OUT_OF_RANGE, CIGI_SUCCESS, and XScale.

00134 {
00135 
00136 #ifndef CIGI_NO_BND_CHK
00137    if(bndchk && ((XScaleIn < 0.0)||(XScaleIn > 512.0)))
00138    {
00139 #ifndef CIGI_NO_EXCEPT
00140       throw CigiValueOutOfRangeException("XScale",(float)XScaleIn,0.0,512.0);
00141 #endif
00142       return(CIGI_ERROR_VALUE_OUT_OF_RANGE);
00143    }
00144 #endif
00145 
00146    XScale = XScaleIn;
00147    return(CIGI_SUCCESS);
00148 
00149 }

int CigiBaseSpecEffDef::SetYScale	(	const float	YScaleIn,
		bool	bndchk = `true`
	)

Sets the YScale with bound checking control

Parameters:

	YScaleIn	- Scaling factor along the Y axis for the effect.
	bndchk	- Enables (true) or disables (false) bounds checking.

Returns:: This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 155 of file CigiBaseSpecEffDef.cpp.

References CIGI_ERROR_VALUE_OUT_OF_RANGE, CIGI_SUCCESS, and YScale.

00156 {
00157 
00158 #ifndef CIGI_NO_BND_CHK
00159    if(bndchk && ((YScaleIn < 0.0)||(YScaleIn > 512.0)))
00160    {
00161 #ifndef CIGI_NO_EXCEPT
00162       throw CigiValueOutOfRangeException("YScale",(float)YScaleIn,0.0,512.0);
00163 #endif
00164       return(CIGI_ERROR_VALUE_OUT_OF_RANGE);
00165    }
00166 #endif
00167 
00168    YScale = YScaleIn;
00169    return(CIGI_SUCCESS);
00170 
00171 }

int CigiBaseSpecEffDef::SetZScale	(	const float	ZScaleIn,
		bool	bndchk = `true`
	)

Sets the ZScale with bound checking control

Parameters:

	ZScaleIn	- Scaling factor along the Z axis for the effect.
	bndchk	- Enables (true) or disables (false) bounds checking.

Returns:: This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 177 of file CigiBaseSpecEffDef.cpp.

References CIGI_ERROR_VALUE_OUT_OF_RANGE, CIGI_SUCCESS, and ZScale.

00178 {
00179 
00180 #ifndef CIGI_NO_BND_CHK
00181    if(bndchk && ((ZScaleIn < 0.0)||(ZScaleIn > 512.0)))
00182    {
00183 #ifndef CIGI_NO_EXCEPT
00184       throw CigiValueOutOfRangeException("ZScale",(float)ZScaleIn,0.0,512.0);
00185 #endif
00186       return(CIGI_ERROR_VALUE_OUT_OF_RANGE);
00187    }
00188 #endif
00189 
00190    ZScale = ZScaleIn;
00191    return(CIGI_SUCCESS);
00192 
00193 }