LightBase

Engine/source/T3D/lightBase.h

More...

Protected Types

enum
LightMasks {
  InitialUpdateMask = Parent::NextFreeMask
  EnabledMask = Parent::NextFreeMask << 1
  TransformMask = Parent::NextFreeMask << 2
  UpdateMask = Parent::NextFreeMask << 3
  DatablockMask = Parent::NextFreeMask << 4
  NextFreeMask = Parent::NextFreeMask << 5
}

Private Types

Parent 

Public Friends

Protected Static Attributes

Protected Functions

Called when the object is selected in the editor.

Called when the object is unselected in the editor.

Public Functions

advanceTime(F32 timeDelta)

This method is called once every frame regardless of the return value of isProcessingTicks and informs the object of the passage of time.

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

This method is called every frame and lets the control interpolate between ticks so you can smooth things as long as isProcessingTicks returns true when it is called on the object.

bool

Called when the object is added to the sim.

Called when the object is removed from the sim.

packUpdate(NetConnection * conn, U32 mask, BitStream * stream)

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

Animate the light.

Called when the SceneManager is ready for the registration of render instances.

This method is called once every 32ms if isProcessingTicks returns true when called on the object.

setLightEnabled(bool enabled)

Toggles the light on and off.

Sets the Object -> World transform.

submitLights(LightManager * lm, bool staticLighting)

Submit lights to the light manager passed in.

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

Public Static Functions

Detailed Description

Protected Types

LightMasks

Enumerator

InitialUpdateMask = Parent::NextFreeMask
EnabledMask = Parent::NextFreeMask << 1
TransformMask = Parent::NextFreeMask << 2
UpdateMask = Parent::NextFreeMask << 3
DatablockMask = Parent::NextFreeMask << 4
NextFreeMask = Parent::NextFreeMask << 5

Private Types

typedef SceneObject Parent 

Public Friends

Protected Attributes

LightAnimData * mAnimationData 
LightAnimState mAnimState 
F32 mBrightness 
bool mCastShadows 
LinearColorF mColor 
S32 mDynamicRefreshFreq 
LightFlareData * mFlareData 
F32 mFlareScale 
LightFlareState mFlareState 
bool mIsEnabled 
LightInfo * mLight 
bool mLocalRenderViz 
F32 mPriority 
S32 mStaticRefreshFreq 

Protected Static Attributes

bool smRenderViz 

Protected Functions

_conformLights()

Reimplemented by: PointLight, SpotLight

_onRenderViz(ObjectRenderInst * ri, SceneRenderState * state, BaseMatInstance * overrideMat)

_onSelected()

Reimplemented from: SimObject

_onUnselected()

Reimplemented from: SimObject

_renderViz(SceneRenderState * state)

Reimplemented by: PointLight, SpotLight

Public Functions

LightBase()

~LightBase()

advanceTime(F32 timeDelta)

Reimplemented from: ITickable

DECLARE_CONOBJECT(LightBase )

getLight()

Reimplemented from: ISceneLight

getLightEnabled()

inspectPostApply()

Reimplemented from: SceneObject

interpolateTick(F32 delta)

Reimplemented from: ITickable

onAdd()

Reimplemented from: SceneObject

onRemove()

Reimplemented from: SceneObject

packUpdate(NetConnection * conn, U32 mask, BitStream * stream)

Reimplemented from: SceneObject

Reimplemented by: PointLight, SpotLight

pauseAnimation(void )

Animate the light.

playAnimation(LightAnimData * animData)

playAnimation(void )

prepRenderImage(SceneRenderState * state)

Reimplemented from: SceneObject

processTick()

Reimplemented from: ITickable

setLightEnabled(bool enabled)

Toggles the light on and off.

setTransform(const MatrixF & mat)

Reimplemented from: SceneObject

submitLights(LightManager * lm, bool staticLighting)

Reimplemented from: ISceneLight

Reimplemented by: PointLightProxy, SpotLightProxy

unpackUpdate(NetConnection * conn, BitStream * stream)

Reimplemented from: SceneObject

Reimplemented by: PointLight, SpotLight

Public Static Functions

initPersistFields()