1. Epic GamesDeveloper
  3. IDatasmithScene

IDatasmithScene

API > API/Runtime > API/Runtime/DatasmithCore

   
Name IDatasmithScene
Type class
Header File /Engine/Source/Runtime/Datasmith/DatasmithCore/Public/IDatasmithSceneElements.h
Include Path #include "IDatasmithSceneElements.h"

Syntax

class IDatasmithScene : public IDatasmithElement

Implements Interfaces

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~IDatasmithScene()

   IDatasmithSceneElements.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddActor ( const TSharedPtr< IDatasmithActorElement >& InActor
)

 Adds an Actor to the scene. IDatasmithSceneElements.h  
  IDatasmithSceneElements.h  

void AddLevelSequence ( const TSharedRef< IDatasmithLevelSequenceElement >& InSequence
)

 Adds a level sequence to the scene. IDatasmithSceneElements.h  

void AddLevelVariantSets ( const TSharedPtr< IDatasmithLevelVariantSetsElement >& InLevelVariantSets
)

 Adds a LevelVariantSets to the scene. IDatasmithSceneElements.h  

void AddMaterial ( const TSharedPtr< IDatasmithBaseMaterialElement >& InMaterial
)

 Adds a new Material to the scene (it won't be applied to any mesh). IDatasmithSceneElements.h  

void AddMesh ( const TSharedPtr< IDatasmithMeshElement >& InMesh
)

 Adds a new Mesh to the scene. IDatasmithSceneElements.h  

void AddMetaData ( const TSharedPtr< IDatasmithMetaDataElement >& InMetaData
)

 Add a metadata to the scene There should be only one metadata per Datasmith element (the element associated with the metadata) IDatasmithSceneElements.h  

void AddTexture ( const TSharedPtr< IDatasmithTextureElement >& InTexture
)

 Adds a new Texture Element to the scene (it won't be applied to any material). IDatasmithSceneElements.h  

void AttachActor ( const TSharedPtr< IDatasmithActorElement >& NewParent,
const TSharedPtr< IDatasmithActorElement >& Child,
EDatasmithActorAttachmentRule AttachmentRule
)

 Attach the actor to its new parent. Detach the actor if it was already attached. IDatasmithSceneElements.h  

void AttachActorToSceneRoot ( const TSharedPtr< IDatasmithActorElement >& Child,
EDatasmithActorAttachmentRule AttachmentRule
)

 Attach the actor to the scene root. Detach the actor if it was already attached. IDatasmithSceneElements.h  

void EmptyClothes()

   IDatasmithSceneElements.h  

void EmptyMaterials()

 Remove all materials from the scene IDatasmithSceneElements.h  

void EmptyMeshes()

 Remove all meshes from the scene IDatasmithSceneElements.h  

void EmptyTextures()

 Remove all textures from the scene IDatasmithSceneElements.h  

const TSharedPtr< IDatasmithActorElement > & GetActor ( int32 InIndex
) const

 Returns the actor using this index IDatasmithSceneElements.h  
Returns the actor using this index IDatasmithSceneElements.h  

int32 GetActorsCount()

 Returns the amount of actors added to the scene IDatasmithSceneElements.h  
  IDatasmithSceneElements.h  

const TSharedPtr< IDatasmithClothElement > & GetCloth ( int32 InIndex
) const

   IDatasmithSceneElements.h  

int32 GetClothesCount()

   IDatasmithSceneElements.h  

int32 GetExportDuration()

 Returns the time taken to export the scene IDatasmithSceneElements.h  

const TCHAR * GetExporterSDKVersion()

 Return the enterprise version of the SDK used by the exporter IDatasmithSceneElements.h  

const TCHAR * GetExporterVersion()

 Returns the Datasmith format version used to export the scene IDatasmithSceneElements.h  

FVector GetGeolocation ()

 Get Geolocation data of the scene. IDatasmithSceneElements.h  

const TCHAR * GetHost()

 Returns the name of the host application which created the scene IDatasmithSceneElements.h  
Returns the level sequence using this index IDatasmithSceneElements.h  

const TSharedPtr< IDatasmithLevelSequenceElement > & GetLevelSequence ( int32 InIndex
) const

   IDatasmithSceneElements.h  

int32 GetLevelSequencesCount()

 Returns the number of level sequences in the scene IDatasmithSceneElements.h  
Returns the LevelVariantSets using this index IDatasmithSceneElements.h  
  IDatasmithSceneElements.h  

int32 GetLevelVariantSetsCount()

 Returns the number of LevelVariantSets in the scene IDatasmithSceneElements.h  

const TSharedPtr< IDatasmithBaseMaterialElement > & GetMaterial ( int32 InIndex
) const

   IDatasmithSceneElements.h  
  IDatasmithSceneElements.h  

int32 GetMaterialsCount()

 Returns the amount of materials added to the scene IDatasmithSceneElements.h  

const TSharedPtr< IDatasmithMeshElement > & GetMesh ( int32 InIndex
) const

 Returns the mesh using this index IDatasmithSceneElements.h  
Returns the mesh using this index IDatasmithSceneElements.h  

int32 GetMeshesCount()

 Returns the amount of meshes added to the scene IDatasmithSceneElements.h  
  IDatasmithSceneElements.h  

const TSharedPtr< IDatasmithMetaDataElement > & GetMetaData ( int32 InIndex
) const

   IDatasmithSceneElements.h  
  IDatasmithSceneElements.h  
  IDatasmithSceneElements.h  

int32 GetMetaDataCount()

   IDatasmithSceneElements.h  
  IDatasmithSceneElements.h  
  IDatasmithSceneElements.h  

const TCHAR * GetProductName()

 Returns the product name of the application used to export the scene IDatasmithSceneElements.h  

const TCHAR * GetProductVersion()

 Returns the product version of the application used to export the scene IDatasmithSceneElements.h  

const TCHAR * GetResourcePath()

 Returns the ';' separated list of paths where resources are stored IDatasmithSceneElements.h  

const TSharedPtr< IDatasmithTextureElement > & GetTexture ( int32 InIndex
) const

   IDatasmithSceneElements.h  
  IDatasmithSceneElements.h  

int32 GetTexturesCount()

 Returns the amount of textures added to the scene IDatasmithSceneElements.h  
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. IDatasmithSceneElements.h  

const TCHAR * GetUserID()

 Returns the user identifier who exported the scene IDatasmithSceneElements.h  

const TCHAR * GetUserOS()

 Returns the OS name used by user who exported the scene IDatasmithSceneElements.h  

const TCHAR * GetVendor()

 Returns the vendor name of the application used to export the scene IDatasmithSceneElements.h  

void RemoveActor ( const TSharedPtr< IDatasmithActorElement >& InActor,
EDatasmithActorRemovalRule RemoveRule
)

 Remove Actor from the scene. IDatasmithSceneElements.h  

void RemoveActorAt ( int32 InIndex,
EDatasmithActorRemovalRule RemoveRule
)

 Removes from the scene the Actor at the specified index. IDatasmithSceneElements.h  

void RemoveCloth ( const TSharedPtr< IDatasmithClothElement >& InElement
)

   IDatasmithSceneElements.h  

void RemoveClothAt ( int32 InIndex
)

   IDatasmithSceneElements.h  

void RemoveLevelSequence ( const TSharedRef< IDatasmithLevelSequenceElement >& InSequence
)

 Removes a level sequence from the scene. IDatasmithSceneElements.h  

void RemoveLevelSequenceAt ( int32 InIndex
)

 Removes from the scene the level sequence at the specified index. IDatasmithSceneElements.h  

void RemoveLevelVariantSets ( const TSharedPtr< IDatasmithLevelVariantSetsElement >& InLevelVariantSets
)

 Removes a LevelVariantSets from the scene. IDatasmithSceneElements.h  

void RemoveLevelVariantSetsAt ( int32 InIndex
)

 Removes from the scene the LevelVariantSets at the specified index. IDatasmithSceneElements.h  

void RemoveMaterial ( const TSharedPtr< IDatasmithBaseMaterialElement >& InMaterial
)

 Removes a Material Element from the scene. IDatasmithSceneElements.h  

void RemoveMaterialAt ( int32 InIndex
)

 Removes from the scene the Material Element at the specified index. IDatasmithSceneElements.h  

void RemoveMesh ( const TSharedPtr< IDatasmithMeshElement >& InMesh
)

 Remove a Mesh to the scene. IDatasmithSceneElements.h  

void RemoveMeshAt ( int32 InIndex
)

 Removes from the scene the Mesh element at the specified index. IDatasmithSceneElements.h  

void RemoveMetaData ( const TSharedPtr< IDatasmithMetaDataElement >& Element
)

   IDatasmithSceneElements.h  

void RemoveMetaDataAt ( int32 InIndex
)

   IDatasmithSceneElements.h  

void RemoveTexture ( const TSharedPtr< IDatasmithTextureElement >& InTexture
)

 Removes a Texture Element from the scene. IDatasmithSceneElements.h  

void RemoveTextureAt ( int32 InIndex
)

 Removes from the scene the Texture element at the specified index. IDatasmithSceneElements.h  

void Reset()

 Resets all the settings on the scene IDatasmithSceneElements.h  

void SetExportDuration ( int32
)

 Sets the time taken to export the scene. IDatasmithSceneElements.h  

void SetExporterSDKVersion ( const TCHAR*
)

 Sets the enterprise SDK version used to export the scene. IDatasmithSceneElements.h  

void SetExporterVersion ( const TCHAR*
)

 Sets the Datasmith version used to export the scene. IDatasmithSceneElements.h  

void SetGeolocationElevation ( double
)

   IDatasmithSceneElements.h  

void SetGeolocationLatitude ( double
)

   IDatasmithSceneElements.h  

void SetGeolocationLongitude ( double
)

   IDatasmithSceneElements.h  

void SetHost ( const TCHAR*
)

 Sets the name of the host application from which we're exporting from. IDatasmithSceneElements.h  

void SetPostProcess ( const TSharedPtr< IDatasmithPostProcessElement >& InPostProcess
)

 Set a new Postprocess for the scene IDatasmithSceneElements.h  

void SetProductName ( const TCHAR*
)

 Sets the product name of the application used to export the scene. IDatasmithSceneElements.h  

void SetProductVersion ( const TCHAR*
)

 Sets the product version of the application used to export the scene. IDatasmithSceneElements.h  

void SetResourcePath ( const TCHAR*
)

 Similar to how the PATH environment variable works, sets list of paths where resources can be stored. IDatasmithSceneElements.h  

void SetUsePhysicalSky ( bool bInUsePhysicalSky
)

 Enable or disable the usage of Physical Sky Notice that if a HDRI environment is used this gets disabled. IDatasmithSceneElements.h  

void SetUserID ( const TCHAR*
)

 Sets the user identifier who exported the scene. IDatasmithSceneElements.h  

void SetUserOS ( const TCHAR*
)

 Sets the user's OS name. IDatasmithSceneElements.h  

void SetVendor ( const TCHAR*
)

 Sets the vendor name of the application used to export the scene. IDatasmithSceneElements.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page