Class Height

Namespace

AlphaFramework.Editor.World.TerrainModifiers

Assembly

AlphaFramework.Editor.dll

Abstract base class for interactively changing the height of an area on a ITerrain.

public abstract class Height : Base

Inheritance

object

Base

Height

Derived

HeightNoise

HeightPlateau

HeightShift

HeightSmooth

Inherited Members

Base.OldData

Base.NewData

Base.Terrain

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Extension Methods

XmlStorage.SaveXmlZip<T>(T, Stream, string?, params EmbeddedFile[])

XmlStorage.SaveXmlZip<T>(T, string, string?, params EmbeddedFile[])

XmlStorage.SaveXml<T>(T, Stream, string?)

XmlStorage.SaveXml<T>(T, string, string?)

XmlStorage.ToXmlString<T>(T, string?)

Constructors

Height(ITerrain, Terrain, Action)

Creates a new terrain height modifier.

protected Height(ITerrain terrain, Terrain engineTerrain, Action refreshHandler)

Parameters

terrain ITerrain

The ITerrain to modify.

engineTerrain Terrain

The Terrain to live-update while modifying.

refreshHandler Action

Called when the presenter needs to be reset.

Methods

Apply(Vector2, TerrainBrush)

Applies and accumulates a modification to the Terrain.

public override void Apply(Vector2 terrainCoords, TerrainBrush brush)

Parameters

terrainCoords Vector2

The center coordinates of the area to modify in world space.

brush TerrainBrush

The shape and size of the area around terrainCoords to modify.

GetCommand()

Creates a pre-executed undo command representing the accumulated Apply(Vector2, TerrainBrush) calls to this instance.

public override IUndoCommand GetCommand()

Returns

IUndoCommand

ModifyTerrain(Point, TerrainBrush, byte[,], byte[,])

Modifies the ITerrain and fills arrays with undo/redo data.

protected abstract void ModifyTerrain(Point offset, TerrainBrush brush, byte[,] oldData, byte[,] newData)

Parameters

offset Point

The HeightMap index that corresponds to the top-left corner of the area to modify.

brush TerrainBrush

The shape and size of the area to the lower-right of offset to modify.

oldData byte[,]

An array to be filled with data from HeightMap before the modification. Both dimensions must be equal to Size.

newData byte[,]

An array to be filled with data from HeightMap after the modification. Both dimensions must be equal to Size.