Simplygon Subsystem for Python

Subsystem Methods

Name	Description
is_task_result_available	Checks if the task with the given task id has completed and if its result is available to fetch.
wait_for_task_to_complete	Waits until the specified task is finished. Returns directly if no task with the given ID has been scheduled.
wait_for_all_tasks_to_complete	Waits until all scheduled subsystem tasks are finished.
get_number_of_currently_running_tasks	Returns the number of tasks that are currently running in the background.
export_actors_to_scene	Run an async export task of the given actors using the given export settings.
export_static_mesh_components_to_scene	Run an async export task for the given static mesh components using the given export settings.
export_static_mesh_to_scene	Run an async export task for the given static mesh using the given export settings.
retrieve_export_scene_result	Retrieves the result of a task created using the Export[Actors
import_scene_as_actors	Run an async import task using the given import settings to spawn imported actors into the given world.
retrieve_import_scene_as_actors_result	Retrieves the result of a task created using the ImportSceneAsActors function.

Subsystem Properties

Name	Description
on_task_added	Delegate type for triggering when any task is added.
on_task_completed	Delegate type for triggering when any task is completed.
on_export_scene_completed	Delegate type for triggering when an export task is completed.
on_import_scene_as_actors_completed	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

is_task_result_available

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

Signature

def is_task_result_available(
		task_id: Guid
	) -> bool

Parameters

Name	Type	Description
task_id	Guid	Task to check.

Return value

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

wait_for_task_to_complete

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

Signature

def wait_for_task_to_complete(
		task_id: Guid
	) -> None

Parameters

Name	Type	Description
task_id	Guid	Task to check.

Return value

Type: None

wait_for_all_tasks_to_complete

Waits until all scheduled subsystem tasks are finished.

Signature

def wait_for_all_tasks_to_complete() -> None

Parameters

Function has no parameters

Return value

Type: None

get_number_of_currently_running_tasks

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

Signature

def get_number_of_currently_running_tasks() -> int

Parameters

Function has no parameters

Return value

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

export_actors_to_scene

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

def export_actors_to_scene(
		export_file_path: String,
		actors: Array,
		export_settings: SgSceneExportSettings
	) -> Guid

Parameters

Name	Type	Description
export_file_path	String	The path of where the exported Simplygon scene will get saved.
actors	Array	Actors to export.
export_settings	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.)

export_static_mesh_components_to_scene

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

def export_static_mesh_components_to_scene(
		export_file_path: String,
		in_components: Array,
		export_settings: SgSceneExportSettings
	) -> Guid

Parameters

Name	Type	Description
export_file_path	String	The path of where the exported Simplygon scene will get saved.
in_components	Array	The components to export.
export_settings	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.)

export_static_mesh_to_scene

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

def export_static_mesh_to_scene(
		export_file_path: String,
		in_mesh: StaticMesh,
		export_settings: SgSceneExportSettings
	) -> Guid

Parameters

Name	Type	Description
export_file_path	String	The path of where the exported Simplygon scene will get saved.
in_mesh	StaticMesh	The mesh to export.
export_settings	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.)

retrieve_export_scene_result

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

def retrieve_export_scene_result(
		task_id: Guid
	) -> ExportSceneResult

Parameters

Name	Type	Description
task_id	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).

import_scene_as_actors

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

def import_scene_as_actors(
		path_to_scene: String,
		world: World,
		import_settings: SgSceneImportSettings
	) -> Guid

Parameters

Name	Type	Description
path_to_scene	String	Path to the Simplygon scene that should be imported.
world	World	World to spawn the imported actors in.
import_settings	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.)

retrieve_import_scene_as_actors_result

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

def retrieve_import_scene_as_actors_result(
		task_id: Guid
	) -> ImportSceneAsActorsResult

Parameters

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

Return value

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

Properties details

on_task_added

Delegate type for triggering when any task is added.

Type

SgDynamicOnTaskAdded

on_task_completed

Delegate type for triggering when any task is completed.

Type

SgDynamicOnTaskCompleted

on_export_scene_completed

Delegate type for triggering when an export task is completed.

Type

SgDynamicOnExportCompleted

on_import_scene_as_actors_completed

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.

Signature

class SubsystemTaskResult

Properties

Name	Type	Description
task_id	Guid	The ID of the Simplygon subsystem task this result corresponds to.
has_error	bool	Whether the task encountered any errors or not.
error_message	String	The error message, if an error occurred.

ExportSceneResult

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

Signature

class ExportSceneResult(SubsystemTaskResult)

Parent

SubsystemTaskResult

Properties

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

ImportSceneAsActorsResult

The result coming out of an ImportSceneAsActors SimplygonSubsystem task.

Signature

class ImportSceneAsActorsResult(SubsystemTaskResult)

Parent

SubsystemTaskResult

Properties

Name	Type	Description
imported_actor_paths	String	The paths to imported Actors (relative to the world, eg PersistentLevel.ActorName)
imported_meshes	Array	Asset data for the imported meshes.
imported_materials	Array	Asset data for the imported materials.
imported_textures	Array	Asset data for the imported textures.

SgSceneImportSettings

Import settings to use when importing a Simplygon scene.

Signature

class SgSceneImportSettings

Properties

Name	Type	Description
static_mesh_package_base_path	String	The base path for where to store imported static meshes.
geometry_settings	SgGeometryImportSettings	Settings related to geometry import.
material_settings	SgMaterialImportSettings	Settings related to material import.

SgGeometryImportSettings

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

Signature

class SgGeometryImportSettings

Properties

Name	Type	Description
tex_coord_names	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.
vertex_color_name	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.

Signature

class SgMaterialImportSettings

Properties

Name	Type	Description
material_package_base_path	String	The base path for where to store imported materials.
texture_package_base_path	String	The base path for where to store imported textures.
base_material	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.
texture_mapping	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.

Signature

class SgComponentExportSettings

Properties

Name	Type	Description
apply_vertex_colors_from_component	bool	Enable to allow the export to transfer vertex colors from components.
apply_transformation_from_component	bool	Enable to allow the export to transfer transformations from components.
apply_spline_deformation_to_mesh	bool	Enable to allow the export to transfer spline deformations.
use_world_offset	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.
world_offset	Vector	The vector that describes the world offset of the exported scene. Enable UseWorldOffset to activate this setting.

SgGeneralExportSettings

General export settings

Signature

class SgGeneralExportSettings

Properties

Name	Type	Description
overwrite_existing_file	bool	Specify if existing file should be overwritten, or if an error should occur.
use_geometry_cache	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.

SgMeshExportSettings

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

Signature

class SgMeshExportSettings

Properties

Name	Type	Description
geometry_export_settings	SgGeometryExportSettings	Geometry specific export settings.
material_export_settings	SgMaterialExportSettings	Material specific export settings.
source_model_export_mode	SgSourceModelExportMode	This setting specifies which source model to export (LODIndex or HiResMeshDescription).
lod_index	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.

Signature

class SgSceneMeshExportSettings

Properties

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

SgSceneExportSettings

Export settings to use when exporting a Simplygon scene.

Signature

class SgSceneExportSettings

Properties

Name	Type	Description
general_export_settings	SgGeneralExportSettings	General export settings.
mesh_export_settings	SgMeshExportSettings	Settings use to handle UStaticMesh's export from Components/Actors.
component_export_settings	SgComponentExportSettings	Settings use to handle UStaticMesh's export from Components/Actors.

SgGeometryExportSettings

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

Signature

class SgGeometryExportSettings

Properties

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

Signature

class SgMaterialExportSettings

Properties

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

SgMaterialProperties

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

Signature

class SgMaterialProperties

Properties

Name	Type	Description
export_ambient_occlusion	bool	Enable to export AmbientOcclusion map
ambient_occlusion_texture_dimensions	IntPoint	AmbientOcclusion map dimensions
export_base_color	bool	Enable to export BaseColor map
base_color_texture_dimensions	IntPoint	BaseColor map dimensions
export_specular	bool	Enable to export Specular map
specular_texture_dimensions	IntPoint	Specular map dimensions
export_roughness	bool	Enable to export Roughness map
roughness_texture_dimensions	IntPoint	Roughness map dimensions
export_metallic	bool	Enable to export Metallic map
metallic_texture_dimensions	IntPoint	Metallic map dimensions
export_emissive_color	bool	Enable to export EmissiveColor map
emissive_color_texture_dimensions	IntPoint	EmissiveColor map dimensions
export_opacity	bool	Enable to export Opacity map
opacity_texture_dimensions	IntPoint	Opacity map dimensions
export_opacity_mask	bool	Enable to export OpacityMask map
opacity_mask_texture_dimensions	IntPoint	OpacityMask map dimensions
export_normal	bool	Enable to export Normal map
normal_texture_dimensions	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
HI_RES_WITH_FALLBACK	Try to retrieve Hi-Res mesh description, fallback to LODIndex 0.
SOURCE_MODEL_FROM_LOD_INDEX	Try to retrieve source model using the specified LODIndex.