Empeld
Empeld plugin documentation.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events
pluginbase.Objects.World.Environment.Sky.SkyLayerBase Class Reference

A base class used for a sky layer More...

Inheritance diagram for pluginbase.Objects.World.Environment.Sky.SkyLayerBase:
pluginbase.Objects.World.Environment.ISkyLayer pluginbase.Objects.World.Environment.IEnvironmentSimulatable essentials.Environment.Fog.FogSkirt essentials.Environment.Sky.AtmosphereLayer essentials.Environment.Sky.CloudLayer essentials.Environment.Sky.ColorLayer essentials.Environment.Sky.RainCloudLayer essentials.Environment.Sky.StarLayer

Public Member Functions

virtual void Simulate (double time, double x, double y, double z)
 Simulate the environment with the time, and an x/y/z More...
 
virtual Rgba DirectionalColor (float x, float y, float z)
 Get the color at a direction More...
 

Protected Member Functions

 SkyLayerBase ()
 Initializes a new instance of the pluginbase.Objects.World.Environment.Sky.SkyLayerBase class. More...
 

Properties

virtual SkyLayerRenderMode RenderMode [get]
 Gets the render mode. More...
 
virtual int Layer [get]
 Gets the layer the sky is drawn on More...
 
virtual Vector3 Direction [get]
 Gets the up-direction for the layer. This can be used to rotate a sky-sphere or position a shader value More...
 
virtual string Resource [get]
 Gets the resource. Either a texture, or shader. Only shaders support multiple resources More...
 
virtual Rgba Color [get]
 Overlay color More...
 
virtual float TextureScale [get]
 Gets the texture scale for render types that support it More...
 
virtual float CameraAdjustmentRatio [get]
 The amount the camera position adjusts the direction of the layer More...
 
virtual bool ReceivesLight [get]
 Gets a value indicating whether this pluginbase.Objects.World.Environment.Sky.SkyLayerBase receives light. More...
 
virtual bool CastsShadow [get]
 Gets a value indicating whether this instance can project on world. More...
 
virtual Rgba LightFilter [get]
 Gets a value to multiply incoming light by to simulate a layer filtering out sunlight More...
 
- Properties inherited from pluginbase.Objects.World.Environment.ISkyLayer
SkyLayerRenderMode RenderMode [get]
 Gets the render mode. More...
 
int Layer [get]
 Gets the layer the sky is drawn on More...
 
Vector3 Direction [get]
 Gets the up-direction for the layer. This can be used to rotate a sky-sphere or position a shader value More...
 
string Resource [get]
 Gets the resource. Either a texture, or shader. Only shaders support multiple resources More...
 
Rgba Color [get]
 Overlay color More...
 
float TextureScale [get]
 Gets the texture scale for render types that support it More...
 
float CameraAdjustmentRatio [get]
 The amount the camera position adjusts the direction of the layer More...
 
bool ReceivesLight [get]
 Gets a value indicating whether this pluginbase.Objects.World.Environment.ISkyLayer receives light. More...
 
bool CastsShadow [get]
 Gets a value indicating whether this instance can project on world. More...
 
Rgba LightFilter [get]
 Gets a value to multiply incoming light by to simulate a layer filtering out sunlight More...
 

Detailed Description

A base class used for a sky layer

Constructor & Destructor Documentation

pluginbase.Objects.World.Environment.Sky.SkyLayerBase.SkyLayerBase ( )
protected

Initializes a new instance of the pluginbase.Objects.World.Environment.Sky.SkyLayerBase class.

16  {
17  }

Member Function Documentation

virtual Rgba pluginbase.Objects.World.Environment.Sky.SkyLayerBase.DirectionalColor ( float  x,
float  y,
float  z 
)
virtual

Get the color at a direction

Returns
The color.
Parameters
xX.
yY.
zZ.

Implements pluginbase.Objects.World.Environment.ISkyLayer.

Reimplemented in essentials.Environment.Sky.AtmosphereLayer, and essentials.Environment.Fog.FogSkirt.

93  {
94  return this.Color;
95  }
virtual Rgba Color
Overlay color
Definition: SkyLayerBase.cs:78
virtual void pluginbase.Objects.World.Environment.Sky.SkyLayerBase.Simulate ( double  time,
double  x,
double  y,
double  z 
)
virtual

Simulate the environment with the time, and an x/y/z

Parameters
timeTime.
xX.
yY.
zZ.

Implements pluginbase.Objects.World.Environment.IEnvironmentSimulatable.

Reimplemented in essentials.Environment.Sky.AtmosphereLayer, essentials.Environment.Sky.CloudLayer, essentials.Environment.Sky.RainCloudLayer, and essentials.Environment.Sky.StarLayer.

27  {
28 
29  }

Property Documentation

virtual float pluginbase.Objects.World.Environment.Sky.SkyLayerBase.CameraAdjustmentRatio
get

The amount the camera position adjusts the direction of the layer

The camera adjustment ratio.

virtual bool pluginbase.Objects.World.Environment.Sky.SkyLayerBase.CastsShadow
get

Gets a value indicating whether this instance can project on world.

true

false

virtual Rgba pluginbase.Objects.World.Environment.Sky.SkyLayerBase.Color
get

Overlay color

The color.

virtual Vector3 pluginbase.Objects.World.Environment.Sky.SkyLayerBase.Direction
get

Gets the up-direction for the layer. This can be used to rotate a sky-sphere or position a shader value

The direction.

virtual int pluginbase.Objects.World.Environment.Sky.SkyLayerBase.Layer
get

Gets the layer the sky is drawn on

The layer.

virtual Rgba pluginbase.Objects.World.Environment.Sky.SkyLayerBase.LightFilter
get

Gets a value to multiply incoming light by to simulate a layer filtering out sunlight

The light filter.

virtual bool pluginbase.Objects.World.Environment.Sky.SkyLayerBase.ReceivesLight
get

Gets a value indicating whether this pluginbase.Objects.World.Environment.Sky.SkyLayerBase receives light.

true if receives light; otherwise, false.

virtual SkyLayerRenderMode pluginbase.Objects.World.Environment.Sky.SkyLayerBase.RenderMode
get

Gets the render mode.

The render mode.

virtual string pluginbase.Objects.World.Environment.Sky.SkyLayerBase.Resource
get

Gets the resource. Either a texture, or shader. Only shaders support multiple resources

The resource.

virtual float pluginbase.Objects.World.Environment.Sky.SkyLayerBase.TextureScale
get

Gets the texture scale for render types that support it

The texture scale.


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