OmegaEngine API  1.0.3
Static Public Member Functions | Protected Member Functions | Properties | List of all members
OmegaEngine.Graphics.WaterView Class Reference

A SupportView for rendering Water refractions or reflections More...

Inheritance diagram for OmegaEngine.Graphics.WaterView:
OmegaEngine.Graphics.SupportView OmegaEngine.Graphics.TextureView OmegaEngine.Graphics.View OmegaEngine.EngineElement OmegaEngine.IResetable

Static Public Member Functions

static WaterView CreateRefraction (View baseView, DoublePlane refractPlane, float clipTolerance)
 Creates a refraction of a View and adds it to View.ChildViews More...
 
static WaterView CreateReflection (View baseView, DoublePlane reflectPlane, float clipTolerance)
 Creates a reflection of a View and adds it to View.ChildViews More...
 

Protected Member Functions

override bool IsToRender (PositionableRenderable body)
 Checks if a PositionableRenderable is supposed to be rendered in this type of View
 
- Protected Member Functions inherited from OmegaEngine.Graphics.SupportView
 SupportView (View baseView, Camera camera)
 Creates a new support-view More...
 
- Protected Member Functions inherited from OmegaEngine.Graphics.TextureView
 TextureView (Scene scene, Camera camera, Size size)
 Creates a new view for rendering to a texture More...
 
override void ApplyPostShaders (bool sceneOnBackBuffer)
 Applies PostShaders to the output
 
override void OnEngineSet ()
 Hook that is calld when Engine is set for the first time.
 
- Protected Member Functions inherited from OmegaEngine.Graphics.View
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.
 
void PrepareRenderTarget ()
 Prepares a OmegaEngine.Graphics.RenderTarget texture if there is none yet - call as often as you want More...
 
void ShaderToRenderTarget (PostShader shader)
 Updates the OmegaEngine.Graphics.RenderTarget using a PostShader More...
 
virtual void RenderBackground ()
 Renders the back of the Scene More...
 
virtual void RenderBody (PositionableRenderable body)
 Renders a PositionableRenderable from the Scene 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...
 

Properties

bool Reflection [get]
 True if this is a WaterViewSource.ReflectedView, false if this is a WaterViewSource.RefractedView More...
 
- Properties inherited from OmegaEngine.Graphics.TextureView
sealed override int FullAlpha [get, set]
 Not applicable to TextureView More...
 
- Properties inherited from OmegaEngine.Graphics.View
bool RenderedInLastFrame [get]
 Was this view rendered in the this frame? More...
 
string Name [get, set]
 Text value to make it easier to identify a particular view More...
 
Rectangle Area [get, set]
 The screen area this view should fill (all zero for fullscreen) More...
 
bool Visible = true [get, set]
 Shall the scene be rendered? More...
 
bool InvertCull [get, set]
 Cull clockwise instead of counter-clockwise? More...
 
virtual int FullAlpha [get, set]
 The level of transparency from 0 (solid) to 255 (invisible) for the complete scene More...
 
virtual bool Fog [get, set]
 Automatically apply a fog using BackgroundColor and the Cameras clip planes More...
 
virtual bool Lighting = true [get, set]
 Is lighting used in RenderScene? More...
 
Color BackgroundColor [get, set]
 The background color and fog color of this scene - Color.Empty for no background, may use alpha-channel if FullAlpha is not set More...
 
Scene Scene [get]
 The scene containing the PositionableRenderables to be rendered. More...
 
Camera Camera [get, set]
 The camera describing how to look at the 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]
 Indicates whether this object has been disposed and can therefore no longer be used. More...
 

Additional Inherited Members

- Public Member Functions inherited from OmegaEngine.Graphics.TextureView
RenderTarget GetRenderTarget ()
 The texture this view renders to. May change, do not store externally! More...
 
- Public Member Functions inherited from OmegaEngine.Graphics.View
override string ToString ()
 
 View (Scene scene, Camera camera, Rectangle area=new Rectangle())
 Creates a new view for rendering More...
 
 View (Color color)
 Creates a new view for rendering a plain color fullscreen More...
 
Ray PickingRay (Point location)
 Generates a 3D picking ray. More...
 
PositionableRenderable Pick (Point location, out DoubleVector3 position)
 Pick an PositionableRenderable in 3D-space using the mouse More...
 
void SwingCameraTo (Camera target, float duration=1)
 Switches from the current camera view to a new view using a cinematic effect More...
 
void SetupGlow (float blurStrength=3, float glowStrength=1.5f)
 Creates a glow-map of this view and adds it to ChildViews More...
 
void SetupShadow (LightSource light)
 Creates a shadow-map for a LightSource in the Scene More...
 
- Public Member Functions inherited from OmegaEngine.EngineElement
void Dispose ()
 
- Public Attributes inherited from OmegaEngine.Graphics.View
Point AreaCenter
 The center point of Area More...
 
ICollection< TextureViewChildViews => _childViews
 A list of TextureViews that are to be Rendered before this View. Usually only Rendered if a PositionableRenderable in OmegaEngine.Graphics.Scene.Positionables has it listed in PositionableRenderable.RequiredViews. More...
 
ICollection< FloatingModelFloatingModels => _floatingModels
 A list of FloatingModels to be overlayed on top of the Scene. Use this for UI-like elements, e.g. axis-arrows. More...
 
ICollection< PostShaderPostShaders => _postShaders
 A list of post-processing shaders to be applied after rendering the scene More...
 
- Public Attributes inherited from OmegaEngine.EngineElement
bool IsEngineSet => _engine != null
 true if the Engine has been set. More...
 
- Protected Attributes inherited from OmegaEngine.Graphics.SupportView
readonly View BaseView
 The View this one is based upon More...
 
- Protected Attributes inherited from OmegaEngine.Graphics.TextureView
override bool TextureRenderTarget => true
 Does this View render to a texture RenderTarget? true since this is a TextureView. More...
 
- Protected Attributes inherited from OmegaEngine.Graphics.View
bool BackgroundQuadDirty = true
 Does the background qaud need to be recreated? More...
 
RenderTarget RenderTarget
 An alternative surface to render onto instead of the back-buffer More...
 
virtual bool TextureRenderTarget => false
 Does this View render to a texture RenderTarget? Only true for TextureViews. More...
 
- Events inherited from OmegaEngine.Graphics.View
Action< CameraPreRender
 Occurs immediately before the Scene begins rendering. ChildViews will have been rendered already. More...
 

Detailed Description

A SupportView for rendering Water refractions or reflections

Member Function Documentation

◆ CreateReflection()

static WaterView OmegaEngine.Graphics.WaterView.CreateReflection ( View  baseView,
DoublePlane  reflectPlane,
float  clipTolerance 
)
inlinestatic

Creates a reflection of a View and adds it to View.ChildViews

Parameters
baseViewThe View the reflection is based on
reflectPlaneA plane alongside which the view shall be reflected
clipToleranceHow much to shift the clip plane away from the reflect plane
Returns
The new view

◆ CreateRefraction()

static WaterView OmegaEngine.Graphics.WaterView.CreateRefraction ( View  baseView,
DoublePlane  refractPlane,
float  clipTolerance 
)
inlinestatic

Creates a refraction of a View and adds it to View.ChildViews

Parameters
baseViewThe View the refraction is based on
refractPlaneA plane alongside which the view shall be refracted
clipToleranceHow much to shift the clip plane away from the refract plane
Returns
The WaterView representing the refraction

Property Documentation

◆ Reflection

bool OmegaEngine.Graphics.WaterView.Reflection
get

True if this is a WaterViewSource.ReflectedView, false if this is a WaterViewSource.RefractedView


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