CrystalSpace

Public API Reference

iLightFactory Struct Reference
[Lighting]

A light factory. More...

#include <iengine/light.h>

Inheritance diagram for iLightFactory:

List of all members.

Public Member Functions

virtual const csVector4GetAttenuationConstants () const =0
 Get attenuation constants.
virtual csLightAttenuationMode GetAttenuationMode () const =0
 Return current attenuation mode.
virtual const csColorGetColor () const =0
 Get the diffuse color of this light.
virtual float GetCutoffDistance () const =0
 Get the the maximum distance at which the light is guaranteed to shine.
virtual float GetDirectionalCutoffRadius () const =0
 Get radial cutoff distance for directional lights.
virtual csFlagsGetFlags ()=0
 Get flags for this light.
virtual const csColorGetSpecularColor () const =0
 Get the specular color of this light.
virtual void GetSpotLightFalloff (float &inner, float &outer) const =0
 Get spot light falloff angles.
virtual csLightType GetType () const =0
 Get the light type of this light.
virtual iObjectQueryObject ()=0
 Get the iObject for this light factory.
virtual void SetAttenuationConstants (const csVector4 &constants)=0
 Set attenuation constants.
virtual void SetAttenuationMode (csLightAttenuationMode a)=0
 Set attenuation mode.
virtual void SetColor (const csColor &col)=0
 Set the diffuse color of this light.
virtual void SetCutoffDistance (float distance)=0
 Set the the maximum distance at which the light is guaranteed to shine.
virtual void SetDirectionalCutoffRadius (float radius)=0
 Set radial cutoff distance for directional lights.
virtual void SetDynamicType (csLightDynamicType type)=0
 Set/Get the dynamic type of this light.
virtual void SetSpecularColor (const csColor &col)=0
 Set the specular color of this light.
virtual void SetSpotLightFalloff (float inner, float outer)=0
 Set spot light falloff angles.
virtual void SetType (csLightType type)=0
 Set the light type of this light.

Detailed Description

A light factory.

Factories can be used to create lights.

Main creators of instances implementing this interface:

Main ways to get pointers to this interface:

Main users of this interface:

Definition at line 519 of file light.h.


Member Function Documentation

virtual const csVector4& iLightFactory::GetAttenuationConstants (  )  const [pure virtual]

Get attenuation constants.

See also:
csLightAttenuationMode
virtual csLightAttenuationMode iLightFactory::GetAttenuationMode (  )  const [pure virtual]

Return current attenuation mode.

See also:
csLightAttenuationMode
virtual const csColor& iLightFactory::GetColor (  )  const [pure virtual]

Get the diffuse color of this light.

virtual float iLightFactory::GetCutoffDistance (  )  const [pure virtual]

Get the the maximum distance at which the light is guaranteed to shine.

Can be seen as the distance at which we turn the light off. Used for culling and selection of meshes to light, but not for the lighting itself.

virtual float iLightFactory::GetDirectionalCutoffRadius (  )  const [pure virtual]

Get radial cutoff distance for directional lights.

The directional light can be viewed as a cylinder with radius equal to DirectionalCutoffRadius and length CutoffDistance

virtual csFlags& iLightFactory::GetFlags (  )  [pure virtual]

Get flags for this light.

Supported flags:

virtual const csColor& iLightFactory::GetSpecularColor (  )  const [pure virtual]

Get the specular color of this light.

virtual void iLightFactory::GetSpotLightFalloff ( float &  inner,
float &  outer 
) const [pure virtual]

Get spot light falloff angles.

Get in cosine of the angle.

virtual csLightType iLightFactory::GetType (  )  const [pure virtual]

Get the light type of this light.

virtual iObject* iLightFactory::QueryObject (  )  [pure virtual]

Get the iObject for this light factory.

virtual void iLightFactory::SetAttenuationConstants ( const csVector4 constants  )  [pure virtual]

Set attenuation constants.

See also:
csLightAttenuationMode
virtual void iLightFactory::SetAttenuationMode ( csLightAttenuationMode  a  )  [pure virtual]

Set attenuation mode.

See also:
csLightAttenuationMode
virtual void iLightFactory::SetColor ( const csColor col  )  [pure virtual]

Set the diffuse color of this light.

virtual void iLightFactory::SetCutoffDistance ( float  distance  )  [pure virtual]

Set the the maximum distance at which the light is guaranteed to shine.

Can be seen as the distance at which we turn the light off. Used for culling and selection of meshes to light, but not for the lighting itself.

virtual void iLightFactory::SetDirectionalCutoffRadius ( float  radius  )  [pure virtual]

Set radial cutoff distance for directional lights.

The directional light can be viewed as a cylinder with radius equal to DirectionalCutoffRadius and length CutoffDistance

virtual void iLightFactory::SetDynamicType ( csLightDynamicType  type  )  [pure virtual]

Set/Get the dynamic type of this light.

Supported types:

virtual void iLightFactory::SetSpecularColor ( const csColor col  )  [pure virtual]

Set the specular color of this light.

virtual void iLightFactory::SetSpotLightFalloff ( float  inner,
float  outer 
) [pure virtual]

Set spot light falloff angles.

Set in cosine of the angle.

virtual void iLightFactory::SetType ( csLightType  type  )  [pure virtual]

Set the light type of this light.


The documentation for this struct was generated from the following file:

Generated for Crystal Space 2.1 by doxygen 1.6.1