1. Epic GamesDeveloper
  3. UDMMaterialComponent

UDMMaterialComponent

The base class for all material components. Has a few useful things.

API > API/Plugins > API/Plugins/DynamicMaterial

The base class for all material components. Has a few useful things.

   
Name UDMMaterialComponent
Type class
Header File /Engine/Plugins/VirtualProduction/DynamicMaterial/Source/DynamicMaterial/Public/Components/DMMaterialComponent.h
Include Path #include "Components/DMMaterialComponent.h"

Syntax

UCLASS (MinimalAPI, Abstract, BlueprintType, Meta=(DisplayName="Material Designer Component"))  
class UDMMaterialComponent :  
    public UObject ,  
    public FNotifyHook

Inheritance Hierarchy

Derived Classes

UDMMaterialComponent derived class hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UDMMaterialComponent()

   Components/DMMaterialComponent.h  

Typedefs

Name Type Remarks Include Path
FOnLifetimeStateChanged TMulticastDelegate_TwoParams< void, UDMMaterialComponent *, EDMComponentLifetimeState >   Components/DMMaterialComponent.h
FOnUpdate TMulticastDelegate_ThreeParams< void, UDMMaterialComponent *, UDMMaterialComponent *, EDMUpdateType >   Components/DMMaterialComponent.h

Constants

Name Type Remarks Include Path
MinCleanTime double   Components/DMMaterialComponent.h
MinTimeBeforeClean const double   Components/DMMaterialComponent.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual void DoClean()

 Performs whatever operation is involved in cleaning this component. Components/DMMaterialComponent.h  

UDMMaterialComponent * GetComponentByPath ( const FString& InPath
) const

 Searches the component for a specific component based on a path. Components/DMMaterialComponent.h
  • BlueprintCallable
  • Category="Material Designer"
Searches the component for a specific component based on a path. Components/DMMaterialComponent.h  
  Components/DMMaterialComponent.h  

virtual FText GetComponentDescription()

 Returns a description of this class/object. Components/DMMaterialComponent.h
  • BlueprintPure
  • Category="Material Designer"

virtual FSlateIcon GetComponentIcon()

 Returns a brush which indicates this component (type) Components/DMMaterialComponent.h  

FString GetComponentPath()

 Returns the complete path from the model to this component. Components/DMMaterialComponent.h
  • BlueprintPure
  • Category="Material Designer"

virtual FString GetComponentPathComponent()

 Returns the part of the component representing just this object Components/DMMaterialComponent.h  

EDMComponentLifetimeState GetComponentState()

   Components/DMMaterialComponent.h
  • BlueprintPure
  • Category="Material Designer"

const TArray< FName > & GetEditableProperties()

 Returns a list of FNames for this component representing editable UPROPERTYs. Components/DMMaterialComponent.h
  • BlueprintPure
  • Category="Material Designer"

FOnLifetimeStateChanged::RegistrationType & GetOnAdded()

 Event called when this component's state changes to Added. Components/DMMaterialComponent.h  

FOnLifetimeStateChanged::RegistrationType & GetOnRemoved()

 Event called when this component's state changes to Removed. Components/DMMaterialComponent.h  

FOnUpdate::RegistrationType & GetOnUpdate()

 Delegate called when this component's Update method is called. Components/DMMaterialComponent.h  

virtual UDMMaterialComponent * GetParentComponent()

 Returns the component that owns this component in the model hierarchy. Components/DMMaterialComponent.h
  • BlueprintCallable
  • Category="Material Designer"

InParentClass * GetTypedParent ( bool bInAllowSubclasses
) const

   Components/DMMaterialComponent.h  

UDMMaterialComponent * GetTypedParent ( UClass* InParentClass,
bool bInAllowSubclasses
) const

 Returns the first in the model hierarchy above this component of the given type. Components/DMMaterialComponent.h
  • BlueprintCallable
  • Category="Material Designer"

bool HasComponentBeenAdded()

 Returns true if this component is in the Added or greater state. Components/DMMaterialComponent.h
  • BlueprintPure
  • Category="Material Designer"
This is a kind of "useless" check, a component has always been created. Components/DMMaterialComponent.h
  • BlueprintPure
  • Category="Material Designer"

bool HasComponentBeenRemoved()

 Returns true if this component is in the Removed or greater state. Components/DMMaterialComponent.h
  • BlueprintPure
  • Category="Material Designer"

bool IsComponentAdded()

 Returns true if this component is in the Added state. Components/DMMaterialComponent.h
  • BlueprintPure
  • Category="Material Designer"

bool IsComponentCreated()

 Returns true if this component is in the original "Created" state and has not been moved onto Added or Removed. Components/DMMaterialComponent.h
  • BlueprintPure
  • Category="Material Designer"

bool IsComponentRemoved()

 Returns true if this component is in the Removed state. Components/DMMaterialComponent.h
  • BlueprintPure
  • Category="Material Designer"

bool IsComponentValid()

 Checks object flags and IsValid() Components/DMMaterialComponent.h
  • BlueprintPure
  • Category="Material Designer"

virtual bool IsPropertyVisible ( FName InProperty
) const

 Returns true the given UPROPERTY name is editable. Components/DMMaterialComponent.h
  • BlueprintPure
  • Category="Material Designer"

bool NeedsClean()

 Returns true if this component has been marked dirty. Components/DMMaterialComponent.h  

virtual void PostEditorDuplicate ( UDynamicMaterialModel* InMaterialModel,
UDMMaterialComponent* InParent
)

 Called to ensure that the object hierarchy is correct. Components/DMMaterialComponent.h  

void SetComponentState ( EDMComponentLifetimeState InNewState
)

 Changes the component state to a new one. Should not be used to set it back to Created. Components/DMMaterialComponent.h
  • BlueprintCallable
  • Category="Material Designer"

virtual void Update ( UDMMaterialComponent* InSource,
EDMUpdateType InUpdateType
)

 Event that is triggered when this component, or a sub-component, changes to trigger other updates in the model. Components/DMMaterialComponent.h
  • BlueprintCallable
  • Category="Material Designer"

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual bool Modify ( bool bInAlwaysMarkDirty
)

   Components/DMMaterialComponent.h  

virtual void PostLoad()

   Components/DMMaterialComponent.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual void GetComponentPathInternal ( TArray< FString >& OutChildComponentPathComponents
) const

 Allows this object to modify the child path when generating a path. Components/DMMaterialComponent.h  

UObject * GetOuterSafe()

 Does some checks to see whether the out is safe to retrieve and retrieves it. Components/DMMaterialComponent.h
  • BlueprintPure
  • Category="Material Designer"

virtual UDMMaterialComponent * GetSubComponentByPath ( FDMComponentPath& InPath,
const FDMComponentPathSegment& InPathSegment
) const

 Searches the component for a specific component based on a path. Components/DMMaterialComponent.h  

void MarkComponentDirty()

 Marks this component as needed to be cleaned. Preview materials updates, etc. Components/DMMaterialComponent.h  

virtual void OnComponentAdded()

 Called when a component enters the Added state. Components/DMMaterialComponent.h  

virtual void OnComponentRemoved()

 Called when a component enters the Removed state. Components/DMMaterialComponent.h  

virtual void OnComponentStateChange ( EDMComponentLifetimeState InNewState
)

 Called when a component state changes to call the enter state functions. Components/DMMaterialComponent.h  

Static

Name Remarks Include Path Unreal Specifiers

static bool CanClean()

 Returns true if we can attempt to un-dirty a component. Components/DMMaterialComponent.h  

static void PreventClean ( double InDelayFor
)

 Called to prevent cleaning for InDelayFor. Components/DMMaterialComponent.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page