Scene object

Classes

struct UmbraSceneInfo
A structure containing scene information.
struct UmbraScene
Opaque scene object.

Enums

enum UmbraConnectionStatus { UmbraConnectionStatus_Connected = 0, UmbraConnectionStatus_Connecting, UmbraConnectionStatus_ConnectionError }
An enumeration of statuses a scene object can be in.

Functions

UmbraScene* UmbraSceneCreate(UmbraRuntime* runtime, const char* apiKey, const char* locator)
Creates a scene object and uses the api key to connect to the specified locator.
UmbraScene* UmbraSceneCreatePublic(UmbraRuntime* runtime, const char* publicLink)
Creates a scene object and connects to the specified public link.
UmbraScene* UmbraSceneCreateLocal(UmbraRuntime* runtime, const char* path)
Creates a scene object and connects to the specified local path.
UmbraConnectionStatus UmbraSceneGetConnectionStatus(UmbraScene* scene)
Returns the connection status of the scene.
UmbraBool UmbraSceneGetInfo(const UmbraScene* scene, UmbraSceneInfo* info)
Returns the UmbraSceneInfo structure of the scene.
void UmbraSceneSetTransform(UmbraScene* scene, const UmbraFloat4_4* transform)
Sets the new transform matrix to the scene.
void UmbraSceneDestroy(UmbraScene* scene)
Destroys the scene object.

Enum details

enum UmbraConnectionStatus

An enumeration of statuses a scene object can be in.

Enumerators
UmbraConnectionStatus_Connected

Scene is connected.

UmbraConnectionStatus_Connecting

Scene is connecting.

UmbraConnectionStatus_ConnectionError

Scene connection has failed.

Connection can fail due to many reasons, including but not limited to: an incorrect locator, an invalid api key, and a bad network connection.

Function details

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

Creates a scene object and uses the api key to connect to the specified locator.

Parameters
runtime in The runtime object used to create the scene.
apiKey in The api key used to connect to the locator.
locator in The locator to the location of the scene.
Returns The pointer to the opaque scene object.

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

Creates a scene object and connects to the specified public link.

Parameters
runtime in The runtime object used to create the scene.
publicLink in The public link to the location of the scene.
Returns The pointer to the opaque scene object.

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

Creates a scene object and connects to the specified local path.

Parameters
runtime in The runtime object used to create the scene.
path in The path to the location of the scene.
Returns The pointer to the opaque scene object.

UmbraConnectionStatus UmbraSceneGetConnectionStatus(UmbraScene* scene)

Returns the connection status of the scene.

Parameters
scene in The scene object whose connection status to query.
Returns The current connection status of the scene.

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

Returns the UmbraSceneInfo structure of the scene.

Parameters
scene in The scene object whose information to query.
info out Where to store the UmbraSceneInfo structure.
Returns Returns whether or not this function failed.

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

Sets the new transform matrix to the scene.

Parameters
scene in The scene object whose transform to change.
transform in The transform matrix.

void UmbraSceneDestroy(UmbraScene* scene)

Destroys the scene object.

Parameters
scene in The scene object to destroy.