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

Modifies height-map data in a ITerrain. More...

Inheritance diagram for AlphaFramework.Editor.World.Commands.ModifyHeightMap:
NanoByte::Common::Undo::FirstExecuteCommand NanoByte::Common::Undo::IUndoCommand

Public Member Functions

 ModifyHeightMap (ITerrain terrain, Point offset, byte[,] oldPartialData, byte[,] newPartialData, Action refreshHandler)
 Creates a new command for modifying a rectangular area of the height-map in a ITerrain. More...
 
- Public Member Functions inherited from NanoByte::Common::Undo::FirstExecuteCommand
void Execute ()
 
virtual void Undo ()
 

Protected Member Functions

override void OnFirstExecute ()
 
override void OnRedo ()
 Applies the _newPartialData to ITerrain.HeightMap. More...
 
override void OnUndo ()
 Applies the _oldPartialData to ITerrain.HeightMap. More...
 

Detailed Description

Modifies height-map data in a ITerrain.

Constructor & Destructor Documentation

◆ ModifyHeightMap()

AlphaFramework.Editor.World.Commands.ModifyHeightMap.ModifyHeightMap ( ITerrain  terrain,
Point  offset,
byte  oldPartialData[,],
byte  newPartialData[,],
Action  refreshHandler 
)
inline

Creates a new command for modifying a rectangular area of the height-map in a ITerrain.

Parameters
terrainThe ITerrain to modify.
offsetThe top-left coordinates of the area to modify.
oldPartialDataThe height-map data of the area before it was modified. Do not modify this array after calling this method!
newPartialDataThe height-map data of the area after it was modified. Do not modify this array after calling this method!
refreshHandlerCalled when the presenter needs to be reset.

Member Function Documentation

◆ OnRedo()

override void AlphaFramework.Editor.World.Commands.ModifyHeightMap.OnRedo ( )
inlineprotectedvirtual

Applies the _newPartialData to ITerrain.HeightMap.

Implements NanoByte::Common::Undo::FirstExecuteCommand.

◆ OnUndo()

override void AlphaFramework.Editor.World.Commands.ModifyHeightMap.OnUndo ( )
inlineprotectedvirtual

Applies the _oldPartialData to ITerrain.HeightMap.

Implements NanoByte::Common::Undo::FirstExecuteCommand.


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