Class PaintAreasUserToolState<TBrushTarget, THexSurface>

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

Constructors

PaintAreasUserToolState(IHexTerrainAPI)

Declaration
protected PaintAreasUserToolState(IHexTerrainAPI userToolAPI)
Parameters
Type Name Description
IHexTerrainAPI userToolAPI

Fields

ReadPropKey

When this key is pressed, click will read terrain item under cursor instead of applying it

Declaration
public KeyCode ReadPropKey
Field Value
Type Description
KeyCode

Properties

CellArea

Declaration
public int CellArea { get; set; }
Property Value
Type Description
int

MaxCellHeight

Declaration
public int MaxCellHeight { get; set; }
Property Value
Type Description
int

MinCellHeight

Declaration
public int MinCellHeight { get; set; }
Property Value
Type Description
int

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

IsAppliedToEveryCellOnMap(int)

Declaration
public override bool IsAppliedToEveryCellOnMap(int brushMode)
Parameters
Type Name Description
int brushMode
Returns
Type Description
bool
Overrides

LoadSettings()

Declaration
protected override void LoadSettings()
Overrides

PrepareToRun()

Declaration
public override void PrepareToRun()
Overrides

ReadCellData(TBrushTarget, int2)

Declaration
protected virtual byte ReadCellData(TBrushTarget brushTarget, int2 cellCoord)
Parameters
Type Name Description
TBrushTarget brushTarget
int2 cellCoord
Returns
Type Description
byte

SaveSettings()

Declaration
protected override void SaveSettings()
Overrides

Implements

Extension Methods