Class TrackedDeviceGraphicRaycaster

Custom implementation of UnityEngine.UI.GraphicRaycaster for XR Interaction Toolkit. This behavior is used to ray cast against a Canvas. The Raycaster looks at all Graphics on the canvas and determines if any of them have been hit by a ray from a tracked device.

Inheritance
object
Object
Component
Behaviour
MonoBehaviour
UIBehaviour
BaseRaycaster
TrackedDeviceGraphicRaycaster
Implements
Inherited Members
BaseRaycaster.sortOrderPriority
BaseRaycaster.renderOrderPriority
BaseRaycaster.rootRaycaster
BaseRaycaster.ToString()
BaseRaycaster.OnEnable()
BaseRaycaster.OnCanvasHierarchyChanged()
BaseRaycaster.OnTransformParentChanged()
UIBehaviour.Start()
UIBehaviour.IsActive()
UIBehaviour.OnValidate()
UIBehaviour.Reset()
UIBehaviour.OnRectTransformDimensionsChange()
UIBehaviour.OnBeforeTransformParentChanged()
UIBehaviour.OnDidApplyAnimationProperties()
UIBehaviour.OnCanvasGroupChanged()
UIBehaviour.IsDestroyed()
Object.FindObjectsByType<T>(FindObjectsSortMode)
Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)
Object.FindFirstObjectByType<T>()
Object.FindAnyObjectByType<T>()
Object.FindFirstObjectByType<T>(FindObjectsInactive)
Object.FindAnyObjectByType<T>(FindObjectsInactive)
Namespace: UnityEngine.XR.Interaction.Toolkit.UI
Assembly: Unity.XR.Interaction.Toolkit.dll
Syntax
[AddComponentMenu("Event/Tracked Device Graphic Raycaster", 11)]
[HelpURL("https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit@3.0/api/UnityEngine.XR.Interaction.Toolkit.UI.TrackedDeviceGraphicRaycaster.html")]
public class TrackedDeviceGraphicRaycaster : BaseRaycaster, IPokeStateDataProvider, IMultiPokeStateDataProvider

Properties

blockingMask

The layers of objects that are checked to determine if they block Graphic ray casts when checking for 2D or 3D occlusion.

Declaration
public LayerMask blockingMask { get; set; }
Property Value
Type Description
LayerMask

checkFor2DOcclusion

Whether or not 2D occlusion is checked when performing ray casts. Enable to make Graphics be blocked by 2D objects that exist in front of it.

Declaration
public bool checkFor2DOcclusion { get; set; }
Property Value
Type Description
bool
Remarks

This property has no effect when the project does not include the Physics 2D module.

checkFor3DOcclusion

Whether or not 3D occlusion is checked when performing ray casts. Enable to make Graphics be blocked by 3D objects that exist in front of it.

Declaration
public bool checkFor3DOcclusion { get; set; }
Property Value
Type Description
bool

eventCamera

See BaseRaycaster.eventCamera.

Declaration
public override Camera eventCamera { get; }
Property Value
Type Description
Camera
Overrides
UnityEngine.EventSystems.BaseRaycaster.eventCamera

ignoreReversedGraphics

Whether Graphics facing away from the ray caster are checked for ray casts. Enable this to ignore backfacing Graphics.

Declaration
public bool ignoreReversedGraphics { get; set; }
Property Value
Type Description
bool

pokeStateData

Unity.XR.CoreUtils.Bindings.Variables.IReadOnlyBindableVariable<T> that updates whenever the poke logic state is evaluated.

Declaration
public IReadOnlyBindableVariable<PokeStateData> pokeStateData { get; }
Property Value
Type Description
IReadOnlyBindableVariable<PokeStateData>
See Also

raycastTriggerInteraction

Specifies whether the ray cast should hit Triggers when checking for 3D occlusion.

Declaration
public QueryTriggerInteraction raycastTriggerInteraction { get; set; }
Property Value
Type Description
QueryTriggerInteraction

Methods

Awake()

See MonoBehaviour.Awake.

Declaration
protected override void Awake()
Overrides
UnityEngine.EventSystems.UIBehaviour.Awake()

GetPokeStateDataForTarget(Transform)

Gets the PokeStateData as a Unity.XR.CoreUtils.Bindings.Variables.IReadOnlyBindableVariable<T> for the target transform.

Declaration
public IReadOnlyBindableVariable<PokeStateData> GetPokeStateDataForTarget(Transform target)
Parameters
Type Name Description
Transform target

The target to get the PokeStateData for.
Returns
Type Description
IReadOnlyBindableVariable<PokeStateData>

Returns a Unity.XR.CoreUtils.Bindings.Variables.IReadOnlyBindableVariable<T> for the PokeStateData for the target.

OnDestroy()

See MonoBehaviour.OnDestroy.

Declaration
protected override void OnDestroy()
Overrides
UnityEngine.EventSystems.UIBehaviour.OnDestroy()

OnDisable()

Declaration
protected override void OnDisable()
Overrides
UnityEngine.EventSystems.BaseRaycaster.OnDisable()

OnDrawGizmosSelected()

See MonoBehaviour.

Declaration
[Conditional("UNITY_EDITOR")]
protected void OnDrawGizmosSelected()

Raycast(PointerEventData, List<RaycastResult>)

Performs a ray cast against objects within this Raycaster's domain.

Declaration
public override void Raycast(PointerEventData eventData, List<RaycastResult> resultAppendList)
Parameters
Type Name Description
PointerEventData eventData

Data containing where and how to ray cast.
List<RaycastResult> resultAppendList

The resultant hits from the ray cast.
Overrides

Implements