torque Torque Game Engine Documentation
TGE Version 1.5.2

fxSunLight Class Reference

#include <fxSunLight.h>

Inheritance diagram for fxSunLight:

Inheritance graph
[legend]

Public Member Functions

 fxSunLight ()
 ~fxSunLight ()
void setEnable (bool Status)
void setFlareBitmaps (const char *LocalName, const char *RemoteName)
void setSunAzimuth (F32 Azimuth)
void setSunElevation (F32 Elevation)
void setFlareTP (bool Status)
void setFlareColour (ColorF Colour)
void setFlareBrightness (F32 Brightness)
void setFlareSize (F32 Size)
void setFadeTime (F32 Time)
void setBlendMode (U32 Mode)
void setUseColour (bool Status)
void setUseBrightness (bool Status)
void setUseRotation (bool Status)
void setUseSize (bool Status)
void setUseAzimuth (bool Status)
void setUseElevation (bool Status)
void setLerpColour (bool Status)
void setLerpBrightness (bool Status)
void setLerpRotation (bool Status)
void setLerpSize (bool Status)
void setLerpAzimuth (bool Status)
void setLerpElevation (bool Status)
void setLinkFlareSize (bool Status)
void setSingleColourKeys (bool Status)
void setMinColour (ColorF Colour)
void setMaxColour (ColorF Colour)
void setMinBrightness (F32 Brightness)
void setMaxBrightness (F32 Brightness)
void setMinRotation (F32 Rotation)
void setMaxRotation (F32 Rotation)
void setMinSize (F32 Size)
void setMaxSize (F32 Size)
void setMinAzimuth (F32 Azimuth)
void setMaxAzimuth (F32 Azimuth)
void setMinElevation (F32 Elevation)
void setMaxElevation (F32 Elevation)
void setRedKeys (const char *Keys)
void setGreenKeys (const char *Keys)
void setBlueKeys (const char *Keys)
void setBrightnessKeys (const char *Keys)
void setRotationKeys (const char *Keys)
void setSizeKeys (const char *Keys)
void setAzimuthKeys (const char *Keys)
void setElevationKeys (const char *Keys)
void setColourTime (F32 Time)
void setBrightnessTime (F32 Time)
void setRotationTime (F32 Time)
void setSizeTime (F32 Time)
void setAzimuthTime (F32 Time)
void setElevationTime (F32 Time)
void reset (void)
bool prepRenderImage (SceneState *state, const U32 stateKey, const U32 startZone, const bool modifyBaseZoneState)
 Called when the SceneGraph is ready for the registration of RenderImages.
void renderObject (SceneState *state, SceneRenderImage *image)
 Called when the object is supposed to render itself.
bool onAdd ()
 Called when the object is added to the sim.
void onRemove ()
 Called when the object is removed from the sim.
void inspectPostApply ()
 Called after any property of the object is changed in the world editor.
U32 packUpdate (NetConnection *conn, U32 mask, BitStream *stream)
 Instructs this object to pack its state for transfer over the network.
void unpackUpdate (NetConnection *conn, BitStream *stream)
 Instructs this object to read state data previously packed with packUpdate.
 DECLARE_CONOBJECT (fxSunLight)

Static Public Member Functions

static void initPersistFields ()
 Register dynamic fields in a subclass of ConsoleObject.

Data Fields

bool mDoneSunLock
bool mEnable
StringTableEntry mLocalFlareTextureName
StringTableEntry mRemoteFlareTextureName
F32 mSunAzimuth
F32 mSunElevation
bool mLockToRealSun
bool mFlareTP
ColorF mFlareColour
F32 mFlareBrightness
F32 mFlareSize
F32 mFadeTime
U32 mBlendMode
bool mUseColour
bool mUseBrightness
bool mUseRotation
bool mUseSize
bool mUseAzimuth
bool mUseElevation
bool mLerpColour
bool mLerpBrightness
bool mLerpRotation
bool mLerpSize
bool mLerpAzimuth
bool mLerpElevation
bool mLinkFlareSize
bool mSingleColourKeys
ColorF mMinColour
ColorF mMaxColour
F32 mMinBrightness
F32 mMaxBrightness
F32 mMinRotation
F32 mMaxRotation
F32 mMinSize
F32 mMaxSize
F32 mMinAzimuth
F32 mMaxAzimuth
F32 mMinElevation
F32 mMaxElevation
StringTableEntry mRedKeys
StringTableEntry mGreenKeys
StringTableEntry mBlueKeys
StringTableEntry mBrightnessKeys
StringTableEntry mRotationKeys
StringTableEntry mSizeKeys
StringTableEntry mAzimuthKeys
StringTableEntry mElevationKeys
F32 mColourTime
F32 mBrightnessTime
F32 mRotationTime
F32 mSizeTime
F32 mAzimuthTime
F32 mElevationTime
ColorF mAnimationColour
F32 mAnimationBrightness
F32 mAnimationRotation
F32 mAnimationSize
F32 mAnimationAzimuth
F32 mAnimationElevation
F32 mColourElapsedTime
F32 mBrightnessElapsedTime
F32 mRotationElapsedTime
F32 mSizeElapsedTime
F32 mAzimuthElapsedTime
F32 mElevationElapsedTime
F32 mColourTimeScale
F32 mBrightnessTimeScale
F32 mRotationTimeScale
F32 mSizeTimeScale
F32 mAzimuthTimeScale
F32 mElevationTimeScale
U32 mRedKeysLength
U32 mGreenKeysLength
U32 mBlueKeysLength
U32 mBrightnessKeysLength
U32 mRotationKeysLength
U32 mSizeKeysLength
U32 mAzimuthKeysLength
U32 mElevationKeysLength

Protected Types

enum  { fxSunLightConfigChangeMask = BIT(0) }

Protected Attributes

bool mAddedToScene
MRandomLCG RandomGen
TextureHandle mLocalFlareTextureHandle
TextureHandle mRemoteFlareTextureHandle
F32 mElapsedTime
S32 mLastRenderTime
F32 mLocalFlareScale
Point3F mSunlightPosition

Private Types

typedef SceneObject Parent

Private Member Functions

U32 CheckKeySyntax (StringTableEntry Key)
void CheckAnimationKeys (void)
F32 GetLerpKey (StringTableEntry Key, U32 PosFrom, U32 PosTo, F32 ValueFrom, F32 ValueTo, F32 Lerp)
void AnimateSun (F32 ElapsedTime)
void InitialiseAnimation (void)
void ResetAnimation (void)
bool TestLOS (const Point3F &Pos)

Member Typedef Documentation

typedef SceneObject fxSunLight::Parent [private]

Reimplemented from SceneObject.


Member Enumeration Documentation

anonymous enum [protected]

Enumerator:
fxSunLightConfigChangeMask 


Constructor & Destructor Documentation

fxSunLight::fxSunLight (  ) 

fxSunLight::~fxSunLight (  ) 


Member Function Documentation

U32 fxSunLight::CheckKeySyntax ( StringTableEntry  Key  )  [private]

void fxSunLight::CheckAnimationKeys ( void   )  [private]

F32 fxSunLight::GetLerpKey ( StringTableEntry  Key,
U32  PosFrom,
U32  PosTo,
F32  ValueFrom,
F32  ValueTo,
F32  Lerp 
) [private]

void fxSunLight::AnimateSun ( F32  ElapsedTime  )  [private]

void fxSunLight::InitialiseAnimation ( void   )  [private]

void fxSunLight::ResetAnimation ( void   )  [private]

bool fxSunLight::TestLOS ( const Point3F Pos  )  [private]

void fxSunLight::setEnable ( bool  Status  ) 

void fxSunLight::setFlareBitmaps ( const char *  LocalName,
const char *  RemoteName 
)

void fxSunLight::setSunAzimuth ( F32  Azimuth  ) 

void fxSunLight::setSunElevation ( F32  Elevation  ) 

void fxSunLight::setFlareTP ( bool  Status  ) 

void fxSunLight::setFlareColour ( ColorF  Colour  ) 

void fxSunLight::setFlareBrightness ( F32  Brightness  ) 

void fxSunLight::setFlareSize ( F32  Size  ) 

void fxSunLight::setFadeTime ( F32  Time  ) 

void fxSunLight::setBlendMode ( U32  Mode  ) 

void fxSunLight::setUseColour ( bool  Status  ) 

void fxSunLight::setUseBrightness ( bool  Status  ) 

void fxSunLight::setUseRotation ( bool  Status  ) 

void fxSunLight::setUseSize ( bool  Status  ) 

void fxSunLight::setUseAzimuth ( bool  Status  ) 

void fxSunLight::setUseElevation ( bool  Status  ) 

void fxSunLight::setLerpColour ( bool  Status  ) 

void fxSunLight::setLerpBrightness ( bool  Status  ) 

void fxSunLight::setLerpRotation ( bool  Status  ) 

void fxSunLight::setLerpSize ( bool  Status  ) 

void fxSunLight::setLerpAzimuth ( bool  Status  ) 

void fxSunLight::setLerpElevation ( bool  Status  ) 

void fxSunLight::setLinkFlareSize ( bool  Status  ) 

void fxSunLight::setSingleColourKeys ( bool  Status  ) 

void fxSunLight::setMinColour ( ColorF  Colour  ) 

void fxSunLight::setMaxColour ( ColorF  Colour  ) 

void fxSunLight::setMinBrightness ( F32  Brightness  ) 

void fxSunLight::setMaxBrightness ( F32  Brightness  ) 

void fxSunLight::setMinRotation ( F32  Rotation  ) 

void fxSunLight::setMaxRotation ( F32  Rotation  ) 

void fxSunLight::setMinSize ( F32  Size  ) 

void fxSunLight::setMaxSize ( F32  Size  ) 

void fxSunLight::setMinAzimuth ( F32  Azimuth  ) 

void fxSunLight::setMaxAzimuth ( F32  Azimuth  ) 

void fxSunLight::setMinElevation ( F32  Elevation  ) 

void fxSunLight::setMaxElevation ( F32  Elevation  ) 

void fxSunLight::setRedKeys ( const char *  Keys  ) 

void fxSunLight::setGreenKeys ( const char *  Keys  ) 

void fxSunLight::setBlueKeys ( const char *  Keys  ) 

void fxSunLight::setBrightnessKeys ( const char *  Keys  ) 

void fxSunLight::setRotationKeys ( const char *  Keys  ) 

void fxSunLight::setSizeKeys ( const char *  Keys  ) 

void fxSunLight::setAzimuthKeys ( const char *  Keys  ) 

void fxSunLight::setElevationKeys ( const char *  Keys  ) 

void fxSunLight::setColourTime ( F32  Time  ) 

void fxSunLight::setBrightnessTime ( F32  Time  ) 

void fxSunLight::setRotationTime ( F32  Time  ) 

void fxSunLight::setSizeTime ( F32  Time  ) 

void fxSunLight::setAzimuthTime ( F32  Time  ) 

void fxSunLight::setElevationTime ( F32  Time  ) 

void fxSunLight::reset ( void   ) 

bool fxSunLight::prepRenderImage ( SceneState state,
const U32  stateKey,
const U32  startZone,
const bool  modifyBaseZoneState 
) [virtual]

Called when the SceneGraph is ready for the registration of RenderImages.

See also:
SceneState
Parameters:
state SceneState
stateKey State key of the current SceneState
startZone Base zone index
modifyBaseZoneState If true, the object needs to modify the zone state.

Reimplemented from SceneObject.

void fxSunLight::renderObject ( SceneState state,
SceneRenderImage image 
) [virtual]

Called when the object is supposed to render itself.

Parameters:
state Current rendering state.
See also:
SceneState
Parameters:
image Image associated with this object to render.
See also:
SceneRenderImage

Reimplemented from SceneObject.

bool fxSunLight::onAdd (  )  [virtual]

Called when the object is added to the sim.

Reimplemented from SceneObject.

void fxSunLight::onRemove (  )  [virtual]

Called when the object is removed from the sim.

Reimplemented from SceneObject.

void fxSunLight::inspectPostApply (  )  [virtual]

Called after any property of the object is changed in the world editor.

See also:
inspectPreApply

Reimplemented from SceneObject.

U32 fxSunLight::packUpdate ( NetConnection conn,
U32  mask,
BitStream stream 
) [virtual]

Instructs this object to pack its state for transfer over the network.

Parameters:
conn Net connection being used
mask Mask indicating fields to transmit.
stream Bitstream to pack data to
Returns:
Any bits which were not dealt with. The value is stored by the networking system. Don't set bits you weren't passed.

Reimplemented from NetObject.

void fxSunLight::unpackUpdate ( NetConnection conn,
BitStream stream 
) [virtual]

Instructs this object to read state data previously packed with packUpdate.

Parameters:
conn Net connection being used
stream stream to read from

Reimplemented from NetObject.

static void fxSunLight::initPersistFields (  )  [static]

Register dynamic fields in a subclass of ConsoleObject.

See also:
addField(), addFieldV(), addDepricatedField(), addGroup(), endGroup()

Reimplemented from SceneObject.

fxSunLight::DECLARE_CONOBJECT ( fxSunLight   ) 


Field Documentation

bool fxSunLight::mAddedToScene [protected]

TextureHandle fxSunLight::mLocalFlareTextureHandle [protected]

TextureHandle fxSunLight::mRemoteFlareTextureHandle [protected]




All Rights Reserved GarageGames.com, Inc. 1999-2005
Auto-magically Generated with Doxygen