Simplygon Subsystem for C++

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.
GetNativeOnExportSceneCompleted	Returns handle to delegate that will get triggered when an export job is completed.
GetNativeOnImportSceneCompleted	Returns handle to delegate that will get triggered when an import job is completed.
GetNativeOnCaptureComponentsCompleted	Returns the native completion delegate for component capture jobs.
GetNativeOnExportToSceneContextCompleted	Returns the native completion delegate for managed component-export jobs.
GetNativeOnCaptureToSceneContextCompleted	Returns the native completion delegate for managed component-capture jobs.
GetNativeOnSaveSceneContextCompleted	Returns the native completion delegate for managed scene-save jobs.
GetNativeOnLoadSceneContextCompleted	Returns the native completion delegate for managed scene-load jobs.
GetNativeOnCreateLandscapeSceneMeshDescriptionsCompleted	Returns the native completion delegate for landscape scene-mesh-description jobs.
GetNativeOnAppendSceneMeshDescriptionsToSceneContextCompleted	Returns the native completion delegate for managed scene-mesh-description append jobs.

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
FSubsystemJobResult	Struct holding a result coming out of a SimplygonSubsystem job.
FExportSceneResult	The result coming out of an Export[Actors
FImportSceneResult	The result coming out of an ImportScene SimplygonSubsystem job.
FSubsystemCameraResult	Result of synchronous OBB camera generation through SimplygonSubsystem.
FCapturedSceneImage	One captured material channel produced from one camera.
FCapturedSceneData	All requested channel images captured from one camera.
FCaptureComponentsResult	Result of a CaptureComponents SimplygonSubsystem job.
FExportToSceneContextResult	Result of exporting components to an existing managed scene.
FCaptureToSceneContextResult	Result of appending captured resources to a managed scene.
FSaveSceneContextResult	Result of saving a managed scene to disk.
FLoadSceneContextResult	Result of loading a scene file into a managed scene context.
FCreateLandscapeSceneMeshDescriptionsResult	Result of creating reusable landscape scene mesh descriptions.
FAppendSceneMeshDescriptionsToSceneContextResult	Result of appending scene mesh descriptions to a managed scene.
FSgSceneMeshDescription	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.
FSgLandscapeGeometryExportSettings	Settings controlling landscape discovery and conversion into reusable scene mesh descriptions.
FSgAppendSceneGeometrySettings	Settings controlling how scene mesh descriptions are converted and appended to a managed scene.
FSCCameraSettings	Defines one perspective camera used by Scene Capture.
FSCCaptureSettings	Controls the cameras and image resources produced by one Scene Capture operation.
FSCSceneSettings	Controls the temporary world and lighting used to render capture sources.
FSCCaptureRequestSettings	Complete source-independent configuration for one capture request.
FSCOBBCameraGenerationSettings	Controls OBB camera distribution around source component bounds.
FSgCaptureComponentsToSceneSettings	Settings for capturing components and appending the captured resources to a managed scene.
FSgImportDestinationSettings	Specifies where imported objects are stored and optionally overrides their base asset name.
FSgSceneImportSettings	Import settings to use when importing a Simplygon scene.
FSgGeometryImportSettings	Import settings to use when importing a Simplygon geometry data to a FMeshDescription.
FSgMaterialImportSettings	Import settings to use when importing a Simplygon material to UMaterialInterface.
FSgComponentExportSettings	Export settings to use when exporting a UStaticMeshComponent.
FSgGeneralExportSettings	General export settings
FSgMeshExportSettings	Settings used to setup Simplygon API scene when exporting an individual UStaticMesh.
FSgSceneMeshExportSettings	Settings used to setup a Simplygon API scene when exporting a UStaticMesh.
FSgSceneExportSettings	Export settings to use when exporting a Simplygon scene.
FSgGeometryExportSettings	Export settings for geometry data to use when exporting a Simplygon scene.
FSgMaterialExportSettings	Export settings for material data to use when exporting a Simplygon scene.
FSgMaterialProperties	The material properties that are enabled will get flattened to textures, and exported with the scene.

Enums

Name	Description
ESgSeparateMaterialsMode	The material separation mode to use when there is unique data sampled in a material.
ESgSourceModelExportMode	This enum specifies which source model to export.
ESgMaterialExportMode	Selects whether Unreal materials and per-triangle material IDs are exported.
ESgImportDestinationMode	This enum specifies how imported objects are stored.
ESgBufferCaptureType	Material channels that can be requested from Scene Capture.
ESgCapturedImageColorSpace	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.

Signature

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

Parameters

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

Return value

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

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.

Signature

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

Parameters

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

Return value

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

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.

Signature

FGuid ExportStaticMeshToScene(
		const FString& ExportFilePath,
		UStaticMesh* Mesh,
		const FSgSceneMeshExportSettings& ExportSettings
	)

Parameters

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

Return value

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

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.

Signature

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

Parameters

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

Return value

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

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.

Signature

FGuid ImportSceneAsStaticMeshes(
		const FString& PathToScene,
		const FSgSceneImportSettings& ImportSettings
	)

Parameters

Name	Type	Description
PathToScene	const FString&	Path to the Simplygon scene that should be imported.
ImportSettings	const FSgSceneImportSettings&	Import settings.

Return value

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

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.

Signature

USimplygonSceneContext* CreateSceneContext()

Parameters

Function has no parameters

Return value

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

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.

Signature

FGuid ExportStaticMeshComponentsToSceneContext(
		USimplygonSceneContext* SceneContext,
		const TArray<UStaticMeshComponent*>& Components,
		const FSgSceneExportSettings& ExportSettings
	)

Parameters

Name	Type	Description
SceneContext	USimplygonSceneContext*	Context that receives the exported components. Existing resources are preserved.
Components	const TArray<UStaticMeshComponent*>&	Static mesh components to export.
ExportSettings	const FSgSceneExportSettings&	Settings controlling mesh, material and geometry-data export.

Return value

Type: FGuid Identifier of the asynchronous export job.

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.

Signature

FGuid CaptureComponentsToSceneContext(
		USimplygonSceneContext* SceneContext,
		const TArray<UStaticMeshComponent*>& Components,
		const FSgCaptureComponentsToSceneSettings& Settings
	)

Parameters

Name	Type	Description
SceneContext	USimplygonSceneContext*	Context that receives the captured resources.
Components	const TArray<UStaticMeshComponent*>&	Static mesh components to capture together.
Settings	const FSgCaptureComponentsToSceneSettings&	Capture configuration and destination camera selection-set name.

Return value

Type: FGuid Identifier of the asynchronous capture job.

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.

Signature

FGuid SaveSceneContextToFile(
		USimplygonSceneContext* SceneContext,
		const FString& FilePath
	)

Parameters

Name	Type	Description
SceneContext	USimplygonSceneContext*	Context identifying the scene to save.
FilePath	const FString&	Destination path for the Simplygon scene file.

Return value

Type: FGuid Identifier of the asynchronous save job.

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.

Signature

FGuid LoadSceneContextFromFile(
		const FString& FilePath
	)

Parameters

Name	Type	Description
FilePath	const FString&	Path to the Simplygon scene file.

Return value

Type: FGuid Identifier of the asynchronous load job.

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.

Signature

FGuid CreateLandscapeSceneMeshDescriptions(
		UWorld* World,
		const FSgLandscapeGeometryExportSettings& Settings
	)

Parameters

Name	Type	Description
World	UWorld*	World containing the landscape geometry.
Settings	const FSgLandscapeGeometryExportSettings&	World-space discovery bounds and landscape tessellation precision.

Return value

Type: FGuid Identifier of the asynchronous landscape extraction job.

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.

Signature

FGuid AppendSceneMeshDescriptionsToSceneContext(
		USimplygonSceneContext* SceneContext,
		const TArray<FSgSceneMeshDescription>& SceneMeshDescriptions,
		const FSgAppendSceneGeometrySettings& Settings
	)

Parameters

Name	Type	Description
SceneContext	USimplygonSceneContext*	Context that receives the geometry.
SceneMeshDescriptions	const TArray<FSgSceneMeshDescription>&	Geometry and placement information to append.
Settings	const FSgAppendSceneGeometrySettings&	Geometry export, selection-set and coordinate-frame settings.

Return value

Type: FGuid Identifier of the asynchronous append job.

CaptureComponents

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

Signature

FGuid CaptureComponents(
		const TArray<UStaticMeshComponent*>& Components,
		const FSCCaptureRequestSettings& CaptureSettings
	)

Parameters

Name	Type	Description
Components	const TArray<UStaticMeshComponent*>&	Static mesh components to capture together.
CaptureSettings	const FSCCaptureRequestSettings&	Scene, camera, output resolution and channel settings.

Return value

Type: FGuid Identifier of the asynchronous capture job.

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.

Signature

FSubsystemCameraResult GenerateOBBCamerasForComponents(
		const TArray<UStaticMeshComponent*>& Components,
		const FSCOBBCameraGenerationSettings& Settings
	)

Parameters

Name	Type	Description
Components	const TArray<UStaticMeshComponent*>&	Components whose aggregate world-space bounds should be covered.
Settings	const FSCOBBCameraGenerationSettings&	Camera-distribution settings.

Return value

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

GetNativeOnExportSceneCompleted

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

Signature

FSgNativeOnExportCompleted& GetNativeOnExportSceneCompleted()

Parameters

Function has no parameters

Return value

Type: FSgNativeOnExportCompleted& The delegate handle.

GetNativeOnImportSceneCompleted

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

Signature

FSgNativeOnImportCompleted& GetNativeOnImportSceneCompleted()

Parameters

Function has no parameters

Return value

Type: FSgNativeOnImportCompleted& The delegate handle.

GetNativeOnCaptureComponentsCompleted

Returns the native completion delegate for component capture jobs.

Signature

FSgNativeOnCaptureComponentsCompleted& GetNativeOnCaptureComponentsCompleted()

Parameters

Function has no parameters

Return value

Type: FSgNativeOnCaptureComponentsCompleted& The delegate handle.

GetNativeOnExportToSceneContextCompleted

Returns the native completion delegate for managed component-export jobs.

Signature

FSgNativeOnExportToSceneContextCompleted& GetNativeOnExportToSceneContextCompleted()

Parameters

Function has no parameters

Return value

Type: FSgNativeOnExportToSceneContextCompleted& The delegate handle.

GetNativeOnCaptureToSceneContextCompleted

Returns the native completion delegate for managed component-capture jobs.

Signature

FSgNativeOnCaptureToSceneContextCompleted& GetNativeOnCaptureToSceneContextCompleted()

Parameters

Function has no parameters

Return value

Type: FSgNativeOnCaptureToSceneContextCompleted& The delegate handle.

GetNativeOnSaveSceneContextCompleted

Returns the native completion delegate for managed scene-save jobs.

Signature

FSgNativeOnSaveSceneContextCompleted& GetNativeOnSaveSceneContextCompleted()

Parameters

Function has no parameters

Return value

Type: FSgNativeOnSaveSceneContextCompleted& The delegate handle.

GetNativeOnLoadSceneContextCompleted

Returns the native completion delegate for managed scene-load jobs.

Signature

FSgNativeOnLoadSceneContextCompleted& GetNativeOnLoadSceneContextCompleted()

Parameters

Function has no parameters

Return value

Type: FSgNativeOnLoadSceneContextCompleted& The delegate handle.

GetNativeOnCreateLandscapeSceneMeshDescriptionsCompleted

Returns the native completion delegate for landscape scene-mesh-description jobs.

Signature

FSgNativeOnCreateLandscapeSceneMeshDescriptionsCompleted& GetNativeOnCreateLandscapeSceneMeshDescriptionsCompleted()

Parameters

Function has no parameters

Return value

Type: FSgNativeOnCreateLandscapeSceneMeshDescriptionsCompleted& The delegate handle.

GetNativeOnAppendSceneMeshDescriptionsToSceneContextCompleted

Returns the native completion delegate for managed scene-mesh-description append jobs.

Signature

FSgNativeOnAppendSceneMeshDescriptionsToSceneContextCompleted& GetNativeOnAppendSceneMeshDescriptionsToSceneContextCompleted()

Parameters

Function has no parameters

Return value

Type: FSgNativeOnAppendSceneMeshDescriptionsToSceneContextCompleted& The delegate handle.

Properties details

OnExportSceneCompleted

Delegate type for triggering when an export job is completed.

Type

FSgDynamicOnExportCompleted

OnImportSceneCompleted

Delegate type for triggering when an import job is completed.

Type

FSgDynamicOnImportCompleted

OnCaptureComponentsCompleted

Called when a component capture job is completed.

Type

FSgDynamicOnCaptureComponentsCompleted

OnExportToSceneContextCompleted

Called when components have been exported to a managed scene.

Type

FSgDynamicOnExportToSceneContextCompleted

OnCaptureToSceneContextCompleted

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

Type

FSgDynamicOnCaptureToSceneContextCompleted

OnSaveSceneContextCompleted

Called after a managed scene save finishes.

Type

FSgDynamicOnSaveSceneContextCompleted

OnLoadSceneContextCompleted

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

Type

FSgDynamicOnLoadSceneContextCompleted

OnCreateLandscapeSceneMeshDescriptionsCompleted

Called after reusable landscape scene mesh descriptions have been created.

Type

FSgDynamicOnCreateLandscapeSceneMeshDescriptionsCompleted

OnAppendSceneMeshDescriptionsToSceneContextCompleted

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

Type

FSgDynamicOnAppendSceneMeshDescriptionsToSceneContextCompleted

Data structs details

FSubsystemJobResult

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

struct FSubsystemJobResult

Properties

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

FExportSceneResult

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

Signature

struct FExportSceneResult: public FSubsystemJobResult

Parent

FSubsystemJobResult

Properties

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

FImportSceneResult

The result coming out of an ImportScene SimplygonSubsystem job.

Signature

struct FImportSceneResult: public FSubsystemJobResult

Parent

FSubsystemJobResult

Properties

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

FSubsystemCameraResult

Result of synchronous OBB camera generation through SimplygonSubsystem.

Signature

struct FSubsystemCameraResult

Properties

Name	Type	Description
Cameras	TArray<FSCCameraSettings>	Generated camera settings. Empty when the operation fails.
CaptureImageDimensions	FIntPoint	Image dimensions used to generate the cameras.
PixelsPerUnit	FVector2D	Effective horizontal and vertical pixel density of the generated cameras.
bHasError	bool	Whether the operation encountered an error.
ErrorMessage	FString	Error details when the operation fails.

FCapturedSceneImage

One captured material channel produced from one camera.

Signature

struct FCapturedSceneImage

Properties

Name	Type	Description
BufferType	int32	ESgBufferCaptureType value identifying the captured channel.
Dimensions	FIntPoint	Pixel dimensions of the image.
ColorSpace	ESgCapturedImageColorSpace	Color space used to encode the image values.
Pixels	TArray<FColor>	Row-major BGRA8 pixels. Empty for HDR images.
HDRPixels	TArray<FLinearColor>	Row-major linear HDR pixels used for emissive capture.

FCapturedSceneData

All requested channel images captured from one camera.

Signature

struct FCapturedSceneData

Properties

Name	Type	Description
Camera	FSCCameraSettings	Camera definition used to produce the images.
Images	TArray<FCapturedSceneImage>	One image for every requested buffer.

FCaptureComponentsResult

Result of a CaptureComponents SimplygonSubsystem job.

Signature

struct FCaptureComponentsResult: public FSubsystemJobResult

Parent

FSubsystemJobResult

Properties

Name	Type	Description
CapturedSceneData	TArray<FCapturedSceneData>	Captured camera definitions and requested images.

FExportToSceneContextResult

Result of exporting components to an existing managed scene.

Signature

struct FExportToSceneContextResult: public FSubsystemJobResult

Parent

FSubsystemJobResult

Properties

FCaptureToSceneContextResult

Result of appending captured resources to a managed scene.

Signature

struct FCaptureToSceneContextResult: public FSubsystemJobResult

Parent

FSubsystemJobResult

Properties

FSaveSceneContextResult

Result of saving a managed scene to disk.

Signature

struct FSaveSceneContextResult: public FSubsystemJobResult

Parent

FSubsystemJobResult

Properties

Name	Type	Description
OutputFilePath	FString	Path to the saved Simplygon scene file.

FLoadSceneContextResult

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

Signature

struct FLoadSceneContextResult: public FSubsystemJobResult

Parent

FSubsystemJobResult

Properties

Name	Type	Description
SceneContext	TObjectPtr<USimplygonSceneContext>	Context representing the loaded manager-owned scene. Null when the job fails.

FCreateLandscapeSceneMeshDescriptionsResult

Result of creating reusable landscape scene mesh descriptions.

Signature

struct FCreateLandscapeSceneMeshDescriptionsResult: public FSubsystemJobResult

Parent

FSubsystemJobResult

Properties

Name	Type	Description
SceneMeshDescriptions	TArray<FSgSceneMeshDescription>	Geometry extracted from landscape proxies intersecting the requested bounds.

FAppendSceneMeshDescriptionsToSceneContextResult

Result of appending scene mesh descriptions to a managed scene.

Signature

struct FAppendSceneMeshDescriptionsToSceneContextResult: public FSubsystemJobResult

Parent

FSubsystemJobResult

Properties

FSgSceneMeshDescription

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

struct FSgSceneMeshDescription

Properties

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

FSgLandscapeGeometryExportSettings

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

Signature

struct FSgLandscapeGeometryExportSettings

Properties

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

FSgAppendSceneGeometrySettings

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

Signature

struct FSgAppendSceneGeometrySettings

Properties

Name	Type	Description
SelectionSetName	FString	Optional Simplygon selection set that receives the appended scene-mesh node GUIDs. Empty adds only the nodes.
GeometryExportSettings	FSgGeometryExportSettings	Controls which optional mesh-description attributes are exported. Material IDs are omitted.
UseWorldOffset	bool	Whether WorldOffset is added to geometry node translations in the Simplygon scene.
WorldOffset	FVector	World offset added to geometry node translations when UseWorldOffset is enabled.

FSCCameraSettings

Defines one perspective camera used by Scene Capture.

Signature

struct FSCCameraSettings

Properties

Name	Type	Description
ViewName	FString	Logical camera identity. Must be unique within one capture request.
Position	FVector	World-space camera position in Unreal coordinates.
Target	FVector	World-space point observed by the camera.
UpVector	FVector	Camera up vector.
HorizontalFOVAngle	float	Horizontal perspective field of view in degrees.
VerticalFOVAngle	float	Vertical perspective field of view in degrees.
NearClippingPlane	float	Optional near clipping-plane distance. Values at or below zero use the default.
FarClippingPlane	float	Optional far clipping-plane distance.

FSCCaptureSettings

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

Signature

struct FSCCaptureSettings

Properties

Name	Type	Description
Name	FString	Descriptive capture name used for diagnostics and temporary resources.
Cameras	TArray<FSCCameraSettings>	Perspective views to capture. View names must be unique.
OutputImageDimensions	FIntPoint	Pixel dimensions of every captured image.
BufferTypes	int32	Bitmask of ESgBufferCaptureType channels to capture.

FSCSceneSettings

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

Signature

struct FSCSceneSettings

Properties

Name	Type	Description
DisplayName	FText	Display name assigned to the temporary capture world.
bForceLOD0	bool	Forces duplicated static-mesh components to render source LOD 0.
bUseViewDirectionForLight	bool	Aligns the directional light with each camera's view direction.
bUseSkyLightOnly	bool	Disables directional lighting and uses only the sky light.
DirectionalLightIntensity	float	Directional-light intensity.
SkyBrightness	float	Sky-light brightness used by the temporary capture world.

FSCCaptureRequestSettings

Complete source-independent configuration for one capture request.

Signature

struct FSCCaptureRequestSettings

Properties

Name	Type	Description
SceneSettings	FSCSceneSettings	Settings for the temporary capture world.
CaptureSettings	FSCCaptureSettings	Cameras, channels and resolution used by the capture.

FSCOBBCameraGenerationSettings

Controls OBB camera distribution around source component bounds.

Signature

struct FSCOBBCameraGenerationSettings

Properties

Name	Type	Description
ViewDistance	double	Expected viewing distance from the captured assets' surface.
ViewportFOVs	FVector2D	Field of view of the target game viewport.
CaptureCameraFOVs	FVector2D	Field of view used by generated capture cameras.
CaptureImageDimensions	FIntPoint	Resolution of the images that CaptureComponents will produce.
MinimumOBBSubdivisions	FIntVector	Minimum subdivisions along each axis of the aggregate bounds.
ViewportResolution	FIntPoint	Target game viewport resolution used to calculate pixel density.
MaximumCameraCount	int32	Maximum number of cameras that may be generated.
CameraNamePrefix	FString	Prefix used to generate unique camera view names.

FSgCaptureComponentsToSceneSettings

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

Signature

struct FSgCaptureComponentsToSceneSettings

Properties

Name	Type	Description
CaptureRequestSettings	FSCCaptureRequestSettings	Capture request configuration.
CameraSelectionSetName	FString	Name of the Simplygon selection set that receives cameras.
UseWorldOffset	bool	Apply the same world offset used by component export to serialized camera positions and targets.
WorldOffset	FVector	World offset applied to serialized camera positions and targets when UseWorldOffset is enabled.

FSgImportDestinationSettings

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

Signature

struct FSgImportDestinationSettings

Properties

Name	Type	Description
Mode	ESgImportDestinationMode	Determines whether each imported asset gets a new package or is added to an existing package.
NewPackageDirectory	FString	Package directory where imported asset packages are created when Mode is CreateNewPackage.
ExistingPackageOuter	TObjectPtr<UObject>	Package or object whose package receives imported objects when Mode is AddToExistingPackage.
BaseAssetName	FString	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.

FSgSceneImportSettings

Import settings to use when importing a Simplygon scene.

Signature

struct FSgSceneImportSettings

Properties

Name	Type	Description
StaticMeshDestination	FSgImportDestinationSettings	Destination for imported static meshes.
GeometrySettings	FSgGeometryImportSettings	Settings related to geometry import.
MaterialSettings	FSgMaterialImportSettings	Settings related to material import.

FSgGeometryImportSettings

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

Signature

struct FSgGeometryImportSettings

Properties

Name	Type	Description
TexCoordNames	TArray<FString>	List of tex coord names used by the Simplygon Geometry Data to import. These will be imported in the order they are written, eg the name at index 0 in TexCoordNames will be imported into texcoord index 0 in the mesh description.
VertexColorName	FString	The name of the vertex color field used by the Simplygon Geometry Data to import.
bImportCustomPrimitiveData	bool	Whether custom primitive data stored on scene mesh nodes during export should be applied to imported static mesh components.

FSgMaterialImportSettings

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

Signature

struct FSgMaterialImportSettings

Properties

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

FSgComponentExportSettings

Export settings to use when exporting a UStaticMeshComponent.

Signature

struct FSgComponentExportSettings

Properties

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

FSgGeneralExportSettings

General export settings

Signature

struct FSgGeneralExportSettings

Properties

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

FSgMeshExportSettings

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

Signature

struct FSgMeshExportSettings

Properties

Name	Type	Description
MaterialExportMode	ESgMaterialExportMode	Selects the material export implementation. None omits materials and per-triangle material IDs.
GeometryExportSettings	FSgGeometryExportSettings	Geometry specific export settings.
MaterialExportSettings	FSgMaterialExportSettings	Material specific export settings.
SourceModelExportMode	ESgSourceModelExportMode	This setting specifies which source model to export (LODIndex or HiResMeshDescription).
LODIndex	int32	If SourceModelExportMode is set to LODIndex, the export will use the specified LODIndex during export.

FSgSceneMeshExportSettings

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

Signature

struct FSgSceneMeshExportSettings

Properties

Name	Type	Description
GeneralExportSettings	FSgGeneralExportSettings	General export settings.
MeshExportSettings	FSgMeshExportSettings	Settings used to export the UStaticMesh.

FSgSceneExportSettings

Export settings to use when exporting a Simplygon scene.

Signature

struct FSgSceneExportSettings

Properties

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

FSgGeometryExportSettings

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

Signature

struct FSgGeometryExportSettings

Properties

Name	Type	Description
ExportTexCoords	bool	Exports texture coordinates. Disabling this also disables baked material export.
ExportNormals	bool	Exports normals with the geometry.
ExportTangents	bool	Exports tangents and bitangents with the geometry.
ExportVertexColors	bool	Exports vertex colors with the geometry.
TexCoordsIndexToName	TMap<int32, FString>	Texture coordinate mapping from index in the mesh description to name in Simplygon. If not specified, the default map will be used (0 -> "0", ..., 7 -> "7").

FSgMaterialExportSettings

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

Signature

struct FSgMaterialExportSettings

Properties

Name	Type	Description
ExportBakedMaterials	bool	Exports flattened textures for the material properties specified in MaterialPropertiesToExport.
MaterialProperties	FSgMaterialProperties	The material properties that are enabled will get flattened to textures, and exported with the scene.
TexCoordsName	FString	This is a new texcoord field generated by Simplygon during export, it can be used as source when baking materials and textures using Simplygon's material baking feature.
MaterialSeparationMode	ESgSeparateMaterialsMode	The material separation mode to use when there is unique data sampled in a material, such as vertex colors, transformations or world position.
AddTexCoordsToFirstAvailableIndex	bool	If true, put flatten texcoords at the first available texcoord index in Simplygon's GeometryData.
OverlapTexCoordsPerMaterial	bool	Whether generated material-export texcoords should overlap per material. Disabling this produces lower-quality exported textures.

FSgMaterialProperties

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

Signature

struct FSgMaterialProperties

Properties

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

Enums details

ESgSeparateMaterialsMode

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

Values

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

ESgSourceModelExportMode

This enum specifies which source model to export.

Values

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

ESgMaterialExportMode

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

Values

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

ESgImportDestinationMode

This enum specifies how imported objects are stored.

Values

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

ESgBufferCaptureType

Material channels that can be requested from Scene Capture.

Values

Name	Description
BaseColor	Base color.
Roughness	Roughness.
Metallic	Metallic.
Specular	Specular.
Emissive	Emissive color.
AmbientOcclusion	Ambient occlusion.
SubsurfaceColor	Subsurface color.
WorldNormal	World-space normal.
FinalImage	Rendered final image.

ESgCapturedImageColorSpace

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

Values

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