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

Base class to simplify use of an IOrbital More...

Inheritance diagram for pluginbase.Objects.World.Environment.Orbitals.OrbitalBase:
pluginbase.Objects.World.Environment.IOrbital pluginbase.Objects.World.Environment.IEnvironmentSimulatable pluginbase.Objects.World.Environment.Orbitals.OrbitalRevolutionBase essentials.Environment.Orbital.Moon essentials.Environment.Orbital.Sun

Public Member Functions

 OrbitalBase ()
 Initializes a new instance of the pluginbase.Objects.World.Environment.Orbitals.OrbitalBase class. More...
 
virtual void Simulate (double time, double x, double y, double z)
 Simulate the environment with the time, and an x/y/z More...
 

Properties

virtual OrbitalRenderMode RenderMode [get]
 Gets the render mode of the orbital More...
 
virtual int RenderDetail [get]
 
virtual EnvironmentBlendMode BlendMode [get]
 
virtual Rgba Color [get]
 
virtual bool ReceivesLight [get]
 
virtual bool HasEmittance [get]
 
virtual Rgba EmittanceDiffuse [get]
 
virtual Rgba EmittanceSpecular [get]
 
virtual Rgba EmittanceAmbient [get]
 
virtual Rgba OrbitalEmittance [get]
 
virtual string Resource [get]
 
virtual float Size [get]
 
virtual Vector3 Direction [get]
 
virtual int Layer [get]
 
virtual float Rotation [get]
 
- Properties inherited from pluginbase.Objects.World.Environment.IOrbital
OrbitalRenderMode RenderMode [get]
 Gets the render mode. More...
 
int RenderDetail [get]
 Gets the render detail. Currently only applies to sphere rendering. Default 12 More...
 
Rgba EmittanceDiffuse [get]
 Gets the emittance color for lighting More...
 
Rgba EmittanceAmbient [get]
 Gets the emittance ambient for lighting More...
 
Rgba EmittanceSpecular [get]
 Gets the emmitance specular for lighting More...
 
Rgba OrbitalEmittance [get]
 The color that affects other orbitals. Defaults to emittance More...
 
bool HasEmittance [get]
 Gets a value indicating whether this instance has emittance. More...
 
string Resource [get]
 Gets the resource. In most cases this is a texture More...
 
EnvironmentBlendMode BlendMode [get]
 Gets the blend mode. More...
 
Rgba Color [get]
 Gets the color that the orbital is affected by More...
 
bool ReceivesLight [get]
 Gets a value indicating whether this pluginbase.Objects.World.Environment.IOrbital receives light from other orbitals during environmental rendering More...
 
float Size [get]
 Gets the relative size More...
 
Vector3 Direction [get]
 Gets the direction that the object is rendered in Needs to be normalized More...
 
int Layer [get]
 Gets the layer that the object is drawn on More...
 
float Rotation [get]
 Gets the rotation around the direction More...
 

Detailed Description

Base class to simplify use of an IOrbital

Constructor & Destructor Documentation

pluginbase.Objects.World.Environment.Orbitals.OrbitalBase.OrbitalBase ( )

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

16  {
17 
18  }

Member Function Documentation

virtual void pluginbase.Objects.World.Environment.Orbitals.OrbitalBase.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 pluginbase.Objects.World.Environment.Orbitals.OrbitalRevolutionBase.

28  {
29 
30  }

Property Documentation

virtual EnvironmentBlendMode pluginbase.Objects.World.Environment.Orbitals.OrbitalBase.BlendMode
get
virtual Rgba pluginbase.Objects.World.Environment.Orbitals.OrbitalBase.Color
get
virtual Vector3 pluginbase.Objects.World.Environment.Orbitals.OrbitalBase.Direction
get
virtual Rgba pluginbase.Objects.World.Environment.Orbitals.OrbitalBase.EmittanceAmbient
get
virtual Rgba pluginbase.Objects.World.Environment.Orbitals.OrbitalBase.EmittanceDiffuse
get
virtual Rgba pluginbase.Objects.World.Environment.Orbitals.OrbitalBase.EmittanceSpecular
get
virtual bool pluginbase.Objects.World.Environment.Orbitals.OrbitalBase.HasEmittance
get
virtual int pluginbase.Objects.World.Environment.Orbitals.OrbitalBase.Layer
get
virtual Rgba pluginbase.Objects.World.Environment.Orbitals.OrbitalBase.OrbitalEmittance
get
virtual bool pluginbase.Objects.World.Environment.Orbitals.OrbitalBase.ReceivesLight
get
virtual int pluginbase.Objects.World.Environment.Orbitals.OrbitalBase.RenderDetail
get
virtual OrbitalRenderMode pluginbase.Objects.World.Environment.Orbitals.OrbitalBase.RenderMode
get

Gets the render mode of the orbital

The render mode.

virtual string pluginbase.Objects.World.Environment.Orbitals.OrbitalBase.Resource
get
virtual float pluginbase.Objects.World.Environment.Orbitals.OrbitalBase.Rotation
get
virtual float pluginbase.Objects.World.Environment.Orbitals.OrbitalBase.Size
get

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