Simplygon Subsystem for Python

Subsystem Methods

Name	Description
export_actors_to_scene	Run an async export job of the given actors using the given export settings.
export_static_mesh_components_to_scene	Run an async export job for the given static mesh components using the given export settings.
export_static_mesh_to_scene	Run an async export job for the given static mesh using the given export settings.
import_scene_as_actors	Run an async import job using the given import settings to spawn imported actors into the given world.
import_scene_as_static_meshes	Run an async import job using the given import settings to import Static Meshes into the project.
create_scene_context	Create an empty managed Simplygon scene context.
export_static_mesh_components_to_scene_context	Export static mesh components into a managed scene.
capture_components_to_scene_context	Capture components and append the resources to a managed scene.
save_scene_context_to_file	Save a managed scene to a Simplygon scene file.
load_scene_context_from_file	Load a Simplygon scene file into a new managed context.
create_landscape_scene_mesh_descriptions	Create reusable scene mesh descriptions from intersecting landscape geometry.
append_scene_mesh_descriptions_to_scene_context	Append reusable scene mesh descriptions to a managed scene.
capture_components	Capture components without appending the images to a managed scene.
generate_obb_cameras_for_components	Generate OBB-distributed cameras for component capture.

Subsystem Properties

Name	Description
on_export_scene_completed	Delegate type for triggering when an export job is completed.
on_import_scene_completed	Delegate type for triggering when an import job is completed.
on_capture_components_completed	Called when a component capture job is completed.
on_export_to_scene_context_completed	Called when components have been exported to a managed scene.
on_capture_to_scene_context_completed	Called when captured resources have been appended to a managed scene.
on_save_scene_context_completed	Called after a managed scene save finishes.
on_load_scene_context_completed	Called after a scene file is loaded into a managed context.
on_create_landscape_scene_mesh_descriptions_completed	Called after reusable landscape scene mesh descriptions have been created.
on_append_scene_mesh_descriptions_to_scene_context_completed	Called after scene mesh descriptions have been appended to a managed scene.

Data structs

Name	Description
SubsystemJobResult	Struct holding a result coming out of a SimplygonSubsystem job.
ExportSceneResult	The result coming out of an Export[Actors
ImportSceneResult	The result coming out of an ImportScene SimplygonSubsystem job.
SubsystemCameraResult	Result of synchronous OBB camera generation through SimplygonSubsystem.
CapturedSceneImage	One captured material channel produced from one camera.
CapturedSceneData	All requested channel images captured from one camera.
CaptureComponentsResult	Result of a CaptureComponents SimplygonSubsystem job.
ExportToSceneContextResult	Result of exporting components to an existing managed scene.
CaptureToSceneContextResult	Result of appending captured resources to a managed scene.
SaveSceneContextResult	Result of saving a managed scene to disk.
LoadSceneContextResult	Result of loading a scene file into a managed scene context.
CreateLandscapeSceneMeshDescriptionsResult	Result of creating reusable landscape scene mesh descriptions.
AppendSceneMeshDescriptionsToSceneContextResult	Result of appending scene mesh descriptions to a managed scene.
SgSceneMeshDescription	Immutable Unreal geometry and placement information used to create a Simplygon scene-mesh node. The native mesh payload is shared between copies and is not exposed as a reflected property.
SgLandscapeGeometryExportSettings	Settings controlling landscape discovery and conversion into reusable scene mesh descriptions.
SgAppendSceneGeometrySettings	Settings controlling how scene mesh descriptions are converted and appended to a managed scene.
SCCameraSettings	Defines one perspective camera used by Scene Capture.
SCCaptureSettings	Controls the cameras and image resources produced by one Scene Capture operation.
SCSceneSettings	Controls the temporary world and lighting used to render capture sources.
SCCaptureRequestSettings	Complete source-independent configuration for one capture request.
SCOBBCameraGenerationSettings	Controls OBB camera distribution around source component bounds.
SgCaptureComponentsToSceneSettings	Settings for capturing components and appending the captured resources to a managed scene.
SgImportDestinationSettings	Specifies where imported objects are stored and optionally overrides their base asset name.
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 a Simplygon API scene when exporting a UStaticMesh.
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.
SgMaterialExportMode	Selects whether Unreal materials and per-triangle material IDs are exported.
SgImportDestinationMode	This enum specifies how imported objects are stored.
SgBufferCaptureType	Material channels that can be requested from Scene Capture.
SgCapturedImageColorSpace	Color space used to encode captured 8-bit image values.

Functions details

export_actors_to_scene

Initiates an asynchronous export job for the specified actors using the provided export settings. To retrieve the results, you must bind a completion callback:

• Python/Blueprints: Use OnExportSceneCompleted
• C++: Use GetNativeOnExportSceneCompleted

The callback will be triggered once the export job finishes.

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 A GUID representing the ID of the started export job.

export_static_mesh_components_to_scene

Initiates an asynchronous export job for the specified components using the provided export settings. To retrieve the results, you must bind a completion callback:

• Python/Blueprints: Use OnExportSceneCompleted
• C++: Use GetNativeOnExportSceneCompleted

The callback will be triggered once the export job finishes.

Signature

def export_static_mesh_components_to_scene(
		export_file_path: String,
		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.
components	Array	The components to export.
export_settings	SgSceneExportSettings	Export settings.

Return value

Type: Guid A GUID representing the ID of the started export job.

export_static_mesh_to_scene

Initiates an asynchronous export job for the specified Static Mesh using the provided export settings. To retrieve the results, you must bind a completion callback:

• Python/Blueprints: Use OnExportSceneCompleted
• C++: Use GetNativeOnExportSceneCompleted

The callback will be triggered once the export job finishes.

Signature

def export_static_mesh_to_scene(
		export_file_path: String,
		mesh: StaticMesh,
		export_settings: SgSceneMeshExportSettings
	) -> Guid

Parameters

Name	Type	Description
export_file_path	String	The path of where the exported Simplygon scene will get saved.
mesh	StaticMesh	The mesh to export.
export_settings	SgSceneMeshExportSettings	Export settings.

Return value

Type: Guid A GUID representing the ID of the started export job.

import_scene_as_actors

Initiates an asynchronous import job to load a Simplygon scene and spawn its actors into the specified world using the provided import settings. To retrieve results, bind a completion callback:

• Python/Blueprints: Use OnImportSceneCompleted
• C++: Use GetNativeOnImportSceneCompleted

The callback is triggered when the import job finishes.

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 GUID representing the ID of the started import job.

import_scene_as_static_meshes

Initiates an asynchronous import job to load a Simplygon scene and convert its contents into static meshes using the specified import settings. To retrieve results, you must bind a completion callback:

• Python/Blueprints: Use OnImportSceneCompleted
• C++: Use GetNativeOnImportSceneCompleted

The callback is triggered when the import job finishes.

Signature

def import_scene_as_static_meshes(
		path_to_scene: String,
		import_settings: SgSceneImportSettings
	) -> Guid

Parameters

Name	Type	Description
path_to_scene	String	Path to the Simplygon scene that should be imported.
import_settings	SgSceneImportSettings	Import settings.

Return value

Type: Guid GUID representing the ID of the started import job.

create_scene_context

Creates an empty manager-owned Simplygon scene. This subsystem method must be called on the game thread. Retain the returned scene context while asynchronous jobs use it, then release it for deterministic cleanup. Native worker code can use FSimplygonSceneManager::CreateSceneContext for any-thread creation.

Signature

def create_scene_context() -> SimplygonSceneContext

Parameters

Function has no parameters

Return value

Type: SimplygonSceneContext Opaque context for the managed scene, or null if creation fails.

export_static_mesh_components_to_scene_context

Starts an asynchronous job that exports components into a managed scene. Existing scene resources are preserved, and the caller must ensure they are compatible with the export settings. A context accepts one component-export attempt. Failures or cancellations after the export transaction begins consume the attempt; cancellation while waiting to begin leaves the context reusable. Bind OnExportToSceneContextCompleted, or GetNativeOnExportToSceneContextCompleted in C++, and match the callback JobID to the returned ID.

Signature

def export_static_mesh_components_to_scene_context(
		scene_context: SimplygonSceneContext,
		components: Array,
		export_settings: SgSceneExportSettings
	) -> Guid

Parameters

Name	Type	Description
scene_context	SimplygonSceneContext	Context that receives the exported components. Existing resources are preserved.
components	Array	Static mesh components to export.
export_settings	SgSceneExportSettings	Settings controlling mesh, material and geometry-data export.

Return value

Type: Guid Identifier of the asynchronous export job.

capture_components_to_scene_context

Starts an asynchronous job that captures components and appends cameras, textures and renders to a managed scene. Bind OnCaptureToSceneContextCompleted, or GetNativeOnCaptureToSceneContextCompleted in C++, and match the callback JobID to the returned ID.

Signature

def capture_components_to_scene_context(
		scene_context: SimplygonSceneContext,
		components: Array,
		settings: SgCaptureComponentsToSceneSettings
	) -> Guid

Parameters

Name	Type	Description
scene_context	SimplygonSceneContext	Context that receives the captured resources.
components	Array	Static mesh components to capture together.
settings	SgCaptureComponentsToSceneSettings	Capture configuration and destination camera selection-set name.

Return value

Type: Guid Identifier of the asynchronous capture job.

save_scene_context_to_file

Starts an asynchronous job that saves a managed scene to disk. Bind the matching save completion delegate and filter by JobID. Cancellation is observed while waiting for the context transaction, but cannot interrupt the Simplygon SDK serializer after serialization begins.

Signature

def save_scene_context_to_file(
		scene_context: SimplygonSceneContext,
		file_path: String
	) -> Guid

Parameters

Name	Type	Description
scene_context	SimplygonSceneContext	Context identifying the scene to save.
file_path	String	Destination path for the Simplygon scene file.

Return value

Type: Guid Identifier of the asynchronous save job.

load_scene_context_from_file

Starts an asynchronous job that loads a Simplygon scene file into a new managed context. The context is returned through the load completion result.

Signature

def load_scene_context_from_file(
		file_path: String
	) -> Guid

Parameters

Name	Type	Description
file_path	String	Path to the Simplygon scene file.

Return value

Type: Guid Identifier of the asynchronous load job.

create_landscape_scene_mesh_descriptions

Starts an asynchronous job that creates reusable scene mesh descriptions from landscape geometry intersecting the requested world-space bounds. Only landscape proxies with Use Landscape for Culling Invisible HLOD Vertices enabled contribute geometry. Bind OnCreateLandscapeSceneMeshDescriptionsCompleted, or GetNativeOnCreateLandscapeSceneMeshDescriptionsCompleted in C++, and match the callback JobID to the returned ID.

Signature

def create_landscape_scene_mesh_descriptions(
		world: World,
		settings: SgLandscapeGeometryExportSettings
	) -> Guid

Parameters

Name	Type	Description
world	World	World containing the landscape geometry.
settings	SgLandscapeGeometryExportSettings	World-space discovery bounds and landscape tessellation precision.

Return value

Type: Guid Identifier of the asynchronous landscape extraction job.

append_scene_mesh_descriptions_to_scene_context

Starts an asynchronous job that converts scene mesh descriptions into Simplygon scene meshes, appends them to a managed scene and optionally adds their GUIDs to a selection set. Bind OnAppendSceneMeshDescriptionsToSceneContextCompleted, or GetNativeOnAppendSceneMeshDescriptionsToSceneContextCompleted in C++, and match the callback JobID to the returned ID.

Signature

def append_scene_mesh_descriptions_to_scene_context(
		scene_context: SimplygonSceneContext,
		scene_mesh_descriptions: Array,
		settings: SgAppendSceneGeometrySettings
	) -> Guid

Parameters

Name	Type	Description
scene_context	SimplygonSceneContext	Context that receives the geometry.
scene_mesh_descriptions	Array	Geometry and placement information to append.
settings	SgAppendSceneGeometrySettings	Geometry export, selection-set and coordinate-frame settings.

Return value

Type: Guid Identifier of the asynchronous append job.

capture_components

Starts an asynchronous component capture and returns the captured pixels through the capture completion result.

Signature

def capture_components(
		components: Array,
		capture_settings: SCCaptureRequestSettings
	) -> Guid

Parameters

Name	Type	Description
components	Array	Static mesh components to capture together.
capture_settings	SCCaptureRequestSettings	Scene, camera, output resolution and channel settings.

Return value

Type: Guid Identifier of the asynchronous capture job.

generate_obb_cameras_for_components

Synchronously generates cameras around the aggregate component bounds. A single component transform or instanced-mesh instance retains its oriented bounds; multiple component or instance transforms use one world-aligned aggregate bound. Assign the returned cameras and image dimensions to capture settings.

Signature

def generate_obb_cameras_for_components(
		components: Array,
		settings: SCOBBCameraGenerationSettings
	) -> SubsystemCameraResult

Parameters

Name	Type	Description
components	Array	Components whose aggregate world-space bounds should be covered.
settings	SCOBBCameraGenerationSettings	Camera-distribution settings.

Return value

Type: SubsystemCameraResult Generated cameras, image dimensions and pixel density, or an error.

Properties details

on_export_scene_completed

Delegate type for triggering when an export job is completed.

Type

SgDynamicOnExportCompleted

on_import_scene_completed

Delegate type for triggering when an import job is completed.

Type

SgDynamicOnImportCompleted

on_capture_components_completed

Called when a component capture job is completed.

Type

SgDynamicOnCaptureComponentsCompleted

on_export_to_scene_context_completed

Called when components have been exported to a managed scene.

Type

SgDynamicOnExportToSceneContextCompleted

on_capture_to_scene_context_completed

Called when captured resources have been appended to a managed scene.

Type

SgDynamicOnCaptureToSceneContextCompleted

on_save_scene_context_completed

Called after a managed scene save finishes.

Type

SgDynamicOnSaveSceneContextCompleted

on_load_scene_context_completed

Called after a scene file is loaded into a managed context.

Type

SgDynamicOnLoadSceneContextCompleted

on_create_landscape_scene_mesh_descriptions_completed

Called after reusable landscape scene mesh descriptions have been created.

Type

SgDynamicOnCreateLandscapeSceneMeshDescriptionsCompleted

on_append_scene_mesh_descriptions_to_scene_context_completed

Called after scene mesh descriptions have been appended to a managed scene.

Type

SgDynamicOnAppendSceneMeshDescriptionsToSceneContextCompleted

Data structs details

SubsystemJobResult

Struct holding a result coming out of a SimplygonSubsystem job. FSubsystemJobResult is the base abstract class holding everything common between the different types of jobs.

Signature

class SubsystemJobResult

Properties

Name	Type	Description
job_id	Guid	The ID of the Simplygon subsystem job this result corresponds to.
has_error	bool	Whether the job 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 job.

Signature

class ExportSceneResult(SubsystemJobResult)

Parent

SubsystemJobResult

Properties

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

ImportSceneResult

The result coming out of an ImportScene SimplygonSubsystem job.

Signature

class ImportSceneResult(SubsystemJobResult)

Parent

SubsystemJobResult

Properties

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

SubsystemCameraResult

Result of synchronous OBB camera generation through SimplygonSubsystem.

Signature

class SubsystemCameraResult

Properties

Name	Type	Description
cameras	Array	Generated camera settings. Empty when the operation fails.
capture_image_dimensions	IntPoint	Image dimensions used to generate the cameras.
pixels_per_unit	Vector2D	Effective horizontal and vertical pixel density of the generated cameras.
has_error	bool	Whether the operation encountered an error.
error_message	String	Error details when the operation fails.

CapturedSceneImage

One captured material channel produced from one camera.

Signature

class CapturedSceneImage

Properties

Name	Type	Description
buffer_type	int	ESgBufferCaptureType value identifying the captured channel.
dimensions	IntPoint	Pixel dimensions of the image.
color_space	SgCapturedImageColorSpace	Color space used to encode the image values.
pixels	Array	Row-major BGRA8 pixels. Empty for HDR images.
hdr_pixels	Array	Row-major linear HDR pixels used for emissive capture.

CapturedSceneData

All requested channel images captured from one camera.

Signature

class CapturedSceneData

Properties

Name	Type	Description
camera	SCCameraSettings	Camera definition used to produce the images.
images	Array	One image for every requested buffer.

CaptureComponentsResult

Result of a CaptureComponents SimplygonSubsystem job.

Signature

class CaptureComponentsResult(SubsystemJobResult)

Parent

SubsystemJobResult

Properties

Name	Type	Description
captured_scene_data	Array	Captured camera definitions and requested images.

ExportToSceneContextResult

Result of exporting components to an existing managed scene.

Signature

class ExportToSceneContextResult(SubsystemJobResult)

Parent

SubsystemJobResult

Properties

CaptureToSceneContextResult

Result of appending captured resources to a managed scene.

Signature

class CaptureToSceneContextResult(SubsystemJobResult)

Parent

SubsystemJobResult

Properties

SaveSceneContextResult

Result of saving a managed scene to disk.

Signature

class SaveSceneContextResult(SubsystemJobResult)

Parent

SubsystemJobResult

Properties

Name	Type	Description
output_file_path	String	Path to the saved Simplygon scene file.

LoadSceneContextResult

Result of loading a scene file into a managed scene context.

Signature

class LoadSceneContextResult(SubsystemJobResult)

Parent

SubsystemJobResult

Properties

Name	Type	Description
scene_context	SimplygonSceneContext	Context representing the loaded manager-owned scene. Null when the job fails.

CreateLandscapeSceneMeshDescriptionsResult

Result of creating reusable landscape scene mesh descriptions.

Signature

class CreateLandscapeSceneMeshDescriptionsResult(SubsystemJobResult)

Parent

SubsystemJobResult

Properties

Name	Type	Description
scene_mesh_descriptions	Array	Geometry extracted from landscape proxies intersecting the requested bounds.

AppendSceneMeshDescriptionsToSceneContextResult

Result of appending scene mesh descriptions to a managed scene.

Signature

class AppendSceneMeshDescriptionsToSceneContextResult(SubsystemJobResult)

Parent

SubsystemJobResult

Properties

SgSceneMeshDescription

Immutable Unreal geometry and placement information used to create a Simplygon scene-mesh node. The native mesh payload is shared between copies and is not exposed as a reflected property.

Signature

class SgSceneMeshDescription

Properties

Name	Type	Description
node_name	String	Stable name assigned to the Simplygon scene-mesh node.
local_to_world	Transform	Transform from mesh-description coordinates to Unreal world space before an optional append world offset is applied.

SgLandscapeGeometryExportSettings

Settings controlling landscape discovery and conversion into reusable scene mesh descriptions.

Signature

class SgLandscapeGeometryExportSettings

Properties

Name	Type	Description
world_bounds	Box	World-space bounds used to discover intersecting landscape proxies and components.
landscape_culling_precision	LandscapeCullingPrecision	Landscape tessellation precision used while exporting clipping geometry.

SgAppendSceneGeometrySettings

Settings controlling how scene mesh descriptions are converted and appended to a managed scene.

Signature

class SgAppendSceneGeometrySettings

Properties

Name	Type	Description
selection_set_name	String	Optional Simplygon selection set that receives the appended scene-mesh node GUIDs. Empty adds only the nodes.
geometry_export_settings	SgGeometryExportSettings	Controls which optional mesh-description attributes are exported. Material IDs are omitted.
use_world_offset	bool	Whether WorldOffset is added to geometry node translations in the Simplygon scene.
world_offset	Vector	World offset added to geometry node translations when UseWorldOffset is enabled.

SCCameraSettings

Defines one perspective camera used by Scene Capture.

Signature

class SCCameraSettings

Properties

Name	Type	Description
view_name	String	Logical camera identity. Must be unique within one capture request.
position	Vector	World-space camera position in Unreal coordinates.
target	Vector	World-space point observed by the camera.
up_vector	Vector	Camera up vector.
horizontal_fov_angle	float	Horizontal perspective field of view in degrees.
vertical_fov_angle	float	Vertical perspective field of view in degrees.
near_clipping_plane	float	Optional near clipping-plane distance. Values at or below zero use the default.
far_clipping_plane	float	Optional far clipping-plane distance.

SCCaptureSettings

Controls the cameras and image resources produced by one Scene Capture operation.

Signature

class SCCaptureSettings

Properties

Name	Type	Description
name	String	Descriptive capture name used for diagnostics and temporary resources.
cameras	Array	Perspective views to capture. View names must be unique.
output_image_dimensions	IntPoint	Pixel dimensions of every captured image.
buffer_types	int	Bitmask of ESgBufferCaptureType channels to capture.

SCSceneSettings

Controls the temporary world and lighting used to render capture sources.

Signature

class SCSceneSettings

Properties

Name	Type	Description
display_name	Text	Display name assigned to the temporary capture world.
force_lod0	bool	Forces duplicated static-mesh components to render source LOD 0.
use_view_direction_for_light	bool	Aligns the directional light with each camera's view direction.
use_sky_light_only	bool	Disables directional lighting and uses only the sky light.
directional_light_intensity	float	Directional-light intensity.
sky_brightness	float	Sky-light brightness used by the temporary capture world.

SCCaptureRequestSettings

Complete source-independent configuration for one capture request.

Signature

class SCCaptureRequestSettings

Properties

Name	Type	Description
scene_settings	SCSceneSettings	Settings for the temporary capture world.
capture_settings	SCCaptureSettings	Cameras, channels and resolution used by the capture.

SCOBBCameraGenerationSettings

Controls OBB camera distribution around source component bounds.

Signature

class SCOBBCameraGenerationSettings

Properties

Name	Type	Description
view_distance	float	Expected viewing distance from the captured assets' surface.
viewport_fo_vs	Vector2D	Field of view of the target game viewport.
capture_camera_fo_vs	Vector2D	Field of view used by generated capture cameras.
capture_image_dimensions	IntPoint	Resolution of the images that CaptureComponents will produce.
minimum_obb_subdivisions	IntVector	Minimum subdivisions along each axis of the aggregate bounds.
viewport_resolution	IntPoint	Target game viewport resolution used to calculate pixel density.
maximum_camera_count	int	Maximum number of cameras that may be generated.
camera_name_prefix	String	Prefix used to generate unique camera view names.

SgCaptureComponentsToSceneSettings

Settings for capturing components and appending the captured resources to a managed scene.

Signature

class SgCaptureComponentsToSceneSettings

Properties

Name	Type	Description
capture_request_settings	SCCaptureRequestSettings	Capture request configuration.
camera_selection_set_name	String	Name of the Simplygon selection set that receives cameras.
use_world_offset	bool	Apply the same world offset used by component export to serialized camera positions and targets.
world_offset	Vector	World offset applied to serialized camera positions and targets when UseWorldOffset is enabled.

SgImportDestinationSettings

Specifies where imported objects are stored and optionally overrides their base asset name.

Signature

class SgImportDestinationSettings

Properties

Name	Type	Description
mode	SgImportDestinationMode	Determines whether each imported asset gets a new package or is added to an existing package.
new_package_directory	String	Package directory where imported asset packages are created when Mode is CreateNewPackage.
existing_package_outer	Object	Package or object whose package receives imported objects when Mode is AddToExistingPackage.
base_asset_name	String	Optional naming seed for imported objects. Source names are used when empty. Asset type prefixes are added and names are made unique within the destination.

SgSceneImportSettings

Import settings to use when importing a Simplygon scene.

Signature

class SgSceneImportSettings

Properties

Name	Type	Description
static_mesh_destination	SgImportDestinationSettings	Destination for 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.
import_custom_primitive_data	bool	Whether custom primitive data stored on scene mesh nodes during export should be applied to imported static mesh components.

SgMaterialImportSettings

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

Signature

class SgMaterialImportSettings

Properties

Name	Type	Description
material_destination	SgImportDestinationSettings	Destination for imported materials.
texture_destination	SgImportDestinationSettings	Destination for 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_custom_primitive_data_from_component	bool	Enable to store custom primitive data from components as user data on exported scene mesh nodes.
apply_transformation_from_component	bool	Enable to allow the export to transfer transformations from components.
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
material_export_mode	SgMaterialExportMode	Selects the material export implementation. None omits materials and per-triangle material IDs.
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 a Simplygon API scene when exporting a UStaticMesh.

Signature

class SgSceneMeshExportSettings

Properties

Name	Type	Description
general_export_settings	SgGeneralExportSettings	General export settings.
mesh_export_settings	SgMeshExportSettings	Settings used to export the UStaticMesh.

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
export_tex_coords	bool	Exports texture coordinates. Disabling this also disables baked material export.
export_normals	bool	Exports normals with the geometry.
export_tangents	bool	Exports tangents and bitangents with the geometry.
export_vertex_colors	bool	Exports vertex colors with the geometry.
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.
overlap_tex_coords_per_material	bool	Whether generated material-export texcoords should overlap per material. Disabling this produces lower-quality exported textures.

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.

SgMaterialExportMode

Selects whether Unreal materials and per-triangle material IDs are exported.

Values

Name	Description
NONE	Do not export materials or per-triangle material IDs.
UE_MATERIAL_BAKING	Export Unreal materials and optionally bake their properties to flattened textures.

SgImportDestinationMode

This enum specifies how imported objects are stored.

Values

Name	Description
CREATE_NEW_PACKAGE	Create a standalone package for each imported asset.
ADD_TO_EXISTING_PACKAGE	Add imported objects to the package containing ExistingPackageOuter.

SgBufferCaptureType

Material channels that can be requested from Scene Capture.

Values

Name	Description
BASE_COLOR	Base color.
ROUGHNESS	Roughness.
METALLIC	Metallic.
SPECULAR	Specular.
EMISSIVE	Emissive color.
AMBIENT_OCCLUSION	Ambient occlusion.
SUBSURFACE_COLOR	Subsurface color.
WORLD_NORMAL	World-space normal.
FINAL_IMAGE	Rendered final image.

SgCapturedImageColorSpace

Color space used to encode captured 8-bit image values.

Values

Name	Description
LINEAR	Linear values.
SRGB	sRGB-encoded values.