Struct ARPlaneBoundaryChangedEventArgs

Data associated with an boundaryChanged event.

Namespace: UnityEngine.XR.ARFoundation

Syntax

public struct ARPlaneBoundaryChangedEventArgs : IEquatable<ARPlaneBoundaryChangedEventArgs>

Constructors

ARPlaneBoundaryChangedEventArgs(ARPlane)

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

Declaration

public ARPlaneBoundaryChangedEventArgs(ARPlane plane)

Parameters

Type	Name	Description
ARPlane	plane	The ARPlane that triggered the event.

Exceptions

Type	Condition
ArgumentNullException	Thrown if plane is null.

Properties

plane

The ARPlane which triggered the event.

Declaration

public ARPlane plane { get; }

Property Value

Type	Description
ARPlane

Methods

Equals(Object)

Tests for equality.

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
Object	obj	The object to compare against.

Returns

Type	Description
Boolean	True if obj is of type ARPlaneBoundaryChangedEventArgs and Equals(ARPlaneBoundaryChangedEventArgs) also returns true; otherwise false.

Overrides

ValueType.Equals(Object)

Equals(ARPlaneBoundaryChangedEventArgs)

Tests for equality.

Declaration

public bool Equals(ARPlaneBoundaryChangedEventArgs other)

Parameters

Type	Name	Description
ARPlaneBoundaryChangedEventArgs	other	The other ARPlaneBoundaryChangedEventArgs to compare against.

Returns

Type	Description
Boolean	True if every field in other is equal to this ARPlaneBoundaryChangedEventArgs, otherwise false.

GetHashCode()

Generates a hash suitable for use with containers like HashSet and Dictionary.

Declaration

public override int GetHashCode()

Returns

Type	Description
Int32	A hash code generated from this object's fields.

Overrides

ValueType.GetHashCode()

ToString()

Generates a string representation fo this ARPlaneBoundaryChangedEventArgs.

Declaration

public override string ToString()

Returns

Type	Description
String	A string representation fo this ARPlaneBoundaryChangedEventArgs.

Overrides

ValueType.ToString()

Operators

Equality(ARPlaneBoundaryChangedEventArgs, ARPlaneBoundaryChangedEventArgs)

Tests for equality. Same as Equals(ARPlaneBoundaryChangedEventArgs).

Declaration

public static bool operator ==(ARPlaneBoundaryChangedEventArgs lhs, ARPlaneBoundaryChangedEventArgs rhs)

Parameters

Type	Name	Description
ARPlaneBoundaryChangedEventArgs	lhs	The left-hand side of the comparison.
ARPlaneBoundaryChangedEventArgs	rhs	The right-hand side of the comparison.

Returns

Type	Description
Boolean	True if lhs is equal to rhs, otherwise false.

Inequality(ARPlaneBoundaryChangedEventArgs, ARPlaneBoundaryChangedEventArgs)

Tests for inequality. Same as !Equals(ARPlaneBoundaryChangedEventArgs).

Declaration

public static bool operator !=(ARPlaneBoundaryChangedEventArgs lhs, ARPlaneBoundaryChangedEventArgs rhs)

Parameters

Type	Name	Description
ARPlaneBoundaryChangedEventArgs	lhs	The left-hand side of the comparison.
ARPlaneBoundaryChangedEventArgs	rhs	The right-hand side of the comparison.

Returns

Type	Description
Boolean	True if lhs is not equal to rhs, otherwise false.