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

    Class BrushScatterVariator

    Inheritance
    Object
    BaseBrushVariator
    BrushScatterVariator
    Inherited Members
    BaseBrushVariator.isInUse
    BaseBrushVariator.RequestRepaint()
    BaseBrushVariator.GetEditorPrefs(String, Boolean)
    BaseBrushVariator.SetEditorPrefs(String, Boolean)
    BaseBrushVariator.GetEditorPrefs(String, Single)
    BaseBrushVariator.SetEditorPrefs(String, Single)
    BaseBrushVariator.CalculateMouseDeltaFromInitialPosition(Event, Single)
    BaseBrushVariator.CalculateMouseDelta(Event, Single)
    BaseBrushVariator.OnBeginModifier()
    BaseBrushVariator.OnModifierUsingMouseMove(Event, Terrain, IOnSceneGUI)
    BaseBrushVariator.OnModifierUsingMouseWheel(Event, Terrain, IOnSceneGUI)
    BaseBrushVariator.OnEndModifier()
    BaseBrushVariator.OnPaint(Terrain, IOnPaint)
    BaseBrushVariator.terrainUnderCursor
    BaseBrushVariator.isRaycastHitUnderCursorValid
    BaseBrushVariator.raycastHitUnderCursor
    BaseBrushVariator.canUpdateTerrainUnderCursor
    BaseBrushVariator.LockTerrainUnderCursor(Boolean)
    BaseBrushVariator.UnlockTerrainUnderCursor()
    Namespace: UnityEditor.Experimental.TerrainAPI
    Syntax
    public class BrushScatterVariator : BaseBrushVariator, IBrushTerrainCache, IBrushScatterController, IBrushController

    Constructors

    BrushScatterVariator(String, IBrushEventHandler, IBrushTerrainCache)

    Declaration
    public BrushScatterVariator(string toolName, IBrushEventHandler eventHandler, IBrushTerrainCache terrainCache)
    Parameters
    Type Name Description
    String toolName
    IBrushEventHandler eventHandler
    IBrushTerrainCache terrainCache

    Properties

    brushScatter

    Declaration
    public float brushScatter { get; }
    Property Value
    Type Description
    Single
    Implements
    IBrushScatterController.brushScatter

    Methods

    AppendBrushInfo(Terrain, IOnSceneGUI, StringBuilder)

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

    OnEnterToolMode(BrushShortcutHandler<BrushShortcutType>)

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

    OnExitToolMode(BrushShortcutHandler<BrushShortcutType>)

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

    OnInspectorGUI(Terrain, IOnInspectorGUI)

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

    OnSceneGUI(Event, Int32, Terrain, IOnSceneGUI)

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

    RequestRandomisation()

    Declaration
    public void RequestRandomisation()
    Implements
    IBrushScatterController.RequestRandomisation()

    ScatterBrushStamp(Vector2, Single)

    Declaration
    public Vector2 ScatterBrushStamp(Vector2 uv, float brushSize)
    Parameters
    Type Name Description
    Vector2 uv
    Single brushSize
    Returns
    Type Description
    Vector2
    Implements
    IBrushScatterController.ScatterBrushStamp(Vector2, Single)
    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