docs.unity.cn
Search Results for

    Show / Hide Table of Contents

    Interface IXRGrabTransformer

    An interface that allows the target position, rotation, and scale of an XRGrabInteractable to be calculated. The Process(XRGrabInteractable, UpdatePhase, ref Pose, ref Vector3) method is responsible for calculating the pose that the interactable will move to and the scale it will be resized to. Implementers are only responsible for calculating the pose and scale, which is handled and applied by Unity in XRGrabInteractable.

    Namespace: UnityEngine.XR.Interaction.Toolkit.Transformers
    Assembly: solution.dll
    Syntax
    public interface IXRGrabTransformer
    Remarks

    Implementers are encouraged to derive from XRBaseGrabTransformer instead of this interface directly. However, advanced users can use this interface to totally override that behavior.

    Properties

    Name Description
    canProcess

    Whether this grab transformer can process targets. Transformers that can process targets receive calls to Process(XRGrabInteractable, UpdatePhase, ref Pose, ref Vector3), transformers that cannot process do not. Transformers will still have other event methods called to allow for initialization on the frame the grab changes happens.

    Methods

    Name Description
    OnGrab(XRGrabInteractable)

    Called by Unity when the given Interactable is grabbed (in other words, when entering the Select state). This method won't be called again until the Interactable is released by every Interactor. Use this to do any code initialization based on the first Interactor that selects the Interactable.

    OnGrabCountChanged(XRGrabInteractable, Pose, Vector3)

    Called by Unity each time the number of selections changes for the given Interactable while grabbed by at least one Interactor, including when it is first grabbed. Use this to do any code initialization based on each Interactor currently selecting the Interactable, for example computing the initial distance between both Interactors grabbing the object.

    OnLink(XRGrabInteractable)

    Called by Unity when the given Interactable links to this grab transformer. Use this to do any code initialization for the given Interactable.

    OnUnlink(XRGrabInteractable)

    Called by Unity when the given Interactable unlinks from this grab transformer. Use this to do any code cleanup for the given Interactable.

    Process(XRGrabInteractable, UpdatePhase, ref Pose, ref Vector3)

    Called by the linked Interactable to calculate the target pose and scale. Modify the value of targetPose and/or localScale (or neither).

    See Also

    XRBaseGrabTransformer
    XRGrabInteractable
    IXRDropTransformer
    In This Article
    Back to top
    Copyright © 2023 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)