DatasmithCore

Windows
MacOS
Linux

Classes

Name

Description

Public class

FDatasmithAnimationSerializer

Public class

FDatasmithAnimationUtils

Public class

FDatasmithMesh

Public struct

FDatasmithMeshSourceModel

Public class

FDatasmithMeshUtils

Public class

FDatasmithSceneFactory

Factory to create the scene elements used for the export and import process.

Public class

FDatasmithSceneUtils

Public class

FDatasmithSceneXmlReader

Public class

FDatasmithSceneXmlWriter

Public class

FDatasmithTextureSampler

Public class

FDatasmithTextureUtils

Public struct

FDatasmithTransformFrameInfo

FDatasmithTransformFrameInfo holds the data for the transform values of a frame The transform values must be relative to the parent The rotation is represented as Euler angles in degrees

Public class

FDatasmithUniqueNameProvider

Name provider with internal cache implemented with a simple TSet

Public class

FDatasmithUniqueNameProviderBase

Based on a table of frequently used names, this class generates unique names with a good complexity when the number of name is important.

Public class

FDatasmithUtils

Public struct

FDatasmithVisibilityFrameInfo

FDatasmithVisibilityFrameInfo holds the visibility value for a frame

Public struct

FUVEditParameters

Public class

IDatasmithActorBindingElement

Public class

IDatasmithActorElement

Base definition for Actor Elements like geometry instances, cameras or lights

Public class

IDatasmithAreaLightElement

An area light is an emissive shape (light shape) with a light component (light type)

Public class

IDatasmithBaseAnimationElement

Public class

IDatasmithBaseMaterialElement

Public class

IDatasmithBasePropertyCaptureElement

Public class

IDatasmithCameraActorElement

Public class

IDatasmithCompositeTexture

Public class

IDatasmithCustomActorElement

Public class

IDatasmithDirectionalLightElement

Public class

IDatasmithElement

Root class for every element in a Datasmith scene

Public class

IDatasmithEnvironmentElement

Public class

IDatasmithExpressionInput

Public class

IDatasmithExpressionOutput

Public class

IDatasmithExpressionParameter

Public class

IDatasmithHierarchicalInstancedStaticMeshActorElement

Public class

IDatasmithKeyValueProperty

Public class

IDatasmithLandscapeElement

Public class

IDatasmithLevelSequenceElement

IDatasmithLevelSequenceElement holds a set of animations

Public class

IDatasmithLevelVariantSetsElement

Public class

IDatasmithLightActorElement

Public class

IDatasmithLightmassPortalElement

Represents a ALightmassPortal

Public class

IDatasmithMasterMaterialElement

Public class

IDatasmithMaterialElement

Public class

IDatasmithMaterialExpression

Public class

IDatasmithMaterialExpressionBool

Represents a UMaterialExpressionStaticBoolParameter

Public class

IDatasmithMaterialExpressionColor

Public class

IDatasmithMaterialExpressionFlattenNormal

Public class

IDatasmithMaterialExpressionFunctionCall

Public class

IDatasmithMaterialExpressionGeneric

Public class

IDatasmithMaterialExpressionScalar

Public class

IDatasmithMaterialExpressionTexture

Public class

IDatasmithMaterialExpressionTextureCoordinate

Public class

IDatasmithMaterialIDElement

Public class

IDatasmithMeshActorElement

IDatasmithActorElement used in any geometry instance independently if it could be static or movable.

Public class

IDatasmithMeshElement

IDatasmithMeshElement defines an actual geometry.

Public class

IDatasmithMetaDataElement

Public class

IDatasmithObjectPropertyCaptureElement

Public class

IDatasmithPointLightElement

Public class

IDatasmithPostProcessElement

Public class

IDatasmithPostProcessVolumeElement

Represents the APostProcessVolume object

Public class

IDatasmithPropertyCaptureElement

Public class

IDatasmithScene

Public class

IDatasmithShaderElement

Public class

IDatasmithSpotLightElement

Public class

IDatasmithSubsequenceAnimationElement

IDatasmithSubsequenceAnimationElement holds a reference to a IDatasmithLevelSequenceElement, to be played as a subsequence

Public class

IDatasmithTextureElement

Public class

IDatasmithTransformAnimationElement

IDatasmithTransformAnimationElement holds the frames for an actor transform animation

Public class

IDatasmithUEPbrMaterialElement

Public class

IDatasmithVariantElement

Public class

IDatasmithVariantSetElement

Public class

IDatasmithVisibilityAnimationElement

IDatasmithVisibilityAnimationElement holds the frames for an actor's visibility animation

Public class

UDatasmithMesh

Constants

Enums

Name

Description

Public enum

EDatasmithActorAttachmentRule

Public enum

EDatasmithActorRemovalRule

Public enum

EDatasmithAreaLightType

Public enum

EDatasmithBlendMode

Material blend modes

Public enum

EDatasmithCompletionMode

Describes how an animated node should behave after its animation has completed Mirrors EMovieSceneCompletionMode

Public enum

EDatasmithCompMode

Different methods for mixing textures: Just one texture Mix blended by weight Fresnel using a fresnel weight expression Ior using a fresnel weight expression where its curve is defined by the ior value ColorCorrectGamma color correct over the texture ColorCorrectContrast color correct over the texture Multiply simple multiplication of textures Composite blending used common image editor modes

Public enum

EDatasmithCompositeCompMode

Classic blend modes used in image editors

Public enum

EDatasmithCurveInterpMode

Public enum

EDatasmithElementAnimationSubType

Subtype of the Animation EDatasmithElementType, containing base, transform, visibility animations and etc.

Public enum

EDatasmithElementType

Element type is used to identify its class like Mesh, Actor, Light, etc.

Public enum

EDatasmithElementVariantSubType

Subtype of the Variant EDatasmithElementType, containing property value, variant, variant set, etc.

Public enum

EDatasmithKeyValuePropertyType

Key-value property

Public enum

EDatasmithLightShape

Different supported light shapes

Public enum

EDatasmithLightUnits

Light intensity units

Public enum

EDatasmithMasterMaterialQuality

Public enum

EDatasmithMasterMaterialType

Public enum

EDatasmithMaterialExpressionType

Public enum

EDatasmithMaterialMode

Regular: lambertians, glossy materials and almost every type of material but glass, metal or highly reflective.

Public enum

EDatasmithPropertyCategory

Describes a category of an UPropertyValue asset, indicating types of properties that require special handling for any reason.

Public enum

EDatasmithShaderUsage

Analog to UE material domain, besides UE has some other modes currently we only support Surface and LightFunction.

Public enum

EDatasmithTextureAddress

Texture address mode for textures. Note: Preserve enum order.

Public enum

EDatasmithTextureFilter

Texture filtering for textures.

Public enum

EDatasmithTextureFormat

Texture format for raw data importing.

Public enum

EDatasmithTextureMode

Different usage for textures. Note: Preserve enum order.

Public enum

EDatasmithTransformChannels

Describes a set of channels from a transform animation.

Public enum

EDatasmithTransformType

Supported transform types for animations

Public enum

EDSResizeTextureMode

NoResize: Keep original size NearestPowerOfTwo: resizes to the nearest power of two value (recommended) PreviousPowerOfTwo: it decreases the value to the previous power of two NextPowerOfTwo: it increases the value to the next power of two

Public enum

EDSTextureUtilsError

Public enum

ETransformChannelComponents

Enum mainly used to describe which components of a transform animation are enabled.

Functions

Name Description

Public function

IDatasmithMaterialExpressionTexture *

 

DatasmithMaterialsUtils::CreateTextureExpression

(
    const TSharedRef< IDatasmithUEPbrMaterialElement >& MaterialElement,
    const TCHAR* ParameterName,
    const TCHAR* TextureMapPath,
    const FUVEditParameters& UVParameters
)

Generate material expressions on a given DatasmithUEPbrMaterialElement to output a texture with UV settings applied to it

Public function

IDatasmithMaterialExpression *

 

DatasmithMaterialsUtils::CreateWeightedMaterialExpression

(
    const TSharedRef< IDatasmithUEPbrMaterialElement >& MaterialElement,
    const TCHAR* ParameterName,
    TOptional< FLinearColor > Color,
    TOptional< float > Scalar,
    IDatasmithMaterialExpression* Expression,
    float Weight,
    EDatasmithTextureMode TextureMode
)

Generate material expressions on a given DatasmithUEPbrMaterialElement that output a color or scalar interpolated with a MaterialExpression

Public function

constexpr bool

 

operator!

(
    EDatasmithElementType E
)

Public function

constexpr bool

 

operator!

(
    EDatasmithElementAnimationSubType E
)

Public function

constexpr bool

 

operator!

(
    EDatasmithElementVariantSubType E
)

Public function

constexpr bool

 

operator!

(
    EDatasmithTransformChannels E
)

Public function

constexpr bool

 

operator!

(
    EDatasmithPropertyCategory E
)

Public function

constexpr bool

 

operator!

(
    ETransformChannelComponents E
)

Public function

constexpr ETransformChannelComponents

 

operator&

(
    ETransformChannelComponents Lhs,
    ETransformChannelComponents Rhs
)

Public function

constexpr EDatasmithPropertyCategory

 

operator&

(
    EDatasmithPropertyCategory Lhs,
    EDatasmithPropertyCategory Rhs
)

Public function

constexpr EDatasmithTransformChannels

 

operator&

(
    EDatasmithTransformChannels Lhs,
    EDatasmithTransformChannels Rhs
)

Public function

constexpr EDatasmithElementVariantSubType

 

operator&

(
    EDatasmithElementVariantSubType Lhs,
    EDatasmithElementVariantSubType Rhs
)

Public function

constexpr EDatasmithElementAnimationSubType

 

operator&

(
    EDatasmithElementAnimationSubType Lhs,
    EDatasmithElementAnimationSubType Rhs
)

Public function

constexpr EDatasmithElementType

 

operator&

(
    EDatasmithElementType Lhs,
    EDatasmithElementType Rhs
)

Public function

EDatasmithElementType &

 

operator&=

(
    EDatasmithElementType& Lhs,
    EDatasmithElementType Rhs
)

Public function

EDatasmithElementAnimationSubType &

 

operator&=

(
    EDatasmithElementAnimationSubType& Lhs,
    EDatasmithElementAnimationSubType Rhs
)

Public function

EDatasmithElementVariantSubType &

 

operator&=

(
    EDatasmithElementVariantSubType& Lhs,
    EDatasmithElementVariantSubType Rhs
)

Public function

EDatasmithTransformChannels &

 

operator&=

(
    EDatasmithTransformChannels& Lhs,
    EDatasmithTransformChannels Rhs
)

Public function

EDatasmithPropertyCategory &

 

operator&=

(
    EDatasmithPropertyCategory& Lhs,
    EDatasmithPropertyCategory Rhs
)

Public function

ETransformChannelComponents &

 

operator&=

(
    ETransformChannelComponents& Lhs,
    ETransformChannelComponents Rhs
)

Public function

constexpr ETransformChannelComponents

 

operator^

(
    ETransformChannelComponents Lhs,
    ETransformChannelComponents Rhs
)

Public function

constexpr EDatasmithTransformChannels

 

operator^

(
    EDatasmithTransformChannels Lhs,
    EDatasmithTransformChannels Rhs
)

Public function

constexpr EDatasmithPropertyCategory

 

operator^

(
    EDatasmithPropertyCategory Lhs,
    EDatasmithPropertyCategory Rhs
)

Public function

constexpr EDatasmithElementAnimationSubType

 

operator^

(
    EDatasmithElementAnimationSubType Lhs,
    EDatasmithElementAnimationSubType Rhs
)

Public function

constexpr EDatasmithElementType

 

operator^

(
    EDatasmithElementType Lhs,
    EDatasmithElementType Rhs
)

Public function

constexpr EDatasmithElementVariantSubType

 

operator^

(
    EDatasmithElementVariantSubType Lhs,
    EDatasmithElementVariantSubType Rhs
)

Public function

EDatasmithElementType &

 

operator^=

(
    EDatasmithElementType& Lhs,
    EDatasmithElementType Rhs
)

Public function

EDatasmithElementAnimationSubType &

 

operator^=

(
    EDatasmithElementAnimationSubType& Lhs,
    EDatasmithElementAnimationSubType Rhs
)

Public function

EDatasmithElementVariantSubType &

 

operator^=

(
    EDatasmithElementVariantSubType& Lhs,
    EDatasmithElementVariantSubType Rhs
)

Public function

EDatasmithTransformChannels &

 

operator^=

(
    EDatasmithTransformChannels& Lhs,
    EDatasmithTransformChannels Rhs
)

Public function

EDatasmithPropertyCategory &

 

operator^=

(
    EDatasmithPropertyCategory& Lhs,
    EDatasmithPropertyCategory Rhs
)

Public function

ETransformChannelComponents &

 

operator^=

(
    ETransformChannelComponents& Lhs,
    ETransformChannelComponents Rhs
)

Public function

constexpr ETransformChannelComponents

 

operator|

(
    ETransformChannelComponents Lhs,
    ETransformChannelComponents Rhs
)

Public function

constexpr EDatasmithTransformChannels

 

operator|

(
    EDatasmithTransformChannels Lhs,
    EDatasmithTransformChannels Rhs
)

Public function

constexpr EDatasmithPropertyCategory

 

operator|

(
    EDatasmithPropertyCategory Lhs,
    EDatasmithPropertyCategory Rhs
)

Public function

constexpr EDatasmithElementAnimationSubType

 

operator|

(
    EDatasmithElementAnimationSubType Lhs,
    EDatasmithElementAnimationSubType Rhs
)

Public function

constexpr EDatasmithElementType

 

operator|

(
    EDatasmithElementType Lhs,
    EDatasmithElementType Rhs
)

Public function

constexpr EDatasmithElementVariantSubType

 

operator|

(
    EDatasmithElementVariantSubType Lhs,
    EDatasmithElementVariantSubType Rhs
)

Public function

EDatasmithElementType &

 

operator|=

(
    EDatasmithElementType& Lhs,
    EDatasmithElementType Rhs
)

Public function

EDatasmithElementAnimationSubType &

 

operator|=

(
    EDatasmithElementAnimationSubType& Lhs,
    EDatasmithElementAnimationSubType Rhs
)

Public function

EDatasmithElementVariantSubType &

 

operator|=

(
    EDatasmithElementVariantSubType& Lhs,
    EDatasmithElementVariantSubType Rhs
)

Public function

EDatasmithTransformChannels &

 

operator|=

(
    EDatasmithTransformChannels& Lhs,
    EDatasmithTransformChannels Rhs
)

Public function

EDatasmithPropertyCategory &

 

operator|=

(
    EDatasmithPropertyCategory& Lhs,
    EDatasmithPropertyCategory Rhs
)

Public function

ETransformChannelComponents &

 

operator|=

(
    ETransformChannelComponents& Lhs,
    ETransformChannelComponents Rhs
)

Public function

constexpr EDatasmithPropertyCategory

 

operator~

(
    EDatasmithPropertyCategory E
)

Public function

constexpr EDatasmithElementType

 

operator~

(
    EDatasmithElementType E
)

Public function

constexpr EDatasmithElementAnimationSubType

 

operator~

(
    EDatasmithElementAnimationSubType E
)

Public function

constexpr EDatasmithElementVariantSubType

 

operator~

(
    EDatasmithElementVariantSubType E
)

Public function

constexpr EDatasmithTransformChannels

 

operator~

(
    EDatasmithTransformChannels E
)

Public function

constexpr ETransformChannelComponents

 

operator~

(
    ETransformChannelComponents E
)

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback