WVR Scene¶

These APIs provide the way to access scene DS to manage the system resource of the scene perception and anchors.

#include <wvr/wvr_scene.h>
#include <wvr/wvr_anchor.h>

Contents

Scene Mesh
Spatial Anchor
Cached Anchor
Persisted Anchor
Events

Scene Mesh¶

If you want to use scene mesh related features, you need declare and require the permission wave.permission.GET_SCENE_MESH in AndroidManifest.xml. This permission is belong to dangerous level. Please refer to Android developer guide Request runtime permissions to grant the permission in your application.

<uses-permission android:name="wave.permission.GET_SCENE_MESH" />

Developers should require wave.feature.sceneperception “true” in AndroidManifest.xml to use the following APIs which are related scene perception feature and operation.

<uses-feature
    android:name="wave.feature.sceneperception"
    android:required="true" />

Note

Before using the scene perception feature, the developer must check whether the scene perception feature is supported or not through WVR Supported Features.

Spatial Anchor¶

The following APIs provide developers to create a spatial anchor, an selected point in developers physical environment that will be tracked by the VIVE Wave™ runtime.

Cached Anchor¶

The cached anchor is SLAM tracking map dependent. It will be deleted by VIVE Wave™ runtime once the SLAM map is reset and re-create for this room.

Persisted Anchor¶

The persisted anchor is saved with feature points information around the object and environment, so it exists even the SLAM tracking map is reset and re-create.

Events¶

Once the amount of spatial anchor/cached anchor/persisted anchor changed, the corresponding event will be fired. Check the following event enum WVR_EventType of Types in wvr.h for anchors feature.

1. WVR_EventType_SpatialAnchor_Changed

Once the spatial anchor list has been changed, this event will be fired. The following APIs may cause this event.

WVR_CreateSpatialAnchor

WVR_DestroySpatialAnchor

WVR_CreateSpatialAnchorFromCacheName

WVR_CreateSpatialAnchorFromPersistenceName

2. WVR_EventType_CachedAnchor_Changed

Once the cached spatial anchor list has been changed, this event will be fired. The following APIs may cause this event.

WVR_CacheSpatialAnchor

WVR_UncacheSpatialAnchor

Due to the cached anchors is SLAM tracking map dependent, they will be effected by VIVE Wave™ runtime once the SLAM map is reset and re-create for this room and this event will also be fired.

3. WVR_EventType_PersistedAnchor_Changed

Once the persisted spatial anchor list has been changed, this event will be fired. The following APIs may cause this event.

WVR_PersistSpatialAnchor

WVR_UnpersistSpatialAnchor