Class ToolsMenuButton | Unity Reflect | 1.0.0-preview.11
docs.unity3d.com
    Show / Hide Table of Contents

    Class ToolsMenuButton

    Inheritance
    Object
    ToolsMenuButton
    Namespace: UnityEditor.Experimental.EditorVR.Menus
    Syntax
    public sealed class ToolsMenuButton : MonoBehaviour, IToolsMenuButton, ITooltip, ITooltipPlacement, IUsesSetTooltipVisibility, IFunctionalitySubscriber<IProvidesSetTooltipVisibility>, IUsesFunctionalityInjection, IFunctionalitySubscriber<IProvidesFunctionalityInjection>, IFunctionalitySubscriber

    Properties

    activeButtonCount

    Declaration
    public int activeButtonCount { get; set; }
    Property Value
    Type Description
    Int32

    closeButton

    Declaration
    public Func<bool> closeButton { get; set; }
    Property Value
    Type Description
    Func<Boolean>
    Implements
    IToolsMenuButton.closeButton

    destroy

    Declaration
    public Action destroy { get; }
    Property Value
    Type Description
    Action
    Implements
    IToolsMenuButton.destroy

    gradientPair

    GradientPair should be set with new random gradientPair each time a new Tool is associated with this Button This gradientPair is also used to highlight the input device when appropriate

    Declaration
    public GradientPair gradientPair { get; set; }
    Property Value
    Type Description
    GradientPair

    highlighted

    Declaration
    public bool highlighted { get; set; }
    Property Value
    Type Description
    Boolean
    Implements
    IToolsMenuButton.highlighted

    highlightSingleButton

    Declaration
    public Action<Transform, int, bool> highlightSingleButton { get; set; }
    Property Value
    Type Description
    Action<Transform, Int32, Boolean>

    hoverExit

    Declaration
    public Action hoverExit { set; }
    Property Value
    Type Description
    Action
    Implements
    IToolsMenuButton.hoverExit

    icon

    Declaration
    public Sprite icon { set; }
    Property Value
    Type Description
    Sprite

    iconHighlightedLocalZOffset

    Declaration
    public float iconHighlightedLocalZOffset { set; }
    Property Value
    Type Description
    Single
    Implements
    IToolsMenuButton.iconHighlightedLocalZOffset

    implementsSecondaryButton

    Declaration
    public bool implementsSecondaryButton { set; }
    Property Value
    Type Description
    Boolean
    Implements
    IToolsMenuButton.implementsSecondaryButton

    interactable

    Declaration
    public bool interactable { get; set; }
    Property Value
    Type Description
    Boolean
    Implements
    IToolsMenuButton.interactable

    isActiveTool

    Declaration
    public bool isActiveTool { set; }
    Property Value
    Type Description
    Boolean
    Implements
    IToolsMenuButton.isActiveTool

    isMainMenu

    Declaration
    public bool isMainMenu { get; }
    Property Value
    Type Description
    Boolean

    isSelectionTool

    Declaration
    public bool isSelectionTool { get; }
    Property Value
    Type Description
    Boolean

    maxButtonCount

    Declaration
    public int maxButtonCount { get; set; }
    Property Value
    Type Description
    Int32
    Implements
    IToolsMenuButton.maxButtonCount

    menuOrigin

    Declaration
    public Transform menuOrigin { get; set; }
    Property Value
    Type Description
    Transform

    node

    Declaration
    public Node node { get; set; }
    Property Value
    Type Description
    Node

    openMenu

    Declaration
    public Action<Transform, Transform> openMenu { get; set; }
    Property Value
    Type Description
    Action<Transform, Transform>

    order

    Declaration
    public int order { get; set; }
    Property Value
    Type Description
    Int32
    Implements
    IToolsMenuButton.order

    previewToolDescription

    Declaration
    public string previewToolDescription { get; set; }
    Property Value
    Type Description
    String
    Implements
    IToolsMenuButton.previewToolDescription

    previewToolType

    Type, that if not null, denotes that preview-mode is enabled This is enabled when highlighting a tool on the main menu

    Declaration
    public Type previewToolType { set; }
    Property Value
    Type Description
    Type
    Implements
    IToolsMenuButton.previewToolType

    primaryUIContentContainerLocalScale

    Declaration
    public Vector3 primaryUIContentContainerLocalScale { get; set; }
    Property Value
    Type Description
    Vector3
    Implements
    IToolsMenuButton.primaryUIContentContainerLocalScale

    rayOrigin

    Declaration
    public Transform rayOrigin { get; set; }
    Property Value
    Type Description
    Transform

    secondaryButtonHighlighted

    Declaration
    public bool secondaryButtonHighlighted { get; }
    Property Value
    Type Description
    Boolean
    Implements
    IToolsMenuButton.secondaryButtonHighlighted

    selectHighlightedButton

    Declaration
    public Action<Transform> selectHighlightedButton { get; set; }
    Property Value
    Type Description
    Action<Transform>

    selectTool

    Declaration
    public Action<Type> selectTool { get; set; }
    Property Value
    Type Description
    Action<Type>
    Implements
    IToolsMenuButton.selectTool

    showAllButtons

    Declaration
    public Action<IToolsMenuButton> showAllButtons { set; }
    Property Value
    Type Description
    Action<IToolsMenuButton>
    Implements
    IToolsMenuButton.showAllButtons

    stencilRef

    Declaration
    public byte stencilRef { set; }
    Property Value
    Type Description
    Byte
    Implements
    IToolsMenuButton.stencilRef

    toolButtonActivePosition

    Declaration
    public Vector3 toolButtonActivePosition { get; }
    Property Value
    Type Description
    Vector3

    tooltip

    Declaration
    public ITooltip tooltip { set; }
    Property Value
    Type Description
    ITooltip

    tooltipAlignment

    Declaration
    public TextAlignment tooltipAlignment { get; }
    Property Value
    Type Description
    TextAlignment
    Implements
    ITooltipPlacement.tooltipAlignment

    tooltipSource

    Declaration
    public Transform tooltipSource { get; }
    Property Value
    Type Description
    Transform
    Implements
    ITooltipPlacement.tooltipSource

    tooltipTarget

    Declaration
    public Transform tooltipTarget { get; set; }
    Property Value
    Type Description
    Transform
    Implements
    IToolsMenuButton.tooltipTarget
    ITooltipPlacement.tooltipTarget

    tooltipText

    Declaration
    public string tooltipText { get; }
    Property Value
    Type Description
    String
    Implements
    ITooltip.tooltipText

    tooltipVisible

    Declaration
    public bool tooltipVisible { set; }
    Property Value
    Type Description
    Boolean
    Implements
    IToolsMenuButton.tooltipVisible

    toolType

    Declaration
    public Type toolType { get; set; }
    Property Value
    Type Description
    Type
    Implements
    IToolsMenuButton.toolType

    visibleButtonCount

    Declaration
    public Func<Type, int> visibleButtonCount { get; set; }
    Property Value
    Type Description
    Func<Type, Int32>
    Implements
    IToolsMenuButton.visibleButtonCount

    Events

    hovered

    Declaration
    public event Action hovered
    Event Type
    Type Description
    Action
    Implements
    IToolsMenuButton.hovered

    Explicit Interface Implementations

    IFunctionalitySubscriber<IProvidesSetTooltipVisibility>.provider

    Declaration
    IProvidesSetTooltipVisibility IFunctionalitySubscriber<IProvidesSetTooltipVisibility>.provider { get; set; }
    Returns
    Type Description
    IProvidesSetTooltipVisibility
    Implements
    IFunctionalitySubscriber<TProvider>.provider

    IFunctionalitySubscriber<IProvidesFunctionalityInjection>.provider

    Declaration
    IProvidesFunctionalityInjection IFunctionalitySubscriber<IProvidesFunctionalityInjection>.provider { get; set; }
    Returns
    Type Description
    IProvidesFunctionalityInjection
    Implements
    IFunctionalitySubscriber<TProvider>.provider

    Extension Methods

    IUsesFunctionalityInjectionMethods.InjectFunctionality(IUsesFunctionalityInjection, List<Object>)
    IUsesFunctionalityInjectionMethods.InjectFunctionalitySingle(IUsesFunctionalityInjection, Object)
    IUsesFunctionalityInjectionMethods.InjectPreparedFunctionality(IUsesFunctionalityInjection, List<Object>)
    UsesSetTooltipVisibilityMethods.ShowTooltip(IUsesSetTooltipVisibility, ITooltip, Boolean, Single, ITooltipPlacement, Action)
    UsesSetTooltipVisibilityMethods.HideTooltip(IUsesSetTooltipVisibility, ITooltip, Boolean)
    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