FExternalSource

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

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

TSharedFromThis

FExternalSource

FDirectLinkExternalSource

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

		Name	Description
	OnExternalSourc...	OnExternalSourceChanged	Delegate called on main thread every time the loaded data is updated.

Constructors

	Name	Description
	FExternalSource ( const FSourceUri& InSourceUri )

Destructors

	Name	Description
	~FExternalSource()

Functions

	Name	Description
TFuture< TSh...	AsyncLoad()	Load the external source asynchronously, the returned TFuture gives a valid IDatasmithScene TSharedPtr if successful.
void	CancelAsyncLoad()	Cancel any pending AsyncLoad() operation, pending TFuture will return invalid TSharedPtr.
void	ClearOnExternalSourceLoadedDelegates()	Interrupt async task notification and clear all registered delegates.
const TShare...	GetAssetTranslator()	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.).
FExternalSou...	GetCapabilities()
TSharedPtr< ...	GetDatasmithScene()	Return the DatasmithScene if it is loaded, return an invalid TSharedPtr otherwise.
FString	GetFallbackFilepath()	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.
FString	GetSceneName()	Return the name of the scene that will be loaded.
FMD5Hash	GetSourceHash()	Gives the hash of the source, only returns a valid hash after loading the scene.
FString	GetSourceName()
const FSourc...	GetSourceUri()
bool	IsAsyncLoading()	True when the ExternalSource is currently loading the source asynchronously.
bool	IsAvailable()	Return true if the resource pointed by this ExternalSource is available for being loaded.
bool	IsOutOfSync()	Return true if the loaded scene is out-of-sync and needs to be reloaded.
TSharedPtr< ...	Load()	Load the external source and return a valid IDatasmithScene TSharedPtr if successful.
TSharedPtr< ...	LoadImpl()	Synchronously load the DatasmithScene.
void	SetSceneName ( const TCHAR* SceneName )	Override the name of the scene that will be loaded.
bool	StartAsyncLoad()	Starts an async task for loading the DatasmithScene.
void	TriggerOnExternalSourceChanged()	Broadcast OnExternalSourceChanged delegates and set pending TPromises.
TSharedPtr< ...	TryLoad()	Attempt to load the FExternalSource according to its supported capabilities.

Typedefs

Name	Description
FOptionalScenePromise