Umbra::Scene class

A scene is an umbrafied dataset.

This corresponds to a single version of a Model (ModelVersion) in the project API

Public types

enum ConnectionStatus { Connected = 0, Connecting, ConnectionError }
State of scene/data connection.

Constructors, destructors, conversion operators

~Scene() virtual

Public functions

void connect(const char* credentials, const ProjectContext& model) pure virtual
Connect to an online Umbra scene data repository.
void connect(const char* localPath) pure virtual
Connect to a local Umbra scene data repository.
auto connectionStatus(char* err, int errLen) -> ConnectionStatus pure virtual
Query current connection status.
auto getSceneInfo(SceneInfo& info) -> bool pure virtual
Query scene metadata.
void update(const Float4_4& transform) pure virtual
Change the transform of the scene.

Enum details

enum Umbra::Scene::ConnectionStatus

State of scene/data connection.

A scene starts out without an association to any data and must be connected to do anything

Enumerators
Connected
Connecting
ConnectionError

Function details

void Umbra::Scene::connect(const char* credentials, const ProjectContext& model) pure virtual

Connect to an online Umbra scene data repository.

Parameters
credentials Cloud Token for a user with rights to read the given project/model
model Project/Model identifier. The latest version of the model will be loaded

void Umbra::Scene::connect(const char* localPath) pure virtual

Connect to a local Umbra scene data repository.

Parameters
localPath Path to scene data

A local scene copy can be acquired with Runtime::copyScene

ConnectionStatus Umbra::Scene::connectionStatus(char* err, int errLen) pure virtual

Query current connection status.

Update and query connection status. Connection status must be queried until success or failure is reported, a connection in progress will not complete by waiting without querying.