Cafu Engine
ComponentRadiosityLightT Class Reference

This component adds a radiosity point light source to its entity. More...

Inheritance diagram for ComponentRadiosityLightT:

Public Attributes

tuple Color
 The color of the emitted light. More...
 
number Intensity
 The intensity (per color-component) of the light source in watt per steradian (W/sr). More...
 
number ConeAngle
 The size of the cone in which light is emitted (in degrees; use 360.0 for a spherical light). More...
 

Additional Inherited Members

- Public Member Functions inherited from ComponentBaseT
any get (string var_name)
 Returns the value of an attribute (a member variable) of this class. More...
 
 set (string var_name, any new_value)
 Sets an attribute (a member variable) of this class to a new value. More...
 
string GetExtraMessage (string var_name)
 Returns the result of VarBaseT::GetExtraMessage() for the given member variable. More...
 
 interpolate (string var_name, number start_value, number end_value, number time)
 Schedules a value for interpolation between a start and end value over a given period of time. More...
 
EntityT GetEntity ()
 Returns the entity that this component is a part of (or nil if the component is currently "stand-alone", not a part of any entity). More...
 
 InitClientApprox (string VarName)
 Registers the given attribute (a member variable) of this class for interpolation over client frames in order to bridge the larger intervals between server frames. More...
 
 OnInit ()
 This method is called for each component of each entity as the last step of initializing a newly loaded map. More...
 
 OnClientFrame (number t)
 This method is called for each component of each entity before the client renders the next frame. More...
 

Detailed Description

This component adds a radiosity point light source to its entity.

Radiosity lights are preprocessed and their effects are baked into lightmaps. Consequently, radiosity lights are static, and script-updating them at run-time has no effect. However, their results look very natural and their performance at run-time is very good.

Note that the variables of this class (also referred to as "Public Attributes" or "Member Data") must be used with the get() and set() methods at this time – see get() and set() for details.

If you would like to create a new component of this type explicitly (those defined in the CaWE Map Editor are instantiated automatically), use WorldT::new():

local comp = world:new("ComponentRadiosityLightT")
Implementing C++ Class:
cf::GameSys::ComponentRadiosityLightT

Member Data Documentation

tuple Color

The color of the emitted light.

Related C++ type:
Vector3fT
number ConeAngle

The size of the cone in which light is emitted (in degrees; use 360.0 for a spherical light).

Related C++ type:
float
number Intensity

The intensity (per color-component) of the light source in watt per steradian (W/sr).

Related C++ type:
float