Lights

Functions

int SO3LightCreate (mmachine m)
 main include
int SO3LightSetType (mmachine m)
 SO3LightSetType : Defines the type of light.
int SO3LightGetType (mmachine m)
 SO3LightGetType : Returns the type of light.
int SO3LightSetDiffuseColor (mmachine m)
 SO3LightSetDiffuseColor : defines diffuse color of a light.
int SO3LightGetDiffuseColor (mmachine m)
 SO3LightGetDiffuseColor : Get the diffuse color of a light.
int SO3LightSetPowerScale (mmachine m)
 SO3LightSetPowerScale : defines power scale of a light.
int SO3LightSetShadowFarDistance (mmachine m)
 SO3LightSetShadowFarDistance : defines shadows far distance of a light.
int SO3LightGetPowerScale (mmachine m)
 SO3LightGetPowerScale : Get the power scale of a light.
int SO3LightGetShadowFarDistance (mmachine m)
 SO3LightGetShadowFarDistance : Get the shadow far distance of a light.
int SO3LightSetVisible (mmachine m)
 SO3LightSetVisible : defines visibility state of a light.
int SO3LightGetVisible (mmachine m)
 SO3LightGetVisible : Get the visibility state of a light.
int SO3LightSetAttenuation (mmachine m)
 SO3LightSetAttenuation : defines attenuation coefficients for a light.
int SO3LightSetAttenuationAuto (mmachine m)
 SO3LightSetAttenuationAuto : defines attenuation coefficients for a light automatically, from given range.
int SO3LightGetAttenuation (mmachine m)
 SO3LightGetAttenuation : Get the attenuation coefficients for a light.
int SO3LightSetSpecularColor (mmachine m)
 SO3LightSetSpecularColor : defines specular color of a light.
int SO3LightGetSpecularColor (mmachine m)
 SO3LightGetSpecularColor : Get the specular color of a light.
int SO3LightSetSpotFallOff (mmachine m)
 SO3LightSetSpotFallOff : defines spot fall off of a spot light.
int SO3LightGetSpotFallOff (mmachine m)
 SO3LightGetSpotFallOff : Get the spot fall off of a spot light.
int SO3LightSetSpotInnerAngle (mmachine m)
 SO3LightSetSpotInnerAngle : defines spot inner angle of a spot light.
int SO3LightSetSpotOuterAngle (mmachine m)
 SO3LightSetSpotOuterAngle : defines spot outer angle of a spot light.
int SO3LightSetSpotRange (mmachine m)
 SO3LightSetSpotRange : defines spot range of a spot light.
int SO3LightGetSpotInnerAngle (mmachine m)
 SO3LightGetSpotInnerAngle : Get the spot inner angle of a spot light.
int SO3LightGetSpotOuterAngle (mmachine m)
 SO3LightGetSpotOuterAngle : Get the spot outer angle of a spot light.

Detailed Description

Scol functions definition

Function Documentation

int SO3LightCreate ( mmachine  m  ) 

main include

SO3LightCreate : Create a new material Prototype: fun [SO3_SCENE S] SO3_OBJECT

Parameters:
SO3_SCENE : current scene
S : given name for the new light
Returns:
SO3_OBJECT : Created light if success , NIL otherwise

Definition at line 52 of file SCOLLight.cpp.

int SO3LightGetAttenuation ( mmachine  m  ) 

SO3LightGetAttenuation : Get the attenuation coefficients for a light.

Prototype: fun [SO3_OBJECT] [F F F F]

Parameters:
SO3_OBJECT : current light
Returns:
[F F F F] : Coefficient (range, constant, linear, quadratic) if success , NIL otherwise

Definition at line 578 of file SCOLLight.cpp.

int SO3LightGetDiffuseColor ( mmachine  m  ) 

SO3LightGetDiffuseColor : Get the diffuse color of a light.

Prototype: fun [SO3_OBJECT] I

Parameters:
SO3_OBJECT : current light
Returns:
I : Diffuse color (rgba) if success , NIL otherwise

Definition at line 228 of file SCOLLight.cpp.

int SO3LightGetPowerScale ( mmachine  m  ) 

SO3LightGetPowerScale : Get the power scale of a light.

Prototype: fun [SO3_OBJECT] F

Parameters:
SO3_OBJECT : current light
Returns:
F : The power scale if success , NIL otherwise

Definition at line 341 of file SCOLLight.cpp.

int SO3LightGetShadowFarDistance ( mmachine  m  ) 

SO3LightGetShadowFarDistance : Get the shadow far distance of a light.

Prototype: fun [SO3_OBJECT] F

Parameters:
SO3_OBJECT : current light
Returns:
F : Distance if success , NIL otherwise

Definition at line 378 of file SCOLLight.cpp.

int SO3LightGetSpecularColor ( mmachine  m  ) 

SO3LightGetSpecularColor : Get the specular color of a light.

Prototype: fun [SO3_OBJECT] I

Parameters:
SO3_OBJECT : current light
Returns:
I : color (rgba) if success , NIL otherwise

Definition at line 667 of file SCOLLight.cpp.

int SO3LightGetSpotFallOff ( mmachine  m  ) 

SO3LightGetSpotFallOff : Get the spot fall off of a spot light.

Prototype: fun [SO3_OBJECT] F

Parameters:
SO3_OBJECT : current light
Returns:
F : fall off value if success , NIL otherwise

Definition at line 743 of file SCOLLight.cpp.

int SO3LightGetSpotInnerAngle ( mmachine  m  ) 

SO3LightGetSpotInnerAngle : Get the spot inner angle of a spot light.

Prototype: fun [SO3_OBJECT] F

Parameters:
SO3_OBJECT : current light
Returns:
F : inner angle value if success , NIL otherwise

Definition at line 908 of file SCOLLight.cpp.

int SO3LightGetSpotOuterAngle ( mmachine  m  ) 

SO3LightGetSpotOuterAngle : Get the spot outer angle of a spot light.

Prototype: fun [SO3_OBJECT] F

Parameters:
SO3_OBJECT : current light
Returns:
F : outer angle value if success , NIL otherwise

Definition at line 945 of file SCOLLight.cpp.

int SO3LightGetType ( mmachine  m  ) 

SO3LightGetType : Returns the type of light.

Prototype: fun [SO3_OBJECT] I

Parameters:
SO3_OBJECT : current light
Returns:
I : Type if success , NIL otherwise

For type, values are :

  • SO3_POINT_LIGHT
  • SO3_DIRECTIONAL_LIGHT
  • SO3_SPOT_LIGHT

Definition at line 153 of file SCOLLight.cpp.

int SO3LightGetVisible ( mmachine  m  ) 

SO3LightGetVisible : Get the visibility state of a light.

Prototype: fun [SO3_OBJECT] I

Parameters:
SO3_OBJECT : current light
Returns:
I : visibility state (1 enable, 0 disable) if success , NIL otherwise

Definition at line 457 of file SCOLLight.cpp.

int SO3LightSetAttenuation ( mmachine  m  ) 

SO3LightSetAttenuation : defines attenuation coefficients for a light.

Prototype: fun [SO3_OBJECT [F F F F]] I

Parameters:
SO3_OBJECT : current light
[F F F F] : Coefficient (range, constant, linear, quadratic)
Returns:
I : 1 if success , NIL otherwise

Definition at line 499 of file SCOLLight.cpp.

int SO3LightSetAttenuationAuto ( mmachine  m  ) 

SO3LightSetAttenuationAuto : defines attenuation coefficients for a light automatically, from given range.

Prototype: fun [SO3_OBJECT F] I

Parameters:
SO3_OBJECT : current light
F : Light propagation range
Returns:
I : 1 if success , NIL otherwise

Definition at line 541 of file SCOLLight.cpp.

int SO3LightSetDiffuseColor ( mmachine  m  ) 

SO3LightSetDiffuseColor : defines diffuse color of a light.

Prototype: fun [SO3_OBJECT I] I

Parameters:
SO3_OBJECT : current light
I : Color value (rgba)
Returns:
I : 1 if success , NIL otherwise

Definition at line 191 of file SCOLLight.cpp.

int SO3LightSetPowerScale ( mmachine  m  ) 

SO3LightSetPowerScale : defines power scale of a light.

Prototype: fun [SO3_OBJECT F] I

Parameters:
SO3_OBJECT : current light
F :Power scale value
Returns:
I : 1 if success , NIL otherwise

Definition at line 264 of file SCOLLight.cpp.

int SO3LightSetShadowFarDistance ( mmachine  m  ) 

SO3LightSetShadowFarDistance : defines shadows far distance of a light.

Prototype: fun [SO3_OBJECT F] I

Parameters:
SO3_OBJECT : current light
F : Distance
Returns:
I : 1 if success , NIL otherwise

Definition at line 303 of file SCOLLight.cpp.

int SO3LightSetSpecularColor ( mmachine  m  ) 

SO3LightSetSpecularColor : defines specular color of a light.

Prototype: fun [SO3_OBJECT I] I

Parameters:
SO3_OBJECT : current light
I : Given color (rgba)
Returns:
I : 1 if success , NIL otherwise

Definition at line 628 of file SCOLLight.cpp.

int SO3LightSetSpotFallOff ( mmachine  m  ) 

SO3LightSetSpotFallOff : defines spot fall off of a spot light.

Prototype: fun [SO3_OBJECT F] I

Parameters:
SO3_OBJECT : current light
F : fall off value
Returns:
I : 1 if success , NIL otherwise

Definition at line 705 of file SCOLLight.cpp.

int SO3LightSetSpotInnerAngle ( mmachine  m  ) 

SO3LightSetSpotInnerAngle : defines spot inner angle of a spot light.

Prototype: fun [SO3_OBJECT F] I

Parameters:
SO3_OBJECT : current light
F : inner angle value
Returns:
I : 1 if success , NIL otherwise

Definition at line 781 of file SCOLLight.cpp.

int SO3LightSetSpotOuterAngle ( mmachine  m  ) 

SO3LightSetSpotOuterAngle : defines spot outer angle of a spot light.

Prototype: fun [SO3_OBJECT F] I

Parameters:
SO3_OBJECT : current light
F : outer angle value
Returns:
I : 1 if success , NIL otherwise

Definition at line 821 of file SCOLLight.cpp.

int SO3LightSetSpotRange ( mmachine  m  ) 

SO3LightSetSpotRange : defines spot range of a spot light.

Prototype: fun [SO3_OBJECT F] I

Parameters:
SO3_OBJECT : current light
F : range value
Returns:
I : 1 if success , NIL otherwise

Definition at line 861 of file SCOLLight.cpp.

int SO3LightSetType ( mmachine  m  ) 

SO3LightSetType : Defines the type of light.

Prototype: fun [SO3_OBJECT I] I

Parameters:
SO3_OBJECT : current light
I : Type

For type, values are :

  • SO3_POINT_LIGHT
  • SO3_DIRECTIONAL_LIGHT
  • SO3_SPOT_LIGHT
Returns:
I : 1 if success , NIL otherwise

Definition at line 108 of file SCOLLight.cpp.

int SO3LightSetVisible ( mmachine  m  ) 

SO3LightSetVisible : defines visibility state of a light.

Prototype: fun [SO3_OBJECT I] I

Parameters:
SO3_OBJECT : current light
I : visibility state (1 enable, 0 disable)
Returns:
I : 1 if success , NIL otherwise

Definition at line 416 of file SCOLLight.cpp.

 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Generated on Mon Oct 31 14:42:34 2011 for SO3Engine by  doxygen 1.6.3