torque Torque Game Engine Documentation
TGE Version 1.5.2

sgLightObjectData Class Reference

#include <sgLightObject.h>

Inheritance diagram for sgLightObjectData:

Inheritance graph
[legend]

Detailed Description

The datablock class for sgUniversalStaticLight.


Public Member Functions

 sgLightObjectData ()
virtual void packData (BitStream *stream)
virtual void unpackData (BitStream *stream)
 DECLARE_CONOBJECT (sgLightObjectData)

Static Public Member Functions

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

Data Fields

bool sgStatic
 Enables static lighting (baked into light maps) instead of Torque's default dynamic lighting.
bool sgSpot
 Turns this light into a spotlight (only works with static lights).
F32 sgSpotAngle
 The spotlight spread angle.
bool sgAdvancedLightingModel
 Selects the lighting model.
bool sgEffectsDTSObjects
 Allows this light to illuminate dts objects.
bool sgCastsShadows
bool sgDiffuseRestrictZone
bool sgAmbientRestrictZone
F32 sgLocalAmbientAmount
bool sgSmoothSpotLight
bool sgDoubleSidedAmbient
StringTableEntry sgLightingModelName
bool sgUseNormals
U32 sgMountPoint
MatrixF sgMountTransform

Private Types

typedef fxLightData Parent


Member Typedef Documentation

Reimplemented from fxLightData.


Constructor & Destructor Documentation

sgLightObjectData::sgLightObjectData (  ) 


Member Function Documentation

static void sgLightObjectData::initPersistFields (  )  [static]

Register dynamic fields in a subclass of ConsoleObject.

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

Reimplemented from fxLightData.

virtual void sgLightObjectData::packData ( BitStream stream  )  [virtual]

Reimplemented from fxLightData.

virtual void sgLightObjectData::unpackData ( BitStream stream  )  [virtual]

Reimplemented from fxLightData.

sgLightObjectData::DECLARE_CONOBJECT ( sgLightObjectData   ) 


Field Documentation

Enables static lighting (baked into light maps) instead of Torque's default dynamic lighting.

Turns this light into a spotlight (only works with static lights).

The spotlight spread angle.

Selects the lighting model.

The default lighting model uses (rad^2 / dist^2) and creates a distinct drop off. The advanced lighting model uses (1 - (dist^2 / rad^2)) and creates gradual / global illumination feel (does not perform radiosity).

Allows this light to illuminate dts objects.




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