docs.unity3d.com
    Show / Hide Table of Contents

    Class TrackedDeviceGraphicRaycaster

    Custom implementation of for XR Interaction Toolkit. This behavior is used to raycast against a . 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
    TrackedDeviceGraphicRaycaster
    Namespace: UnityEngine.XR.Interaction.Toolkit.UI
    Syntax
    public class TrackedDeviceGraphicRaycaster : BaseRaycaster

    Properties

    blockingMask

    The layers of objects that are checked to determine if they block Graphic raycasts 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 raycasts. 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
    Boolean
    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 raycasts. 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
    Boolean

    eventCamera

    Declaration
    public override Camera eventCamera { get; }
    Property Value
    Type Description
    Camera

    ignoreReversedGraphics

    Whether Graphics facing away from the raycaster are checked for raycasts. Enable this to ignore backfacing Graphics.

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

    raycastTriggerInteraction

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

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

    Methods

    Raycast(PointerEventData, List<RaycastResult>)

    Perform a raycast 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 raycast.

    List<RaycastResult> resultAppendList

    The resultant hits from the raycast.

    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023