Runtime Scene API

Functions for connecting to Umbra scenes.

Functions

UmbraScene* UmbraSceneCreate(UmbraRuntime* runtime, const char* apiKey, const char* locator)
Create a scene object and connect with the given sdk-concept-api-key and sdk-concept-locator.
UmbraScene* UmbraSceneCreatePublic(UmbraRuntime* runtime, const char* publicLink)
Create a scene from a sdk-concept-public-link.
UmbraScene* UmbraSceneCreateLocal(UmbraRuntime* runtime, const char* path)
Create a scene from a local file or directory.
UmbraConnectionStatus UmbraSceneGetConnectionStatus(UmbraScene* scene)
Get a scene's connection status.
UmbraBool UmbraSceneGetInfo(const UmbraScene* scene, UmbraSceneInfo* info)
Get information about a scene.
void UmbraSceneSetTransform(UmbraScene* scene, const UmbraFloat4_4* transform)
Set a scene's transformation.
void UmbraSceneDestroy(UmbraScene* scene)
Destroy a scene object.

Function details

UmbraScene* UmbraSceneCreate(UmbraRuntime* runtime, const char* apiKey, const char* locator)

Create a scene object and connect with the given sdk-concept-api-key and sdk-concept-locator.

Parameters
runtime in The runtime object.
apiKey in Your API key.
locator in The scene locator.
Returns A new scene object.

UmbraScene* UmbraSceneCreatePublic(UmbraRuntime* runtime, const char* publicLink)

Create a scene from a sdk-concept-public-link.

Parameters
runtime in The runtime object.
publicLink in The public link.
Returns A new scene object.

UmbraScene* UmbraSceneCreateLocal(UmbraRuntime* runtime, const char* path)

Create a scene from a local file or directory.

Parameters
runtime in The runtime object.
path in The path to the scene.
Returns A new scene object.

UmbraConnectionStatus UmbraSceneGetConnectionStatus(UmbraScene* scene)

Get a scene's connection status.

Parameters
scene in The scene.
Returns The scene's connection status.

UmbraBool UmbraSceneGetInfo(const UmbraScene* scene, UmbraSceneInfo* info)

Get information about a scene.

Parameters
scene in The scene.
info out The scene information.
Returns Non-zero on success, zero on failure.

void UmbraSceneSetTransform(UmbraScene* scene, const UmbraFloat4_4* transform)

Set a scene's transformation.

Parameters
scene in The scene object.
transform in The transformation.

void UmbraSceneDestroy(UmbraScene* scene)

Destroy a scene object.

Parameters
scene in The scene.