AlphaFramework API  1.0.3
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events
Public Member Functions | Protected Member Functions | List of all members
AlphaFramework.Editor.World.TerrainModifiers.HeightPlateau Class Reference

Interactivley turns a ITerrain area into a plateau (all points have the same height). More...

Inheritance diagram for AlphaFramework.Editor.World.TerrainModifiers.HeightPlateau:
AlphaFramework.Editor.World.TerrainModifiers.Height AlphaFramework.Editor.World.TerrainModifiers.Base

Public Member Functions

 HeightPlateau (ITerrain terrain, OmegaEngine.Graphics.Renderables.Terrain engineTerrain, Action refreshHandler)
 Creates a new terrain plateau creator. More...
 
- Public Member Functions inherited from AlphaFramework.Editor.World.TerrainModifiers.Height
override void Apply (Vector2 terrainCoords, TerrainBrush brush)
 Applies and accumulates a modification to the Terrain.
Parameters
terrainCoordsThe center coordinates of the area to modify in world space.
brushThe shape and size of the area around terrainCoords to modify.

 
override IUndoCommand GetCommand ()
 Creates a pre-executed undo command representing the accumulated Apply calls to this instance.
 

Protected Member Functions

override void ModifyTerrain (Point offset, TerrainBrush brush, byte[,] oldData, byte[,] newData)
 Modifies the ITerrain and fills arrays with undo/redo data.
Parameters
offsetThe ITerrain.HeightMap index that corresponds to the top-left corner of the area to modify.
brushThe shape and size of the area to the lower-right of offset to modify.
oldDataAn array to be filled with data from ITerrain.HeightMap before the modification. Both dimensions must be equal to TerrainBrush.Size.
newDataAn array to be filled with data from ITerrain.HeightMap after the modification. Both dimensions must be equal to TerrainBrush.Size.

 
- Protected Member Functions inherited from AlphaFramework.Editor.World.TerrainModifiers.Height
 Height (ITerrain terrain, Terrain engineTerrain, Action refreshHandler)
 Creates a new terrain height modifier. More...
 
- Protected Member Functions inherited from AlphaFramework.Editor.World.TerrainModifiers.Base
 Base (ITerrain terrain)
 Creates a new Terrain modifier. More...
 

Additional Inherited Members

- Protected Attributes inherited from AlphaFramework.Editor.World.TerrainModifiers.Base
readonly
ExpandableRectangleArray< byte > 
OldData = new ExpandableRectangleArray<byte>()
 Used to collect data as it was before the modifications. More...
 
readonly
ExpandableRectangleArray< byte > 
NewData = new ExpandableRectangleArray<byte>()
 Used to collect data as it is after the modifcations. More...
 
readonly ITerrain Terrain
 The Terrain to modify. More...
 

Detailed Description

Interactivley turns a ITerrain area into a plateau (all points have the same height).

Constructor & Destructor Documentation

AlphaFramework.Editor.World.TerrainModifiers.HeightPlateau.HeightPlateau ( ITerrain  terrain,
OmegaEngine.Graphics.Renderables.Terrain  engineTerrain,
Action  refreshHandler 
)
inline

Creates a new terrain plateau creator.

Parameters
terrainThe ITerrain to modify.
engineTerrainThe OmegaEngine.Graphics.Renderables.Terrain to live-update while modifying.
refreshHandlerCalled when the presenter needs to be reset.

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