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

    Class BrushRotationVariator

    Inheritance
    Object
    BaseBrushVariator
    BrushRotationVariator
    Inherited Members
    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.OnModifierUsingMouseWheel(Event, Terrain, IOnSceneGUI)
    BaseBrushVariator.terrainUnderCursor
    BaseBrushVariator.isRaycastHitUnderCursorValid
    BaseBrushVariator.raycastHitUnderCursor
    BaseBrushVariator.canUpdateTerrainUnderCursor
    BaseBrushVariator.LockTerrainUnderCursor(Boolean)
    BaseBrushVariator.UnlockTerrainUnderCursor()
    Namespace: UnityEditor.Experimental.TerrainAPI
    Syntax
    public class BrushRotationVariator : BaseBrushVariator, IBrushTerrainCache, IBrushRotationController, IBrushController

    Constructors

    BrushRotationVariator(String, IBrushEventHandler, IBrushTerrainCache, Boolean)

    Declaration
    public BrushRotationVariator(string toolName, IBrushEventHandler eventHandler, IBrushTerrainCache terrainCache, bool smoothJitter = false)
    Parameters
    Type Name Description
    String toolName
    IBrushEventHandler eventHandler
    IBrushTerrainCache terrainCache
    Boolean smoothJitter

    Properties

    brushRotation

    Declaration
    public float brushRotation { get; set; }
    Property Value
    Type Description
    Single
    Implements
    IBrushRotationController.brushRotation

    currentRotation

    Declaration
    public float currentRotation { get; }
    Property Value
    Type Description
    Single
    Implements
    IBrushRotationController.currentRotation

    isInUse

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

    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)

    GetMouseFollowAngle(RaycastHit)

    Declaration
    public float GetMouseFollowAngle(RaycastHit hit)
    Parameters
    Type Name Description
    RaycastHit hit
    Returns
    Type Description
    Single

    OnBeginModifier()

    Declaration
    protected override bool OnBeginModifier()
    Returns
    Type Description
    Boolean
    Overrides
    BaseBrushVariator.OnBeginModifier()

    OnEndModifier()

    Declaration
    protected override bool OnEndModifier()
    Returns
    Type Description
    Boolean
    Overrides
    BaseBrushVariator.OnEndModifier()

    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)

    OnModifierUsingMouseMove(Event, Terrain, IOnSceneGUI)

    Declaration
    protected override bool OnModifierUsingMouseMove(Event mouseEvent, Terrain terrain, IOnSceneGUI editContext)
    Parameters
    Type Name Description
    Event mouseEvent
    Terrain terrain
    IOnSceneGUI editContext
    Returns
    Type Description
    Boolean
    Overrides
    BaseBrushVariator.OnModifierUsingMouseMove(Event, Terrain, IOnSceneGUI)

    OnPaint(Terrain, IOnPaint)

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

    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)
    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