Empeld
Empeld plugin documentation.
pluginbase.Objects.World.Environment.EnvironmentBase Class Reference

Base class for a world environment More...

Inheritance diagram for pluginbase.Objects.World.Environment.EnvironmentBase:
pluginbase.Objects.World.Environment.IEnvironment essentials.Environment.BasicEnvironment

Public Member Functions

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

Public Attributes

virtual string LutTextureResource => null
 

Protected Member Functions

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

Properties

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...
 

Detailed Description

Base class for a world environment

Constructor & Destructor Documentation

◆ EnvironmentBase()

pluginbase.Objects.World.Environment.EnvironmentBase.EnvironmentBase ( )
protected

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

15  {
16  }

Member Function Documentation

◆ CreateAtmosphere()

virtual IAtmosphere pluginbase.Objects.World.Environment.EnvironmentBase.CreateAtmosphere ( )
virtual

Creates the world atmosphere

Returns
The atmosphere.

Implements pluginbase.Objects.World.Environment.IEnvironment.

Reimplemented in essentials.Environment.BasicEnvironment.

45  {
46  return null;
47  }

◆ CreateFilters()

virtual IFilter [] pluginbase.Objects.World.Environment.EnvironmentBase.CreateFilters ( )
virtual

Creates the filters.

Returns
The filters.

Implements pluginbase.Objects.World.Environment.IEnvironment.

Reimplemented in essentials.Environment.BasicEnvironment.

35  {
36  return null;
37  }

◆ CreateFog()

virtual IFog pluginbase.Objects.World.Environment.EnvironmentBase.CreateFog ( )
virtual

Creates the fog.

Returns
The fog.

Implements pluginbase.Objects.World.Environment.IEnvironment.

Reimplemented in essentials.Environment.BasicEnvironment.

40  {
41  return null;
42  }

◆ CreateLayers()

virtual ISkyLayer [] pluginbase.Objects.World.Environment.EnvironmentBase.CreateLayers ( )
virtual

Create all sky-layers

Returns
The layers.

Implements pluginbase.Objects.World.Environment.IEnvironment.

Reimplemented in essentials.Environment.BasicEnvironment.

25  {
26  return null;
27  }

◆ CreateOrbitals()

virtual IOrbital [] pluginbase.Objects.World.Environment.EnvironmentBase.CreateOrbitals ( )
virtual

Create all orbitals high up in the sky

Returns
The orbitals.

Implements pluginbase.Objects.World.Environment.IEnvironment.

Reimplemented in essentials.Environment.BasicEnvironment.

20  {
21  return null;
22  }

◆ CreatePrecipitationSystems()

virtual IPrecipitation [] pluginbase.Objects.World.Environment.EnvironmentBase.CreatePrecipitationSystems ( )
virtual

Create all precipitation systems

Returns
The precipitation systems.

Implements pluginbase.Objects.World.Environment.IEnvironment.

Reimplemented in essentials.Environment.BasicEnvironment.

30  {
31  return null;
32  }

Member Data Documentation

◆ LutTextureResource

virtual string pluginbase.Objects.World.Environment.EnvironmentBase.LutTextureResource => null

Property Documentation

◆ SkyColor

virtual Rgba pluginbase.Objects.World.Environment.EnvironmentBase.SkyColor
get

◆ WorldAmbient

virtual Rgba pluginbase.Objects.World.Environment.EnvironmentBase.WorldAmbient
get

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