Struct XRPointCloudData

Represents the data (arrays of positions, confidence values, and identifiers) associated with a point cloud.

Inherited Members

Namespace: UnityEngine.XR.ARSubsystems

Syntax

public struct XRPointCloudData : IEquatable<XRPointCloudData>, IDisposable

Properties

confidenceValues

Confidence values for each point in the point cloud. This array is parallel to positions and identifiers. Use confidenceValues.IsCreated to check if these exist.

Declaration

public NativeArray<float> confidenceValues { get; set; }

Property Value

Type	Description
Unity.Collections.NativeArray<Single>

identifiers

Identifiers for each point in the point cloud. This array is parallel to positions and confidenceValues. Use identifiers.IsCreated to check if these exist.

Declaration

public NativeArray<ulong> identifiers { get; set; }

Property Value

Type	Description
Unity.Collections.NativeArray<UInt64>

Remarks

Identifiers are unique to a particular session, which means you can use the identifier to match a particular point in the point cloud with a previously detected point.

positions

Positions for each point in the point cloud. This array is parallel to confidenceValues and identifiers. Use positions.IsCreated to check if these exist.

Declaration

public NativeArray<Vector3> positions { get; set; }

Property Value

Type	Description
Unity.Collections.NativeArray<UnityEngine.Vector3>

Methods

Dispose()

Checks for the existence of the NativeArrays and disposes them.

Declaration

public void Dispose()

Implements

IDisposable.Dispose()

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

Overrides

ValueType.Equals(Object)

Equals(XRPointCloudData)

Tests for equality.

Declaration

public bool Equals(XRPointCloudData other)

Parameters

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

Returns

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

Implements

IEquatable<T>.Equals(T)

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 of this XRPointCloudData.

Declaration

public override string ToString()

Returns

Type	Description
String	A string representation of this XRPointCloudData.

Overrides

ValueType.ToString()

Operators

Equality(XRPointCloudData, XRPointCloudData)

Tests for equality. Same as Equals(XRPointCloudData).

Declaration

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

Parameters

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

Returns

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

Inequality(XRPointCloudData, XRPointCloudData)

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

Declaration

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

Parameters

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

Returns

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