Class ApplyHeightMapUserToolStateBase<TBrushTarget, TTerrainLayer, TDataLayer>
Inheritance
Implements
Inherited Members
Namespace: Fwt.HexTerrains.UserTools.SM.States
Assembly: fwt.hexterrains.dll
Syntax
public abstract class ApplyHeightMapUserToolStateBase<TBrushTarget, TTerrainLayer, TDataLayer> : DataLayerBrushUserToolState<TBrushTarget, UserToolSettingsDataSource, UniversalToolSettingsScreen, TTerrainLayer, TDataLayer, float>, ISmState where TBrushTarget : HexTerrainLayerGroup where TTerrainLayer : HexTerrainLayer where TDataLayer : CellValueDataLayer<float>Type Parameters
| Name | Description |
|---|---|
| TBrushTarget | |
| TTerrainLayer | |
| TDataLayer |
Constructors
ApplyHeightMapUserToolStateBase(ISmState)
Declaration
protected ApplyHeightMapUserToolStateBase(ISmState parent)Parameters
| Type | Name | Description |
|---|---|---|
| ISmState | parent |
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 |
HeightmapsPalette
Gets or sets the collection of heightmap textures available for use in terrain generation or rendering.
Declaration
public virtual List<Texture2D> HeightmapsPalette { get; set; }Property Value
| Type | Description |
|---|---|
| List<Texture2D> |
Remarks
Each texture in the palette represents a distinct heightmap that can be applied to terrain surfaces. Modifying this collection affects which heightmaps are accessible for selection or processing within the application.
Offset
This offset will be added to one calculated from heightmap
Declaration
public float Offset { get; }Property Value
| Type | Description |
|---|---|
| float |
Scale
Pixel value from heightmap will be multiplied by this scale value
Declaration
public float Scale { get; }Property Value
| Type | Description |
|---|---|
| float |
TerrainLayerIndex
If IsGetLayerByIndex is true, this index is used to get terrain layer from terrain layers list."/>
Declaration
public override int TerrainLayerIndex { get; set; }Property Value
| Type | Description |
|---|---|
| int |
Overrides
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
Init(UserToolStateSettings)
Initializes the tool state with the specified settings.
Declaration
public override void Init(UserToolStateSettings settings)Parameters
| Type | Name | Description |
|---|---|---|
| UserToolStateSettings | settings | The settings to apply to the tool state. Cannot be null. |
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.
Init<TInitArgs>(TInitArgs)
Initializes the tool using the specified initialization arguments.
Declaration
public override void Init<TInitArgs>(TInitArgs args)Parameters
| Type | Name | Description |
|---|---|---|
| TInitArgs | args | The initialization arguments used to configure the tool. If the argument implements IUserToolStateConfig, its ToolSettings are used; otherwise, default settings are applied. |
Type Parameters
| Name | Description |
|---|---|
| TInitArgs | The type of the initialization arguments used to configure the tool. If the type implements IUserToolStateConfig, its ToolSettings will be used; otherwise, default settings are applied. |
Overrides
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.