Navigation
API > API/Developer > API/Developer/DatasmithFacade
| Name | FDatasmithFacadeScene |
| Type | class |
| Header File | /Engine/Source/Developer/Datasmith/DatasmithFacade/Public/DatasmithFacadeScene.h |
| Include Path | #include "DatasmithFacadeScene.h" |
Syntax
class FDatasmithFacadeScene
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FDatasmithFacadeScene
(
const TCHAR* InApplicationHostName, |
DatasmithFacadeScene.h |
Enums
Public
| Name | Remarks |
|---|---|
| EActorRemovalRule | Copy from EDatasmithActorRemovalRule. |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| SceneExporterRef | TSharedRef< FDatasmithSceneExporter > | Datasmith scene exporter. | DatasmithFacadeScene.h | |
| SceneRef | TSharedRef< IDatasmithScene > | Datasmith scene instance built with the collected elements. | DatasmithFacadeScene.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddActor
(
FDatasmithFacadeActor* InActorPtr |
Collect an element for the Datasmith scene to build. | DatasmithFacadeScene.h | |
void AddLevelSequence
(
FDatasmithFacadeLevelSequence* InLevelSequence |
DatasmithFacadeScene.h | ||
void AddLevelVariantSets
(
FDatasmithFacadeLevelVariantSets* InLevelVariantSetsPtr |
DatasmithFacadeScene.h | ||
void AddMaterial
(
FDatasmithFacadeBaseMaterial* InMaterialPtr |
DatasmithFacadeScene.h | ||
void AddMesh
(
FDatasmithFacadeMeshElement* InMeshPtr |
DatasmithFacadeScene.h | ||
void AddMetaData
(
FDatasmithFacadeMetaData* InMetaDataPtr |
DatasmithFacadeScene.h | ||
void AddTexture
(
FDatasmithFacadeTexture* InTexturePtr |
DatasmithFacadeScene.h | ||
void CleanUp() |
Validate assets and remove unused ones. | DatasmithFacadeScene.h | |
bool ExportDatasmithMesh
(
FDatasmithFacadeMeshElement* MeshElement, |
DatasmithFacadeScene.h | ||
FDatasmithFacadeMeshElement * ExportDatasmithMesh
(
FDatasmithFacadeMesh* Mesh, |
DatasmithFacadeScene.h | ||
bool ExportScene
(
const TCHAR* InOutputPath, |
Build and export a Datasmith scene instance and its scene element assets. | DatasmithFacadeScene.h | |
bool ExportScene
(
bool bCleanupUnusedElements |
Build and export a Datasmith scene instance and its scene element assets. | DatasmithFacadeScene.h | |
int32 GetActorsCount() |
DatasmithFacadeScene.h | ||
const TCHAR * GetAssetsOutputPath() |
Get the path were additional assets will be saved to. | DatasmithFacadeScene.h | |
void GetGeolocation
(
double& OutLatitude, |
Get the Datasmith scene Geolocation data | DatasmithFacadeScene.h | |
const TCHAR * GetHost() |
Gets the name of the host application which created the scene | DatasmithFacadeScene.h | |
const TCHAR * GetLabel() |
Return the Datasmith scene's label. | DatasmithFacadeScene.h | |
int32 GetLevelSequencesCount() |
DatasmithFacadeScene.h | ||
int32 GetLevelVariantSetsCount() |
DatasmithFacadeScene.h | ||
int32 GetMaterialsCount() |
Returns the number of material elements added to the scene. | DatasmithFacadeScene.h | |
int32 GetMeshesCount() |
DatasmithFacadeScene.h | ||
int32 GetMetaDataCount() |
DatasmithFacadeScene.h | ||
const TCHAR * GetName() |
Get the Datasmith scene file name | DatasmithFacadeScene.h | |
FDatasmithFacadeActor * GetNewActor
(
int32 ActorIndex |
DatasmithFacadeScene.h | ||
FDatasmithFacadeLevelSequence * GetNewLevelSequence
(
int32 LevelSequenceIndex |
DatasmithFacadeScene.h | ||
FDatasmithFacadeLevelVariantSets * GetNewLevelVariantSets
(
int32 LevelVariantSetsIndex |
DatasmithFacadeScene.h | ||
FDatasmithFacadeBaseMaterial * GetNewMaterial
(
int32 MaterialIndex |
Returns a new FDatasmithFacadeBaseMaterial pointing to the Material at the specified index. | DatasmithFacadeScene.h | |
FDatasmithFacadeMeshElement * GetNewMesh
(
int32 MeshIndex |
DatasmithFacadeScene.h | ||
FDatasmithFacadeMetaData * GetNewMetaData
(
int32 MetaDataIndex |
Returns a new FDatasmithFacadeMetaData pointing to the MetaData at the specified index. | DatasmithFacadeScene.h | |
FDatasmithFacadeMetaData * GetNewMetaData
(
FDatasmithFacadeElement* Element |
Returns a new FDatasmithFacadeMetaData pointing to the MetaData associated to the specified DatasmithElement. | DatasmithFacadeScene.h | |
FDatasmithFacadeTexture * GetNewTexture
(
int32 TextureIndex |
Returns a new FDatasmithFacadeTexture pointing to the Texture at the specified index. | DatasmithFacadeScene.h | |
const TCHAR * GetOutputPath() |
Get the path to the folder where the .datasmith file will be saved. | DatasmithFacadeScene.h | |
const TCHAR * GetProductName() |
Returns the product name of the application used to export the scene | DatasmithFacadeScene.h | |
const TCHAR * GetProductVersion() |
Returns the product version of the application used to export the scene | DatasmithFacadeScene.h | |
TSharedRef< IDatasmithScene > GetScene() |
Return the build Datasmith scene instance. | DatasmithFacadeScene.h | |
int32 GetTexturesCount() |
DatasmithFacadeScene.h | ||
const TCHAR * GetVendor() |
Returns the vendor name of the application used to export the scene | DatasmithFacadeScene.h | |
void PreExport() |
Instantiate an exporter and register export start time | DatasmithFacadeScene.h | |
void RemoveActor
(
FDatasmithFacadeActor* InActorPtr, |
DatasmithFacadeScene.h | ||
void RemoveActorAt
(
int32 ActorIndex, |
DatasmithFacadeScene.h | ||
void RemoveLevelSequence
(
FDatasmithFacadeLevelSequence* InLevelSequence |
DatasmithFacadeScene.h | ||
void RemoveLevelSequenceAt
(
int32 LevelSequenceIndex |
DatasmithFacadeScene.h | ||
void RemoveLevelVariantSets
(
FDatasmithFacadeLevelVariantSets* InLevelVariantSetsPtr |
DatasmithFacadeScene.h | ||
void RemoveLevelVariantSetsAt
(
int32 LevelVariantSetsIndex |
DatasmithFacadeScene.h | ||
void RemoveMaterial
(
FDatasmithFacadeBaseMaterial* InMaterialPtr |
Removes a Material Element from the scene. | DatasmithFacadeScene.h | |
void RemoveMaterialAt
(
int32 MaterialIndex |
DatasmithFacadeScene.h | ||
void RemoveMesh
(
FDatasmithFacadeMeshElement* MeshElement |
DatasmithFacadeScene.h | ||
void RemoveMeshAt
(
int32 MeshIndex |
DatasmithFacadeScene.h | ||
void RemoveMetaData
(
FDatasmithFacadeMetaData* InMetaDataPtr |
DatasmithFacadeScene.h | ||
void RemoveMetaDataAt
(
int32 MetaDataIndex |
DatasmithFacadeScene.h | ||
void RemoveTexture
(
FDatasmithFacadeTexture* InTexturePtr |
DatasmithFacadeScene.h | ||
void RemoveTextureAt
(
int32 TextureIndex |
DatasmithFacadeScene.h | ||
void Reset() |
DatasmithFacadeScene.h | ||
void SerializeLevelSequences() |
Save Datasmith LevelSequences into files and specify those files in each corresponding LevelSequenceElement | DatasmithFacadeScene.h | |
void SetGeolocationElevation
(
double Elevation |
DatasmithFacadeScene.h | ||
void SetGeolocationLatitude
(
double Latitude |
Set the Datasmith scene Geolocation data | DatasmithFacadeScene.h | |
void SetGeolocationLongitude
(
double Longitude |
DatasmithFacadeScene.h | ||
void SetHost
(
const TCHAR* InHost |
Sets the name of the host application from which we're exporting from. | DatasmithFacadeScene.h | |
void SetLabel
(
const TCHAR* InSceneLabel |
Set the Datasmith scene's label. | DatasmithFacadeScene.h | |
void SetName
(
const TCHAR* InName |
Set the Datasmith scene name | DatasmithFacadeScene.h | |
void SetOutputPath
(
const TCHAR* InOutputPath |
Set the path to the folder where the .datasmith file will be saved. | DatasmithFacadeScene.h | |
void SetProductName
(
const TCHAR* InApplicationProductName |
Sets the product name of the application used to export the scene. | DatasmithFacadeScene.h | |
void SetProductVersion
(
const TCHAR* InApplicationProductVersion |
Sets the product version of the application used to export the scene. | DatasmithFacadeScene.h | |
void SetVendor
(
const TCHAR* InApplicationVendorName |
Sets the vendor name of the application used to export the scene. | DatasmithFacadeScene.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static void Shutdown() |
Manually shutdown the Facade and close down all the core engine systems and release the resources they allocated You don't need to call this function on Windows platform. | DatasmithFacadeScene.h |