Class BaseBrushVariator | Terrain Tools | 3.0.2-preview.3
docs.unity3d.com
    Show / Hide Table of Contents

    Class BaseBrushVariator

    Inheritance
    Object
    BaseBrushVariator
    BrushRotationVariator
    BrushScatterVariator
    BrushSizeVariator
    BrushSpacingVariator
    BrushStrengthVariator
    Namespace: UnityEditor.Experimental.TerrainAPI
    Syntax
    public abstract class BaseBrushVariator : IBrushController, IBrushTerrainCache

    Constructors

    BaseBrushVariator(String, IBrushEventHandler, IBrushTerrainCache)

    Declaration
    protected BaseBrushVariator(string toolName, IBrushEventHandler eventHandler, IBrushTerrainCache terrainCache)
    Parameters
    Type Name Description
    String toolName
    IBrushEventHandler eventHandler
    IBrushTerrainCache terrainCache

    Properties

    canUpdateTerrainUnderCursor

    Declaration
    public bool canUpdateTerrainUnderCursor { get; }
    Property Value
    Type Description
    Boolean
    Implements
    IBrushTerrainCache.canUpdateTerrainUnderCursor

    isInUse

    Declaration
    public virtual bool isInUse { get; }
    Property Value
    Type Description
    Boolean
    Implements
    IBrushController.isInUse

    isRaycastHitUnderCursorValid

    Declaration
    public bool isRaycastHitUnderCursorValid { get; }
    Property Value
    Type Description
    Boolean
    Implements
    IBrushTerrainCache.isRaycastHitUnderCursorValid

    raycastHitUnderCursor

    Declaration
    public RaycastHit raycastHitUnderCursor { get; }
    Property Value
    Type Description
    RaycastHit
    Implements
    IBrushTerrainCache.raycastHitUnderCursor

    terrainUnderCursor

    Declaration
    public Terrain terrainUnderCursor { get; }
    Property Value
    Type Description
    Terrain
    Implements
    IBrushTerrainCache.terrainUnderCursor

    Methods

    AppendBrushInfo(Terrain, IOnSceneGUI, StringBuilder)

    Declaration
    public virtual void AppendBrushInfo(Terrain terrain, IOnSceneGUI editContext, StringBuilder builder)
    Parameters
    Type Name Description
    Terrain terrain
    IOnSceneGUI editContext
    StringBuilder builder
    Implements
    IBrushController.AppendBrushInfo(Terrain, IOnSceneGUI, StringBuilder)

    CalculateMouseDelta(Event, Single)

    Declaration
    protected static Vector2 CalculateMouseDelta(Event mouseEvent, float scale = 1F)
    Parameters
    Type Name Description
    Event mouseEvent
    Single scale
    Returns
    Type Description
    Vector2

    CalculateMouseDeltaFromInitialPosition(Event, Single)

    Declaration
    protected Vector2 CalculateMouseDeltaFromInitialPosition(Event mouseEvent, float scale = 1F)
    Parameters
    Type Name Description
    Event mouseEvent
    Single scale
    Returns
    Type Description
    Vector2

    GetEditorPrefs(String, Boolean)

    Declaration
    protected bool GetEditorPrefs(string name, bool defaultValue)
    Parameters
    Type Name Description
    String name
    Boolean defaultValue
    Returns
    Type Description
    Boolean

    GetEditorPrefs(String, Single)

    Declaration
    protected float GetEditorPrefs(string name, float defaultValue)
    Parameters
    Type Name Description
    String name
    Single defaultValue
    Returns
    Type Description
    Single

    LockTerrainUnderCursor(Boolean)

    Declaration
    public void LockTerrainUnderCursor(bool cursorVisible)
    Parameters
    Type Name Description
    Boolean cursorVisible
    Implements
    IBrushTerrainCache.LockTerrainUnderCursor(Boolean)

    OnBeginModifier()

    Declaration
    protected virtual bool OnBeginModifier()
    Returns
    Type Description
    Boolean

    OnEndModifier()

    Declaration
    protected virtual bool OnEndModifier()
    Returns
    Type Description
    Boolean

    OnEnterToolMode(BrushShortcutHandler<BrushShortcutType>)

    Declaration
    public virtual void OnEnterToolMode(BrushShortcutHandler<BrushShortcutType> shortcutHandler)
    Parameters
    Type Name Description
    BrushShortcutHandler<BrushShortcutType> shortcutHandler
    Implements
    IBrushController.OnEnterToolMode(BrushShortcutHandler<BrushShortcutType>)

    OnExitToolMode(BrushShortcutHandler<BrushShortcutType>)

    Declaration
    public virtual void OnExitToolMode(BrushShortcutHandler<BrushShortcutType> shortcutHandler)
    Parameters
    Type Name Description
    BrushShortcutHandler<BrushShortcutType> shortcutHandler
    Implements
    IBrushController.OnExitToolMode(BrushShortcutHandler<BrushShortcutType>)

    OnInspectorGUI(Terrain, IOnInspectorGUI)

    Declaration
    public virtual void OnInspectorGUI(Terrain terrain, IOnInspectorGUI editContext)
    Parameters
    Type Name Description
    Terrain terrain
    IOnInspectorGUI editContext
    Implements
    IBrushController.OnInspectorGUI(Terrain, IOnInspectorGUI)

    OnModifierUsingMouseMove(Event, Terrain, IOnSceneGUI)

    Declaration
    protected virtual bool OnModifierUsingMouseMove(Event mouseEvent, Terrain terrain, IOnSceneGUI editContext)
    Parameters
    Type Name Description
    Event mouseEvent
    Terrain terrain
    IOnSceneGUI editContext
    Returns
    Type Description
    Boolean

    OnModifierUsingMouseWheel(Event, Terrain, IOnSceneGUI)

    Declaration
    protected virtual bool OnModifierUsingMouseWheel(Event mouseEvent, Terrain terrain, IOnSceneGUI editContext)
    Parameters
    Type Name Description
    Event mouseEvent
    Terrain terrain
    IOnSceneGUI editContext
    Returns
    Type Description
    Boolean

    OnPaint(Terrain, IOnPaint)

    Declaration
    public virtual bool OnPaint(Terrain terrain, IOnPaint editContext)
    Parameters
    Type Name Description
    Terrain terrain
    IOnPaint editContext
    Returns
    Type Description
    Boolean
    Implements
    IBrushController.OnPaint(Terrain, IOnPaint)

    OnSceneGUI(Event, Int32, Terrain, IOnSceneGUI)

    Declaration
    public virtual void OnSceneGUI(Event currentEvent, int controlId, Terrain terrain, IOnSceneGUI editContext)
    Parameters
    Type Name Description
    Event currentEvent
    Int32 controlId
    Terrain terrain
    IOnSceneGUI editContext
    Implements
    IBrushController.OnSceneGUI(Event, Int32, Terrain, IOnSceneGUI)

    RequestRepaint()

    Declaration
    protected void RequestRepaint()

    SetEditorPrefs(String, Boolean)

    Declaration
    protected void SetEditorPrefs(string name, bool currentValue)
    Parameters
    Type Name Description
    String name
    Boolean currentValue

    SetEditorPrefs(String, Single)

    Declaration
    protected void SetEditorPrefs(string name, float currentValue)
    Parameters
    Type Name Description
    String name
    Single currentValue

    UnlockTerrainUnderCursor()

    Declaration
    public void UnlockTerrainUnderCursor()
    Implements
    IBrushTerrainCache.UnlockTerrainUnderCursor()
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023