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

A representation of WaterViews used for water refraction and reflections More...

Inheritance diagram for OmegaEngine.Graphics.Renderables.WaterViewSource:

Public Member Functions

void Dispose ()
 Disposes the WaterShaders created for this WaterViewSource More...
 

Static Public Member Functions

static WaterViewSource FromEngine (Engine engine, double height, View baseView, float clipTolerance)
 Gets an existing WaterViewSource if there is one fitting the parameters, otherwise creates a new one More...
 

Public Attributes

readonly double Height
 The height of the Water planes (Y axis) More...
 
readonly View BaseView
 The View the Water planes are shown in More...
 
readonly WaterView RefractedView
 
See Also
WaterView.CreateRefraction

 
readonly WaterView ReflectedView
 
See Also
WaterView.CreateReflection

 
readonly float ClipTolerance
 How far to shift the clip plane along its normal vector to reduce graphical glitches at corners More...
 
readonly WaterShader RefractionOnlyShader
 The WaterShaders used to render these waters More...
 

Static Public Attributes

static Vector3 UpVector = new Vector3(0, 1, 0)
 A vector indicating the up-direction More...
 

Package Functions

void ReleaseReference ()
 Decrements the ReferenceCount by one. More...
 

Properties

int ReferenceCount [get, set]
 How many Waters use this WaterViewSource More...
 

Detailed Description

A representation of WaterViews used for water refraction and reflections

Member Function Documentation

void OmegaEngine.Graphics.Renderables.WaterViewSource.Dispose ( )
inline

Disposes the WaterShaders created for this WaterViewSource

static WaterViewSource OmegaEngine.Graphics.Renderables.WaterViewSource.FromEngine ( Engine  engine,
double  height,
View  baseView,
float  clipTolerance 
)
inlinestatic

Gets an existing WaterViewSource if there is one fitting the parameters, otherwise creates a new one

Parameters
engineThe Engine to create the views in
heightThe height of the Water planes (Y axis)
baseViewThe View the Water planes are shown in
clipToleranceHow far to shift the clip plane along its normal vector to reduce graphical glitches at corners
Returns
A WaterViewSource fitting the parameters
See Also
Engine.WaterViewSources
void OmegaEngine.Graphics.Renderables.WaterViewSource.ReleaseReference ( )
inlinepackage

Decrements the ReferenceCount by one.

Member Data Documentation

readonly View OmegaEngine.Graphics.Renderables.WaterViewSource.BaseView

The View the Water planes are shown in

readonly float OmegaEngine.Graphics.Renderables.WaterViewSource.ClipTolerance

How far to shift the clip plane along its normal vector to reduce graphical glitches at corners

readonly double OmegaEngine.Graphics.Renderables.WaterViewSource.Height

The height of the Water planes (Y axis)

readonly WaterShader OmegaEngine.Graphics.Renderables.WaterViewSource.RefractionOnlyShader

The WaterShaders used to render these waters

Vector3 OmegaEngine.Graphics.Renderables.WaterViewSource.UpVector = new Vector3(0, 1, 0)
static

A vector indicating the up-direction

Property Documentation

int OmegaEngine.Graphics.Renderables.WaterViewSource.ReferenceCount
getsetpackage

How many Waters use this WaterViewSource

When this hits zero you can call Dispose


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