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

An object that can be Rendered by the Engine. More...

Inheritance diagram for OmegaEngine.Graphics.Renderables.Renderable:
OmegaEngine.EngineElement OmegaEngine.IResetable OmegaEngine.Graphics.Renderables.PositionableRenderable OmegaEngine.Graphics.Renderables.Skybox OmegaEngine.Graphics.Renderables.AnimatedModel OmegaEngine.Graphics.Renderables.CpuParticleSystem OmegaEngine.Graphics.Renderables.GpuParticleSystem OmegaEngine.Graphics.Renderables.Model OmegaEngine.Graphics.Renderables.VertexGroup OmegaEngine.Graphics.Renderables.AdvancedSkybox OmegaEngine.Graphics.Renderables.SimpleSkybox OmegaEngine.Graphics.Renderables.FloatingModel OmegaEngine.Graphics.Renderables.Terrain OmegaEngine.Graphics.Renderables.Water

Public Member Functions

override string ToString ()
 
- Public Member Functions inherited from OmegaEngine.EngineElement
void Dispose ()
 

Protected Member Functions

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...
 
virtual void OnEngineSet ()
 Hook that is calld when Engine is set for the first time. More...
 
virtual void OnDispose ()
 Hook that is called when the object needs to dispose its internal resources. More...
 

Package Functions

virtual void Render (Camera camera, GetLights getLights=null)
 To be called when this object ist to be rendered. More...
 

Properties

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

Action PreRender
 Occurs once per frame before rendering the entity. Will not be executed if the entity is excluded by a culling test. More...
 

Additional Inherited Members

- Public Attributes inherited from OmegaEngine.EngineElement
bool IsEngineSet => _engine != null
 true if the Engine has been set. More...
 

Detailed Description

An object that can be Rendered by the Engine.

Member Function Documentation

void OmegaEngine.Graphics.Renderables.Renderable.PrepareRender ( )
inlineprotected

Should be called before rendering anything - usually called by base constructor

virtual void OmegaEngine.Graphics.Renderables.Renderable.Render ( Camera  camera,
GetLights  getLights = null 
)
inlinepackagevirtual

Property Documentation

int OmegaEngine.Graphics.Renderables.Renderable.Alpha
getset

The level of transparency from 0 (solid) to 255 (invisible), OmegaEngine.EngineState.AlphaChannel, OmegaEngine.EngineState.BinaryAlphaChannel or OmegaEngine.EngineState.AdditivBlending

string OmegaEngine.Graphics.Renderables.Renderable.Name
getset

Text value to make it easier to identify a particular render entity

int OmegaEngine.Graphics.Renderables.Renderable.RenderCount
getset

How many times has this entity been rendered in this frame?

Used to debug culling methods

float OmegaEngine.Graphics.Renderables.Renderable.VisibilityDistance
getset

The maximum distance from which the entity is visible - 0 for infinite

bool OmegaEngine.Graphics.Renderables.Renderable.Visible
getset

Shall the entity be rendered?

bool OmegaEngine.Graphics.Renderables.Renderable.Wireframe = true
getset

Shall this entity be drawn in wireframe-mode? (used for debugging)

Event Documentation

Action OmegaEngine.Graphics.Renderables.Renderable.PreRender

Occurs once per frame before rendering the entity. Will not be executed if the entity is excluded by a culling test.


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