Class StampUserToolStateBase<TBrushTarget, TCellData>

Inheritance
object
SmState
UserToolStateBase
BrushUserToolState<TBrushTarget>
BrushUserToolState<TBrushTarget, UserToolSettingsDataSource>
BrushUserToolState<TBrushTarget, UserToolSettingsDataSource, UniversalToolSettingsScreen>
StampUserToolStateBase<TBrushTarget, TCellData>
StampAreaUserToolStateBase<TBrushTarget>
StampCellEntitiesUserToolStateBase<TBrushTarget>
StampCellItemsToolStateBase<TBrushTarget>
StampSurfaceBiomeUserToolStateBase<TBrushTarget>
StampSurfaceHeightUserToolStateBase<TBrushTarget>
Implements
Inherited Members
Namespace: Fwt.HexTerrains.TerrainEditors.UserTools.StateMachines.States
Assembly: fwt.hexterrains.dll
Syntax
public abstract class StampUserToolStateBase<TBrushTarget, TCellData> : BrushUserToolState<TBrushTarget, UserToolSettingsDataSource, UniversalToolSettingsScreen>, ISmState where TBrushTarget : class
Type Parameters
Name Description
TBrushTarget
TCellData

Constructors

StampUserToolStateBase(IHexTerrainAPI)

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

Fields

ReadCellKey

Declaration
public KeyCode ReadCellKey
Field Value
Type Description
KeyCode

StartPaintCellCoord

Declaration
protected int2? StartPaintCellCoord
Field Value
Type Description
int2?

Properties

OriginCellIndex

Declaration
public int? OriginCellIndex { get; }
Property Value
Type Description
int?

OriginCoordinate

Declaration
public int2 OriginCoordinate { get; set; }
Property Value
Type Description
int2

OriginXCoord

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

OriginYCoord

Declaration
public int OriginYCoord { 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

PrepareToRun()

Declaration
public override void PrepareToRun()
Overrides

ReadOriginCellData(int, out TCellData)

Declaration
public abstract bool ReadOriginCellData(int cellIndex, out TCellData cellData)
Parameters
Type Name Description
int cellIndex
TCellData cellData
Returns
Type Description
bool

SetCellDataToTarget(int, TCellData)

Declaration
public abstract bool SetCellDataToTarget(int cellIndex, TCellData cellData)
Parameters
Type Name Description
int cellIndex
TCellData cellData
Returns
Type Description
bool

UpdateBrush()

Declaration
protected override void UpdateBrush()
Overrides

Implements

Extension Methods