OmegaEngine API  1.0.3
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events
Static Public Member Functions | Protected Member Functions | Package Functions | List of all members
OmegaEngine.Graphics.Renderables.SimpleSkybox Class Reference

A cubic skybox existing of 4 or 6 non-animated planes. More...

Inheritance diagram for OmegaEngine.Graphics.Renderables.SimpleSkybox:
OmegaEngine.Graphics.Renderables.Skybox OmegaEngine.Graphics.Renderables.Renderable OmegaEngine.EngineElement OmegaEngine.IResetable

Static Public Member Functions

static SimpleSkybox FromAssets (Engine engine, string rt, string lf, string up, string dn, string ft, string bk)
 Creates a new skybox using a cached XTextures (loading new ones if they aren't cached). More...
 

Protected Member Functions

 SimpleSkybox (XTexture[] textures)
 Creates a new skybox using texture-files More...
 
override void OnEngineSet ()
 Hook that is calld when Engine is set for the first time.
 
override void OnDispose ()
 Hook that is called when the object needs to dispose its internal resources.
 
- Protected Member Functions inherited from OmegaEngine.Graphics.Renderables.Skybox
 Skybox (ITextureProvider[] textures)
 Creates a new skybox using texture-files More...
 
override void OnDispose ()
 Hook that is called when the object needs to dispose its internal resources.
 
- Protected Member Functions inherited from OmegaEngine.Graphics.Renderables.Renderable
virtual void OnPreRender ()
 
void PrepareRender ()
 Should be called before rendering anything - usually called by base constructor More...
 
- Protected Member Functions inherited from OmegaEngine.EngineElement
void RegisterChild (EngineElement element, bool autoDispose=true)
 Registers a child EngineElement for automatic Engine setting and Dispose calling. More...
 
void UnregisterChild (EngineElement element)
 Unregisters a child EngineElement (opposite of RegisterChild). More...
 

Package Functions

override void Render (Camera camera, GetLights getLights=null)
 To be called when this object ist to be rendered.
Parameters
cameraSupplies information for the view transformation.
getLightsA delegate that will be called to get lighting information.

 
- Package Functions inherited from OmegaEngine.Graphics.Renderables.Skybox
override void Render (Camera camera, GetLights getLights=null)
 To be called when this object ist to be rendered.
Parameters
cameraSupplies information for the view transformation.
getLightsA delegate that will be called to get lighting information.

 

Additional Inherited Members

- Public Member Functions inherited from OmegaEngine.Graphics.Renderables.Renderable
override string ToString ()
 
- Public Member Functions inherited from OmegaEngine.EngineElement
void Dispose ()
 
- Public Attributes inherited from OmegaEngine.EngineElement
bool IsEngineSet => _engine != null
 true if the Engine has been set. More...
 
- Protected Attributes inherited from OmegaEngine.Graphics.Renderables.Skybox
readonly ITextureProvider[] Textures = new ITextureProvider[6]
 
- Properties inherited from OmegaEngine.Graphics.Renderables.Renderable
int RenderCount [get, set]
 How many times has this entity been rendered in this frame? More...
 
string Name [get, set]
 Text value to make it easier to identify a particular render entity More...
 
bool Visible [get, set]
 Shall the entity be rendered? More...
 
bool Wireframe = true [get, set]
 Shall this entity be drawn in wireframe-mode? (used for debugging) More...
 
float VisibilityDistance [get, set]
 The maximum distance from which the entity is visible - 0 for infinite More...
 
int Alpha [get, set]
 The level of transparency from 0 (solid) to 255 (invisible), OmegaEngine.EngineState.AlphaChannel, OmegaEngine.EngineState.BinaryAlphaChannel or OmegaEngine.EngineState.AdditivBlending More...
 
- Properties inherited from OmegaEngine.EngineElement
Engine Engine [get, set]
 The Engine instance used by this object. Must be set before using the object. May not be changed once it has been set! More...
 
bool IsDisposed [get, set]
 Indicates whether this object has been disposed and can therefore no longer be used. More...
 
- Events inherited from OmegaEngine.Graphics.Renderables.Renderable
Action PreRender
 Occurs once per frame before rendering the entity. Will not be executed if the entity is excluded by a culling test. More...
 

Detailed Description

A cubic skybox existing of 4 or 6 non-animated planes.

Constructor & Destructor Documentation

OmegaEngine.Graphics.Renderables.SimpleSkybox.SimpleSkybox ( XTexture[]  textures)
inlineprotected

Creates a new skybox using texture-files

Parameters
texturesAn array of the 6 textures to be uses (right, left, top, bottom, front, back)
Exceptions
ArgumentExceptionThere are not exactly 6 textures.

Member Function Documentation

static SimpleSkybox OmegaEngine.Graphics.Renderables.SimpleSkybox.FromAssets ( Engine  engine,
string  rt,
string  lf,
string  up,
string  dn,
string  ft,
string  bk 
)
inlinestatic

Creates a new skybox using a cached XTextures (loading new ones if they aren't cached).

Parameters
engineThe Engine providing the cache and rendering capabilities.
rtThe ID of the "right" texture.
lfThe ID of the "left" texture
upThe ID of the "up" texture.
dnThe ID of the "down" texture.
ftThe ID of the "front" texture.
bkThe ID of the "back" texture.
Returns
The skybox that was created.
Exceptions
FileNotFoundExceptionOn of the specified texture files could not be found.
IOExceptionThere was an error reading one of the texture files.
UnauthorizedAccessExceptionRead access to one of the texture files is not permitted.
InvalidDataExceptionOne of the texture files does not contain a valid texture.

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