1. Epic GamesDeveloper
  3. FDMMaterialBuildState

FDMMaterialBuildState

BuildState is a class that stores the current state of a material that is being built.

API > API/Plugins > API/Plugins/DynamicMaterialEditor

BuildState is a class that stores the current state of a material that is being built. It stores useful lists of UMaterialExpressions relating to various object within the builder, such a Stages or Sources. It is an entirely transient object. It is not meant to be saved outside of the material building processs. It also provides some helper functions for creating UMaterialExpressions.

   
Name FDMMaterialBuildState
Type struct
Header File /Engine/Plugins/VirtualProduction/DynamicMaterial/Source/DynamicMaterialEditor/Public/Model/DMMaterialBuildState.h
Include Path #include "Model/DMMaterialBuildState.h"

Syntax

struct FDMMaterialBuildState :  
    public IDMMaterialBuildStateInterface ,  
    public TSharedFromThis< FDMMaterialBuildState >

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

FDMMaterialBuildState ( UMaterial* InDynamicMaterial,
UDynamicMaterialModel* InMaterialModel,
bool bInDirtyAssets
)

   Model/DMMaterialBuildState.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FDMMaterialBuildState()

   Model/DMMaterialBuildState.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bDirtyAssets bool   Model/DMMaterialBuildState.h  
bIgnoreUVs bool   Model/DMMaterialBuildState.h  
CurrentProperty const UDMMaterialProperty *   Model/DMMaterialBuildState.h  
DynamicMaterial UMaterial *   Model/DMMaterialBuildState.h  
GlobalExpressions TMap< FName, UMaterialExpression * >   Model/DMMaterialBuildState.h  
Layers TMap< const UDMMaterialLayerObject *, TArray< UMaterialExpression * > >   Model/DMMaterialBuildState.h  
MaterialModel UDynamicMaterialModel *   Model/DMMaterialBuildState.h  
OtherExpressions TSet< UMaterialExpression * >   Model/DMMaterialBuildState.h  
PreviewObject UObject *   Model/DMMaterialBuildState.h  
SlotProperties TMap< const UDMMaterialSlot *, TMap< EDMMaterialPropertyType, TArray< UMaterialExpression * > > >   Model/DMMaterialBuildState.h  
Slots TMap< const UDMMaterialSlot *, TArray< UMaterialExpression * > >   Model/DMMaterialBuildState.h  
Stages TMap< const UDMMaterialStage *, TArray< UMaterialExpression * > >   Model/DMMaterialBuildState.h  
StageSources TMap< const UDMMaterialStageSource *, TArray< UMaterialExpression * > >   Model/DMMaterialBuildState.h  
Utils TSharedRef< FDMMaterialBuildUtils >   Model/DMMaterialBuildState.h  
Values TMap< const UDMMaterialValue *, TArray< UMaterialExpression * > >   Model/DMMaterialBuildState.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddLayerExpressions ( const UDMMaterialLayerObject* InLayer,
const TArray< UMaterialExpression* >& InLayerExpressions
)

   Model/DMMaterialBuildState.h  

void AddSlotExpressions ( const UDMMaterialSlot* InSlot,
const TArray< UMaterialExpression* >& InSlotExpressions
)

   Model/DMMaterialBuildState.h  

void AddSlotPropertyExpressions ( const UDMMaterialSlot* InSlot,
const TMap< EDMMaterialPropertyType, TArray< UMaterialExpression* > >& InSlotPropertyExpressio...
)

   Model/DMMaterialBuildState.h  

void AddStageExpressions ( const UDMMaterialStage* InStage,
const TArray< UMaterialExpression* >& InStageExpressions
)

   Model/DMMaterialBuildState.h  

void AddStageSourceExpressions ( const UDMMaterialStageSource* InStageSource,
const TArray< UMaterialExpression* >& InStageSourceExpressions
)

   Model/DMMaterialBuildState.h  
The current material property being generated for. Model/DMMaterialBuildState.h  

UMaterialExpression * GetGlobalExpression ( FName InName
) const

 Global expression. Model/DMMaterialBuildState.h  

UMaterialExpression * GetLastLayerExpression ( const UDMMaterialLayerObject* InLayer
) const

   Model/DMMaterialBuildState.h  

UMaterialExpression * GetLastSlotExpression ( const UDMMaterialSlot* InSlot
) const

   Model/DMMaterialBuildState.h  

UMaterialExpression * GetLastSlotPropertyExpression ( const UDMMaterialSlot* InSlot,
EDMMaterialPropertyType InMaterialProperty
) const

   Model/DMMaterialBuildState.h  

UMaterialExpression * GetLastStageExpression ( const UDMMaterialStage* InStage
) const

   Model/DMMaterialBuildState.h  

UMaterialExpression * GetLastStageSourceExpression ( const UDMMaterialStageSource* InStageSource
) const

   Model/DMMaterialBuildState.h  

const TArray< UMaterialExpression * > & GetLayerExpressions ( const UDMMaterialLayerObject* InLayer
) const

   Model/DMMaterialBuildState.h  

const TMap< const UDMMaterialLayerObject *, TArray< UMaterialExpression * > > & GetLayerMap()

   Model/DMMaterialBuildState.h  

TArray< const UDMMaterialLayerObject * > GetLayers()

   Model/DMMaterialBuildState.h  

FExpressionInput * GetMaterialProperty ( EDMMaterialPropertyType InProperty
) const

 Returns the FExpressionInput for the given material property on the material's editor only data. Model/DMMaterialBuildState.h  

UObject * GetPreviewObject()

 Whether the build state is building a full material or a preview. Model/DMMaterialBuildState.h  

const TArray< UMaterialExpression * > & GetSlotExpressions ( const UDMMaterialSlot* InSlot
) const

   Model/DMMaterialBuildState.h  

const TMap< const UDMMaterialSlot *, TArray< UMaterialExpression * > > & GetSlotMap()

   Model/DMMaterialBuildState.h  

const TMap< EDMMaterialPropertyType, TArray< UMaterialExpression * > > & GetSlotPropertyExpressions ( const UDMMaterialSlot* InSlot
)

   Model/DMMaterialBuildState.h  

TArray< const UDMMaterialSlot * > GetSlots()

   Model/DMMaterialBuildState.h  

const TArray< UMaterialExpression * > & GetStageExpressions ( const UDMMaterialStage* InStage
) const

   Model/DMMaterialBuildState.h  

const TMap< const UDMMaterialStage *, TArray< UMaterialExpression * > > & GetStageMap()

   Model/DMMaterialBuildState.h  

TArray< const UDMMaterialStage * > GetStages()

   Model/DMMaterialBuildState.h  

const TArray< UMaterialExpression * > & GetStageSourceExpressions ( const UDMMaterialStageSource* InStageSource
) const

   Model/DMMaterialBuildState.h  

const TMap< const UDMMaterialStageSource *, TArray< UMaterialExpression * > > & GetStageSourceMap()

   Model/DMMaterialBuildState.h  

TArray< const UDMMaterialStageSource * > GetStageSources()

   Model/DMMaterialBuildState.h  

bool HasLayer ( const UDMMaterialLayerObject* InLayer
) const

 Layers. Model/DMMaterialBuildState.h  

bool HasSlot ( const UDMMaterialSlot* InSlot
) const

 Slots. Model/DMMaterialBuildState.h  

bool HasSlotProperties ( const UDMMaterialSlot* InSlot
) const

   Model/DMMaterialBuildState.h  

bool HasStage ( const UDMMaterialStage* InStage
) const

 Stages. Model/DMMaterialBuildState.h  

bool HasStageSource ( const UDMMaterialStageSource* InStageSource
) const

 Stage Sources. Model/DMMaterialBuildState.h  

bool IsIgnoringUVs()

 If ignoring UVs is on, UV nodes will not be processed. Useful for preview materials. Model/DMMaterialBuildState.h  

void SetCurrentMaterialProperty ( const UDMMaterialProperty* InProperty
)

   Model/DMMaterialBuildState.h  

void SetGlobalExpression ( FName InName,
UMaterialExpression* InExpression
)

   Model/DMMaterialBuildState.h  

void SetIgnoreUVs()

   Model/DMMaterialBuildState.h  

void SetPreviewObject ( UObject* InObject
)

   Model/DMMaterialBuildState.h  

bool ShouldDirtyAssets()

 Whether assets can potentially be dirtied by the build process. Model/DMMaterialBuildState.h  

Overridden from IDMMaterialBuildStateInterface

Name Remarks Include Path Unreal Specifiers

virtual void AddOtherExpressions ( const TArray< UMaterialExpression* >& InOtherExpressions
)

 Other expression. Model/DMMaterialBuildState.h  

virtual void AddValueExpressions ( const UDMMaterialValue* InValue,
const TArray< UMaterialExpression* >& InValueExpressions
)

   Model/DMMaterialBuildState.h  

virtual IDMMaterialBuildUtilsInterface & GetBuildUtils()

 A handy set of tools for creating material expressions. Model/DMMaterialBuildState.h  

virtual UMaterial * GetDynamicMaterial()

   Model/DMMaterialBuildState.h  

virtual UMaterialExpression * GetLastValueExpression ( const UDMMaterialValue* InValue
) const

   Model/DMMaterialBuildState.h  

virtual UDynamicMaterialModel * GetMaterialModel()

   Model/DMMaterialBuildState.h  

virtual const TSet< UMaterialExpression * > & GetOtherExpressions()

   Model/DMMaterialBuildState.h  

virtual const TArray< UMaterialExpression * > & GetValueExpressions ( const UDMMaterialValue* InValue
) const

   Model/DMMaterialBuildState.h  

virtual const TMap< const UDMMaterialValue *, TArray< UMaterialExpression * > > & GetValueMap()

   Model/DMMaterialBuildState.h  

virtual TArray< const UDMMaterialValue * > GetValues()

   Model/DMMaterialBuildState.h  

virtual bool HasValue ( const UDMMaterialValue* InValue
) const

 Values. Model/DMMaterialBuildState.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page