LightInfo

LightInfo Class Reference

unpackExtended(BitStream *)

Will traverse the vector of LightInfoEx pointers (mExtended) and call their individual unpackUpdate function with the passed in stream as a parameter.

Syntax:

unpackExtended( BitStream *stream )isCompatible()

Parameters:stream – Used to pass to the individual calls of the unpackUpdate through the traversed mExtended. Returns:No return value.

Examples:

// From LightBase::unpackUpdate
mLight->unpackExtended( stream );

packExtended(BitStream *)

Will traverse the vector of LightInfoEx pointers (mExtended) and call their individual packUpdate function with the passed in stream as a parameter.

Syntax:

packExtended( BitStream *stream )

Parameters:stream – Used to pass to the individual calls of the packUpdate through the traversed mExtended. Returns:No return value.

Examples:

// From LightNase::packUpdate at lightBase.cpp
mLight->packExtended( stream );

packExtended(BitStream *)

Will traverse the vector of LightInfoEx pointers (mExtended) and call their individual packUpdate function with the passed in stream as a parameter.

Syntax:

packExtended( BitStream *stream )

Parameters:stream – Used to pass to the individual calls of the packUpdate through the traversed mExtended. Returns:No return value.

Examples:

// From LightNase::packUpdate at lightBase.cpp
mLight->packExtended( stream );

getWorldToLightProj(MatrixF *)

Builds the world to light view projected used for shadow texture and cookie lookups.

Syntax:

getWorldToLightProj( MatrixF *outMatrix )

Parameters:outMatrix – The generated Matrix, if the type of the light is a spot then this matrix will be created by multiplying the cone projection by the inverse transform of the light. If the type of the light is not a Spot, then the Matrix will be assigned to the inverse of the light. Returns:No return value.

Examples:

// From AdvancedLightManager::setLightInfo
MatrixF proj;
light->getWorldToLightProj( &proj );

deleteAllLightInfoEx()

Deletes all LightInfoEx objects.

Syntax:

deleteAllLightInfoEx()

Returns:No return value.

Examples:

// From the destructor of LightInfo
deleteAllLightInfoEx();

addExtended(LightInfoEx *)

Will add the passed in LightInfoEx * to the current vector of LightInfo * (mExtended) if it is not null.

Syntax:

addExtended( LightInfoEx *lightInfoEx )

Parameters:lightInfoEx – Will be added to mExtended. Returns:No return value.

Examples:

// AdvancedLightManager::_addLightInfoEx from advancedLightManager.cpp
lightInfo->addExtended( new ShadowMapParams( lightInfo ) );

getExtended(const LightInfoExType&)

Will return the LightInfoEx * mExtended based upon the LightInfoExType passed in.

Syntax:

getExtended( const LightInfoExType &type )

Parameters:type – The type of a LightInfoEx to be used to return the LightInfoExType. Returns:LightInfoEx * The LightInfoEx * from mExtended with regards to the type passed in.

Examples:

// From CubeLightShadowMap::setShaderParameters at cubeLightShadowMap.cpp
ShadowMapParams *p = mLight->getExtended<ShadowMapParams>();

setGFXLight(GFXLightInfo *)

Sets a fixed function GFXLight with the properties on this class.

Syntax:

setGFXLight(GFXLightInfo *light )

Parameters:light – The light that will have its properties filled in based upon the properties of this class. Returns:No return value.

Examples:

// From ProcessedFFMaterial::_setPrimaryLightInfo at porcessedFFMaterial.cpp
GFXLightInfo xlatedLight;
light->setGFXLight(&xlatedLight);

set(const LightInfo *)

Copies the data passed in from the LightInfo passed in, such as the properties and the contents of mExtended.

Syntax:

set(const LightInfo *light )

Parameters:light – The light in which the information to be set to this class should be obtained from. Returns:No return value.

Examples:

None.