Class ApplyHeightmapUserToolState<TBrushTarget>

Inheritance
object
SmState
UserToolStateBase
BrushUserToolState<TBrushTarget>
BrushUserToolState<TBrushTarget, UserToolSettingsDataSource>
BrushUserToolState<TBrushTarget, UserToolSettingsDataSource, UniversalToolSettingsScreen>
ApplyHeightmapUserToolState<TBrushTarget>
ApplyGroundHeightmapUserToolState
ApplyWaterHeightmapUserToolState
Implements
Inherited Members
Namespace: Fwt.HexTerrains.TerrainEditors.UserTools.StateMachines.States
Assembly: fwt.hexterrains.dll
Syntax
public abstract class ApplyHeightmapUserToolState<TBrushTarget> : BrushUserToolState<TBrushTarget, UserToolSettingsDataSource, UniversalToolSettingsScreen>, ISmState where TBrushTarget : HexSurfaceLayer
Type Parameters
Name Description
TBrushTarget

Constructors

ApplyHeightmapUserToolState(IHexTerrainAPI)

Declaration
public ApplyHeightmapUserToolState(IHexTerrainAPI userToolAPI)
Parameters
Type Name Description
IHexTerrainAPI userToolAPI

Fields

HeightmapsPalette

Declaration
public List<Texture2D> HeightmapsPalette
Field Value
Type Description
List<Texture2D>

Properties

Heightmap

Returns the current heightmap texture from HeightmapsPalette based on the HeightmapIndex.

Declaration
public Texture2D Heightmap { get; }
Property Value
Type Description
Texture2D

HeightmapIndex

Index of the heightmap in the HeightmapsPalette.

Declaration
public int HeightmapIndex { get; }
Property Value
Type Description
int

Offset

This offset will be added to calculated from heightmap terrain height

Declaration
public int Offset { get; }
Property Value
Type Description
int

Scale

Pixel value from heightmap will be multiplied by this scale value

Declaration
public float Scale { get; }
Property Value
Type Description
float

Methods

ApplyBrush(int, int2, int, TBrushTarget, int)

Applies brush to the brushView. Returns true if changes were applied

Declaration
public override bool ApplyBrush(int brushMode, int2 cellCoord, int cellIndex, TBrushTarget brushTarget, int mouseButton)
Parameters
Type Name Description
int brushMode
int2 cellCoord
int cellIndex
TBrushTarget brushTarget
int mouseButton
Returns
Type Description
bool
Overrides

InitDefaultSettings()

Declaration
protected override void InitDefaultSettings()
Overrides

LoadSettings()

Declaration
protected override void LoadSettings()
Overrides

SaveSettings()

Declaration
protected override void SaveSettings()
Overrides

SetHeightmapsPalette(INativeList<HeightmapsPalette>)

Declaration
public virtual void SetHeightmapsPalette(INativeList<HeightmapsPalette> heightmapsPalette)
Parameters
Type Name Description
INativeList<HeightmapsPalette> heightmapsPalette

Implements

Extension Methods