1. Epic GamesDeveloper
  3. FExternalSource

FExternalSource

Class allowing to load a [IDatasmithScene](API\Runtime\DatasmithCore\IDatasmithScene) from a source URI.

API > API/Plugins > API/Plugins/ExternalSource

Inheritance Hierarchy

References

   
Module ExternalSource
Header /Engine/Plugins/Enterprise/DatasmithImporter/Source/ExternalSource/Public/ExternalSource.h
Include #include "ExternalSource.h"

Syntax

class FExternalSource : public TSharedFromThis< FExternalSource >

Remarks

Class allowing to load a IDatasmithScene from a source URI.

Variables

  Type Name Description
Public variable OnExternalSourceChangedDelegate OnExternalSourceChanged Delegate called on main thread every time the loaded data is updated.

Constructors

  Type Name Description
Public function  

FExternalSource ( const FSourceUri& InSourceUri
)

  

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function TFuture< TSharedPtr< IDatasmithScene > > Load the external source asynchronously, the returned TFuture gives a valid IDatasmithSceneTSharedPtr if successful.
Public function void Cancel any pending AsyncLoad() operation, pending TFuture will return invalid TSharedPtr.
Protected function void Interrupt async task notification and clear all registered delegates.
Public function const TSharedPtr< IDatasmithTranslator > & DISCLAIMER: The translator is exposed here as a temporary workaround in order to set the import option before the load and load assets with bulk data (StaticMeshes/LoadLevelSequence/etc.).
Public function Const FExternalSourceCapabilities  
Public function Const TSharedPtr< IDatasmithScene > Return the DatasmithScene if it is loaded, return an invalid TSharedPtr otherwise.
Public function Const FString As long as UFactory does not offer a way to import FExternalSource directly, we must rely on using filepaths, even for source that are not on the file system.
Public function Const FString Return the name of the scene that will be loaded.
Public function Const FMD5Hash Gives the hash of the source, only returns a valid hash after loading the scene.
Public function Const FString  
Public function Const const FSourceUri &  
Public function Const bool True when the ExternalSource is currently loading the source asynchronously.
Public function Const bool Return true if the resource pointed by this ExternalSource is available for being loaded.
Public function Const bool Return true if the loaded scene is out-of-sync and needs to be reloaded.
Public function TSharedPtr< IDatasmithScene >

Load ()

 Load the external source and return a valid IDatasmithSceneTSharedPtr if successful.
Protected function TSharedPtr< IDatasmithScene > Synchronously load the DatasmithScene.
Public function void

SetSceneName ( const TCHAR* SceneName
)

 Override the name of the scene that will be loaded.
Protected function bool Starts an async task for loading the DatasmithScene.
Protected function bool Loads a scene from the translator and starts a new translator load lifecycle.
Protected function void Broadcast OnExternalSourceChanged delegates and set pending TPromises.
Public function TSharedPtr< IDatasmithScene >

TryLoad ()

 Attempt to load the FExternalSource according to its supported capabilities.

Typedefs

Name Description
FOptionalScenePromise  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page