essentials.Environment.Sky.AtmosphereLayer Class Reference

Simple atmosphere layer that inspects orbitals and compares them to simulate atmospheric scattering More...

Inheritance diagram for essentials.Environment.Sky.AtmosphereLayer:

Public Member Functions
	AtmosphereLayer (IEnumerable< IOrbital > orbitals)
override Rgba	DirectionalColor (float x, float y, float z)
	Get the color at a direction More...
override 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]
virtual Rgba	ZenithColor [get]
virtual Rgba	HorizonColor [get]
virtual Rgba	NadirColor [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

Simple atmosphere layer that inspects orbitals and compares them to simulate atmospheric scattering

Constructor & Destructor Documentation

AtmosphereLayer()

essentials.Environment.Sky.AtmosphereLayer.AtmosphereLayer

(

IEnumerable< IOrbital >

orbitals

)

        {
            _orbitals = orbitals.ToArray();
            _glowing = _orbitals.OfType<IOrbitalGlow>().ToArray();
        }

Member Function Documentation

DirectionalColor()

override Rgba essentials.Environment.Sky.AtmosphereLayer.DirectionalColor ( float  x, float  y, float  z  )

virtual

Get the color at a direction

Returns

The color.

Parameters

x	X.
y	Y.
z	Z.

Attribute: i

;

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

        {
            Rgba color;
            if (z > 0.0)
            {
                color = (1f - z) * _horizon + _zenith * z;
            }
            else
            {
                color = (1f + z) * _horizon - _nadir * z;
            }

            for (int i=0; i<_glowing.Length; ++i)
            {
                var orbital = _glowing[i];
                Vector3 pt = orbital.Direction;
                float dot = ((pt.X * x + pt.Y * y + pt.Z * z) - (1f - orbital.GlowRadius)) * (1f / orbital.GlowRadius);
                if (dot > 0.0)
                {
                    color += (orbital.GlowColor * dot * orbital.GlowStrength);
                }
            }
            color.Clamp();
            return color;
        }

Simulate()

override void essentials.Environment.Sky.AtmosphereLayer.Simulate ( double  time, double  x, double  y, double  z  )

virtual

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

Parameters

time	Time.
x	X.
y	Y.
z	Z.

Attribute: i

;

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

        {
            Rgba totalEmit = Rgba.Zero;
            for (int i=0; i<_orbitals.Length; ++i)
            {
                var orbital = _orbitals[i];
                if (orbital.Direction.Z > 0f)
                {
                    totalEmit += orbital.EmittanceDiffuse * Math.Min(1f, orbital.Direction.Z * 2f);
                }
            }

            _zenith = new Rgba(ZenithColor, totalEmit.Luminosity);
            _horizon = new Rgba(HorizonColor, totalEmit.Luminosity);
            _nadir = NadirColor;
        }

Property Documentation

HorizonColor

virtual Rgba essentials.Environment.Sky.AtmosphereLayer.HorizonColor

getprotected

Layer

override int essentials.Environment.Sky.AtmosphereLayer.Layer

get

NadirColor

virtual Rgba essentials.Environment.Sky.AtmosphereLayer.NadirColor

getprotected

RenderMode

override SkyLayerRenderMode essentials.Environment.Sky.AtmosphereLayer.RenderMode

get

ZenithColor

virtual Rgba essentials.Environment.Sky.AtmosphereLayer.ZenithColor

getprotected

---

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

• essentials/Environment/Sky/AtmosphereLayer.cs