Public Member Functions | |
Management | |
| Sky | getSky () |
| Owner sky. More... | |
| int | getLayerIndex () |
| Layer index. More... | |
Layers | |
| Vector | getOffset () |
| Relative offset of layer center. More... | |
| void | setOffset (Vector offset) |
| Set relative offset of layer center. More... | |
| Vector | getOrientation () |
| Orientation. More... | |
| void | setOrientation (Vector orientation) |
| Set orientation. More... | |
| Color | getColor () |
| Tint color. More... | |
| void | setColor (Color color) |
| Set tint color. More... | |
| float | getIntensity () |
| Intensity. More... | |
| void | setIntensity (float intensity) |
| Set intensity. More... | |
| float | getTransparency () |
| Transparency. More... | |
| void | setTransparency (float transparency) |
| Set transparency. More... | |
| Skin | getSkin () |
| Skin or null to use background color only. More... | |
| void | setSkin (Skin skin) |
| Set skin or null to use background color only. More... | |
| Quaternion | getLightOrientation () |
| Light orientation. More... | |
| void | setLightOrientation (Quaternion orientation) |
| Set light orientation. More... | |
| Color | getLightColor () |
| Light color. More... | |
| void | setLightColor (Color color) |
| Set light color. More... | |
| float | getLightIntensity () |
| Direct light intensity. More... | |
| void | setLightIntensity (float intensity) |
| Set direct light intensity. More... | |
| float | getAmbientIntensity () |
| Diffuse ambient light intensity. More... | |
| void | setAmbientIntensity (float intensity) |
| Set diffuse ambient light intensity. More... | |
| int | getBodyCount () |
| Number of bodies. More... | |
| void | setBodyCount (int count) |
| Set number of bodies. More... | |
| SkyBody | getBodyAt (int index) |
| Get wrapper for body. More... | |
| SkyTarget | getTarget (SkyLayerTargetType target) |
| Get wrapper for parameter. More... | |
| bool | getMuliplyBySkyLight () |
| Layer intensity is multiplied by total sky light intensity. More... | |
| void | setMultiplyBySkyLight (bool multiply) |
| Set if layer intensity is multiplied by total sky light intensity. More... | |
| bool | getMuliplyBySkyColor () |
| Layer color is multiplied by total sky light color. More... | |
| void | setMultiplyBySkyColor (bool multiply) |
| Set if layer color is multiplied by total sky light color. More... | |
Detailed Description
Sky layer.
Wraps a sky layer by layer index. Valid only as long as the wrapped sky does not change layer layout. The user is responsible to call Sky.contentChanged() after changing one or more layers. Sky layers should not be changed if possible after being used in sky instances.
The TARGET_ROTATION_* rotation is applied ontop of the layer orientation. This allows to define planetary movement with the layer orientation representing the planet orbit coordinate frame and TARGET_ROTATION_X for example rotating the planet along the x axis easily.
Member Function Documentation
◆ getAmbientIntensity()
| float Dragengine.Scenery.SkyLayer.getAmbientIntensity | ( | ) |
Diffuse ambient light intensity.
◆ getBodyAt()
| SkyBody Dragengine.Scenery.SkyLayer.getBodyAt | ( | int | index | ) |
Get wrapper for body.
- Warning
- The wrapper is only valid as long as the layer structure in the parent sky is not changed and the body layout is not changed.
- Exceptions
-
EOutOfBoundary body is less than 0 or larger than or equal to getBodyCount().
◆ getBodyCount()
| int Dragengine.Scenery.SkyLayer.getBodyCount | ( | ) |
Number of bodies.
◆ getColor()
| Color Dragengine.Scenery.SkyLayer.getColor | ( | ) |
Tint color.
◆ getIntensity()
| float Dragengine.Scenery.SkyLayer.getIntensity | ( | ) |
Intensity.
◆ getLayerIndex()
| int Dragengine.Scenery.SkyLayer.getLayerIndex | ( | ) |
Layer index.
◆ getLightColor()
◆ getLightIntensity()
| float Dragengine.Scenery.SkyLayer.getLightIntensity | ( | ) |
Direct light intensity.
◆ getLightOrientation()
| Quaternion Dragengine.Scenery.SkyLayer.getLightOrientation | ( | ) |
Light orientation.
◆ getMuliplyBySkyColor()
| bool Dragengine.Scenery.SkyLayer.getMuliplyBySkyColor | ( | ) |
Layer color is multiplied by total sky light color.
◆ getMuliplyBySkyLight()
| bool Dragengine.Scenery.SkyLayer.getMuliplyBySkyLight | ( | ) |
Layer intensity is multiplied by total sky light intensity.
◆ getOffset()
| Vector Dragengine.Scenery.SkyLayer.getOffset | ( | ) |
Relative offset of layer center.
◆ getOrientation()
| Vector Dragengine.Scenery.SkyLayer.getOrientation | ( | ) |
Orientation.
◆ getSkin()
◆ getSky()
| Sky Dragengine.Scenery.SkyLayer.getSky | ( | ) |
Owner sky.
◆ getTarget()
| SkyTarget Dragengine.Scenery.SkyLayer.getTarget | ( | SkyLayerTargetType | target | ) |
Get wrapper for parameter.
- Warning
- The wrapper is only valid as long as the layer structure in the parent sky is not changed.
◆ getTransparency()
| float Dragengine.Scenery.SkyLayer.getTransparency | ( | ) |
Transparency.
◆ setAmbientIntensity()
| void Dragengine.Scenery.SkyLayer.setAmbientIntensity | ( | float | intensity | ) |
Set diffuse ambient light intensity.
◆ setBodyCount()
| void Dragengine.Scenery.SkyLayer.setBodyCount | ( | int | count | ) |
Set number of bodies.
Sets all bodies to default vaules.
◆ setColor()
| void Dragengine.Scenery.SkyLayer.setColor | ( | Color | color | ) |
Set tint color.
◆ setIntensity()
| void Dragengine.Scenery.SkyLayer.setIntensity | ( | float | intensity | ) |
Set intensity.
◆ setLightColor()
| void Dragengine.Scenery.SkyLayer.setLightColor | ( | Color | color | ) |
Set light color.
◆ setLightIntensity()
| void Dragengine.Scenery.SkyLayer.setLightIntensity | ( | float | intensity | ) |
Set direct light intensity.
◆ setLightOrientation()
| void Dragengine.Scenery.SkyLayer.setLightOrientation | ( | Quaternion | orientation | ) |
Set light orientation.
◆ setMultiplyBySkyColor()
| void Dragengine.Scenery.SkyLayer.setMultiplyBySkyColor | ( | bool | multiply | ) |
Set if layer color is multiplied by total sky light color.
◆ setMultiplyBySkyLight()
| void Dragengine.Scenery.SkyLayer.setMultiplyBySkyLight | ( | bool | multiply | ) |
Set if layer intensity is multiplied by total sky light intensity.
◆ setOffset()
| void Dragengine.Scenery.SkyLayer.setOffset | ( | Vector | offset | ) |
Set relative offset of layer center.
◆ setOrientation()
| void Dragengine.Scenery.SkyLayer.setOrientation | ( | Vector | orientation | ) |
Set orientation.
◆ setSkin()
| void Dragengine.Scenery.SkyLayer.setSkin | ( | Skin | skin | ) |
Set skin or null to use background color only.
◆ setTransparency()
| void Dragengine.Scenery.SkyLayer.setTransparency | ( | float | transparency | ) |
Set transparency.
The documentation for this class was generated from the following file:
