SurfaceObserver is the main API portal for spatial mapping functionality in Unity.
Users should create an SurfaceObserver, call Update to generate SurfaceChanged events, call GetMeshAsync for those surfaces that are interesting, and call Dispose when finished with the object.
| SurfaceObserver | Basic constructor for SurfaceObserver. |
| Dispose | Call Dispose when the SurfaceObserver is no longer needed. This will ensure that the object is cleaned up appropriately but will not affect any Meshes, components, or objects returned by RequestMeshAsync. |
| RequestMeshAsync | Call RequestMeshAsync to start the process of baking mesh data for the specified surface. This data may take several frames to create. Baked data will be delivered through the specified SurfaceDataReadyDelegate. This method will throw ArgumentNullExcpetion and ArgumentException if parameters specified in the dataRequest are invalid. |
| SetVolumeAsAxisAlignedBox | This method sets the observation volume as an axis aligned box at the requested location. Successive calls can be used to reshape the observation volume and/or to move it in the scene as needed. Extents are the distance from the center of the box to its edges along each axis. |
| SetVolumeAsFrustum | This method sets the observation volume as a frustum at the requested location. Successive calls can be used to reshape the observation volume and/or to move it in the scene as needed. |
| SetVolumeAsOrientedBox | This method sets the observation volume as an oriented box at the requested location. Successive calls can be used to reshape the observation volume and/or to move it in the scene as needed. Extents are the distance from the center of the box to its edges along each axis. |
| SetVolumeAsSphere | This method sets the observation volume as a sphere at the requested location. Successive calls can be used to reshape the observation volume and/or to move it in the scene as needed. |
| Update | Update generates SurfaceChanged events which are propagated through the specified callback. If no callback is specified, the system will throw an ArgumentNullException. Generated callbacks are synchronous with this call. Scenes containing multiple SurfaceObservers should consider using different callbacks so that events can be properly routed. |
| SurfaceChangedDelegate | The SurfaceChanged delegate handles SurfaceChanged events as generated by calling Update on a SurfaceObserver. Applications can use the bounds, changeType, and updateTime to selectively generate mesh data for the set of known surfaces. |
| SurfaceDataReadyDelegate | The SurfaceDataReadyDelegate handles events generated when the engine has completed generating a mesh. Mesh generation is requested through GetMeshAsync and may take many frames to complete. |
Did you find this page useful? Please give it a rating: