Hex Terrains Framework
Search Results for

    Show / Hide Table of Contents

    Class PaintCellItemAllDataUserToolStateBase<TBrushTarget, TTerrainLayer, TChunkMeshLayerGroup, TChunkMeshLayer>

    Inheritance
    object
    SmState
    UserToolStateBase
    HexTerrainUserToolStateBase
    BrushUserToolState<TBrushTarget>
    BrushUserToolState<TBrushTarget, UserToolSettingsDataSource>
    BrushUserToolState<TBrushTarget, UserToolSettingsDataSource, UniversalToolSettingsScreen>
    BrushUserToolState<TBrushTarget, UserToolSettingsDataSource, UniversalToolSettingsScreen, TTerrainLayer>
    PaintCellItemUserToolStateBase<TBrushTarget, TTerrainLayer, TChunkMeshLayerGroup, TChunkMeshLayer>
    PaintCellItemAllDataUserToolStateBase<TBrushTarget, TTerrainLayer, TChunkMeshLayerGroup, TChunkMeshLayer>
    PaintCellEntityUserToolState
    PaintCellObjectsUserToolState
    Implements
    ISmState
    Inherited Members
    PaintCellItemUserToolStateBase<TBrushTarget, TTerrainLayer, TChunkMeshLayerGroup, TChunkMeshLayer>.TerrainLayerIndex
    PaintCellItemUserToolStateBase<TBrushTarget, TTerrainLayer, TChunkMeshLayerGroup, TChunkMeshLayer>.ChunkMeshLayerIndex
    PaintCellItemUserToolStateBase<TBrushTarget, TTerrainLayer, TChunkMeshLayerGroup, TChunkMeshLayer>.IsCheckCellHeight
    PaintCellItemUserToolStateBase<TBrushTarget, TTerrainLayer, TChunkMeshLayerGroup, TChunkMeshLayer>.MinCellHeight
    PaintCellItemUserToolStateBase<TBrushTarget, TTerrainLayer, TChunkMeshLayerGroup, TChunkMeshLayer>.MaxCellHeight
    PaintCellItemUserToolStateBase<TBrushTarget, TTerrainLayer, TChunkMeshLayerGroup, TChunkMeshLayer>.IsCheckBiome
    PaintCellItemUserToolStateBase<TBrushTarget, TTerrainLayer, TChunkMeshLayerGroup, TChunkMeshLayer>.MinBiomeIndex
    PaintCellItemUserToolStateBase<TBrushTarget, TTerrainLayer, TChunkMeshLayerGroup, TChunkMeshLayer>.MaxBiomeIndex
    PaintCellItemUserToolStateBase<TBrushTarget, TTerrainLayer, TChunkMeshLayerGroup, TChunkMeshLayer>.DataSourceItemsCount
    PaintCellItemUserToolStateBase<TBrushTarget, TTerrainLayer, TChunkMeshLayerGroup, TChunkMeshLayer>.ReadCellKey
    PaintCellItemUserToolStateBase<TBrushTarget, TTerrainLayer, TChunkMeshLayerGroup, TChunkMeshLayer>.ChunkMeshLayerReference
    PaintCellItemUserToolStateBase<TBrushTarget, TTerrainLayer, TChunkMeshLayerGroup, TChunkMeshLayer>.Init(UserToolStateSettings)
    PaintCellItemUserToolStateBase<TBrushTarget, TTerrainLayer, TChunkMeshLayerGroup, TChunkMeshLayer>.Init<TInitArgs>(TInitArgs)
    PaintCellItemUserToolStateBase<TBrushTarget, TTerrainLayer, TChunkMeshLayerGroup, TChunkMeshLayer>.InitDefaultSettings()
    PaintCellItemUserToolStateBase<TBrushTarget, TTerrainLayer, TChunkMeshLayerGroup, TChunkMeshLayer>.SaveSettings()
    PaintCellItemUserToolStateBase<TBrushTarget, TTerrainLayer, TChunkMeshLayerGroup, TChunkMeshLayer>.LoadSettings()
    PaintCellItemUserToolStateBase<TBrushTarget, TTerrainLayer, TChunkMeshLayerGroup, TChunkMeshLayer>.IsValidCellToPaint(int)
    PaintCellItemUserToolStateBase<TBrushTarget, TTerrainLayer, TChunkMeshLayerGroup, TChunkMeshLayer>.GetCellHeight(int)
    PaintCellItemUserToolStateBase<TBrushTarget, TTerrainLayer, TChunkMeshLayerGroup, TChunkMeshLayer>.GetCellBiome(int)
    PaintCellItemUserToolStateBase<TBrushTarget, TTerrainLayer, TChunkMeshLayerGroup, TChunkMeshLayer>.IsAppliedToEveryCellOnMap(int)
    BrushUserToolState<TBrushTarget, UserToolSettingsDataSource, UniversalToolSettingsScreen, TTerrainLayer>.IsGetLayerByIndex
    BrushUserToolState<TBrushTarget, UserToolSettingsDataSource, UniversalToolSettingsScreen, TTerrainLayer>.TerrainLayerIndex
    BrushUserToolState<TBrushTarget, UserToolSettingsDataSource, UniversalToolSettingsScreen, TTerrainLayer>.IsGetLayerByName
    BrushUserToolState<TBrushTarget, UserToolSettingsDataSource, UniversalToolSettingsScreen, TTerrainLayer>.TerrainLayerName
    BrushUserToolState<TBrushTarget, UserToolSettingsDataSource, UniversalToolSettingsScreen, TTerrainLayer>.ViewModeByLayerIndex
    BrushUserToolState<TBrushTarget, UserToolSettingsDataSource, UniversalToolSettingsScreen, TTerrainLayer>.Init<TInitArgs>(TInitArgs)
    BrushUserToolState<TBrushTarget, UserToolSettingsDataSource, UniversalToolSettingsScreen, TTerrainLayer>.UpdateSettingsScreen()
    BrushUserToolState<TBrushTarget, UserToolSettingsDataSource, UniversalToolSettingsScreen, TTerrainLayer>.OnTerrainLayerChanged()
    BrushUserToolState<TBrushTarget, UserToolSettingsDataSource, UniversalToolSettingsScreen, TTerrainLayer>.UpdateDescriptionAndErrorMessageOnDataSource()
    BrushUserToolState<TBrushTarget, UserToolSettingsDataSource, UniversalToolSettingsScreen, TTerrainLayer>.TrySetViewMode()
    BrushUserToolState<TBrushTarget, UserToolSettingsDataSource, UniversalToolSettingsScreen, TTerrainLayer>.GetViewModeByLayerIndex(int)
    BrushUserToolState<TBrushTarget, UserToolSettingsDataSource, UniversalToolSettingsScreen, TTerrainLayer>.GetTerrainLayer()
    BrushUserToolState<TBrushTarget, UserToolSettingsDataSource, UniversalToolSettingsScreen, TTerrainLayer>.GetTerrainLayer(TBrushTarget)
    BrushUserToolState<TBrushTarget, UserToolSettingsDataSource, UniversalToolSettingsScreen, TTerrainLayer>.GetTerrainLayer(TBrushTarget, int, string)
    BrushUserToolState<TBrushTarget, UserToolSettingsDataSource, UniversalToolSettingsScreen, TTerrainLayer>.GetTerrainLayer(TBrushTarget, int)
    BrushUserToolState<TBrushTarget, UserToolSettingsDataSource, UniversalToolSettingsScreen, TTerrainLayer>.GetTerrainLayer(TBrushTarget, string)
    BrushUserToolState<TBrushTarget, UserToolSettingsDataSource, UniversalToolSettingsScreen>.SettingsScreen
    BrushUserToolState<TBrushTarget, UserToolSettingsDataSource, UniversalToolSettingsScreen>.PrepareToRun()
    BrushUserToolState<TBrushTarget, UserToolSettingsDataSource, UniversalToolSettingsScreen>.PrepareToStop()
    BrushUserToolState<TBrushTarget, UserToolSettingsDataSource, UniversalToolSettingsScreen>.GetSettingsScreen()
    BrushUserToolState<TBrushTarget, UserToolSettingsDataSource, UniversalToolSettingsScreen>.UpdateSettingsScreen()
    BrushUserToolState<TBrushTarget, UserToolSettingsDataSource>.DataSource
    BrushUserToolState<TBrushTarget, UserToolSettingsDataSource>.SettingsPlayerPrefsKeyName
    BrushUserToolState<TBrushTarget, UserToolSettingsDataSource>.PrepareToRun()
    BrushUserToolState<TBrushTarget, UserToolSettingsDataSource>.InitSettings()
    BrushUserToolState<TBrushTarget, UserToolSettingsDataSource>.InitDefaultSettings()
    BrushUserToolState<TBrushTarget, UserToolSettingsDataSource>.PrepareToStop()
    BrushUserToolState<TBrushTarget, UserToolSettingsDataSource>.LoadSettings()
    BrushUserToolState<TBrushTarget, UserToolSettingsDataSource>.SaveSettings()
    BrushUserToolState<TBrushTarget, UserToolSettingsDataSource>.SaveSettingsValue<TValue>(string, TValue)
    BrushUserToolState<TBrushTarget, UserToolSettingsDataSource>.LoadSettingsValue<TValue>(string, TValue)
    BrushUserToolState<TBrushTarget, UserToolSettingsDataSource>.TryLoadSettingsValue<TValue>(string, out TValue)
    BrushUserToolState<TBrushTarget, UserToolSettingsDataSource>.LoadSettingsValueOrDefault<TValue>(string, TValue)
    BrushUserToolState<TBrushTarget>.PrevChangeTimeStamp
    BrushUserToolState<TBrushTarget>.TimeTreshold
    BrushUserToolState<TBrushTarget>.CanChangeBrushSize
    BrushUserToolState<TBrushTarget>.AllowRightMouseButton
    BrushUserToolState<TBrushTarget>.CursorColor
    BrushUserToolState<TBrushTarget>.ChangeModeKey
    BrushUserToolState<TBrushTarget>.ChangeBrushSizeKey
    BrushUserToolState<TBrushTarget>.ChangeOpacityKey
    BrushUserToolState<TBrushTarget>.IncreaseBrushSizeKey
    BrushUserToolState<TBrushTarget>.IncreaseBrushSizeKey2
    BrushUserToolState<TBrushTarget>.DecreaseBrushSizeKey
    BrushUserToolState<TBrushTarget>.DecreaseBrushSizeKey2
    BrushUserToolState<TBrushTarget>.IsTimeTresholdPassed
    BrushUserToolState<TBrushTarget>.BrushSize
    BrushUserToolState<TBrushTarget>.BrushOpacity
    BrushUserToolState<TBrushTarget>.ChangeOpacityMultiplier
    BrushUserToolState<TBrushTarget>.Init<TInitArgs>(TInitArgs)
    BrushUserToolState<TBrushTarget>.SetNewTimestamp()
    BrushUserToolState<TBrushTarget>.PrepareToRun()
    BrushUserToolState<TBrushTarget>.PrepareToStop()
    BrushUserToolState<TBrushTarget>.Tick()
    BrushUserToolState<TBrushTarget>.UpdateBrush()
    BrushUserToolState<TBrushTarget>.TryApplyBrush()
    BrushUserToolState<TBrushTarget>.ApplyToSingleCell(int, int2, int, TBrushTarget, int)
    BrushUserToolState<TBrushTarget>.ApplyBrushToAllCells(int, HexTerrainSettings, TBrushTarget, int)
    BrushUserToolState<TBrushTarget>.ApplyBrushToAllBrushPoints(int, int2, int, HexTerrainSettings, TBrushTarget, int)
    BrushUserToolState<TBrushTarget>.CanBeAppliedToManyPoints(int)
    BrushUserToolState<TBrushTarget>.IsAppliedToEveryCellOnMap(int)
    BrushUserToolState<TBrushTarget>.GetBrushTarget()
    HexTerrainUserToolStateBase.TerrainAPI
    HexTerrainUserToolStateBase.HexTerrainUserToolSettings
    HexTerrainUserToolStateBase.PreviousViewMode
    HexTerrainUserToolStateBase.Init(HexTerrainUserToolStateSettings)
    HexTerrainUserToolStateBase.Init(IHexTerrainAPI)
    HexTerrainUserToolStateBase.Init<TInitArgs>(IHexTerrainAPI, TInitArgs)
    HexTerrainUserToolStateBase.ShowSettingsScreen<TViewData, TScreen>(TViewData)
    HexTerrainUserToolStateBase.GetUIScreen<TScreen>()
    HexTerrainUserToolStateBase.HideSettingsScreen<TScreen>()
    HexTerrainUserToolStateBase.SetupTerrainCursor(bool, int)
    HexTerrainUserToolStateBase.SetupTerrainCursor(bool, int, Color32)
    HexTerrainUserToolStateBase.SetupTerrainCursor(bool, int, Color32, bool)
    HexTerrainUserToolStateBase.SetupTerrainCursor(bool)
    HexTerrainUserToolStateBase.GetTerrainLayer<TLayerGroup, TLayer>(HexTerrainLayerReference)
    HexTerrainUserToolStateBase.TrySetViewMode()
    HexTerrainUserToolStateBase.SetViewMode(SetViewModeRequest)
    HexTerrainUserToolStateBase.TryRestoreViewMode()
    UserToolStateBase.Settings
    UserToolStateBase.Parent
    UserToolStateBase.ParentStateMachine
    UserToolStateBase.UserToolType
    UserToolStateBase.Init(UserToolStateSettings)
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: Fwt.HexTerrains.UserTools.SM.States.CellItems
    Assembly: fwt.hexterrains.dll
    Syntax
    public abstract class PaintCellItemAllDataUserToolStateBase<TBrushTarget, TTerrainLayer, TChunkMeshLayerGroup, TChunkMeshLayer> : PaintCellItemUserToolStateBase<TBrushTarget, TTerrainLayer, TChunkMeshLayerGroup, TChunkMeshLayer>, ISmState where TBrushTarget : HexTerrainLayerGroup where TTerrainLayer : CellItemLayer where TChunkMeshLayerGroup : HexTerrainLayerGroup, IComponentData where TChunkMeshLayer : ChunkMeshLayer
    Type Parameters
    Name Description
    TBrushTarget
    TTerrainLayer
    TChunkMeshLayerGroup
    TChunkMeshLayer

    Constructors

    PaintCellItemAllDataUserToolStateBase(ISmState)

    Declaration
    public PaintCellItemAllDataUserToolStateBase(ISmState parent)
    Parameters
    Type Name Description
    ISmState parent

    Properties

    ItemIndex

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

    ItemPosition

    Declaration
    public virtual Vector3 ItemPosition { get; set; }
    Property Value
    Type Description
    Vector3

    ItemRotation

    Declaration
    public virtual Vector3 ItemRotation { get; set; }
    Property Value
    Type Description
    Vector3

    ItemRotationQuaternion

    Declaration
    public virtual Quaternion ItemRotationQuaternion { get; set; }
    Property Value
    Type Description
    Quaternion

    ItemScale

    Declaration
    public virtual Vector3 ItemScale { get; set; }
    Property Value
    Type Description
    Vector3

    ItemState

    Declaration
    public virtual int ItemState { 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
    BrushUserToolState<TBrushTarget>.ApplyBrush(int, int2, int, TBrushTarget, int)

    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
    PaintCellItemUserToolStateBase<TBrushTarget, TTerrainLayer, TChunkMeshLayerGroup, TChunkMeshLayer>.InitDefaultSettings()
    Remarks

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

    LoadSettings()

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

    Declaration
    protected override void LoadSettings()
    Overrides
    PaintCellItemUserToolStateBase<TBrushTarget, TTerrainLayer, TChunkMeshLayerGroup, TChunkMeshLayer>.LoadSettings()
    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.

    ReadCellData(TTerrainLayer, int2)

    Reads actual data from terrain layer for given cell coordinate.

    Declaration
    protected (int, int, Vector3, Quaternion, Vector3) ReadCellData(TTerrainLayer layer, int2 cellCoord)
    Parameters
    Type Name Description
    TTerrainLayer layer

    terrain layer to read data from

    int2 cellCoord

    coordinate to get data at

    Returns
    Type Description
    (int, int, Vector3, Quaternion, Vector3)

    value at the cell on given terrain layer

    SaveSettings()

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

    Declaration
    protected override void SaveSettings()
    Overrides
    PaintCellItemUserToolStateBase<TBrushTarget, TTerrainLayer, TChunkMeshLayerGroup, TChunkMeshLayer>.SaveSettings()
    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

    ISmState

    Extension Methods

    HashExtensions.GetHashCode_RefType<TValue>(TValue, int)
    Extensions_UnityObject.SmartDestroy(object)
    Extensions_UnityObject.SmartGetComponent<TComponent>(object)
    Extensions_UnityObject.SmartGetGameGameObject(object)
    In this article
    Back to top Generated by DocFX