OmegaEngine API  1.0.3
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events
Public Attributes | Package Functions | Properties | List of all members
OmegaEngine.Graphics.Scene Class Reference

Represents a scene that can be viewed by a Camera. More...

Inheritance diagram for OmegaEngine.Graphics.Scene:
OmegaEngine.EngineElement

Public Attributes

ICollection
< PositionableRenderable
Positionables => _positionables
 All PositionableRenderables contained within this scene. More...
 
ICollection< LightSourceLights => _lights
 All light sources affecting the entities in this scene More...
 
- Public Attributes inherited from OmegaEngine.EngineElement
bool IsEngineSet => _engine != null
 true if the Engine has been set. More...
 

Package Functions

void ActivateLights (View view)
 Must be called before rendering this scene or calling GetEffectiveLights More...
 
void DeactivateLights ()
 To be called after rendering is done - the counterpart to ActivateLights More...
 
LightSource[] GetEffectiveLights (DoubleVector3 position, float radius)
 Returns an array of LightSources effective for this position More...
 

Properties

Skybox Skybox [get, set]
 The current Skybox for this scene 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...
 

Additional Inherited Members

- Public Member Functions inherited from OmegaEngine.EngineElement
void Dispose ()
 
- 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...
 

Detailed Description

Represents a scene that can be viewed by a Camera.

Multiple Views can share one Scene.

See Also
View.Scene

Member Function Documentation

void OmegaEngine.Graphics.Scene.ActivateLights ( View  view)
inlinepackage

Must be called before rendering this scene or calling GetEffectiveLights

Parameters
viewThe View used to render this Scene

Remember to call DeactivateLights when done

void OmegaEngine.Graphics.Scene.DeactivateLights ( )
inlinepackage

To be called after rendering is done - the counterpart to ActivateLights

LightSource [] OmegaEngine.Graphics.Scene.GetEffectiveLights ( DoubleVector3  position,
float  radius 
)
inlinepackage

Returns an array of LightSources effective for this position

Parameters
positionThe position to check for effectiveness of light sources
radiusThe additional search radius to use (usually bounding sphere radius)
Returns
An array of light sources, first all DirectionalLights, then all PointLights

Member Data Documentation

ICollection<LightSource> OmegaEngine.Graphics.Scene.Lights => _lights

All light sources affecting the entities in this scene

ICollection<PositionableRenderable> OmegaEngine.Graphics.Scene.Positionables => _positionables

All PositionableRenderables contained within this scene.

Will be disposed when EngineElement.Dispose is called.

Property Documentation

Skybox OmegaEngine.Graphics.Scene.Skybox
getset

The current Skybox for this scene

Will be disposed when EngineElement.Dispose is called.


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