Class DeformWithSurfaceReferenceUserToolStateBase<TBrushTarget, TTerrainLayer, TDataLayer>

Inheritance
object
SmState
UserToolStateBase
HexTerrainUserToolStateBase
BrushUserToolState<TBrushTarget>
BrushUserToolState<TBrushTarget, UserToolSettingsDataSource>
BrushUserToolState<TBrushTarget, UserToolSettingsDataSource, UniversalToolSettingsScreen>
BrushUserToolState<TBrushTarget, UserToolSettingsDataSource, UniversalToolSettingsScreen, TTerrainLayer>
DataLayerBrushUserToolState<TBrushTarget, UserToolSettingsDataSource, UniversalToolSettingsScreen, TTerrainLayer, TDataLayer, float>
DeformUserToolStateBase<TBrushTarget, TTerrainLayer, TDataLayer>
DeformWithSurfaceReferenceUserToolStateBase<TBrushTarget, TTerrainLayer, TDataLayer>
DeformGeoPlastAmountUserToolState
DeformGeoPlastDensityUserToolState
DeformGeoPlastHeatUserToolState
DeformCellMineralsAmountUserToolState
Implements
Inherited Members
Namespace: Fwt.HexTerrains.UserTools.SM.States
Assembly: fwt.hexterrains.dll
Syntax
public abstract class DeformWithSurfaceReferenceUserToolStateBase<TBrushTarget, TTerrainLayer, TDataLayer> : DeformUserToolStateBase<TBrushTarget, TTerrainLayer, TDataLayer>, ISmState where TBrushTarget : HexTerrainLayerGroup where TTerrainLayer : HexTerrainLayer where TDataLayer : CellValueDataLayer<float>
Type Parameters
Name Description
TBrushTarget
TTerrainLayer
TDataLayer

Constructors

DeformWithSurfaceReferenceUserToolStateBase(ISmState)

Declaration
protected DeformWithSurfaceReferenceUserToolStateBase(ISmState parent)
Parameters
Type Name Description
ISmState parent

Properties

DataSourceItemsCount

Amount of DataSource entries this class contributes to the settings screen.

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

IsRestrictCellHeight

Declaration
public bool IsRestrictCellHeight { get; set; }
Property Value
Type Description
bool

MaxSurfaceHeight

Declaration
public float MaxSurfaceHeight { get; set; }
Property Value
Type Description
float

MinSurfaceHeight

Declaration
public float MinSurfaceHeight { get; set; }
Property Value
Type Description
float

SurfaceLayerIndex

Declaration
public int SurfaceLayerIndex { 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()

Initializes the default settings for the current instance. This method is intended to be overridden in derived classes to configure initial values or options as needed.

Declaration
protected override void InitDefaultSettings()
Overrides
Remarks

Override this method in a subclass to provide custom initialization logic for default settings. The base implementation does not perform any actions.

IsCellWithinSurfaceRestrictions(int)

Declaration
protected bool IsCellWithinSurfaceRestrictions(int cellIndex)
Parameters
Type Name Description
int cellIndex
Returns
Type Description
bool

LoadSettings()

Loads configuration settings for the current instance. Derived classes override this method to implement custom settings initialization.

Declaration
protected override void LoadSettings()
Overrides
Remarks

Override this method in a subclass to provide specific logic for loading or initializing settings. This method is called during the setup or initialization phase and does not perform any actions in the base implementation.

SaveSettings()

Saves the current settings to the underlying storage or configuration source.

Declaration
protected override void SaveSettings()
Overrides
Remarks

Override this method in a derived class to implement custom logic for persisting settings. This method does not perform any action in the base implementation.

Implements

Extension Methods