Drag[en]gine Script Module DragonScript 1.32.1
Loading...
Searching...
No Matches
List of all members
Dragengine.Scenery.Light Class Reference

Light. More...

Inheritance diagram for Dragengine.Scenery.Light:

Public Member Functions

Constructors
Light new ()
 Create light.
 
Management
LightType getType ()
 Type.
 
void setType (LightType type)
 Set type.
 
World getParentWorld ()
 Parent world or null if not added to a world.
 
DVector getPosition ()
 Position.
 
void setPosition (DVector position)
 position.
 
Quaternion getOrientation ()
 Orientation.
 
void setOrientation (Quaternion orientation)
 Set orientation.
 
bool getActivated ()
 Light is actived.
 
void setActivated (bool activated)
 Set if light is activated.
 
Color getColor ()
 Light color.
 
void setColor (Color color)
 Set light color.
 
float getIntensity ()
 Light intensity.
 
void setIntensity (float intensity)
 Set light intensity.
 
float getRange ()
 Range in meters.
 
void setRange (float range)
 Set range in meters.
 
float getHalfIntensityDistance ()
 Half intensity distance in meters.
 
void setHalfIntensityDistance (float halfIntDist)
 Set half intensity distance in meters.
 
float getAmbientRatio ()
 Ratio of ambient light in relation to the total intensity.
 
void setAmbientRatio (float ratio)
 Set ratio of ambient light in relation to the total intensity.
 
ShapeList getShape ()
 Light shape.
 
void setShape (ShapeList shape)
 Set light shape.
 
LayerMask getLayerMask ()
 Layer mask affecting lighting.
 
void setLayerMask (LayerMask layerMask)
 Set layer mask affecting lighting.
 
Spot and projector
float getSpotAngle ()
 Outer spot Angle.
 
void setSpotAngle (float angle)
 Set outer spot angle.
 
float getSpotRatio ()
 Spot ratio as height divided by width.
 
void setSpotRatio (float ratio)
 Set spot ratio as height divided by width.
 
float getSpotSmoothness ()
 Spot smoothness.
 
void setSpotSmoothness (float smoothness)
 Set spot smoothness.
 
float getSpotExponent ()
 Spot exponent.
 
void setSpotExponent (float exponent)
 Set spot exponent.
 
Light source
Skin getLightSkin ()
 Light skin or NULL if not used.
 
void setLightSkin (Skin skin)
 Set light skin or NULL if not used.
 
CanvasView getLightCanvas ()
 Light canvas view or NULL if not used.
 
void setLightCanvas (CanvasView canvas)
 Set light canvas view or NULL if not used.
 
DynamicSkin getDynamicSkin ()
 Light dynamic skin or NULL if not used.
 
void setDynamicSkin (DynamicSkin dynamicSkin)
 Set light dynamic skin or NULL if not used.
 
TexMatrix2 getTransform ()
 Light texture coordinate transformation matrix.
 
void setTransform (TexMatrix2 matrix)
 Set light texture coordinate transformation matrix.
 
Shadow casting
bool getCastShadows ()
 Light is casting shadows.
 
void setCastShadows (bool castShadows)
 Set if light is casting shadows.
 
LayerMask getLayerMaskShadow ()
 Layer mask affecting shadow casting.
 
void setLayerMaskShadow (LayerMask layerMask)
 Set layer mask affecting shadow casting.
 
int getShadowIgnoreComponentCount ()
 Number of components to ignore for shadow casting.
 
Component getShadowIgnoreComponentAt (int index)
 Component to ignore for shadow casting at index.
 
bool hasShadowIgnoreComponent (Component component)
 Component to ignore for shadow casting is present.
 
void addShadowIgnoreComponent (Component component)
 Add component to ignore for shadow casting.
 
void removeShadowIgnoreComponent (Component component)
 Remove component to ignore for shadow casting. Does nothing if component is absent.
 
void removeAllShadowIgnoreComponents ()
 Remove all components to ignore for shadow casting.
 
Hint
int getHintLightImportance ()
 Light importannce in the range from 0 (least important) to 100 (most important).
 
void setHintLightImportance (int type)
 Sets light importannce in the range from 0 (least important) to 100 (most important).
 
int getHintShadowImportance ()
 Shadow important in the range from 0 (least important) to 100 (most important).
 
void setHintShadowImportance (int type)
 Set shadow important in the range from 0 (least important) to 100 (most important).
 
LightHintMovement getHintMovement ()
 Movement hint.
 
void setHintMovement (LightHintMovement hint)
 Set movement hint.
 
LightHintParameter getHintParameters ()
 Parameter change hint.
 
void setHintParameter (LightHintParameter hint)
 Set parameter change hint.
 
ShapeList getCage ()
 Light cage.
 
void setCage (ShapeList cage)
 Set light cage.
 

Detailed Description

Light.

This is a native class.

Member Function Documentation

◆ addShadowIgnoreComponent()

void Dragengine.Scenery.Light.addShadowIgnoreComponent ( Component  component)

Add component to ignore for shadow casting.

Does nothing if component is present.

◆ getActivated()

bool Dragengine.Scenery.Light.getActivated ( )

Light is actived.

◆ getAmbientRatio()

float Dragengine.Scenery.Light.getAmbientRatio ( )

Ratio of ambient light in relation to the total intensity.

◆ getCage()

ShapeList Dragengine.Scenery.Light.getCage ( )

Light cage.

◆ getCastShadows()

bool Dragengine.Scenery.Light.getCastShadows ( )

Light is casting shadows.

◆ getColor()

Color Dragengine.Scenery.Light.getColor ( )

Light color.

◆ getDynamicSkin()

DynamicSkin Dragengine.Scenery.Light.getDynamicSkin ( )

Light dynamic skin or NULL if not used.

◆ getHalfIntensityDistance()

float Dragengine.Scenery.Light.getHalfIntensityDistance ( )

Half intensity distance in meters.

◆ getHintLightImportance()

int Dragengine.Scenery.Light.getHintLightImportance ( )

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

◆ getHintMovement()

LightHintMovement Dragengine.Scenery.Light.getHintMovement ( )

Movement hint.

◆ getHintParameters()

LightHintParameter Dragengine.Scenery.Light.getHintParameters ( )

Parameter change hint.

◆ getHintShadowImportance()

int Dragengine.Scenery.Light.getHintShadowImportance ( )

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

◆ getIntensity()

float Dragengine.Scenery.Light.getIntensity ( )

Light intensity.

◆ getLayerMask()

LayerMask Dragengine.Scenery.Light.getLayerMask ( )

Layer mask affecting lighting.

◆ getLayerMaskShadow()

LayerMask Dragengine.Scenery.Light.getLayerMaskShadow ( )

Layer mask affecting shadow casting.

◆ getLightCanvas()

CanvasView Dragengine.Scenery.Light.getLightCanvas ( )

Light canvas view or NULL if not used.

◆ getLightSkin()

Skin Dragengine.Scenery.Light.getLightSkin ( )

Light skin or NULL if not used.

◆ getOrientation()

Quaternion Dragengine.Scenery.Light.getOrientation ( )

Orientation.

◆ getParentWorld()

World Dragengine.Scenery.Light.getParentWorld ( )

Parent world or null if not added to a world.

Version
1.29

◆ getPosition()

DVector Dragengine.Scenery.Light.getPosition ( )

Position.

◆ getRange()

float Dragengine.Scenery.Light.getRange ( )

Range in meters.

◆ getShadowIgnoreComponentAt()

Component Dragengine.Scenery.Light.getShadowIgnoreComponentAt ( int  index)

Component to ignore for shadow casting at index.

Exceptions
EInvalidParamindex is less than 0.
EInvalidParamindex is greater or equal than getShadowIgnoreComponentCount().

◆ getShadowIgnoreComponentCount()

int Dragengine.Scenery.Light.getShadowIgnoreComponentCount ( )

Number of components to ignore for shadow casting.

◆ getShape()

ShapeList Dragengine.Scenery.Light.getShape ( )

Light shape.

◆ getSpotAngle()

float Dragengine.Scenery.Light.getSpotAngle ( )

Outer spot Angle.

◆ getSpotExponent()

float Dragengine.Scenery.Light.getSpotExponent ( )

Spot exponent.

◆ getSpotRatio()

float Dragengine.Scenery.Light.getSpotRatio ( )

Spot ratio as height divided by width.

◆ getSpotSmoothness()

float Dragengine.Scenery.Light.getSpotSmoothness ( )

Spot smoothness.

◆ getTransform()

TexMatrix2 Dragengine.Scenery.Light.getTransform ( )

Light texture coordinate transformation matrix.

◆ getType()

LightType Dragengine.Scenery.Light.getType ( )

Type.

◆ hasShadowIgnoreComponent()

bool Dragengine.Scenery.Light.hasShadowIgnoreComponent ( Component  component)

Component to ignore for shadow casting is present.

◆ new()

Light Dragengine.Scenery.Light.new ( )

Create light.

◆ removeAllShadowIgnoreComponents()

void Dragengine.Scenery.Light.removeAllShadowIgnoreComponents ( )

Remove all components to ignore for shadow casting.

◆ removeShadowIgnoreComponent()

void Dragengine.Scenery.Light.removeShadowIgnoreComponent ( Component  component)

Remove component to ignore for shadow casting. Does nothing if component is absent.

◆ setActivated()

void Dragengine.Scenery.Light.setActivated ( bool  activated)

Set if light is activated.

◆ setAmbientRatio()

void Dragengine.Scenery.Light.setAmbientRatio ( float  ratio)

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

◆ setCage()

void Dragengine.Scenery.Light.setCage ( ShapeList  cage)

Set light cage.

◆ setCastShadows()

void Dragengine.Scenery.Light.setCastShadows ( bool  castShadows)

Set if light is casting shadows.

◆ setColor()

void Dragengine.Scenery.Light.setColor ( Color  color)

Set light color.

◆ setDynamicSkin()

void Dragengine.Scenery.Light.setDynamicSkin ( DynamicSkin  dynamicSkin)

Set light dynamic skin or NULL if not used.

◆ setHalfIntensityDistance()

void Dragengine.Scenery.Light.setHalfIntensityDistance ( float  halfIntDist)

Set half intensity distance in meters.

◆ setHintLightImportance()

void Dragengine.Scenery.Light.setHintLightImportance ( int  type)

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

◆ setHintMovement()

void Dragengine.Scenery.Light.setHintMovement ( LightHintMovement  hint)

Set movement hint.

◆ setHintParameter()

void Dragengine.Scenery.Light.setHintParameter ( LightHintParameter  hint)

Set parameter change hint.

◆ setHintShadowImportance()

void Dragengine.Scenery.Light.setHintShadowImportance ( int  type)

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

◆ setIntensity()

void Dragengine.Scenery.Light.setIntensity ( float  intensity)

Set light intensity.

◆ setLayerMask()

void Dragengine.Scenery.Light.setLayerMask ( LayerMask  layerMask)

Set layer mask affecting lighting.

◆ setLayerMaskShadow()

void Dragengine.Scenery.Light.setLayerMaskShadow ( LayerMask  layerMask)

Set layer mask affecting shadow casting.

◆ setLightCanvas()

void Dragengine.Scenery.Light.setLightCanvas ( CanvasView  canvas)

Set light canvas view or NULL if not used.

◆ setLightSkin()

void Dragengine.Scenery.Light.setLightSkin ( Skin  skin)

Set light skin or NULL if not used.

◆ setOrientation()

void Dragengine.Scenery.Light.setOrientation ( Quaternion  orientation)

Set orientation.

◆ setPosition()

void Dragengine.Scenery.Light.setPosition ( DVector  position)

position.

◆ setRange()

void Dragengine.Scenery.Light.setRange ( float  range)

Set range in meters.

◆ setShape()

void Dragengine.Scenery.Light.setShape ( ShapeList  shape)

Set light shape.

◆ setSpotAngle()

void Dragengine.Scenery.Light.setSpotAngle ( float  angle)

Set outer spot angle.

◆ setSpotExponent()

void Dragengine.Scenery.Light.setSpotExponent ( float  exponent)

Set spot exponent.

◆ setSpotRatio()

void Dragengine.Scenery.Light.setSpotRatio ( float  ratio)

Set spot ratio as height divided by width.

◆ setSpotSmoothness()

void Dragengine.Scenery.Light.setSpotSmoothness ( float  smoothness)

Set spot smoothness.

◆ setTransform()

void Dragengine.Scenery.Light.setTransform ( TexMatrix2  matrix)

Set light texture coordinate transformation matrix.

◆ setType()

void Dragengine.Scenery.Light.setType ( LightType  type)

Set type.

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