Dragengine.Scenery.Light Class Reference
Inheritance diagram for Dragengine.Scenery.Light:
Public Member Functions | |
Constructors | |
| Light | new () |
| Create light. More... | |
Management | |
| LightType | getType () |
| Type. More... | |
| void | setType (LightType 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 | 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... | |
| ShapeList | getShape () |
| Light shape. More... | |
| void | setShape (ShapeList shape) |
| Set light shape. More... | |
| LayerMask | getLayerMask () |
| Layer mask affecting lighting. More... | |
| void | setLayerMask (LayerMask layerMask) |
| Set layer mask affecting lighting. More... | |
Spot and projector | |
| float | getSpotAngle () |
| Outer spot Angle. More... | |
| void | setSpotAngle (float angle) |
| Set outer spot angle. More... | |
| float | getSpotRatio () |
| Spot ratio as height divided by width. More... | |
| void | setSpotRatio (float ratio) |
| Set spot ratio as height divided by width. More... | |
| float | getSpotSmoothness () |
| Spot smoothness. More... | |
| void | setSpotSmoothness (float smoothness) |
| Set spot smoothness. More... | |
| float | getSpotExponent () |
| Spot exponent. More... | |
| void | setSpotExponent (float exponent) |
| Set spot exponent. More... | |
Light source | |
| Skin | getLightSkin () |
| Light skin or NULL if not used. More... | |
| void | setLightSkin (Skin skin) |
| Set light skin or NULL if not used. More... | |
| CanvasView | getLightCanvas () |
| Light canvas view or NULL if not used. More... | |
| void | setLightCanvas (CanvasView canvas) |
| Set light canvas view or NULL if not used. More... | |
| DynamicSkin | getDynamicSkin () |
| Light dynamic skin or NULL if not used. More... | |
| void | setDynamicSkin (DynamicSkin dynamicSkin) |
| Set light dynamic skin or NULL if not used. More... | |
| TexMatrix2 | getTransform () |
| Light texture coordinate transformation matrix. More... | |
| void | setTransform (TexMatrix2 matrix) |
| Set light texture coordinate transformation matrix. More... | |
Shadow casting | |
| bool | getCastShadows () |
| Light is casting shadows. More... | |
| void | setCastShadows (bool castShadows) |
| Set if light is casting shadows. More... | |
| LayerMask | getLayerMaskShadow () |
| Layer mask affecting shadow casting. More... | |
| void | setLayerMaskShadow (LayerMask layerMask) |
| Set layer mask affecting shadow casting. More... | |
| int | getShadowIgnoreComponentCount () |
| Number of components to ignore for shadow casting. More... | |
| Component | getShadowIgnoreComponentAt (int index) |
| Component to ignore for shadow casting at index. More... | |
| bool | hasShadowIgnoreComponent (Component component) |
| Component to ignore for shadow casting is present. More... | |
| void | addShadowIgnoreComponent (Component component) |
| Add component to ignore for shadow casting. More... | |
| void | removeShadowIgnoreComponent (Component component) |
| Remove component to ignore for shadow casting. More... | |
| void | removeAllShadowIgnoreComponents () |
| Remove all components to ignore for shadow casting. 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... | |
| LightHintMovement | getHintMovement () |
| Movement hint. More... | |
| void | setHintMovement (LightHintMovement hint) |
| Set movement hint. More... | |
| LightHintParameter | getHintParameters () |
| Parameter change hint. More... | |
| void | setHintParameter (LightHintParameter hint) |
| Set parameter change hint. More... | |
| ShapeList | getCage () |
| Light cage. More... | |
| void | setCage (ShapeList cage) |
| Set light cage. More... | |
Detailed Description
This is a native class.
Member Function Documentation
◆ addShadowIgnoreComponent()
| void Dragengine.Scenery.Light.addShadowIgnoreComponent | ( | Component | component | ) |
Add component to ignore for shadow casting.
- Exceptions
-
EInvalidParam 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()
◆ getCastShadows()
| bool Dragengine.Scenery.Light.getCastShadows | ( | ) |
Light is casting shadows.
◆ getColor()
◆ 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()
◆ getOrientation()
| Quaternion Dragengine.Scenery.Light.getOrientation | ( | ) |
Orientation.
◆ 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
-
EInvalidParam index is less than 0. EInvalidParam index is greater or equal than getIgnoreComponentCount()-1.
◆ getShadowIgnoreComponentCount()
| int Dragengine.Scenery.Light.getShadowIgnoreComponentCount | ( | ) |
Number of components to ignore for shadow casting.
◆ getShape()
◆ 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.
- Exceptions
-
EInvalidParam 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:
