Scene copy object

Classes

struct UmbraSceneCopyDestination
A structure describing scene copy destination.
struct UmbraSceneCopySource
A structure describing scene copy source.
struct UmbraSceneCopy
Opaque scene copy object.

Enums

enum UmbraSceneCopyStatus { UmbraSceneCopyStatus_InProgress = 0, UmbraSceneCopyStatus_Done, UmbraSceneCopyStatus_Error }
An enumeration of statuses a scene copy object can be in.
enum UmbraSceneCopyDestinationType { UmbraSceneCopyDestinationType_File = 0, UmbraSceneCopyDestinationType_Directory, UmbraSceneCopyDestinationType_Cloud, UmbraSceneCopyDestinationType_FormatObj }
An enumeration of types of destinations a scene copy can copy to.
enum UmbraSceneCopySourceType { UmbraSceneCopySourceType_Directory = 0, UmbraSceneCopySourceType_Cloud }
An enumeration of types of sources a scene copy can copy from.

Functions

UmbraSceneCopy* UmbraSceneCopyCreate(UmbraRuntime* runtime, const UmbraSceneCopyDestination* destination, const UmbraSceneCopySource* source, const UmbraEnvironmentInfo* environment, const UmbraFilterShape* filter)
Creates a scene copy object and and initiates a copy from the destination to the source.
UmbraSceneCopyStatus UmbraSceneCopyGetStatus(UmbraSceneCopy* sceneCopy, float* progress)
Returns the status of the scene copy object.
const char* UmbraSceneCopyGetError(UmbraSceneCopy* sceneCopy)
Returns the error message of the scene copy object.
void UmbraSceneCopyDestroy(UmbraSceneCopy* sceneCopy)
Destroys the scene copy object.

Enum details

enum UmbraSceneCopyStatus

An enumeration of statuses a scene copy object can be in.

Enumerators
UmbraSceneCopyStatus_InProgress

Scene copy is currently in progress.

UmbraSceneCopyStatus_Done

Scene copy finished successfully.

UmbraSceneCopyStatus_Error

Scene copy has failed.

enum UmbraSceneCopyDestinationType

An enumeration of types of destinations a scene copy can copy to.

Enumerators
UmbraSceneCopyDestinationType_File

Scene is copied to a single file.

UmbraSceneCopyDestinationType_Directory

Scene is copied as a set of files in to a single directory.

UmbraSceneCopyDestinationType_Cloud

Scene is copied to a cloud endpoint.

UmbraSceneCopyDestinationType_FormatObj

Scene is copied and saved as a Wavefront OBJ file.

enum UmbraSceneCopySourceType

An enumeration of types of sources a scene copy can copy from.

Enumerators
UmbraSceneCopySourceType_Directory

Scene is copied from a directory.

UmbraSceneCopySourceType_Cloud

Scene is copied from a cloud endpoint.

Function details

UmbraSceneCopy* UmbraSceneCopyCreate(UmbraRuntime* runtime, const UmbraSceneCopyDestination* destination, const UmbraSceneCopySource* source, const UmbraEnvironmentInfo* environment, const UmbraFilterShape* filter)

Creates a scene copy object and and initiates a copy from the destination to the source.

Parameters
runtime in The runtime object used to create the scene copy object.
destination in The pointer to the UmbraSceneCopyDestination structure describing where the scene is copied to.
source in The pointer to the UmbraSceneCopySource structure describing where the scene is copied from.
environment in The pointer to the UmbraEnvironmentInfo structure describing environment parameters.
filter in The pointer to the UmbraFilterShape structure describing what to copy, or NULL if everything is copied.
Returns The pointer to the scene copy object.

UmbraSceneCopyStatus UmbraSceneCopyGetStatus(UmbraSceneCopy* sceneCopy, float* progress)

Returns the status of the scene copy object.

Parameters
sceneCopy in The scene copy object whose status to query.
progress out Where to store the progress, or NULL if ignored.
Returns The copy status of the scene copy object.

const char* UmbraSceneCopyGetError(UmbraSceneCopy* sceneCopy)

Returns the error message of the scene copy object.

Parameters
sceneCopy in The scene copy object whose error message to query.
Returns The error message if UmbraSceneCopyGetStatus returns UmbraSceneCopyStatus_Error, or an empty message otherwise.

void UmbraSceneCopyDestroy(UmbraSceneCopy* sceneCopy)

Destroys the scene copy object.

Parameters
sceneCopy in The scene copy object to destroy.