AlphaFramework API  1.0.3
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events
Public Attributes | Properties | List of all members
AlphaFramework.World.Positionables.Water Class Reference

A water plane spanning a certain part of the Terrain{TTemplate}. More...

Inheritance diagram for AlphaFramework.World.Positionables.Water:
AlphaFramework.World.Positionables.Positionable< TCoordinates >

Public Attributes

DoubleVector3 EnginePosition => new DoubleVector3(Position.X, Height, -Position.Y)
 The position of origin for this water in the engine coordinate system. More...
 

Properties

Vector2 Size [get, set]
 The size of the area of the ITerrain this water plane spans. More...
 
float Height [get, set]
 The height of the water above reference zero. More...
 
float TraversableDepth [get, set]
 The maximum depth an EntityBase{TCoordinates,TTemplate} can walk into this water. More...
 
- Properties inherited from AlphaFramework.World.Positionables.Positionable< TCoordinates >
string Name [get, set]
 Used for identification in scripts, debugging, etc. More...
 
TCoordinates Position [get, set]
 The Positionable{TCoordinates}'s position. More...
 

Additional Inherited Members

- Public Member Functions inherited from AlphaFramework.World.Positionables.Positionable< TCoordinates >
override string ToString ()
 
virtual Positionable
< TCoordinates > 
Clone ()
 Creates a deep copy of this Positionable{TCoordinates}. More...
 
- Protected Member Functions inherited from AlphaFramework.World.Positionables.Positionable< TCoordinates >
virtual void OnChanged ()
 To be called when a property relevant for rendering has changed. More...
 
void OnChangedRebuild ()
 To be called when a property has changed that requires visual representations to rebuilt from scratch (usually a template). More...
 
- Events inherited from AlphaFramework.World.Positionables.Positionable< TCoordinates >
Action< Positionable
< TCoordinates > > 
Changed
 Occurs when a property relevant for rendering has changed. More...
 
Action< Positionable
< TCoordinates > > 
ChangedRebuild
 Occurs when a property has changed that requires visual representations to rebuilt from scratch (usually a template). More...
 

Detailed Description

A water plane spanning a certain part of the Terrain{TTemplate}.

Member Data Documentation

DoubleVector3 AlphaFramework.World.Positionables.Water.EnginePosition => new DoubleVector3(Position.X, Height, -Position.Y)

The position of origin for this water in the engine coordinate system.

World X = Engine +X
World Y = Engine -Z
World height = Engine +Y

Property Documentation

float AlphaFramework.World.Positionables.Water.Height
getset

The height of the water above reference zero.

Vector2 AlphaFramework.World.Positionables.Water.Size
getset

The size of the area of the ITerrain this water plane spans.

float AlphaFramework.World.Positionables.Water.TraversableDepth
getset

The maximum depth an EntityBase{TCoordinates,TTemplate} can walk into this water.


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