UxrToggleObjectsUsingButtons Class

Component that allows to enable/disable GameObjects based on input from the VR controller buttons.

Inheritance Hierarchy

System.Object
  Object
    Component
      Behaviour
        MonoBehaviour
          UltimateXR.Core.Components.UxrComponent
            UltimateXR.Animation.GameObjects.UxrToggleObjectsUsingButtons
Namespace: UltimateXR.Animation.GameObjects
Assembly: UltimateXR (in UltimateXR.dll) Version: 0.0.0.0

Syntax

C#

public class UxrToggleObjectsUsingButtons : UxrComponent


The UxrToggleObjectsUsingButtons type exposes the following members.

Constructors

NameDescription
Public methodUxrToggleObjectsUsingButtons

Properties

NameDescription
Public propertyButtonsToDisable Gets or sets the button(s) to disable.
Public propertyButtonsToEnable Gets or sets the button(s) used to enable.
Public propertyControllerHand Gets or sets which controller hand is responsible for the input.
Public propertyDisableButtonEvent Gets or sets the button event to disable.
Public propertyEnableButtonEvent Gets or sets the button event to enable.
Public propertyObjectList Gets or sets the object list to enable/disable.

Methods

NameDescription
Protected methodAwake Called at the beginning. Sets the object initial state. (Overrides UxrComponent.Awake().)

Extension Methods

NameDescription
Public Extension MethodCheckSetEnabled Enables/disabled the component if it isn’t enabled already. (Defined by MonoBehaviourExt.)
Public Extension MethodGetOrAddComponent<T> Gets the Component of a given type. If it doesn’t exist, it is added to the GameObject. (Defined by ComponentExt.)
Public Extension MethodGetPathUnderScene Gets the full path under current scene, including all parents, but scene name, for the given component. (Defined by ComponentExt.)
Public Extension MethodGetSceneUid Gets an unique identifier string for the given component. (Defined by ComponentExt.)
Public Extension MethodGetUniqueScenePath 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.)
Public Extension MethodLoopCoroutine Creates a coroutine that simplifies executing a loop during a certain amount of time. (Defined by MonoBehaviourExt.)
Public Extension MethodSafeGetComponentInParent<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.)
Public Extension MethodShowInInspector(Boolean)Overloaded.
Controls whether to show the current object in the inspector. (Defined by ObjectExt.)
Public Extension MethodShowInInspector(Boolean, Boolean)Overloaded.
Controls whether to show the current object in the inspector and whether it is editable. (Defined by ObjectExt.)
Public Extension MethodThrowIfNull Throws an exception if the object is null. (Defined by ObjectExt.)

See Also

Reference

UltimateXR.Animation.GameObjects Namespace