Struct XRPointCloud

Represents the session relative data for the XRDepthSubsystem. XRPointClouds are usually created by GetChanges(Allocator).

Namespace: UnityEngine.XR.ARSubsystems

Syntax

public struct XRPointCloud : ITrackable, IEquatable<XRPointCloud>

Constructors

XRPointCloud(TrackableId, Pose, TrackingState, IntPtr)

Constructs a new XRPointCloud. This is a container for the session-relative data. These are typically created by GetChanges(Allocator).

Declaration

public XRPointCloud(TrackableId trackableId, Pose pose, TrackingState trackingState, IntPtr nativePtr)

Parameters

Type	Name	Description
TrackableId	trackableId	The TrackableId associated with the point cloud.
Pose	pose	The Pose associated with the point cloud.
TrackingState	trackingState	The TrackingState associated with the point cloud.
IntPtr	nativePtr	The native pointer associated with the point cloud.

Properties

defaultValue

Gets a default-initialized XRPointCloud. This may be different from the zero-initialized version, e.g., the pose is Pose.identity instead of zero-initialized.

Declaration

public static XRPointCloud defaultValue { get; }

Property Value

Type	Description
XRPointCloud

nativePtr

Get the native pointer associated with this point cloud.

Declaration

public IntPtr nativePtr { get; }

Property Value

Type	Description
IntPtr

Implements

ITrackable.nativePtr

Remarks

The data this pointer points to is implementation defined.

pose

Get the Pose associated with this point cloud.

Declaration

public Pose pose { get; }

Property Value

Type	Description
Pose

Implements

ITrackable.pose

Remarks

Point cloud points are relative to this pose.

trackableId

Get the TrackableId associated with this point cloud.

Declaration

public TrackableId trackableId { get; }

Property Value

Type	Description
TrackableId

Implements

ITrackable.trackableId

trackingState

Get the TrackingState associated with this point cloud.

Declaration

public TrackingState trackingState { get; }

Property Value

Type	Description
TrackingState

Implements

ITrackable.trackingState

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 XRPointCloud and Equals(XRPointCloud) also returns true; otherwise false.

Overrides

ValueType.Equals(Object)

Equals(XRPointCloud)

Tests for equality.

Declaration

public bool Equals(XRPointCloud other)

Parameters

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

Returns

Type	Description
Boolean	True if every field in other is equal to this XRPointCloud, 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()

Operators

Equality(XRPointCloud, XRPointCloud)

Tests for equality. Same as Equals(XRPointCloud).

Declaration

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

Parameters

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

Returns

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

Inequality(XRPointCloud, XRPointCloud)

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

Declaration

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

Parameters

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

Returns

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