Simplygon Subsystem for C++ ​

Subsystem Methods ​

Subsystem Properties ​

Data structs ​

Enums ​

Functions details ​

IsTaskResultAvailable ​

Checks if the task with the given task id has completed and if its result is available to fetch.

bool IsTaskResultAvailable(
		const FGuid& TaskId
	)

WaitForTaskToComplete ​

Waits until the specified task is finished. Returns directly if no task with the given ID has been scheduled.

void WaitForTaskToComplete(
		const FGuid& TaskId
	)

WaitForAllTasksToComplete ​

Waits until all scheduled subsystem tasks are finished.

void WaitForAllTasksToComplete()

GetNumberOfCurrentlyRunningTasks ​

Returns the number of tasks that are currently running in the background.

int32 GetNumberOfCurrentlyRunningTasks()

ExportActorsToScene ​

Run an async export task of the given actors using the given export settings. Possible to bind a delegate callback to the OnExportActorsToSceneCompleted (from Python/Blueprints) or add a delegate to the native callback using GetNativeOnExportActorsToSceneCompleted (C++) which will be called when the export task is finished.

FGuid ExportActorsToScene(
		const FString& ExportFilePath,
		const TArray<AActor*>& Actors,
		const FSgSceneExportSettings& ExportSettings
	)

RetrieveExportActorsToSceneResult ​

Retrieves the result of a task created using the ExportActorsToScene function. May include errors that should be checked before working with the data. Will wait until the task is completed if it hasn't already. If you don't want to implement a synchronous workflow, use the matching callback which will get the result directly or make sure to create all your ExportActorsToScene tasks before retrieving the result for any of them.

FExportActorsToSceneResult RetrieveExportActorsToSceneResult(
		const FGuid& TaskId
	)

ImportSceneAsActors ​

Run an async import task using the given import settings to spawn imported actors into the given world. Possible to bind a delegate callback to the OnImportSceneAsActorsCompleted (from Python/Blueprints) or add a delegate to the native callback using GetNativeOnImportSceneAsActorsCompleted (C++) which will be called when the import task is finished.

FGuid ImportSceneAsActors(
		const FString& PathToScene,
		UWorld* World,
		const FSgSceneImportSettings& ImportSettings
	)

RetrieveImportSceneAsActorsResult ​

Retrieves the result of a task created using the ImportSceneAsActors function. May include errors that should be checked before working with the data. Will wait until the task is completed if it hasn't already. If you don't want to implement a synchronous workflow, use the matching callback which will get the result directly or make sure to create all your ImportSceneAsActors tasks before retrieving the result for any of them.

FImportSceneAsActorsResult RetrieveImportSceneAsActorsResult(
		const FGuid& TaskId
	)

GetNativeOnTaskAdded ​

Returns handle to delegate that will get triggered when any task is added.

FSgNativeOnTaskAdded& GetNativeOnTaskAdded()

GetNativeOnTaskCompleted ​

Returns handle to delegate that will get triggered when any task is completed.

FSgNativeOnTaskCompleted& GetNativeOnTaskCompleted()

GetNativeOnExportActorsToSceneCompleted ​

Returns handle to delegate that will get triggered when an export task is completed.

FSgNativeOnExportActorsCompleted& GetNativeOnExportActorsToSceneCompleted()

GetNativeOnImportSceneAsActorsCompleted ​

Returns handle to delegate that will get triggered when an import task is completed.

FSgNativeOnImportAsActorsCompleted& GetNativeOnImportSceneAsActorsCompleted()

Properties details ​

OnTaskAdded ​

Delegate type for triggering when any task is added.

OnTaskCompleted ​

Delegate type for triggering when any task is completed.

OnExportActorsToSceneCompleted ​

Delegate type for triggering when an export task is completed.

OnImportSceneAsActorsCompleted ​

Delegate type for triggering when an import task is completed.

Data structs details ​

FSubsystemTaskResult ​

Struct holding a result coming out of a SimplygonSubsystem task. FSubsystemTaskResult is the base abstract class holding everything common between the different types of tasks.

struct FSubsystemTaskResult

FExportActorsToSceneResult ​

The result coming out of an ExportActorsToScene SimplygonSubsystem task.

struct FExportActorsToSceneResult: public FSubsystemTaskResult

FImportSceneAsActorsResult ​

The result coming out of an ImportSceneAsActors SimplygonSubsystem task.

struct FImportSceneAsActorsResult: public FSubsystemTaskResult

FSgSceneImportSettings ​

Import settings to use when importing a Simplygon scene.

struct FSgSceneImportSettings

FSgGeometryImportSettings ​

Import settings to use when importing a Simplygon geometry data to a FMeshDescription.

struct FSgGeometryImportSettings

FSgMaterialImportSettings ​

Import settings to use when importing a Simplygon material to UMaterialInterface.

struct FSgMaterialImportSettings

FSgSceneExportSettings ​

Export settings to use when exporting a Simplygon scene.

struct FSgSceneExportSettings

FSgGeometryExportSettings ​

Export settings for geometry data to use when exporting a Simplygon scene.

struct FSgGeometryExportSettings

FSgMaterialExportSettings ​

Export settings for material data to use when exporting a Simplygon scene.

struct FSgMaterialExportSettings

FSgMaterialProperties ​

The material properties that are enabled will get flattened to textures, and exported with the scene.

struct FSgMaterialProperties

Enums details ​

ESgSeparateMaterialsMode ​

The material separation mode to use when there is unique data sampled in a material.

ESgSourceModelExportMode ​

This enum specifies which source model to export.