UxrCanvas Class

Component that, added to a GameObject with a Canvas component, enables interaction using UxrFingerTip components or UxrLaserPointer components.

Inheritance Hierarchy

System.Object
  Object
    Component
      Behaviour
        MonoBehaviour
          UltimateXR.Core.Components.UxrComponent
            UltimateXR.Core.Components.UxrComponent(UxrCanvas)
              UltimateXR.UI.UnityInputModule.UxrCanvas
Namespace: UltimateXR.UI.UnityInputModule
Assembly: UltimateXR (in UltimateXR.dll) Version: 0.0.0.0

Syntax

C#

public class UxrCanvas : UxrComponent<UxrCanvas>


The UxrCanvas type exposes the following members.

Constructors

NameDescription
Public methodUxrCanvas

Properties

NameDescription
Public propertyAutoEnableDistance Gets or sets the distance below which the UxrLaserPointer will automatically show the laser while pointing towards the canvas.
Public propertyAutoEnableLaserPointer Gets or sets whether the UxrLaserPointer components will automatically show their laser while pointing towards the canvas.
Public propertyCanvasInteractionType Gets or sets the type of interaction with the UI components in the canvas.
Public propertyFingerTipMinHoverDistance Gets or sets the distance below which a UxrFingerTip component will generate hovering events.
Public propertyUnityCanvas Gets the Unity Canvas component.

Methods

NameDescription
Public methodIsCompatible Checks if the canvas can be used with the given hand. This allows some canvases to work for the left or right hand only.
Public methodSetupCanvas Sets up the canvas so that it can be used with UxrPointerInputModule.
Protected methodStart Initializes the component. (Overrides UxrComponent.Start().)

Fields

NameDescription
Protected field_allowLeftHand
Protected field_allowRightHand
Protected field_autoEnableDistance
Protected field_autoEnableLaserPointer
Protected field_fingerTipMinHoverDistance
Protected field_interactionType

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.UI.UnityInputModule Namespace