Simplygon Subsystem for Blueprint

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.

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
SubsystemTaskResult	Struct holding a result coming out of a SimplygonSubsystem task.
ExportSceneResult	The result coming out of an Export[Actors
ImportSceneAsActorsResult	The result coming out of an ImportSceneAsActors SimplygonSubsystem task.
SgSceneImportSettings	Import settings to use when importing a Simplygon scene.
SgGeometryImportSettings	Import settings to use when importing a Simplygon geometry data to a FMeshDescription.
SgMaterialImportSettings	Import settings to use when importing a Simplygon material to UMaterialInterface.
SgComponentExportSettings	Export settings to use when exporting a UStaticMeshComponent.
SgGeneralExportSettings	General export settings
SgMeshExportSettings	Settings used to setup Simplygon API scene when exporting an individual UStaticMesh.
SgSceneMeshExportSettings	Settings used to setup Simplygon API scene when exporting a UStaticMesh as part of a scene.
SgSceneExportSettings	Export settings to use when exporting a Simplygon scene.
SgGeometryExportSettings	Export settings for geometry data to use when exporting a Simplygon scene.
SgMaterialExportSettings	Export settings for material data to use when exporting a Simplygon scene.
SgMaterialProperties	The material properties that are enabled will get flattened to textures, and exported with the scene.

Enums

Name	Description
SgSeparateMaterialsMode	The material separation mode to use when there is unique data sampled in a material.
SgSourceModelExportMode	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.

Parameters

Name	Type	Description
TaskId	Guid	Task to check.

Return value

Type: Boolean 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.

Parameters

Name	Type	Description
TaskId	Guid	Task to check.

Return value

Type: None

WaitForAllTasksToComplete

Waits until all scheduled subsystem tasks are finished.

Parameters

Function has no parameters

Return value

Type: None

GetNumberOfCurrentlyRunningTasks

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

Parameters

Function has no parameters

Return value

Type: int 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.

Parameters

Name	Type	Description
ExportFilePath	String	The path of where the exported Simplygon scene will get saved.
Actors	Array	Actors to export.
ExportSettings	SgSceneExportSettings	Export settings.

Return value

Type: Guid 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.

Parameters

Name	Type	Description
ExportFilePath	String	The path of where the exported Simplygon scene will get saved.
InComponents	Array	The components to export.
ExportSettings	SgSceneExportSettings	Export settings.

Return value

Type: Guid 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.

Parameters

Name	Type	Description
ExportFilePath	String	The path of where the exported Simplygon scene will get saved.
InMesh	StaticMesh	The mesh to export.
ExportSettings	SgSceneExportSettings	Export settings.

Return value

Type: Guid 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.

Parameters

Name	Type	Description
TaskId	Guid	TaskId Id for task to retrieve result for.

Return value

Type: ExportSceneResult 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.

Parameters

Name	Type	Description
PathToScene	String	Path to the Simplygon scene that should be imported.
World	World	World to spawn the imported actors in.
ImportSettings	SgSceneImportSettings	Import settings.

Return value

Type: Guid 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.

Parameters

Name	Type	Description
TaskId	Guid	TaskId Id for task to retrieve result for.

Return value

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

Properties details

OnTaskAdded

Delegate type for triggering when any task is added.

Type

SgDynamicOnTaskAdded

OnTaskCompleted

Delegate type for triggering when any task is completed.

Type

SgDynamicOnTaskCompleted

OnExportSceneCompleted

Delegate type for triggering when an export task is completed.

Type

SgDynamicOnExportCompleted

OnImportSceneAsActorsCompleted

Delegate type for triggering when an import task is completed.

Type

SgDynamicOnImportAsActorsCompleted

Data structs details

SubsystemTaskResult

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.

Properties

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

ExportSceneResult

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

Parent

SubsystemTaskResult

Properties

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

ImportSceneAsActorsResult

The result coming out of an ImportSceneAsActors SimplygonSubsystem task.

Parent

SubsystemTaskResult

Properties

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

SgSceneImportSettings

Import settings to use when importing a Simplygon scene.

Properties

Name	Type	Description
StaticMeshPackageBasePath	String	The base path for where to store imported static meshes.
GeometrySettings	SgGeometryImportSettings	Settings related to geometry import.
MaterialSettings	SgMaterialImportSettings	Settings related to material import.

SgGeometryImportSettings

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

Properties

Name	Type	Description
TexCoordNames	Array	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	String	The name of the vertex color field used by the Simplygon Geometry Data to import.

SgMaterialImportSettings

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

Properties

Name	Type	Description
MaterialPackageBasePath	String	The base path for where to store imported materials.
TexturePackageBasePath	String	The base path for where to store imported textures.
BaseMaterial	MaterialInterface	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	Map	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.

SgComponentExportSettings

Export settings to use when exporting a UStaticMeshComponent.

Properties

Name	Type	Description
ApplyVertexColorsFromComponent	Boolean	Enable to allow the export to transfer vertex colors from components.
ApplyTransformationFromComponent	Boolean	Enable to allow the export to transfer transformations from components.
ApplySplineDeformationToMesh	Boolean	Enable to allow the export to transfer spline deformations.
UseWorldOffset	Boolean	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	Vector	The vector that describes the world offset of the exported scene. Enable UseWorldOffset to activate this setting.

SgGeneralExportSettings

General export settings

Properties

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

SgMeshExportSettings

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

Properties

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

SgSceneMeshExportSettings

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

Properties

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

SgSceneExportSettings

Export settings to use when exporting a Simplygon scene.

Properties

Name	Type	Description
GeneralExportSettings	SgGeneralExportSettings	General export settings.
MeshExportSettings	SgMeshExportSettings	Settings use to handle UStaticMesh's export from Components/Actors.
ComponentExportSettings	SgComponentExportSettings	Settings use to handle UStaticMesh's export from Components/Actors.

SgGeometryExportSettings

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

Properties

Name	Type	Description
TexCoordsIndexToName	Map	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").

SgMaterialExportSettings

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

Properties

Name	Type	Description
ExportBakedMaterials	Boolean	Exports flattened textures for the material properties specified in MaterialPropertiesToExport.
MaterialProperties	SgMaterialProperties	The material properties that are enabled will get flattened to textures, and exported with the scene.
TexCoordsName	String	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	SgSeparateMaterialsMode	The material separation mode to use when there is unique data sampled in a material, such as vertex colors, transformations or world position.
AddTexCoordsToFirstAvailableIndex	Boolean	If true, put flatten texcoords at the first available texcoord index in Simplygon's GeometryData.
ExportMaterialsPerSection	Boolean	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.

SgMaterialProperties

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

Properties

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

Enums details

SgSeparateMaterialsMode

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).

SgSourceModelExportMode

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.