Simplygon Subsystem for Blueprint
Subsystem Methods
| Name | Description |
|---|---|
| ExportActorsToScene | Run an async export job of the given actors using the given export settings. |
| ExportStaticMeshComponentsToScene | Run an async export job for the given static mesh components using the given export settings. |
| ExportStaticMeshToScene | Run an async export job for the given static mesh using the given export settings. |
| ImportSceneAsActors | Run an async import job using the given import settings to spawn imported actors into the given world. |
| ImportSceneAsStaticMeshes | Run an async import job using the given import settings to import Static Meshes into the project. |
| CreateSceneContext | Create an empty managed Simplygon scene context. |
| ExportStaticMeshComponentsToSceneContext | Export static mesh components into a managed scene. |
| CaptureComponentsToSceneContext | Capture components and append the resources to a managed scene. |
| SaveSceneContextToFile | Save a managed scene to a Simplygon scene file. |
| LoadSceneContextFromFile | Load a Simplygon scene file into a new managed context. |
| CreateLandscapeSceneMeshDescriptions | Create reusable scene mesh descriptions from intersecting landscape geometry. |
| AppendSceneMeshDescriptionsToSceneContext | Append reusable scene mesh descriptions to a managed scene. |
| CaptureComponents | Capture components without appending the images to a managed scene. |
| GenerateOBBCamerasForComponents | Generate OBB-distributed cameras for component capture. |
Subsystem Properties
| Name | Description |
|---|---|
| OnExportSceneCompleted | Delegate type for triggering when an export job is completed. |
| OnImportSceneCompleted | Delegate type for triggering when an import job is completed. |
| OnCaptureComponentsCompleted | Called when a component capture job is completed. |
| OnExportToSceneContextCompleted | Called when components have been exported to a managed scene. |
| OnCaptureToSceneContextCompleted | Called when captured resources have been appended to a managed scene. |
| OnSaveSceneContextCompleted | Called after a managed scene save finishes. |
| OnLoadSceneContextCompleted | Called after a scene file is loaded into a managed context. |
| OnCreateLandscapeSceneMeshDescriptionsCompleted | Called after reusable landscape scene mesh descriptions have been created. |
| OnAppendSceneMeshDescriptionsToSceneContextCompleted | 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
ExportActorsToScene
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.
ExportStaticMeshComponentsToScene
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.
ExportStaticMeshToScene
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.
ImportSceneAsActors
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.
ImportSceneAsStaticMeshes
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.
CreateSceneContext
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.
ExportStaticMeshComponentsToSceneContext
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.
CaptureComponentsToSceneContext
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.
SaveSceneContextToFile
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.
LoadSceneContextFromFile
Starts an asynchronous job that loads a Simplygon scene file into a new managed context. The context is returned through the load completion result.
CreateLandscapeSceneMeshDescriptions
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.
AppendSceneMeshDescriptionsToSceneContext
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.
CaptureComponents
Starts an asynchronous component capture and returns the captured pixels through the capture completion result.
GenerateOBBCamerasForComponents
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.
Properties details
OnExportSceneCompleted
Delegate type for triggering when an export job is completed.
OnImportSceneCompleted
Delegate type for triggering when an import job is completed.
OnCaptureComponentsCompleted
Called when a component capture job is completed.
OnExportToSceneContextCompleted
Called when components have been exported to a managed scene.
OnCaptureToSceneContextCompleted
Called when captured resources have been appended to a managed scene.
OnSaveSceneContextCompleted
Called after a managed scene save finishes.
OnLoadSceneContextCompleted
Called after a scene file is loaded into a managed context.
OnCreateLandscapeSceneMeshDescriptionsCompleted
Called after reusable landscape scene mesh descriptions have been created.
OnAppendSceneMeshDescriptionsToSceneContextCompleted
Called after scene mesh descriptions have been appended to a managed scene.
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.
ExportSceneResult
The result coming out of an Export[Actors|StaticMeshComponents|StaticMesh]ToScene SimplygonSubsystem job.
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 details
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.
