Class BoundedPlaneBuilder

Defines a fluent API for constructing a BoundedPlane.

Inheritance

object

BoundedPlaneBuilder

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: UnityEngine.XR.ARSubsystems

Assembly: Unity.XR.ARSubsystems.dll

Syntax

public class BoundedPlaneBuilder

Constructors

BoundedPlaneBuilder()

Construct an instance.

Declaration

public BoundedPlaneBuilder()

Methods

Build()

Build an output BoundedPlane using all this builder's parameter values.

Declaration

public BoundedPlane Build()

Returns

Type	Description
BoundedPlane	The built BoundedPlane.

Reset()

Reset the instance to default values.

Declaration

public void Reset()

WithAlignment(PlaneAlignment)

Set the plane alignment for built BoundedPlane instances.

Declaration

public BoundedPlaneBuilder WithAlignment(PlaneAlignment alignment)

Parameters

Type	Name	Description
PlaneAlignment	alignment	The plane alignment.

Returns

Type	Description
BoundedPlaneBuilder	This instance.

WithCenter(Vector2)

Set the center for built BoundedPlane instances.

Declaration

public BoundedPlaneBuilder WithCenter(Vector2 center)

Parameters

Type	Name	Description
Vector2	center	The center.

Returns

Type	Description
BoundedPlaneBuilder	This instance.

WithClassifications(PlaneClassifications)

Set the classifications for build BoundedPlane instances.

Declaration

public BoundedPlaneBuilder WithClassifications(PlaneClassifications classifications)

Parameters

Type	Name	Description
PlaneClassifications	classifications	The classifications.

Returns

Type	Description
BoundedPlaneBuilder	This instance.

WithNativePtr(IntPtr)

Set the native pointer for built BoundedPlane instances.

Declaration

public BoundedPlaneBuilder WithNativePtr(IntPtr nativePtr)

Parameters

Type	Name	Description
IntPtr	nativePtr	The native pointer.

Returns

Type	Description
BoundedPlaneBuilder	This instance.

WithParentId(TrackableId)

Set the parent ID for built BoundedPlane instances.

Declaration

public BoundedPlaneBuilder WithParentId(TrackableId parentId)

Parameters

Type	Name	Description
TrackableId	parentId	The parent ID.

Returns

Type	Description
BoundedPlaneBuilder	This instance.

WithPose(Pose)

Set the pose for built BoundedPlane instances.

Declaration

public BoundedPlaneBuilder WithPose(Pose pose)

Parameters

Type	Name	Description
Pose	pose	The pose.

Returns

Type	Description
BoundedPlaneBuilder	This instance.

WithSize(Vector2)

Set the size for built BoundedPlane instances.

Declaration

public BoundedPlaneBuilder WithSize(Vector2 size)

Parameters

Type	Name	Description
Vector2	size	The size.

Returns

Type	Description
BoundedPlaneBuilder	This instance.

WithSubsumedById(TrackableId)

Set the subsumed by ID for built BoundedPlane instances.

Declaration

public BoundedPlaneBuilder WithSubsumedById(TrackableId subsumedById)

Parameters

Type	Name	Description
TrackableId	subsumedById	The subsumed by ID.

Returns

Type	Description
BoundedPlaneBuilder	This instance.

WithTrackableId(TrackableId)

Set the trackable ID for built BoundedPlane instances.

Declaration

public BoundedPlaneBuilder WithTrackableId(TrackableId trackableId)

Parameters

Type	Name	Description
TrackableId	trackableId	The trackable ID.

Returns

Type	Description
BoundedPlaneBuilder	This instance.

WithTrackingState(TrackingState)

Set the tracking state for built BoundedPlane instances.

Declaration

public BoundedPlaneBuilder WithTrackingState(TrackingState trackingState)

Parameters

Type	Name	Description
TrackingState	trackingState	The tracking state.

Returns

Type	Description
BoundedPlaneBuilder	This instance.