docs.unity3d.com
    Show / Hide Table of Contents

    Class FeatureButton

    Class FeatureButton.

    Inheritance
    Object
    UnityEngine.EventSystems.UIBehaviour
    UnityEngine.UI.Selectable
    UnityEngine.UI.Toggle
    FeatureButton
    Inherited Members
    UnityEngine.UI.Toggle.toggleTransition
    UnityEngine.UI.Toggle.graphic
    UnityEngine.UI.Toggle.onValueChanged
    UnityEngine.UI.Toggle.OnValidate()
    UnityEngine.UI.Toggle.Rebuild(UnityEngine.UI.CanvasUpdate)
    UnityEngine.UI.Toggle.LayoutComplete()
    UnityEngine.UI.Toggle.GraphicUpdateComplete()
    UnityEngine.UI.Toggle.OnEnable()
    UnityEngine.UI.Toggle.OnDisable()
    UnityEngine.UI.Toggle.OnDidApplyAnimationProperties()
    UnityEngine.UI.Toggle.SetIsOnWithoutNotify(System.Boolean)
    UnityEngine.UI.Toggle.Start()
    UnityEngine.UI.Toggle.OnSubmit(UnityEngine.EventSystems.BaseEventData)
    UnityEngine.UI.Toggle.UnityEngine.UI.ICanvasElement.get_transform()
    UnityEngine.UI.Toggle.group
    UnityEngine.UI.Toggle.isOn
    UnityEngine.UI.Selectable.s_Selectables
    UnityEngine.UI.Selectable.s_SelectableCount
    UnityEngine.UI.Selectable.m_CurrentIndex
    UnityEngine.UI.Selectable.AllSelectablesNoAlloc(UnityEngine.UI.Selectable[])
    UnityEngine.UI.Selectable.Awake()
    UnityEngine.UI.Selectable.OnCanvasGroupChanged()
    UnityEngine.UI.Selectable.IsInteractable()
    UnityEngine.UI.Selectable.OnTransformParentChanged()
    UnityEngine.UI.Selectable.Reset()
    UnityEngine.UI.Selectable.InstantClearState()
    UnityEngine.UI.Selectable.DoStateTransition(UnityEngine.UI.Selectable.SelectionState, System.Boolean)
    UnityEngine.UI.Selectable.FindSelectable(UnityEngine.Vector3)
    UnityEngine.UI.Selectable.FindSelectableOnLeft()
    UnityEngine.UI.Selectable.FindSelectableOnRight()
    UnityEngine.UI.Selectable.FindSelectableOnUp()
    UnityEngine.UI.Selectable.FindSelectableOnDown()
    UnityEngine.UI.Selectable.OnMove(UnityEngine.EventSystems.AxisEventData)
    UnityEngine.UI.Selectable.IsHighlighted()
    UnityEngine.UI.Selectable.IsPressed()
    UnityEngine.UI.Selectable.OnPointerDown(UnityEngine.EventSystems.PointerEventData)
    UnityEngine.UI.Selectable.OnPointerUp(UnityEngine.EventSystems.PointerEventData)
    UnityEngine.UI.Selectable.OnPointerEnter(UnityEngine.EventSystems.PointerEventData)
    UnityEngine.UI.Selectable.OnPointerExit(UnityEngine.EventSystems.PointerEventData)
    UnityEngine.UI.Selectable.OnSelect(UnityEngine.EventSystems.BaseEventData)
    UnityEngine.UI.Selectable.OnDeselect(UnityEngine.EventSystems.BaseEventData)
    UnityEngine.UI.Selectable.Select()
    UnityEngine.UI.Selectable.allSelectablesArray
    UnityEngine.UI.Selectable.allSelectableCount
    UnityEngine.UI.Selectable.allSelectables
    UnityEngine.UI.Selectable.navigation
    UnityEngine.UI.Selectable.transition
    UnityEngine.UI.Selectable.colors
    UnityEngine.UI.Selectable.spriteState
    UnityEngine.UI.Selectable.animationTriggers
    UnityEngine.UI.Selectable.targetGraphic
    UnityEngine.UI.Selectable.interactable
    UnityEngine.UI.Selectable.image
    UnityEngine.UI.Selectable.animator
    UnityEngine.UI.Selectable.currentSelectionState
    UnityEngine.EventSystems.UIBehaviour.IsActive()
    UnityEngine.EventSystems.UIBehaviour.OnRectTransformDimensionsChange()
    UnityEngine.EventSystems.UIBehaviour.OnBeforeTransformParentChanged()
    UnityEngine.EventSystems.UIBehaviour.OnCanvasHierarchyChanged()
    UnityEngine.EventSystems.UIBehaviour.IsDestroyed()
    Namespace: UnityEngine.Industrial.Configuring.RuntimeUI
    Syntax
    public class FeatureButton : Toggle, IMoveHandler, IPointerDownHandler, IPointerUpHandler, IPointerEnterHandler, IPointerExitHandler, ISelectHandler, IDeselectHandler, IPointerClickHandler, ISubmitHandler, IEventSystemHandler, ICanvasElement, IFeatureButton

    Properties

    Icon

    Gets the icon.

    Declaration
    public Texture2D Icon { get; }
    Property Value
    Type Description
    Texture2D

    The icon.

    Implements
    IFeatureButton.Icon

    Label

    Gets the label.

    Declaration
    public string Label { get; }
    Property Value
    Type Description
    String

    The label.

    Implements
    IFeatureButton.Label

    Methods

    OnDestroy()

    Called when [destroy].

    Declaration
    protected override void OnDestroy()
    Overrides
    UnityEngine.UI.Toggle.OnDestroy()

    OnPointerClick(PointerEventData)

    Called when [pointer click].

    Declaration
    public override void OnPointerClick(PointerEventData eventData)
    Parameters
    Type Name Description
    UnityEngine.EventSystems.PointerEventData eventData

    The event data.

    Overrides
    UnityEngine.UI.Toggle.OnPointerClick(UnityEngine.EventSystems.PointerEventData)

    SetAvailability(FeatureAvailability)

    Sets the availability.

    Declaration
    public void SetAvailability(FeatureAvailability featureAvailability)
    Parameters
    Type Name Description
    FeatureAvailability featureAvailability

    The feature availability.

    Implements
    IFeatureButton.SetAvailability(FeatureAvailability)

    SetDisplayInfo(DisplayInfoContent)

    Sets the display information.

    Declaration
    public void SetDisplayInfo(DisplayInfoContent info)
    Parameters
    Type Name Description
    DisplayInfoContent info

    The information.

    Implements
    IFeatureButton.SetDisplayInfo(DisplayInfoContent)

    SetIcon(Texture2D)

    Sets the icon.

    Declaration
    public void SetIcon(Texture2D icon)
    Parameters
    Type Name Description
    Texture2D icon

    The icon.

    Implements
    IFeatureButton.SetIcon(Texture2D)

    SetKnobVisual()

    Sets the knob visual.

    Declaration
    public void SetKnobVisual()

    SetLabel(String)

    Sets the label.

    Declaration
    public void SetLabel(string label)
    Parameters
    Type Name Description
    String label

    The label.

    Implements
    IFeatureButton.SetLabel(String)

    SetSelected(Boolean)

    Sets the selected.

    Declaration
    public void SetSelected(bool on)
    Parameters
    Type Name Description
    Boolean on

    if set to true [on].

    Implements
    IFeatureButton.SetSelected(Boolean)

    Events

    clicked

    Occurs when [clicked].

    Declaration
    public event Action<bool> clicked
    Event Type
    Type Description
    Action<Boolean>
    Implements
    IFeatureButton.clicked

    selected

    Occurs when [selected].

    Declaration
    public event Action selected
    Event Type
    Type Description
    Action
    Implements
    IFeatureButton.selected

    selectedChanged

    Occurs when "selected" as in the checkbox state has changed.

    Declaration
    public event Action<bool> selectedChanged
    Event Type
    Type Description
    Action<Boolean>
    Implements
    IFeatureButton.selectedChanged
    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