IDatasmithScene

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

DatasmithCore

Header

/Engine/Source/Runtime/Datasmith/DatasmithCore/Public/IDatasmithSceneElements.h

Include

#include "IDatasmithSceneElements.h"

Syntax

class IDatasmithScene : public IDatasmithElement

Destructors

Name Description

Public function Virtual

~IDatasmithScene()

Functions

Name Description

Public function

void

 

AddActor

(
    const TSharedPtr< IDatasmithActorEl...
)

Adds an Actor to the scene.

Public function

void

 

AddLevelSequence

(
    const TSharedRef< IDatasmithLevelSe...
)

Adds a level sequence to the scene.

Public function

void

 

AddLevelVariantSets

(
    const TSharedPtr< IDatasmithLevelVa...
)

Adds a LevelVariantSets to the scene.

Public function

void

 

AddLODScreenSize

(
    float ScreenSize
)

Adds a new LOD screen size setting.

Public function

void

 

AddMaterial

(
    const TSharedPtr< IDatasmithBaseMat...
)

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

Public function

void

 

AddMesh

(
    const TSharedPtr< IDatasmithMeshEle...
)

Adds a new Mesh to the scene.

Public function

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)

Public function

void

 

AddTexture

(
    const TSharedPtr< IDatasmithTexture...
)

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

Public function

void

 

AttachActor

(
    const TSharedPtr< IDatasmithActorEl...,
    const TSharedPtr< IDatasmithActorEl...,
    EDatasmithActorAttachmentRule Attac...
)

Attach the actor to his new parent. Detach the actor if he was already attach.

Public function

void

 

AttachActorToSceneRoot

(
    const TSharedPtr< IDatasmithActorEl...,
    EDatasmithActorAttachmentRule Attac...
)

Attach the actor to the scene root. Detach the actor if he was already attach.

Public function

void

 

EmptyMaterials()

Remove all materials from the scene

Public function

void

 

EmptyMeshes()

Remove all meshes from the scene

Public function

void

 

EmptyTextures()

Remove all textures from the scene

Public function Const

const TShare...

 

GetActor

(
    int32 InIndex
)

Returns the actor using this index

Public function

TSharedPtr< ...

 

GetActor

(
    int32 InIndex
)

Returns the actor using this index

Public function Const

int32

 

GetActorsCount()

Returns the amount of actors added to the scene

Public function Const

int32

 

GetExportDuration()

Returns the time taken to export the scene

Public function Const

const TCHAR ...

 

GetExporterSDKVersion()

Return the enterprise version of the SDK used by the exporter

Public function Const

const TCHAR ...

 

GetExporterVersion()

Returns the Datasmith format version used to export the scene

Public function Const

const TCHAR ...

 

GetHost()

Sets the name of the host application which created the scene

Public function

TSharedPtr< ...

 

GetLevelSequence

(
    int32 InIndex
)

Returns the level sequence using this index

Public function Const

const TShare...

 

GetLevelSequence

(
    int32 InIndex
)

Public function Const

int32

 

GetLevelSequencesCount()

Returns the number of level sequences in the scene

Public function

TSharedPtr< ...

 

GetLevelVariantSets

(
    int32 InIndex
)

Returns the LevelVariantSets using this index

Public function Const

const TShare...

 

GetLevelVariantSets

(
    int32 InIndex
)

Public function Const

int32

 

GetLevelVariantSetsCount()

Returns the number of LevelVariantSets in the scene

Public function Const

float

 

GetLODScreenSize

(
    int32 InIndex
)

Public function Const

int32

 

GetLODScreenSizesCount()

Public function Const

const TShare...

 

GetMaterial

(
    int32 InIndex
)

Public function

TSharedPtr< ...

 

GetMaterial

(
    int32 InIndex
)

Public function Const

int32

 

GetMaterialsCount()

Returns the amount of materials added to the scene

Public function Const

const TShare...

 

GetMesh

(
    int32 InIndex
)

Returns the mesh using this index

Public function

TSharedPtr< ...

 

GetMesh

(
    int32 InIndex
)

Returns the mesh using this index

Public function Const

int32

 

GetMeshesCount()

Returns the amount of meshes added to the scene

Public function Const

const TShare...

 

GetMetaData

(
    const TSharedPtr< IDatasmithElement...
)

Public function

TSharedPtr< ...

 

GetMetaData

(
    const TSharedPtr< IDatasmithElement...
)

Public function Const

const TShare...

 

GetMetaData

(
    int32 InIndex
)

Public function

TSharedPtr< ...

 

GetMetaData

(
    int32 InIndex
)

Public function Const

int32

 

GetMetaDataCount()

Public function Const

const TShare...

 

GetPostProcess()

Public function

TSharedPtr< ...

 

GetPostProcess()

Public function Const

const TCHAR ...

 

GetProductName()

Returns the product name of the application used to export the scene

Public function Const

const TCHAR ...

 

GetProductVersion()

Returns the product version of the application used to export the scene

Public function Const

const TCHAR ...

 

GetResourcePath()

Returns the original path resources were stored

Public function Const

const TShare...

 

GetTexture

(
    int32 InIndex
)

Public function

TSharedPtr< ...

 

GetTexture

(
    int32 InIndex
)

Public function Const

int32

 

GetTexturesCount()

Returns the amount of textures added to the scene

Public function Const

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.

Public function Const

const TCHAR ...

 

GetUserID()

Returns the user identifier who exported the scene

Public function Const

const TCHAR ...

 

GetUserOS()

Returns the OS name used by user who exported the scene

Public function Const

const TCHAR ...

 

GetVendor()

Returns the vendor name of the application used to export the scene

Public function

void

 

RemoveActor

(
    const TSharedPtr< IDatasmithActorEl...,
    EDatasmithActorRemovalRule RemoveRu...
)

Remove Actor from the scene.

Public function

void

 

RemoveActorAt

(
    int32 InIndex,
    EDatasmithActorRemovalRule RemoveRu...
)

Removes from the scene the Actor at the specified index.

Public function

void

 

RemoveLevelSequence

(
    const TSharedRef< IDatasmithLevelSe...
)

Removes a level sequence from the scene.

Public function

void

 

RemoveLevelSequenceAt

(
    int32 InIndex
)

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

Public function

void

 

RemoveLevelVariantSets

(
    const TSharedPtr< IDatasmithLevelVa...
)

Removes a LevelVariantSets from the scene.

Public function

void

 

RemoveLevelVariantSetsAt

(
    int32 InIndex
)

Removes from the scene the LevelVariantSets at the specified index.

Public function

void

 

RemoveMaterial

(
    const TSharedPtr< IDatasmithBaseMat...
)

Removes a Material Element from the scene.

Public function

void

 

RemoveMaterialAt

(
    int32 InIndex
)

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

Public function

void

 

RemoveMesh

(
    const TSharedPtr< IDatasmithMeshEle...
)

Remove a Mesh to the scene.

Public function

void

 

RemoveMeshAt

(
    int32 InIndex
)

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

Public function

void

 

RemoveMetaData

(
    const TSharedPtr< IDatasmithMetaDat...
)

Public function

void

 

RemoveMetaDataAt

(
    int32 InIndex
)

Public function

void

 

RemoveTexture

(
    const TSharedPtr< IDatasmithTexture...
)

Removes a Texture Element from the scene.

Public function

void

 

RemoveTextureAt

(
    int32 InIndex
)

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

Public function

void

 

Reset()

Resets all the settings on the scene

Public function

void

 

SetExportDuration

(
    int32
)

Sets the time taken to export the scene.

Public function

void

 

SetExporterSDKVersion

(
    const TCHAR*
)

Sets the enterprise SDK version used to export the scene.

Public function

void

 

SetExporterVersion

(
    const TCHAR*
)

Sets the Datasmith version used to export the scene.

Public function

void

 

SetHost

(
    const TCHAR*
)

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

Public function

void

 

SetPostProcess

(
    const TSharedPtr< IDatasmithPostPro...
)

Set a new Postprocess for the scene

Public function

void

 

SetProductName

(
    const TCHAR*
)

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

Public function

void

 

SetProductVersion

(
    const TCHAR*
)

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

Public function

void

 

SetResourcePath

(
    const TCHAR*
)

Sets the original path resources were stored.

Public function

void

 

SetUsePhysicalSky

(
    bool bInUsePhysicalSky
)

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

Public function

void

 

SetUserID

(
    const TCHAR*
)

Sets the user identifier who exported the scene.

Public function

void

 

SetUserOS

(
    const TCHAR*
)

Sets the user's OS name.

Public function

void

 

SetVendor

(
    const TCHAR*
)

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