Drag[en]gine Script Module DragonScript Script API  1.0
Light Class Reference

Light. More...

Inheritance diagram for Light:

Public Member Functions

Constructors
Light new ()
 Create light. More...
 
Management
int getType ()
 Type. More...
 
void setType (int type)
 Set type. More...
 
DVector getPosition ()
 Position. More...
 
void setPosition (DVector position)
 position. More...
 
Quaternion getOrientation ()
 Orientation. More...
 
void setOrientation (Quaternion orientation)
 Set orientation. More...
 
bool getActivated ()
 Light is actived. More...
 
void setActivated (bool activated)
 Set if light is activated. More...
 
Color getColor ()
 Light color. More...
 
void setColor (Color color)
 Set light color. More...
 
float getIntensity ()
 Light intensity. More...
 
void setIntensity (float intensity)
 Set light intensity. More...
 
float getRange ()
 Range in meters. More...
 
void setRange (float range)
 Set range in meters. More...
 
float getHalfIntensityDistance ()
 Half intensity distance in meters. More...
 
void setHalfIntensityDistance (float halfIntDist)
 Set half intensity distance in meters. More...
 
float getCutOffDistance ()
 Cut-off distance in meters. More...
 
void setCutOffDistance (float distance)
 Set cut-off distance in meters. More...
 
float getAmbientRatio ()
 Ratio of ambient light in relation to the total intensity. More...
 
void setAmbientRatio (float ratio)
 Set ratio of ambient light in relation to the total intensity. More...
 
Spot light
float getAngleX ()
 Spot angle in x direction in dregrees. More...
 
float getAngleY ()
 Spot angle in y direction in dregrees. More...
 
void setAngles (float angleX, float angleY)
 Set spot angle in dregrees. More...
 
float getSpotExponent ()
 Spot exponent. More...
 
void setSpotExponent (float exponent)
 Set spot exponent. More...
 
void setProjectorImage (Image image)
 Projector image or null if not set. More...
 
void setProjectorCanvas (CanvasView canvasView)
 Projector canvas or null if not set. More...
 
Shadow casting
bool getCastShadows ()
 Light is casting shadows. More...
 
void setCastShadows (bool castShadows)
 Set if light is casting shadows. More...
 
Hint
int getHintLightImportance ()
 Light importannce in the range from 0 (least important) to 100 (most important). More...
 
void setHintLightImportance (int type)
 Sets light importannce in the range from 0 (least important) to 100 (most important). More...
 
int getHintShadowImportance ()
 Shadow important in the range from 0 (least important) to 100 (most important). More...
 
void setHintShadowImportance (int type)
 Set shadow important in the range from 0 (least important) to 100 (most important). More...
 
int getHintMovement ()
 Movement hint. More...
 
void setHintMovement (int hint)
 Set movement hint. More...
 
int getHintParameters ()
 Parameter change hint. More...
 
void setHintParameter (int hint)
 Set parameter change hint. More...
 

Static Public Attributes

Light type
static final int POINT = 0
 Point light. More...
 
static final int SEMIPOINT = 1
 Semi point light. More...
 
static final int SPOT = 2
 Spot light. More...
 
static final int PROJECTOR = 3
 Projector light. More...
 
Movement hints.
static final int MOVEMENT_STATIC = 0
 Light is not moving. More...
 
static final int MOVEMENT_JITTERING = 1
 Light moves only in a small area around an equilibrium point. More...
 
static final int MOVEMENT_DYNAMIC = 2
 Light moves all around the place. More...
 
Parameter change hints.
static final int PARAM_STATIC = 0
 Light parameters are never changed after first setting them. More...
 
static final int PARAM_ACTIVATION = 1
 Light parameter are never changed after first setting them except switching the light on and off. More...
 
static final int PARAM_FLICKER = 2
 Light parameters except activate, color and intensity never change after first setting them. More...
 
static final int PARAM_DYNAMIC = 3
 All light parameters are modified dynamically. More...
 

Detailed Description

Light.

This is a native class.

Author
Roland Pl├╝ss
Version
1.0
Date
2015

Member Function Documentation

§ getActivated()

bool getActivated ( )

Light is actived.

§ getAmbientRatio()

float getAmbientRatio ( )

Ratio of ambient light in relation to the total intensity.

§ getAngleX()

float getAngleX ( )

Spot angle in x direction in dregrees.

§ getAngleY()

float getAngleY ( )

Spot angle in y direction in dregrees.

§ getCastShadows()

bool getCastShadows ( )

Light is casting shadows.

§ getColor()

Color getColor ( )

Light color.

§ getCutOffDistance()

float getCutOffDistance ( )

Cut-off distance in meters.

§ getHalfIntensityDistance()

float getHalfIntensityDistance ( )

Half intensity distance in meters.

§ getHintLightImportance()

int getHintLightImportance ( )

Light importannce in the range from 0 (least important) to 100 (most important).

§ getHintMovement()

int getHintMovement ( )

Movement hint.

§ getHintParameters()

int getHintParameters ( )

Parameter change hint.

§ getHintShadowImportance()

int getHintShadowImportance ( )

Shadow important in the range from 0 (least important) to 100 (most important).

§ getIntensity()

float getIntensity ( )

Light intensity.

§ getOrientation()

Quaternion getOrientation ( )

Orientation.

§ getPosition()

DVector getPosition ( )

Position.

§ getRange()

float getRange ( )

Range in meters.

§ getSpotExponent()

float getSpotExponent ( )

Spot exponent.

§ getType()

int getType ( )

Type.

§ new()

Light new ( )

Create light.

§ setActivated()

void setActivated ( bool  activated)

Set if light is activated.

§ setAmbientRatio()

void setAmbientRatio ( float  ratio)

Set ratio of ambient light in relation to the total intensity.

§ setAngles()

void setAngles ( float  angleX,
float  angleY 
)

Set spot angle in dregrees.

§ setCastShadows()

void setCastShadows ( bool  castShadows)

Set if light is casting shadows.

§ setColor()

void setColor ( Color  color)

Set light color.

§ setCutOffDistance()

void setCutOffDistance ( float  distance)

Set cut-off distance in meters.

§ setHalfIntensityDistance()

void setHalfIntensityDistance ( float  halfIntDist)

Set half intensity distance in meters.

§ setHintLightImportance()

void setHintLightImportance ( int  type)

Sets light importannce in the range from 0 (least important) to 100 (most important).

§ setHintMovement()

void setHintMovement ( int  hint)

Set movement hint.

§ setHintParameter()

void setHintParameter ( int  hint)

Set parameter change hint.

§ setHintShadowImportance()

void setHintShadowImportance ( int  type)

Set shadow important in the range from 0 (least important) to 100 (most important).

§ setIntensity()

void setIntensity ( float  intensity)

Set light intensity.

§ setOrientation()

void setOrientation ( Quaternion  orientation)

Set orientation.

§ setPosition()

void setPosition ( DVector  position)

position.

§ setProjectorCanvas()

void setProjectorCanvas ( CanvasView  canvasView)

Projector canvas or null if not set.

§ setProjectorImage()

void setProjectorImage ( Image  image)

Projector image or null if not set.

§ setRange()

void setRange ( float  range)

Set range in meters.

§ setSpotExponent()

void setSpotExponent ( float  exponent)

Set spot exponent.

§ setType()

void setType ( int  type)

Set type.

Member Data Documentation

§ MOVEMENT_DYNAMIC

final int MOVEMENT_DYNAMIC = 2
static

Light moves all around the place.

§ MOVEMENT_JITTERING

final int MOVEMENT_JITTERING = 1
static

Light moves only in a small area around an equilibrium point.

§ MOVEMENT_STATIC

final int MOVEMENT_STATIC = 0
static

Light is not moving.

§ PARAM_ACTIVATION

final int PARAM_ACTIVATION = 1
static

Light parameter are never changed after first setting them except switching the light on and off.

§ PARAM_DYNAMIC

final int PARAM_DYNAMIC = 3
static

All light parameters are modified dynamically.

§ PARAM_FLICKER

final int PARAM_FLICKER = 2
static

Light parameters except activate, color and intensity never change after first setting them.

§ PARAM_STATIC

final int PARAM_STATIC = 0
static

Light parameters are never changed after first setting them.

§ POINT

final int POINT = 0
static

Point light.

§ PROJECTOR

final int PROJECTOR = 3
static

Projector light.

§ SEMIPOINT

final int SEMIPOINT = 1
static

Semi point light.

§ SPOT

final int SPOT = 2
static

Spot light.


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