docs.unity3d.com
    Show / Hide Table of Contents

    Interface IBrushModifierKeyController

    An interface that represent the controller for brush modifier keys.

    Namespace: UnityEditor.TerrainTools
    Syntax
    public interface IBrushModifierKeyController

    Methods

    ModifierActive(BrushModifierKey)

    Checks if the modifier key is active.

    Declaration
    bool ModifierActive(BrushModifierKey k)
    Parameters
    Type Name Description
    BrushModifierKey k

    The modifier key to check.

    Returns
    Type Description
    Boolean

    Returns true when the key is active.

    OnEnterToolMode()

    Defines data when the tool is selected.

    Declaration
    void OnEnterToolMode()

    OnExitToolMode()

    Defines data when the tool is deselected.

    Declaration
    void OnExitToolMode()

    Events

    OnModifierPressed

    Calls the methods in its invocation list when the modifier key is pressed.

    Declaration
    event Action<BrushModifierKey> OnModifierPressed
    Event Type
    Type Description
    Action<BrushModifierKey>

    OnModifierReleased

    Calls the methods in its invocation list when the modifier key is released.

    Declaration
    event Action<BrushModifierKey> OnModifierReleased
    Event Type
    Type Description
    Action<BrushModifierKey>
    Back to top
    Copyright © 2023 Unity Technologies
    • 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 Friday, November 3, 2023