AlphaFramework API  1.0.3
Public Member Functions | Protected Member Functions | List of all members
AlphaFramework.Editor.World.TerrainModifiers.HeightShift Class Reference

Interactivley raises or lowers all points of an area on a ITerrain. More...

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

Public Member Functions

 HeightShift (ITerrain terrain, OmegaEngine.Graphics.Renderables.Terrain engineTerrain, Action refreshHandler, short diff)
 Creates a new terrain height shifter. 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.
 
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.
 
- 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 raises or lowers all points of an area on a ITerrain.

Constructor & Destructor Documentation

◆ HeightShift()

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

Creates a new terrain height shifter.

Parameters
terrainThe ITerrain to modify.
engineTerrainThe OmegaEngine.Graphics.Renderables.Terrain to live-update while modifying.
refreshHandlerCalled when the presenter needs to be reset.
diffThe value by which the terrain height is to be shifted.

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