Navigation
API > API/Plugins > API/Plugins/DatasmithTranslator
Inheritance Hierarchy
- IDatasmithTranslator
- FDatasmithNativeTranslator
- FParametricSurfaceTranslator
References
| Module | DatasmithTranslator |
| Header | /Engine/Plugins/Enterprise/DatasmithImporter/Source/DatasmithTranslator/Public/DatasmithTranslator.h |
| Include | #include "DatasmithTranslator.h" |
Syntax
class IDatasmithTranslator
Remarks
Generic Scene exploration and realization API
Destructors
| Type | Name | Description | |
|---|---|---|---|
Functions
| Type | Name | Description | |
|---|---|---|---|
| FName | GetFName () |
||
| void | GetSceneImportOptions
(
TArray< TObjectPtr< UDatasmithOptionsBase >>& Options |
Get the additional scene import options. | |
| const FDatasmithSceneSource & | GetSource () |
||
| void | Initialize
(
FDatasmithTranslatorCapabilities& OutCapabilities |
Called to initialize this Translator instance | |
| bool | IsSourceSupported
(
const FDatasmithSceneSource& Source |
Additional validation step to ensure the given file is supported (Optional) | |
| bool | LoadCloth
(
const TSharedRef< IDatasmithClothElement > ClothElement, |
Get payload related to the given Element | |
| bool | LoadLevelSequence
(
const TSharedRef< IDatasmithLevelSequenceElement > LevelSequenceElement, |
Get payload related to the given Element | |
| bool | LoadScene
(
TSharedRef< IDatasmithScene > OutScene |
Main feature of the translator system, convert source to a datasmith scene | |
| bool | LoadStaticMesh
(
const TSharedRef< IDatasmithMeshElement > MeshElement, |
Get payload related to the given Element | |
| void | SetSceneImportOptions
(
const TArray< TObjectPtr< UDatasmithOptionsBase >>& Options |
Values of additional options as entered by the user | |
| void | SetSource
(
const FDatasmithSceneSource& Source |
Beginning of a translator instance lifecycle: setup of the source | |
| void | UnloadScene () |
Called when the scene loading is over. All translator resources can be released. |
Deprecated Functions
| Type | Name | Description | |
|---|---|---|---|
| void | GetSceneImportOptions
(
TArray< TStrongObjectPtr< UDatasmithOptionsBase >>& Options |
Deprecated, please use same method using array of TObjectPtr instead | |
| void | SetSceneImportOptions
(
TArray< TStrongObjectPtr< UDatasmithOptionsBase >>& Options |
Deprecated, please use same method using array of TObjectPtr instead |