essentials.Environment.Fog.FogSkirt Class Reference

Sky-layer Skirt that surroudns the atmosphere with a low-layer of fog Assumes Z-up More...

Inheritance diagram for essentials.Environment.Fog.FogSkirt:

Public Member Functions
	FogSkirt (IFog fog, float lowZ=0.05f, float highZ=0.3f)
override Rgba	DirectionalColor (float x, float y, float z)
	Get the color at a direction More...
Public Member Functions inherited from pluginbase.Objects.World.Environment.Sky.SkyLayerBase
virtual void	Simulate (double time, double x, double y, double z)
	Simulate the environment with the time, and an x/y/z More...

Properties
override SkyLayerRenderMode	RenderMode [get]
override int	Layer [get]
Properties inherited from pluginbase.Objects.World.Environment.Sky.SkyLayerBase
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...

Additional Inherited Members
Protected Member Functions inherited from pluginbase.Objects.World.Environment.Sky.SkyLayerBase
	SkyLayerBase ()
	Initializes a new instance of the pluginbase.Objects.World.Environment.Sky.SkyLayerBase class. More...

Detailed Description

Sky-layer Skirt that surroudns the atmosphere with a low-layer of fog Assumes Z-up

Constructor & Destructor Documentation

FogSkirt()

essentials.Environment.Fog.FogSkirt.FogSkirt	(	IFog	fog,
		float	lowZ = 0.05f,
		float	highZ = 0.3f
	)

        {
            _fog = fog;
            _lowZ = lowZ;
            _highZ = highZ;
        }

Member Function Documentation

DirectionalColor()

override Rgba essentials.Environment.Fog.FogSkirt.DirectionalColor ( float  x, float  y, float  z  )

virtual

Get the color at a direction

Returns

The color.

Parameters

x	X.
y	Y.
z	Z.

Reimplemented from pluginbase.Objects.World.Environment.Sky.SkyLayerBase.

        {

            var fogCol = _fog.Color;
            fogCol.Clamp();
            return new Rgba(
                fogCol.R,
                fogCol.G,
                fogCol.B,
                MExt.NormalizeClamp(z, _highZ, _lowZ)
                );
        }

Property Documentation

Layer

override int essentials.Environment.Fog.FogSkirt.Layer

get

RenderMode

override SkyLayerRenderMode essentials.Environment.Fog.FogSkirt.RenderMode

get

---

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

• essentials/Environment/Fog/FogSkirt.cs