Struct ARPlaneBoundaryChangedEventArgs | Package Manager UI website
docs.unity3d.com
    Show / Hide Table of Contents

    Struct ARPlaneBoundaryChangedEventArgs

    Data associated with an boundaryChanged event.

    Inherited Members
    System.Object.Equals(System.Object, System.Object)
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.GetType()
    Namespace: UnityEngine.XR.ARFoundation
    Syntax
    public struct ARPlaneBoundaryChangedEventArgs : IEquatable<ARPlaneBoundaryChangedEventArgs>

    Constructors

    ARPlaneBoundaryChangedEventArgs(ARPlane, Vector3, Vector3, List<Vector3>)

    Constructor for plane changed events. This is normally only used by the ARPlane component for boundaryChanged events.

    Declaration
    public ARPlaneBoundaryChangedEventArgs(ARPlane plane, Vector3 center, Vector3 normal, List<Vector3> convexBoundary)
    Parameters
    Type Name Description
    ARPlane plane

    The ARPlane that triggered the event.

    Vector3 center

    The center of the plane, in plane-relative space.

    Vector3 normal

    The normal of the plane, in plane-relative space.

    List<Vector3> convexBoundary

    The convex boundary points, in plane-relative space. This may not be null.

    Properties

    center

    The center of the ARPlane, in plane-relative space.

    Declaration
    public Vector3 center { get; set; }
    Property Value
    Type Description
    Vector3

    convexBoundary

    The boundary points of the ARPlane, in plane-relative space.

    Declaration
    public List<Vector3> convexBoundary { get; }
    Property Value
    Type Description
    List<Vector3>
    Remarks

    The boundary points are always convex.

    normal

    The normal of the ARPlane, in plane-relative space.

    Declaration
    public Vector3 normal { get; set; }
    Property Value
    Type Description
    Vector3

    plane

    The ARPlane which triggered the event.

    Declaration
    public ARPlane plane { get; set; }
    Property Value
    Type Description
    ARPlane

    Methods

    Equals(Object)

    Declaration
    public override bool Equals(object obj)
    Parameters
    Type Name Description
    System.Object obj
    Returns
    Type Description
    System.Boolean
    Overrides
    System.ValueType.Equals(System.Object)

    Equals(ARPlaneBoundaryChangedEventArgs)

    Declaration
    public bool Equals(ARPlaneBoundaryChangedEventArgs other)
    Parameters
    Type Name Description
    ARPlaneBoundaryChangedEventArgs other
    Returns
    Type Description
    System.Boolean

    GetHashCode()

    Declaration
    public override int GetHashCode()
    Returns
    Type Description
    System.Int32
    Overrides
    System.ValueType.GetHashCode()

    ToString()

    Declaration
    public override string ToString()
    Returns
    Type Description
    System.String
    Overrides
    System.ValueType.ToString()

    Operators

    Equality(ARPlaneBoundaryChangedEventArgs, ARPlaneBoundaryChangedEventArgs)

    Declaration
    public static bool operator ==(ARPlaneBoundaryChangedEventArgs lhs, ARPlaneBoundaryChangedEventArgs rhs)
    Parameters
    Type Name Description
    ARPlaneBoundaryChangedEventArgs lhs
    ARPlaneBoundaryChangedEventArgs rhs
    Returns
    Type Description
    System.Boolean

    Inequality(ARPlaneBoundaryChangedEventArgs, ARPlaneBoundaryChangedEventArgs)

    Declaration
    public static bool operator !=(ARPlaneBoundaryChangedEventArgs lhs, ARPlaneBoundaryChangedEventArgs rhs)
    Parameters
    Type Name Description
    ARPlaneBoundaryChangedEventArgs lhs
    ARPlaneBoundaryChangedEventArgs rhs
    Returns
    Type Description
    System.Boolean
    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