Interface IVRPointer

An interface representing a pointer that can be used by VR input devices.

Namespace: Liminal.SDK.VR.Pointers
Assembly: Liminal.SDK.dll
Syntax
public interface IVRPointer

Properties

| Improve this Doc View Source

CurrentRaycastResult

Gets the current input UnityEngine.EventSystems.RaycastResult.

Declaration
RaycastResult CurrentRaycastResult { get; set; }
Property Value
Type Description
UnityEngine.EventSystems.RaycastResult
| Improve this Doc View Source

DeviceComponent

Gets the IVRDeviceComponent the pointer is bound to.

Declaration
IVRDeviceComponent DeviceComponent { get; }
Property Value
Type Description
IVRDeviceComponent
| Improve this Doc View Source

IsActive

Indicates if the pointer is currently active.

Declaration
bool IsActive { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

Transform

Gets the transform for the origin of the pointer ray.

Declaration
Transform Transform { get; set; }
Property Value
Type Description
UnityEngine.Transform

Methods

| Improve this Doc View Source

Activate()

Activates the pointer.

Declaration
void Activate()
| Improve this Doc View Source

Deactivate()

Deactivates the pointer.

Declaration
void Deactivate()
| Improve this Doc View Source

GetButtonDown()

[Internal use] Indicates if the primary interaction button was pressed.

Declaration
bool GetButtonDown()
Returns
Type Description
System.Boolean

A boolean indicating if the primary interaction button was pressed.
| Improve this Doc View Source

GetButtonUp()

[Internal use] Indicates if the primary interaction button was released.

Declaration
bool GetButtonUp()
Returns
Type Description
System.Boolean

A boolean indicating if the primary interaction button was released.
| Improve this Doc View Source

OnPointerEnter(GameObject)

[Internal use] Executed when the pointer hovers over an interactable GameObject.

Declaration
void OnPointerEnter(GameObject target)
Parameters
Type Name Description
UnityEngine.GameObject target

The GameObject the pointer the pointer entered.
| Improve this Doc View Source

OnPointerExit(GameObject)

[Internal use] Executed when the pointer leaves an interactable GameObject after OnPointerEnter(GameObject) has been executed.

Declaration
void OnPointerExit(GameObject target)
Parameters
Type Name Description
UnityEngine.GameObject target

The GameObject the pointer the pointer exited.

Events

| Improve this Doc View Source

ActiveStateChanged

Raised when the active state of the pointer has changed.

Declaration
event PointerActiveStateChanged ActiveStateChanged
Event Type
Type Description
PointerActiveStateChanged