1. Epic GamesDeveloper
  3. UDMMaterialComponent

UDMMaterialComponent

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

API > API/Plugins > API/Plugins/DynamicMaterial > API/Plugins/DynamicMaterial/Components

Inheritance Hierarchy

References

   
Module DynamicMaterial
Header /Engine/Plugins/Experimental/DynamicMaterial/Source/DynamicMaterial/Public/Components/DMMaterialComponent.h
Include #include "Components/DMMaterialComponent.h"

Syntax

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

Remarks

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

Variables

  Type Name Description
Protected variable UProperty Category BlueprintReadOnly Transient visibleinstanceonly bool bComponentDirty  
Protected variable UProperty Category BlueprintReadOnly visibleinstanceonly EDMComponentLifetimeState ComponentState  
Protected variable UProperty Category BlueprintReadOnly Transient visibleinstanceonly TArray< FName > EditableProperties  
Protected variable FOnLifetimeStateChanged OnAdded  
Protected variable FOnLifetimeStateChanged OnRemoved  
Protected variable FOnUpdate OnUpdate  

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function Static bool Returns true if we can attempt to un-dirty a component.
Public function Virtual void

DoClean ()

 Performs whatever operation is involved in cleaning this component.
Public function Const UFunction BlueprintCallable, Category UDMMaterialComponent *

GetComponentByPath ( const FString& InPath
)

 Searches the component for a specific component based on a path.
Public function Const UDMMaterialComponent * Searches the component for a specific component based on a path.
Public function Const UDMMaterialComponent *  
Public function Virtual Const UFunction BlueprintPure, Category FText Returns a description of this class/object.
Public function Virtual Const FSlateIcon Returns a brush which indicates this component (type)
Public function Const UFunction BlueprintPure, Category FString Returns the complete path from the model to this component.
Public function Virtual Const FString Returns the part of the component representing just this object
Protected function Virtual Const void

GetComponentPathInternal ( TArray< FString >& OutChildComponentPathComponents
)

 Allows this object to modify the child path when generating a path.
Public function Const UFunction BlueprintPure, Category EDMComponentLifetimeState  
Public function Const UFunction BlueprintPure, Category const TArray< FName > & Returns a list of FNames for this component representing editable UPROPERTYs.
Public function FOnLifetimeStateChanged::RegistrationType & Event called when this component's state changes to Added.
Public function FOnLifetimeStateChanged::RegistrationType & Event called when this component's state changes to Removed.
Public function FOnUpdate::RegistrationType & Delegate called when this component's Update method is called.
Protected function Const UFunction BlueprintPure, Category UObject * Does some checks to see whether the out is safe to retrieve and retrieves it.
Public function Virtual Const UFunction BlueprintCallable, Category UDMMaterialComponent * Returns the component that owns this component in the model hierarchy.
Protected function Virtual Const UDMMaterialComponent * Searches the component for a specific component based on a path.
Public function Const InParentClass *

GetTypedParent ( bool bInAllowSubclasses
)

  
Public function Const UFunction BlueprintCallable, Category UDMMaterialComponent *

GetTypedParent ( UClass* InParentClass,
bool bInAllowSubclasses
)

 Returns the first in the model hierarchy above this component of the given type.
Public function Const UFunction BlueprintPure, Category bool Returns true if this component is in the Added or greater state.
Public function Const UFunction BlueprintPure, Category bool This is a kind of "useless" check, a component has always been created.
Public function Const UFunction BlueprintPure, Category bool Returns true if this component is in the Removed or greater state.
Public function Const UFunction BlueprintPure, Category bool Returns true if this component is in the Added state.
Public function Const UFunction BlueprintPure, Category bool Returns true if this component is in the original "Created" state and has not been moved onto Added or Removed.
Public function Const UFunction BlueprintPure, Category bool Returns true if this component is in the Removed state.
Public function Const UFunction BlueprintPure, Category bool Checks object flags and IsValid()
Public function Virtual Const UFunction BlueprintPure, Category bool

IsPropertyVisible ( FName InProperty
)

 Returns true the given UPROPERTY name is editable.
Protected function void Marks this component as needed to be cleaned. Preview materials updates, etc.
Public function Virtual bool

Modify ( bool bInAlwaysMarkDirty
)

  
Public function bool Returns true if this component has been marked dirty.
Public function Virtual void

NotifyPreChange ( FEditPropertyChain* InPropertyAboutToChange
)

  
Protected function Virtual void Called when a component enters the Added state.
Protected function Virtual void Called when a component enters the Removed state.
Protected function Virtual void Called when a component state changes to call the enter state functions.
Public function Virtual void Called to ensure that the object hierarchy is correct.
Public function Virtual void  
Public function Static void

PreventClean ( double InDelayFor
)

 Called to prevent cleaning for InDelayFor.
Public function UFunction BlueprintCallable, Category void Changes the component state to a new one. Should not be used to set it back to Created.
Public function Virtual UFunction BlueprintCallable, Category 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.

Typedefs

Name Description
FOnLifetimeStateChanged  
FOnUpdate  

Constants

Name Description
MinCleanTime  
MinTimeBeforeClean  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page