Torque3D Documentation / _generateds / afxT3DLightBaseData

afxT3DLightBaseData

consoledoc.h

A datablock baseclass for afxT3DPointLightData and afxT3DSpotLightData.

More...

Light

bool

Enables/Disables the object rendering and functionality in the scene.

LinearColorF

Changes the base color hue of the light.

float

Adjusts the lights power, 0 being off completely.

bool

Enables/disables shadow casts by this light.

float

Used for sorting of lights by the light manager. Priority determines if a light has a stronger effect than, those with a lower value.

bool

Enables/disables a semi-transparent geometry to help visualize the light's range and placement.

Light Animation

bool

Toggles animation for the light on and off.

Datablock containing light animation information (LightAnimData)

float

The length of time in seconds for a single playback of the light animation.

float

The phase used to offset the animation start time to vary the animation of nearby lights.

Misc

Datablock containing light flare information (LightFlareData)

float

Globally scales all features of the light flare.

Detailed Description

A datablock baseclass for afxT3DPointLightData and afxT3DSpotLightData.

Not intended to be used directly, afxT3DLightBaseData exists to provide base member variables and generic functionality for the derived classes afxT3DPointLightData and afxT3DSpotLightData.

Light

bool isEnabled 

Enables/Disables the object rendering and functionality in the scene.

LinearColorF color 

Changes the base color hue of the light.

float brightness 

Adjusts the lights power, 0 being off completely.

bool castShadows 

Enables/disables shadow casts by this light.

float priority 

Used for sorting of lights by the light manager. Priority determines if a light has a stronger effect than, those with a lower value.

bool localRenderViz 

Enables/disables a semi-transparent geometry to help visualize the light's range and placement.

Light Animation

bool animate 

Toggles animation for the light on and off.

LightAnimData animationType 

Datablock containing light animation information (LightAnimData)

float animationPeriod 

The length of time in seconds for a single playback of the light animation.

float animationPhase 

The phase used to offset the animation start time to vary the animation of nearby lights.

Misc

LightFlareData flareType 

Datablock containing light flare information (LightFlareData)

float flareScale 

Globally scales all features of the light flare.