essentials.Environment.BasicEnvironment Class Reference

Inheritance diagram for essentials.Environment.BasicEnvironment:

Public Member Functions
	BasicEnvironment ()
override IOrbital []	CreateOrbitals ()
	Create all orbitals high up in the sky More...
override ISkyLayer []	CreateLayers ()
	Create all sky-layers More...
override IFog	CreateFog ()
	Creates the fog. More...
override IFilter []	CreateFilters ()
	Creates the filters. More...
override IPrecipitation []	CreatePrecipitationSystems ()
	Create all precipitation systems More...
override IAtmosphere	CreateAtmosphere ()
	Creates the world atmosphere More...

Public Attributes
override string	LutTextureResource => this._resolver.Resolve("lut/daylight-64.png")
Public Attributes inherited from pluginbase.Objects.World.Environment.EnvironmentBase
virtual string	LutTextureResource => null

Properties
override Rgba	SkyColor [get]
override Rgba	WorldAmbient [get]
Properties inherited from pluginbase.Objects.World.Environment.EnvironmentBase
virtual Rgba	SkyColor [get]
virtual Rgba	WorldAmbient [get]
Properties inherited from pluginbase.Objects.World.Environment.IEnvironment
Rgba	SkyColor [get]
	Gets the color of the sky. More...
Rgba	WorldAmbient [get]
	Gets the world ambient lighting. More...
string	LutTextureResource [get]
	Optional resource path to a 3D LUT texture More...

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

Detailed Description

Attribute: Environment("Basic", Author = "Pontoon City", Description = "Basic environment with sun and moon", IconPath="ui/icons/sun.png")

Constructor & Destructor Documentation

BasicEnvironment()

essentials.Environment.BasicEnvironment.BasicEnvironment

(

)

        {
            this.InjectDependencies();
            _orbitals = new IOrbital[]
            {
                new Sun(3000f),
                new Moon(3400f)
            };
            _fog = new AtmosphereVolumeFog(_orbitals, 10.0);
        }

Member Function Documentation

CreateAtmosphere()

override IAtmosphere essentials.Environment.BasicEnvironment.CreateAtmosphere ( )

virtual

Creates the world atmosphere

Returns

The atmosphere.

Reimplemented from pluginbase.Objects.World.Environment.EnvironmentBase.

        {
            return new SimpleAtmosphere();
        }

CreateFilters()

override IFilter [] essentials.Environment.BasicEnvironment.CreateFilters ( )

virtual

Creates the filters.

Returns

The filters.

Reimplemented from pluginbase.Objects.World.Environment.EnvironmentBase.

        {
            return new IFilter[]
            {
                new VignetteFilter()
            };
        }

CreateFog()

override IFog essentials.Environment.BasicEnvironment.CreateFog ( )

virtual

Creates the fog.

Returns

The fog.

Reimplemented from pluginbase.Objects.World.Environment.EnvironmentBase.

        {
            return _fog;
        }

CreateLayers()

override ISkyLayer [] essentials.Environment.BasicEnvironment.CreateLayers ( )

virtual

Create all sky-layers

Returns

The layers.

Reimplemented from pluginbase.Objects.World.Environment.EnvironmentBase.

        {
            return new ISkyLayer[]
            {
                new StarLayer(),
                new CloudLayer(),
                new AtmosphereLayer(_orbitals),
                new FogSkirt(_fog)
            };
        }

CreateOrbitals()

override IOrbital [] essentials.Environment.BasicEnvironment.CreateOrbitals ( )

virtual

Create all orbitals high up in the sky

Returns

The orbitals.

Reimplemented from pluginbase.Objects.World.Environment.EnvironmentBase.

        {
            return _orbitals;
        }

CreatePrecipitationSystems()

override IPrecipitation [] essentials.Environment.BasicEnvironment.CreatePrecipitationSystems ( )

virtual

Create all precipitation systems

Returns

The precipitation systems.

Reimplemented from pluginbase.Objects.World.Environment.EnvironmentBase.

        {
            return null;
        }

Member Data Documentation

LutTextureResource

override string essentials.Environment.BasicEnvironment.LutTextureResource => this._resolver.Resolve("lut/daylight-64.png")

Property Documentation

SkyColor

override Rgba essentials.Environment.BasicEnvironment.SkyColor

get

WorldAmbient

override Rgba essentials.Environment.BasicEnvironment.WorldAmbient

get

---

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

• essentials/Environment/BasicEnvironment.cs