UxrToggleControlInput Class
Type of UxrControlInput that implements toggle functionality.
Inheritance Hierarchy
System.Object
Object
Component
Behaviour
MonoBehaviour
EventTrigger
UltimateXR.UI.UnityInputModule.Controls.UxrControlInput
UltimateXR.UI.UnityInputModule.Controls.UxrToggleControlInput
Namespace: UltimateXR.UI.UnityInputModule.Controls
Assembly: UltimateXR (in UltimateXR.dll) Version: 0.0.0.0
Syntax
C#
public class UxrToggleControlInput : UxrControlInput
The UxrToggleControlInput type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | UxrToggleControlInput |
Properties
| Name | Description | |
|---|---|---|
 | IsSelected | Gets or sets whether the current toggled state. |
| Text | Gets or sets the text value. If no Text component is configured it will return Empty. |
Methods
| Name | Description | |
|---|---|---|
 | Awake | Sets up the events and initializes the current state. (Overrides UxrControlInput.Awake().) |
| OnClicked | Control was clicked. Toggle state. (Overrides UxrControlInput.OnClicked(PointerEventData).) |
| OnDestroy | Called when the component is destroyed. (Overrides UxrControlInput.OnDestroy().) |
| Reset | Resets the component. (Overrides UxrControlInput.Reset().) |
Events
| Name | Description | |
|---|---|---|
 | Toggled | Event called whenever the state is toggled. |
Extension Methods
| Name | Description | |
|---|---|---|
 | CheckSetEnabled | Enables/disabled the component if it isn’t enabled already. (Defined by MonoBehaviourExt.) |
| GetOrAddComponent<T> | Gets the Component of a given type. If it doesn’t exist, it is added to the GameObject. (Defined by ComponentExt.) |
| GetPathUnderScene | Gets the full path under current scene, including all parents, but scene name, for the given component. (Defined by ComponentExt.) |
| GetSceneUid | Gets an unique identifier string for the given component. (Defined by ComponentExt.) |
| GetUniqueScenePath | Gets an unique path in the scene for the given component. It will include scene name, sibling and component indices to make it unique. (Defined by ComponentExt.) |
| LoopCoroutine | Creates a coroutine that simplifies executing a loop during a certain amount of time. (Defined by MonoBehaviourExt.) |
| SafeGetComponentInParent<T> | Gets the Component of a given type in the GameObject or any of its parents. It also works on prefabs, where regular GetComponentInParent(Type, Boolean) will not work: https://issuetracker.unity3d.com/issues/getcomponentinparent-is-returning-null-when-the-gameobject-is-a-prefab (Defined by ComponentExt.) |
| ShowInInspector(Boolean) | Overloaded. Controls whether to show the current object in the inspector. (Defined by ObjectExt.) |
| ShowInInspector(Boolean, Boolean) | Overloaded. Controls whether to show the current object in the inspector and whether it is editable. (Defined by ObjectExt.) |
| ThrowIfNull | Throws an exception if the object is null. (Defined by ObjectExt.) |