Simplygon Subsystem for C++

Subsystem Methods

Name	Description
IsTaskResultAvailable	Checks if the task with the given task id has completed and if its result is available to fetch.
WaitForTaskToComplete	Waits until the specified task is finished. Returns directly if no task with the given ID has been scheduled.
WaitForAllTasksToComplete	Waits until all scheduled subsystem tasks are finished.
GetNumberOfCurrentlyRunningTasks	Returns the number of tasks that are currently running in the background.
ExportActorsToScene	Run an async export task of the given actors using the given export settings.
ExportStaticMeshComponentsToScene	Run an async export task for the given static mesh components using the given export settings.
ExportStaticMeshToScene	Run an async export task for the given static mesh using the given export settings.
RetrieveExportSceneResult	Retrieves the result of a task created using the Export[Actors
ImportSceneAsActors	Run an async import task using the given import settings to spawn imported actors into the given world.
RetrieveImportSceneAsActorsResult	Retrieves the result of a task created using the ImportSceneAsActors function.
GetNativeOnTaskAdded	Returns handle to delegate that will get triggered when any task is added.
GetNativeOnTaskCompleted	Returns handle to delegate that will get triggered when any task is completed.
GetNativeOnExportSceneCompleted	Returns handle to delegate that will get triggered when an export task is completed.
GetNativeOnImportSceneAsActorsCompleted	Returns handle to delegate that will get triggered when an import task is completed.

Subsystem Properties

Name	Description
OnTaskAdded	Delegate type for triggering when any task is added.
OnTaskCompleted	Delegate type for triggering when any task is completed.
OnExportSceneCompleted	Delegate type for triggering when an export task is completed.
OnImportSceneAsActorsCompleted	Delegate type for triggering when an import task is completed.

Data structs

Name	Description
FSubsystemTaskResult	Struct holding a result coming out of a SimplygonSubsystem task.
FExportSceneResult	The result coming out of an Export[Actors
FImportSceneAsActorsResult	The result coming out of an ImportSceneAsActors SimplygonSubsystem task.
FSgSceneImportSettings	Import settings to use when importing a Simplygon scene.
FSgGeometryImportSettings	Import settings to use when importing a Simplygon geometry data to a FMeshDescription.
FSgMaterialImportSettings	Import settings to use when importing a Simplygon material to UMaterialInterface.
FSgComponentExportSettings	Export settings to use when exporting a UStaticMeshComponent.
FSgGeneralExportSettings	General export settings
FSgMeshExportSettings	Settings used to setup Simplygon API scene when exporting an individual UStaticMesh.
FSgSceneMeshExportSettings	Settings used to setup Simplygon API scene when exporting a UStaticMesh as part of a scene.
FSgSceneExportSettings	Export settings to use when exporting a Simplygon scene.
FSgGeometryExportSettings	Export settings for geometry data to use when exporting a Simplygon scene.
FSgMaterialExportSettings	Export settings for material data to use when exporting a Simplygon scene.
FSgMaterialProperties	The material properties that are enabled will get flattened to textures, and exported with the scene.

Enums

Name	Description
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.

Functions details

IsTaskResultAvailable

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

Signature

bool IsTaskResultAvailable(
		const FGuid& TaskId
	)

Parameters

Name	Type	Description
TaskId	const FGuid&	Task to check.

Return value

Type: bool Whether the task result is available or not.

WaitForTaskToComplete

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

Signature

void WaitForTaskToComplete(
		const FGuid& TaskId
	)

Parameters

Name	Type	Description
TaskId	const FGuid&	Task to check.

Return value

Type: void

WaitForAllTasksToComplete

Waits until all scheduled subsystem tasks are finished.

Signature

void WaitForAllTasksToComplete()

Parameters

Function has no parameters

Return value

Type: void

GetNumberOfCurrentlyRunningTasks

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

Signature

int32 GetNumberOfCurrentlyRunningTasks()

Parameters

Function has no parameters

Return value

Type: int32 The number of currently running tasks in the background.

ExportActorsToScene

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

Signature

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

Parameters

Name	Type	Description
ExportFilePath	const FString&	The path of where the exported Simplygon scene will get saved.
Actors	const TArray<AActor*>&	Actors to export.
ExportSettings	const FSgSceneExportSettings&	Export settings.

Return value

Type: FGuid The ID of the task that has been started (which can be retrieved using the matching RetrieveExportActorsToSceneResult(). Note: If you are using callbacks, the result will be sent directly to the delegate.)

ExportStaticMeshComponentsToScene

Run an async export task for the given static mesh components using the given export settings. Possible to bind a delegate callback to the OnExportSceneCompleted (from Python/Blueprints) or add a delegate to the native callback using GetNativeOnExportSceneCompleted (C++) which will be called when the export task is finished.

Signature

FGuid ExportStaticMeshComponentsToScene(
		const FString& ExportFilePath,
		const TArray<UStaticMeshComponent*>& InComponents,
		const FSgSceneExportSettings& ExportSettings
	)

Parameters

Name	Type	Description
ExportFilePath	const FString&	The path of where the exported Simplygon scene will get saved.
InComponents	const TArray<UStaticMeshComponent*>&	The components to export.
ExportSettings	const FSgSceneExportSettings&	Export settings.

Return value

Type: FGuid The ID of the task that has been started (which can be retrieved using the matching RetrieveExportActorsToSceneResult(). Note: If you are using callbacks, the result will be sent directly to the delegate.)

ExportStaticMeshToScene

Run an async export task for the given static mesh using the given export settings. Possible to bind a delegate callback to the OnExportSceneCompleted (from Python/Blueprints) or add a delegate to the native callback using GetNativeOnExportSceneCompleted (C++) which will be called when the export task is finished.

Signature

FGuid ExportStaticMeshToScene(
		const FString& ExportFilePath,
		UStaticMesh* InMesh,
		const FSgSceneExportSettings& ExportSettings
	)

Parameters

Name	Type	Description
ExportFilePath	const FString&	The path of where the exported Simplygon scene will get saved.
InMesh	UStaticMesh*	The mesh to export.
ExportSettings	const FSgSceneExportSettings&	Export settings.

Return value

Type: FGuid The ID of the task that has been started (which can be retrieved using the matching RetrieveExportActorsToSceneResult(). Note: If you are using callbacks, the result will be sent directly to the delegate.)

RetrieveExportSceneResult

Retrieves the result of a task created using the Export[Actors|StaticMeshComponents|StaticMesh]ToScene 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 Export[Actors|StaticMeshComponents|StaticMesh] tasks before retrieving the result for any of them.

Signature

FExportSceneResult RetrieveExportSceneResult(
		const FGuid& TaskId
	)

Parameters

Name	Type	Description
TaskId	const FGuid&	TaskId Id for task to retrieve result for.

Return value

Type: FExportSceneResult Result of the Export[Actors|StaticMeshComponents|StaticMesh]ToScene task (which may include errors).

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.

Signature

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

Parameters

Name	Type	Description
PathToScene	const FString&	Path to the Simplygon scene that should be imported.
World	UWorld*	World to spawn the imported actors in.
ImportSettings	const FSgSceneImportSettings&	Import settings.

Return value

Type: FGuid The ID of the task that has been started (which can be retrieved using the matching RetrieveImportSceneAsActorsResult(). Note: If you are using callbacks, the result will be sent directly to the delegate.)

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.

Signature

FImportSceneAsActorsResult RetrieveImportSceneAsActorsResult(
		const FGuid& TaskId
	)

Parameters

Name	Type	Description
TaskId	const FGuid&	TaskId Id for task to retrieve result for.

Return value

Type: FImportSceneAsActorsResult Result of the ImportSceneAsActors task (which may include errors).

GetNativeOnTaskAdded

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

Signature

FSgNativeOnTaskAdded& GetNativeOnTaskAdded()

Parameters

Function has no parameters

Return value

Type: FSgNativeOnTaskAdded& The delegate handle.

GetNativeOnTaskCompleted

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

Signature

FSgNativeOnTaskCompleted& GetNativeOnTaskCompleted()

Parameters

Function has no parameters

Return value

Type: FSgNativeOnTaskCompleted& The delegate handle.

GetNativeOnExportSceneCompleted

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

Signature

FSgNativeOnExportActorsCompleted& GetNativeOnExportSceneCompleted()

Parameters

Function has no parameters

Return value

Type: FSgNativeOnExportActorsCompleted& The delegate handle.

GetNativeOnImportSceneAsActorsCompleted

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

Signature

FSgNativeOnImportAsActorsCompleted& GetNativeOnImportSceneAsActorsCompleted()

Parameters

Function has no parameters

Return value

Type: FSgNativeOnImportAsActorsCompleted& The delegate handle.

Properties details

OnTaskAdded

Delegate type for triggering when any task is added.

Type

FSgDynamicOnTaskAdded

OnTaskCompleted

Delegate type for triggering when any task is completed.

Type

FSgDynamicOnTaskCompleted

OnExportSceneCompleted

Delegate type for triggering when an export task is completed.

Type

FSgDynamicOnExportCompleted

OnImportSceneAsActorsCompleted

Delegate type for triggering when an import task is completed.

Type

FSgDynamicOnImportAsActorsCompleted

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.

Signature

struct FSubsystemTaskResult

Properties

Name	Type	Description
TaskID	FGuid	The ID of the Simplygon subsystem task this result corresponds to.
bHasError	bool	Whether the task encountered any errors or not.
ErrorMessage	FString	The error message, if an error occurred.

FExportSceneResult

The result coming out of an Export[Actors|StaticMeshComponents|StaticMesh]ToScene SimplygonSubsystem task.

Signature

struct FExportSceneResult: public FSubsystemTaskResult

Parent

FSubsystemTaskResult

Properties

Name	Type	Description
OutputFilePath	FString	The output path to the exported Simplygon scene.

FImportSceneAsActorsResult

The result coming out of an ImportSceneAsActors SimplygonSubsystem task.

Signature

struct FImportSceneAsActorsResult: public FSubsystemTaskResult

Parent

FSubsystemTaskResult

Properties

Name	Type	Description
ImportedActorPaths	FString	The paths to imported Actors (relative to the world, eg PersistentLevel.ActorName)
ImportedMeshes	TArray<FAssetData>	Asset data for the imported meshes.
ImportedMaterials	TArray<FAssetData>	Asset data for the imported materials.
ImportedTextures	TArray<FAssetData>	Asset data for the imported textures.

FSgSceneImportSettings

Import settings to use when importing a Simplygon scene.

Signature

struct FSgSceneImportSettings

Properties

Name	Type	Description
StaticMeshPackageBasePath	FString	The base path for where to store imported static meshes.
GeometrySettings	FSgGeometryImportSettings	Settings related to geometry import.
MaterialSettings	FSgMaterialImportSettings	Settings related to material import.

FSgGeometryImportSettings

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

Signature

struct FSgGeometryImportSettings

Properties

Name	Type	Description
TexCoordNames	TArray<FString>	List of tex coord names used by the Simplygon Geometry Data to import. These will be imported in the order they are written, eg the name at index 0 in TexCoordNames will be imported into texcoord index 0 in the mesh description.
VertexColorName	FString	The name of the vertex color field used by the Simplygon Geometry Data to import.

FSgMaterialImportSettings

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

Signature

struct FSgMaterialImportSettings

Properties

Name	Type	Description
MaterialPackageBasePath	FString	The base path for where to store imported materials.
TexturePackageBasePath	FString	The base path for where to store imported textures.
BaseMaterial	TObjectPtr<UMaterialInterface>	The base material to create instances of for imported materials. To be able to map imported textures and data to the material the base material needs the following: * Texture parameters (using TextureMapping to map between material channels and texture parameters). * (Optional) Switch parameters to turn on or off reading from the texture. Should be off by default. Needs to follow naming standard, see comment for TextureMapping. * Scalar parameter called 'TexCoordIndex' which will be set to the correct tex coord index. Default is 0.
TextureMapping	TMap<FString, FName>	A mapping between material channel name in the Simplygon material and the name of a TextureParameter in the BaseMaterial. The mapping will also take SwitchParameters into account if they have the following naming standard UseTEXTUREPARAMETERNAME, eg texture parameter called BaseColor will work together with a switch parameter called UseBaseColor and toggle it on if a material channel called BaseColor exists on the material to import.

FSgComponentExportSettings

Export settings to use when exporting a UStaticMeshComponent.

Signature

struct FSgComponentExportSettings

Properties

Name	Type	Description
ApplyVertexColorsFromComponent	bool	Enable to allow the export to transfer vertex colors from components.
ApplyTransformationFromComponent	bool	Enable to allow the export to transfer transformations from components.
ApplySplineDeformationToMesh	bool	Enable to allow the export to transfer spline deformations.
UseWorldOffset	bool	Set this flag to true to apply a world offset to the scene. This setting is intended to be used with WorldOffset vector to mainly center objects that are not centered, for example an HLOD tile in World Partition levels.
WorldOffset	FVector	The vector that describes the world offset of the exported scene. Enable UseWorldOffset to activate this setting.

FSgGeneralExportSettings

General export settings

Signature

struct FSgGeneralExportSettings

Properties

Name	Type	Description
OverwriteExistingFile	bool	Specify if existing file should be overwritten, or if an error should occur.
UseGeometryCache	bool	The geometry cache can in some cases greatly speed up export and reduce file size, and will re-use identical looking geometries where possible.

FSgMeshExportSettings

Settings used to setup Simplygon API scene when exporting an individual UStaticMesh.

Signature

struct FSgMeshExportSettings

Properties

Name	Type	Description
GeometryExportSettings	FSgGeometryExportSettings	Geometry specific export settings.
MaterialExportSettings	FSgMaterialExportSettings	Material specific export settings.
SourceModelExportMode	ESgSourceModelExportMode	This setting specifies which source model to export (LODIndex or HiResMeshDescription).
LODIndex	int32	If SourceModelExportMode is set to LODIndex, the export will use the specified LODIndex during export.

FSgSceneMeshExportSettings

Settings used to setup Simplygon API scene when exporting a UStaticMesh as part of a scene.

Signature

struct FSgSceneMeshExportSettings

Properties

Name	Type	Description
GeneralExportSettings	FSgGeneralExportSettings	General export settings.
MeshExportSettings	FSgMeshExportSettings	Settings use to handle UStaticMesh's export from Components/Actors.

FSgSceneExportSettings

Export settings to use when exporting a Simplygon scene.

Signature

struct FSgSceneExportSettings

Properties

Name	Type	Description
GeneralExportSettings	FSgGeneralExportSettings	General export settings.
MeshExportSettings	FSgMeshExportSettings	Settings use to handle UStaticMesh's export from Components/Actors.
ComponentExportSettings	FSgComponentExportSettings	Settings use to handle UStaticMesh's export from Components/Actors.

FSgGeometryExportSettings

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

Signature

struct FSgGeometryExportSettings

Properties

Name	Type	Description
TexCoordsIndexToName	TMap<int32, FString>	Texture coordinate mapping from index in the mesh description to name in Simplygon. If not specified, the default map will be used (0 -> "0", ..., 7 -> "7").

FSgMaterialExportSettings

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

Signature

struct FSgMaterialExportSettings

Properties

Name	Type	Description
ExportBakedMaterials	bool	Exports flattened textures for the material properties specified in MaterialPropertiesToExport.
MaterialProperties	FSgMaterialProperties	The material properties that are enabled will get flattened to textures, and exported with the scene.
TexCoordsName	FString	This is a new texcoord field generated by Simplygon during export, it can be used as source when baking materials and textures using Simplygon's material baking feature.
MaterialSeparationMode	ESgSeparateMaterialsMode	The material separation mode to use when there is unique data sampled in a material, such as vertex colors, transformations or world position.
AddTexCoordsToFirstAvailableIndex	bool	If true, put flatten texcoords at the first available texcoord index in Simplygon's GeometryData.
ExportMaterialsPerSection	bool	This allows for a simpler material export where each section in the geometry will be preserved. This disables several optimizations and will not be able to reuse data to the same degree.

FSgMaterialProperties

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

Signature

struct FSgMaterialProperties

Properties

Name	Type	Description
ExportAmbientOcclusion	bool	Enable to export AmbientOcclusion map
AmbientOcclusionTextureDimensions	FIntPoint	AmbientOcclusion map dimensions
ExportBaseColor	bool	Enable to export BaseColor map
BaseColorTextureDimensions	FIntPoint	BaseColor map dimensions
ExportSpecular	bool	Enable to export Specular map
SpecularTextureDimensions	FIntPoint	Specular map dimensions
ExportRoughness	bool	Enable to export Roughness map
RoughnessTextureDimensions	FIntPoint	Roughness map dimensions
ExportMetallic	bool	Enable to export Metallic map
MetallicTextureDimensions	FIntPoint	Metallic map dimensions
ExportEmissiveColor	bool	Enable to export EmissiveColor map
EmissiveColorTextureDimensions	FIntPoint	EmissiveColor map dimensions
ExportOpacity	bool	Enable to export Opacity map
OpacityTextureDimensions	FIntPoint	Opacity map dimensions
ExportOpacityMask	bool	Enable to export OpacityMask map
OpacityMaskTextureDimensions	FIntPoint	OpacityMask map dimensions
ExportNormal	bool	Enable to export Normal map
NormalTextureDimensions	FIntPoint	Normal map dimensions

Enums details

ESgSeparateMaterialsMode

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

Values

Name	Description
Disabled	Materials will not get separated during export. While this can result in higher texture density, it can also result in unexpected visual oddities where texcoord separation otherwise would be recommended (for example if vertex colors are sampled in a material). Use with caution!
Enabled	Materials will get separated to enforce unique texcoords. This may result in lower pixel density. Use with caution!
Auto	The export will scan the material after nodes that reads data from the mesh, or using transforms or nodes that uniquely affects the output. If such nodes are detected in the material, then separation will get enabled to enforce unique texcoords (otherwise disabled).

ESgSourceModelExportMode

This enum specifies which source model to export.

Values

Name	Description
HiResWithFallback	Try to retrieve Hi-Res mesh description, fallback to LODIndex 0.
SourceModelFromLODIndex	Try to retrieve source model using the specified LODIndex.