Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > DatasmithCore > IDatasmithScene

Light Theme

Dark Theme

IDatasmithScene

Inheritance Hierarchy

ISceneGraphNode

IDatasmithElement

IDatasmithScene

References

Module	DatasmithCore
Header	/Engine/Source/Runtime/Datasmith/DatasmithCore/Public/IDatasmithSceneElements.h
Include	#include "IDatasmithSceneElements.h"

Syntax

class IDatasmithScene : public IDatasmithElement

Destructors

	Name	Description
	~IDatasmithScene()

Functions

	Name	Description
void	AddActor ( const TSharedPtr< IDatasmithActorEl... )	Adds an Actor to the scene.
void	AddCloth ( const TSharedPtr< IDatasmithClothEl... )	#ue_ds_todo cloth api doc
void	AddLevelSequence ( const TSharedRef< IDatasmithLevelSe... )	Adds a level sequence to the scene.
void	AddLevelVariantSets ( const TSharedPtr< IDatasmithLevelVa... )	Adds a LevelVariantSets to the scene.
void	AddMaterial ( const TSharedPtr< IDatasmithBaseMat... )	Adds a new Material to the scene (it won't be applied to any mesh).
void	AddMesh ( const TSharedPtr< IDatasmithMeshEle... )	Adds a new Mesh to the scene.
void	AddMetaData ( const TSharedPtr< IDatasmithMetaDat... )	Add a metadata to the scene There should be only one metadata per Datasmith element (the element associated with the metadata)
void	AddTexture ( const TSharedPtr< IDatasmithTexture... )	Adds a new Texture Element to the scene (it won't be applied to any material).
void	AttachActor ( const TSharedPtr< IDatasmithActorEl..., const TSharedPtr< IDatasmithActorEl..., EDatasmithActorAttachmentRule Attac... )	Attach the actor to its new parent. Detach the actor if it was already attached.
void	AttachActorToSceneRoot ( const TSharedPtr< IDatasmithActorEl..., EDatasmithActorAttachmentRule Attac... )	Attach the actor to the scene root. Detach the actor if it was already attached.
void	EmptyClothes()
void	EmptyMaterials()	Remove all materials from the scene
void	EmptyMeshes()	Remove all meshes from the scene
void	EmptyTextures()	Remove all textures from the scene
const TShare...	GetActor ( int32 InIndex )	Returns the actor using this index
TSharedPtr< ...	GetActor ( int32 InIndex )	Returns the actor using this index
int32	GetActorsCount()	Returns the amount of actors added to the scene
TSharedPtr< ...	GetCloth ( int32 InIndex )
const TShare...	GetCloth ( int32 InIndex )
int32	GetClothesCount()
int32	GetExportDuration()	Returns the time taken to export the scene
const TCHAR ...	GetExporterSDKVersion()	Return the enterprise version of the SDK used by the exporter
const TCHAR ...	GetExporterVersion()	Returns the Datasmith format version used to export the scene
FVector	GetGeolocation()	Get Geolocation data of the scene.
const TCHAR ...	GetHost()	Returns the name of the host application which created the scene
TSharedPtr< ...	GetLevelSequence ( int32 InIndex )	Returns the level sequence using this index
const TShare...	GetLevelSequence ( int32 InIndex )
int32	GetLevelSequencesCount()	Returns the number of level sequences in the scene
TSharedPtr< ...	GetLevelVariantSets ( int32 InIndex )	Returns the LevelVariantSets using this index
const TShare...	GetLevelVariantSets ( int32 InIndex )
int32	GetLevelVariantSetsCount()	Returns the number of LevelVariantSets in the scene
const TShare...	GetMaterial ( int32 InIndex )
TSharedPtr< ...	GetMaterial ( int32 InIndex )
int32	GetMaterialsCount()	Returns the amount of materials added to the scene
const TShare...	GetMesh ( int32 InIndex )	Returns the mesh using this index
TSharedPtr< ...	GetMesh ( int32 InIndex )	Returns the mesh using this index
int32	GetMeshesCount()	Returns the amount of meshes added to the scene
TSharedPtr< ...	GetMetaData ( const TSharedPtr< IDatasmithElement... )
const TShare...	GetMetaData ( int32 InIndex )
TSharedPtr< ...	GetMetaData ( int32 InIndex )
const TShare...	GetMetaData ( const TSharedPtr< IDatasmithElement... )
int32	GetMetaDataCount()
const TShare...	GetPostProcess()
TSharedPtr< ...	GetPostProcess()
const TCHAR ...	GetProductName()	Returns the product name of the application used to export the scene
const TCHAR ...	GetProductVersion()	Returns the product version of the application used to export the scene
const TCHAR ...	GetResourcePath()	Returns the ';' separated list of paths where resources are stored
const TShare...	GetTexture ( int32 InIndex )
TSharedPtr< ...	GetTexture ( int32 InIndex )
int32	GetTexturesCount()	Returns the amount of textures added to the scene
bool	GetUsePhysicalSky()	Physical Sky could be generated in a large amount of modes, like material, lights etc that's why it has been added as static, just enable it and it is done.
const TCHAR ...	GetUserID()	Returns the user identifier who exported the scene
const TCHAR ...	GetUserOS()	Returns the OS name used by user who exported the scene
const TCHAR ...	GetVendor()	Returns the vendor name of the application used to export the scene
void	RemoveActor ( const TSharedPtr< IDatasmithActorEl..., EDatasmithActorRemovalRule RemoveRu... )	Remove Actor from the scene.
void	RemoveActorAt ( int32 InIndex, EDatasmithActorRemovalRule RemoveRu... )	Removes from the scene the Actor at the specified index.
void	RemoveCloth ( const TSharedPtr< IDatasmithClothEl... )
void	RemoveClothAt ( int32 InIndex )
void	RemoveLevelSequence ( const TSharedRef< IDatasmithLevelSe... )	Removes a level sequence from the scene.
void	RemoveLevelSequenceAt ( int32 InIndex )	Removes from the scene the level sequence at the specified index.
void	RemoveLevelVariantSets ( const TSharedPtr< IDatasmithLevelVa... )	Removes a LevelVariantSets from the scene.
void	RemoveLevelVariantSetsAt ( int32 InIndex )	Removes from the scene the LevelVariantSets at the specified index.
void	RemoveMaterial ( const TSharedPtr< IDatasmithBaseMat... )	Removes a Material Element from the scene.
void	RemoveMaterialAt ( int32 InIndex )	Removes from the scene the Material Element at the specified index.
void	RemoveMesh ( const TSharedPtr< IDatasmithMeshEle... )	Remove a Mesh to the scene.
void	RemoveMeshAt ( int32 InIndex )	Removes from the scene the Mesh element at the specified index.
void	RemoveMetaData ( const TSharedPtr< IDatasmithMetaDat... )
void	RemoveMetaDataAt ( int32 InIndex )
void	RemoveTexture ( const TSharedPtr< IDatasmithTexture... )	Removes a Texture Element from the scene.
void	RemoveTextureAt ( int32 InIndex )	Removes from the scene the Texture element at the specified index.
void	Reset()	Resets all the settings on the scene
void	SetExportDuration ( int32 )	Sets the time taken to export the scene.
void	SetExporterSDKVersion ( const TCHAR* )	Sets the enterprise SDK version used to export the scene.
void	SetExporterVersion ( const TCHAR* )	Sets the Datasmith version used to export the scene.
void	SetGeolocationElevation ( double )
void	SetGeolocationLatitude ( double )
void	SetGeolocationLongitude ( double )
void	SetHost ( const TCHAR* )	Sets the name of the host application from which we're exporting from.
void	SetPostProcess ( const TSharedPtr< IDatasmithPostPro... )	Set a new Postprocess for the scene
void	SetProductName ( const TCHAR* )	Sets the product name of the application used to export the scene.
void	SetProductVersion ( const TCHAR* )	Sets the product version of the application used to export the scene.
void	SetResourcePath ( const TCHAR* )	Similar to how the PATH environment variable works, sets list of paths where resources can be stored.
void	SetUsePhysicalSky ( bool bInUsePhysicalSky )	Enable or disable the usage of Physical Sky Notice that if a HDRI environment is used this gets disabled.
void	SetUserID ( const TCHAR* )	Sets the user identifier who exported the scene.
void	SetUserOS ( const TCHAR* )	Sets the user's OS name.
void	SetVendor ( const TCHAR* )	Sets the vendor name of the application used to export the scene.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Cancel