Import API

Classes

struct UmbraSceneId

Opaque scene identifier struct.

struct UmbraMeshHandle

Opaque handle identifying an UmbraMesh.

struct UmbraTextureHandle

Opaque handle identifiying an UmbraTexture.

struct UmbraMesh

3D triangle mesh.

struct UmbraTexture

2D texture data.

struct UmbraTextureDescriptor

Texture sampling parameters.

struct UmbraPointAttribute

Point cloud attribute descriptor.

struct UmbraPointCloud

Point cloud data.

struct UmbraGeoJSON

A GeoJSON string.

struct UmbraMaterial

A material.

struct UmbraObject

A renderable object.

struct UmbraImportSettings

Per-import settings.

struct UmbraSceneProperties

Scene properties to guide the computation.

struct UmbraFileImportParams

File import parameters.

Enums

enum UmbraTriangleFlagBits { UmbraTriangleFlags_MirroredNormalMap = 1 << 0 }

Optional per-triangle flags.

enum UmbraCoordinateSystem { UmbraCoordinateSystem_LocalMeter = 0, UmbraCoordinateSystem_WGS84AngularDegree, UmbraCoordinateSystem_Undefined }

The input coordinate system.

enum UmbraTriangleWinding { UmbraTriangleWinding_CCW = 0, UmbraTriangleWinding_CW, UmbraTriangleWinding_TwoSided }

Triangle winding order.

enum UmbraTextureWrapMode { UmbraTextureWrapMode_Repeat = 0, UmbraTextureWrapMode_Clamp }

Texture wrap mode.

enum UmbraTextureFilterMode { UmbraTextureFilterMode_Point = 0, UmbraTextureFilterMode_Bilinear }

Texture filter mode.

enum UmbraPointAttributeName { UmbraPointAttributeName_X = 0, UmbraPointAttributeName_Y, UmbraPointAttributeName_Z, UmbraPointAttributeName_Intensity, UmbraPointAttributeName_Red, UmbraPointAttributeName_Green, UmbraPointAttributeName_Blue, UmbraPointAttributeName_NormalX, UmbraPointAttributeName_NormalY, UmbraPointAttributeName_NormalZ, UmbraPointAttributeName_Alpha deprecated, UmbraPointAttributeNameCount }

Point cloud point attributes.

enum UmbraContentProfile { UmbraContentProfile_Unknown = 0, UmbraContentProfile_DCC, UmbraContentProfile_Scanned }

Input data category.

enum UmbraImportStatus { UmbraImportStatus_Done = 0, UmbraImportStatus_Running, UmbraImportStatus_OutOfMemoryError, UmbraImportStatus_WriteError, UmbraImportStatus_PermissionError, UmbraImportStatus_LaunchFailed, UmbraImportStatus_LaunchAborted, UmbraImportStatus_UnrecoverableError, UmbraImportStatus_InputReadError, UmbraImportStatus_ComputationParameterError }

Importer status codes.

enum UmbraInputSceneState { UmbraInputSceneState_Ok = 0, UmbraInputSceneState_Blocked, UmbraInputSceneState_Error }

Scene importer status.

enum UmbraInputFileType { UmbraInputFileType_Automatic = 0, UmbraInputFileType_UmbraRepository, UmbraInputFileType_OBJ, UmbraInputFileType_LAS, UmbraInputFileType_XYZ }

Supported standard 3D file formats.

enum UmbraComputationWaitOption { UmbraComputationWaitOption_DontWait = 0, UmbraComputationWaitOption_WaitForStart, UmbraComputationWaitOption_WaitForFinish }

Option on what stage should the import wait before finishing.

Typedefs

typedef struct UmbraImporter UmbraImporter

Opaque Umbra import context struct.

typedef struct UmbraInputScene UmbraInputScene

Opaque input scene struct.

typedef struct UmbraImporterQuery UmbraImporterQuery

Opaque importer query struct.

Functions

UmbraBool UmbraSceneIdIsValid(UmbraSceneId id)

Check if a scene identifier is valid.

void UmbraSceneIdToString(UmbraSceneId id, char str[41])

Convert a scene identifier to a string.

UmbraSceneId UmbraSceneIdFromString(const char str[41])

Convert a string to a scene identifier.

UmbraSceneId UmbraSceneIdInvalid(void)

Create an invalid scene identifier.

UmbraMeshHandle UmbraMeshHandleInvalid(void)

Create an invalid mesh handle.

UmbraTextureHandle UmbraTextureHandleInvalid(void)

Create an invalid texture handle.

void UmbraMeshInit(UmbraMesh* mesh)

Initialize an empty mesh.

UmbraMeshHandle UmbraInsertMesh(UmbraInputScene* scene, const UmbraMesh* mesh)

Add a mesh to a scene.

void UmbraTextureInit(UmbraTexture* texture)

Initialize an empty texture.

void UmbraTextureDescriptorInit(UmbraTextureDescriptor* descriptor)

Initialize a default texture descriptor.

UmbraTextureHandle UmbraInsertTexture(UmbraInputScene* scene, const UmbraTexture* texture)

Add a texture to a scene.

void UmbraPointAttributeInit(UmbraPointAttribute* attribute)

Initialize a default point attribute.

void UmbraPointCloudInit(UmbraPointCloud* pc)

Initialize an empty point cloud.

void UmbraInsertPointCloud(UmbraInputScene* scene, const UmbraPointCloud* pc)

Add a point cloud to a scene.

void UmbraGeoJSONInit(UmbraGeoJSON* geojson)

Initialize an empty GeoJSON string.

void UmbraInsertGeoJSON(UmbraInputScene* scene, const UmbraGeoJSON* geojson)

Add a GeoJSON string to a scene.

void UmbraMaterialInit(UmbraMaterial* material)

Initialize an empty material.

void UmbraObjectInit(UmbraObject*)

Initialize an empty object.

void UmbraInsertObject(UmbraInputScene* scene, const UmbraObject* obj)

Add an object to a scene.

void UmbraInsertScene(UmbraInputScene* scene, UmbraSceneId id)

Add a previously imported scene to a scene.

void UmbraImportSettingsInit(UmbraImportSettings* settings)

Initialize default import settings.

void UmbraScenePropertiesInit(UmbraSceneProperties* properties)

Initialize default scene properties.

UmbraImporter* UmbraCloudImporterCreate(UmbraClient* client, const char* apiKey, const char* name, const UmbraImportSettings* importSettings)

Create an importer context for importing to the Umbra cloud.

void UmbraDestroyImporter(UmbraImporter* importer)

Destroy an import context.

UmbraInputScene* UmbraGetInputScene(UmbraImporter* importer)

Get the import context's input scene.

UmbraInputSceneState UmbraGetInputSceneState(const UmbraInputScene* scene)

Get the input scene's status.

void UmbraImportFromFile(UmbraImporter* importer, UmbraInputFileType type, const char* path, const UmbraFileImportParams* fileImportParams)

Import assets from a file.

void UmbraSetSceneProperties(UmbraImporter* importer, const UmbraSceneProperties* properties)

Set the scene's properties.

void UmbraSetComputationParameterFloat(UmbraImporter* importer, const char* name, double value)

Set a floating point computation parameter.

void UmbraSetComputationParameterBool(UmbraImporter* importer, const char* name, UmbraBool value)

Set a boolean computation parameter.

void UmbraSetComputationParameterInt(UmbraImporter* importer, const char* name, int value)

Set an integer computation parameter.

void UmbraSetComputationParameterString(UmbraImporter* importer, const char* name, const char* value)

Set a text computation parameter.

void UmbraSetComputationParameterFloatArray(UmbraImporter* importer, const char* name, const double values[], int len)

Set a floating point array computation parameter.

void UmbraSetComputationParametersJson(UmbraImporter*, const char* json)

Set many parameters from a JSON string.

UmbraImportStatus UmbraImportFinish(UmbraImporter* importer, UmbraBool block)

Wait for the import to complete.

const char* UmbraImportGetError(const UmbraImporter*)

Get an explanation of the last error returned by UmbraGetInputSceneState.

UmbraSceneId UmbraImportGetSceneId(const UmbraImporter*)

Get the scene's ID.

const char* UmbraImportGetLocator(const UmbraImporter*)

Get the scene's locator.

void toString(char s[41])

Convert a scene identifier to a string.

Enum details

Function details