docs.unity3d.com
    Show / Hide Table of Contents

    Interface IXRGroupMember

    An interface that represents an object that can be contained as a member in an IXRInteractionGroup. A Group member can be either an Interactor or another Group. Only one member in a Group can perform interaction at a time.

    Namespace: UnityEngine.XR.Interaction.Toolkit
    Syntax
    public interface IXRGroupMember
    Remarks

    Implementations of this interface must also implement either IXRInteractor or IXRInteractionGroup to be functional within the Group.

    Properties

    containingGroup

    The Interaction Group that contains this member.

    Declaration
    IXRInteractionGroup containingGroup { get; }
    Property Value
    Type Description
    IXRInteractionGroup

    Methods

    OnRegisteringAsGroupMember(IXRInteractionGroup)

    An IXRInteractionGroup calls this method just after this member has been added to the Group's list or just after the Group has registered with the XRInteractionManager. This method is called just before the member is re-registered with the Interaction Manager so that it can be registered as being part of a Group.

    Declaration
    void OnRegisteringAsGroupMember(IXRInteractionGroup group)
    Parameters
    Type Name Description
    IXRInteractionGroup group

    The Interaction Group that this member is now a part of.

    Remarks

    Implementations of this method should ensure that containingGroup returns group after this method is called.

    OnRegisteringAsNonGroupMember()

    An IXRInteractionGroup calls this method just after this member has been removed from the Group's list or before the Group unregisters with the XRInteractionManager. This method is called just before the member is re-registered with the Interaction Manager so that it can be registered as being not part of a Group.

    Declaration
    void OnRegisteringAsNonGroupMember()
    Remarks

    Implementations of this method should ensure that containingGroup returns null after this method is called.

    Extension Methods

    XRGroupMemberExtensions.GetTopLevelContainingGroup(IXRGroupMember)

    See Also

    XRInteractionGroup
    XRBaseInteractor
    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