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

Loads new height-map data into a Terrain<TTemplate>. More...

Inheritance diagram for AlphaFramework.Editor.World.Commands.ImportHeightMap:
AlphaFramework.Editor.World.Commands.ImportMap< ByteGrid >

Public Member Functions

 ImportHeightMap (ITerrain terrain, string fileName, Action refreshHandler)
 Creates a new command for loading height-map data into a ITerrain. More...
 

Protected Member Functions

override void LoadMap ()
 Loads the height-map data from a file into the ITerrain More...
 
- Protected Member Functions inherited from AlphaFramework.Editor.World.Commands.ImportMap< ByteGrid >
 ImportMap (ITerrain terrain, string fileName, Action refreshHandler)
 Creates a new command for loading map data into a ITerrain. More...
 
override void OnFirstExecute ()
 Imports the map data More...
 
override void OnRedo ()
 Restores the imported map data More...
 
override void OnUndo ()
 Restores the original map data More...
 

Properties

override ByteGrid MapData [get, set]
 Points to ITerrain.HeightMap More...
 
- Properties inherited from AlphaFramework.Editor.World.Commands.ImportMap< ByteGrid >
abstract T MapData [get, set]
 Override to point to the appropriate ITerrain array map More...
 

Additional Inherited Members

- Protected Attributes inherited from AlphaFramework.Editor.World.Commands.ImportMap< ByteGrid >
readonly ITerrain Terrain
 
readonly string FileName
 

Detailed Description

Loads new height-map data into a Terrain<TTemplate>.

Constructor & Destructor Documentation

◆ ImportHeightMap()

AlphaFramework.Editor.World.Commands.ImportHeightMap.ImportHeightMap ( ITerrain  terrain,
string  fileName,
Action  refreshHandler 
)
inline

Creates a new command for loading height-map data into a ITerrain.

Parameters
terrainThe ITerrain to load new height-map data into.
fileNameThe file to load the height-map data from.
refreshHandlerCalled when the presenter needs to be reset.

Member Function Documentation

◆ LoadMap()

override void AlphaFramework.Editor.World.Commands.ImportHeightMap.LoadMap ( )
inlineprotectedvirtual

Loads the height-map data from a file into the ITerrain

Implements AlphaFramework.Editor.World.Commands.ImportMap< ByteGrid >.

Property Documentation

◆ MapData

override ByteGrid AlphaFramework.Editor.World.Commands.ImportHeightMap.MapData
getsetprotected

Points to ITerrain.HeightMap


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