VolumeLight Class Reference

#include <volLight.h>

Inheritance diagram for VolumeLight:

Inheritance graph
[legend]
List of all members.

Public Member Functions

void buildObjectBox ()
void sgRenderX (const Point3F &near1, const Point3F &far1, const Point3F &far2, const ColorF &nearcol, const ColorF &farcol, F32 offset)
void sgRenderY (const Point3F &near1, const Point3F &far1, const Point3F &far2, const ColorF &nearcol, const ColorF &farcol, F32 offset)
 VolumeLight ()
 ~VolumeLight ()
void initBuffers ()
void makeDIPCall ()
void renderObject (ObjectRenderInst *ri, BaseMatInstance *)
virtual bool prepRenderImage (SceneState *, const U32 stateKey, const U32 startZone, const bool modifyBaseZoneState=false)
 Called when the SceneGraph is ready for the registration of RenderImages.
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 *, U32, BitStream *)
 Instructs this object to pack its state for transfer over the network.
void unpackUpdate (NetConnection *, BitStream *)
 Instructs this object to read state data previously packed with packUpdate.
 DECLARE_CONOBJECT (VolumeLight)
bool onNewDataBlock (GameBaseData *dptr)
 Called when a new datablock is set.

Static Public Member Functions

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

Public Attributes

StringTableEntry mLightTexture
F32 mLPDistance
F32 mShootDistance
F32 mXExtent
F32 mYExtent
U32 mSubdivideU
U32 mSubdivideV
ColorF mFootColor
ColorF mTailColor
GFXVertexBufferHandle< GFXVertexPCT > mVerts
GFXPrimitiveBufferHandle mPrims
U32 mVertCount
U32 mPrimCount
ObjectRenderInst::RenderDelegate mRenderDelegate

Protected Types

 VolLightMask = BIT(0)
 VolLightOther = BIT(1)
enum  {
  VolLightMask = BIT(0),
  VolLightOther = BIT(1)
}

Protected Attributes

GFXTexHandle mLightHandle
 Light beam texture used.
GFXStateBlockRef sgStateBlock

Private Types

typedef sgLightObject Parent

Private Attributes

sgLightObjectDatamDataBlock

Member Typedef Documentation

Reimplemented from sgLightObject.


Member Enumeration Documentation

anonymous enum [protected]

Enumerator:
VolLightMask 
VolLightOther 


Constructor & Destructor Documentation

VolumeLight::VolumeLight (  ) 

VolumeLight::~VolumeLight (  ) 


Member Function Documentation

void VolumeLight::buildObjectBox (  )  [inline, virtual]

Reimplemented from fxLight.

void VolumeLight::sgRenderX ( const Point3F near1,
const Point3F far1,
const Point3F far2,
const ColorF nearcol,
const ColorF farcol,
F32  offset 
)

void VolumeLight::sgRenderY ( const Point3F near1,
const Point3F far1,
const Point3F far2,
const ColorF nearcol,
const ColorF farcol,
F32  offset 
)

void VolumeLight::initBuffers (  ) 

void VolumeLight::makeDIPCall (  ) 

void VolumeLight::renderObject ( ObjectRenderInst ri,
BaseMatInstance  
)

Reimplemented from sgLightObject.

virtual bool VolumeLight::prepRenderImage ( SceneState ,
const U32  stateKey,
const U32  startZone,
const bool  modifyBaseZoneState = false 
) [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 fxLight.

bool VolumeLight::onAdd (  )  [virtual]

Called when the object is added to the sim.

Reimplemented from sgLightObject.

void VolumeLight::onRemove (  )  [virtual]

Called when the object is removed from the sim.

Reimplemented from fxLight.

void VolumeLight::inspectPostApply (  )  [virtual]

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

See also:
inspectPreApply

Reimplemented from sgLightObject.

U32 VolumeLight::packUpdate ( NetConnection ,
U32  ,
BitStream  
) [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 sgLightObject.

void VolumeLight::unpackUpdate ( NetConnection ,
BitStream  
) [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 sgLightObject.

static void VolumeLight::initPersistFields (  )  [static]

Register dynamic fields in a subclass of ConsoleObject.

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

Reimplemented from sgLightObject.

VolumeLight::DECLARE_CONOBJECT ( VolumeLight   ) 

bool VolumeLight::onNewDataBlock ( GameBaseData dptr  )  [virtual]

Called when a new datablock is set.

This allows subclasses to appropriately handle new datablocks.

See also:
setDataBlock()
Parameters:
dptr New datablock

Reimplemented from sgLightObject.


Member Data Documentation

Light beam texture used.

Reimplemented from sgLightObject.