API reference

SpaceLocator Class

Extends MonoBehaviour
Base class to locate space in physical environment for Instant Content Placement Building Block.
See EnvironmentRaycastManager more information for ray-casting on physical environment.

Fields

CustomSize : Vector3
Signature
Vector3 CustomSize
PreferredSurfaceOrientation : SurfaceOrientation
Signature
SurfaceOrientation PreferredSurfaceOrientation
UseCustomSize : bool
Signature
bool UseCustomSize

Protected Properties

MaxRaycastDistance : float
[Get][Set]
Maximum length of raycast ray.
Signature
virtual float MaxRaycastDistance
RaycastOrigin : Transform
[Get][Set]
Origin of raycast ray.
Signature
virtual Transform RaycastOrigin

Properties

OnSpaceLocateCompleted : UnityEvent< Pose, bool >
[Get][Set]
This event will trigger when a suitable space is located within user's physical environment.
Signature
UnityEvent<Pose, bool> OnSpaceLocateCompleted
RaycastHitResult : EnvironmentRaycastHit
[Get]
Resulted raycast hit information.
Signature
EnvironmentRaycastHit RaycastHitResult

Protected Methods

TryLocateSpace ( surfacePose )
Locate a space in physical environment.
Signature
virtual bool TryLocateSpace(out Pose surfacePose)
Parameters
surfacePose: out Pose  Located surface pose data.
Returns
bool  True if a space is located successfully, otherwise, false.

Inner Enum

SurfaceOrientation Enum

Defines different types of surfaces within a user environment.

Enumeration Constants

MemberValue
None
0
Any
1
Vertical
2
HorizontalFaceUp
4
HorizontalFaceDown
8