1. Epic GamesDeveloper
  3. UOptimusDeformer

UOptimusDeformer

A Deformer Graph is an asset that is used to create and control custom deformations on skeletal meshes.

API > API/Plugins > API/Plugins/OptimusCore

Inheritance Hierarchy

References

   
Module OptimusCore
Header /Engine/Plugins/Animation/DeformerGraph/Source/OptimusCore/Public/OptimusDeformer.h
Include #include "OptimusDeformer.h"

Syntax

UCLASS&40;Blueprintable, BlueprintType&41;  
class UOptimusDeformer :  
    public UMeshDeformer,  
    public IInterface_PreviewMeshProvider,  
    public IOptimusPathResolver,  
    public IOptimusNodeGraphCollectionOwner,  
    public IOptimusNodeFunctionLibraryOwner

Remarks

A Deformer Graph is an asset that is used to create and control custom deformations on skeletal meshes.

Variables

  Type Name Description
Protected variable UProperty TArray< FOptimusComputeGraphInfo > ComputeGraphs The compute graphs to execute.
Public variable UProperty Category, EditAnywhere TObjectPtr< USkeletalMesh > Mesh  

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function UOptimusComponentSourceBinding *

AddComponentBinding ( const UOptimusComponentSource* InComponentSource,
FName InName
)

 Component Bindings.
Protected function bool

AddComponentBindingDirect ( UOptimusComponentSourceBinding* InComponentBinding,
const int32 InIndex
)

  
Public function UOptimusResourceDescription *

AddResource ( FOptimusDataTypeRef InDataTypeRef,
FName InName
)

 Resources.
Protected function bool

AddResourceDirect ( UOptimusResourceDescription* InResourceDesc,
const int32 InIndex
)

 Adds a resource that was created by this deformer and is owned by it.
Public function UOptimusNodeGraph * Add a setup graph.
Public function UOptimusNodeGraph *

AddTriggerGraph ( const FString& InName
)

 Add a trigger graph.
Public function UOptimusVariableDescription *

AddVariable ( FOptimusDataTypeRef InDataTypeRef,
FName InName
)

 Variables.
Protected function bool

AddVariableDirect ( UOptimusVariableDescription* InVariableDesc,
const int32 InIndex
)

 Adds a resource that was created by this deformer and is owned by it.
Public function bool

Compile ()

 Graph compilation.
Protected function UOptimusComponentSourceBinding *

CreateComponentBindingDirect ( const UOptimusComponentSource* InComponentSource,
FName InName
)

  
Public function UOptimusNodeGraph *  
Protected function UOptimusResourceDescription * Create a resource owned by this deformer but does not add it to the list of known resources.
Protected function UOptimusVariableDescription * Create a resource owned by this deformer but does not add it to the list of known resources.
Public function UOptimusActionStack * Get the action stack for this deformer graph
Public function FOptimusCompileBegin & Returns a multicast delegate that can be subscribed to listen for the start of compilation.
Public function FOptimusCompileEnd & Returns a multicast delegate that can be subscribed to listen for the end of compilation but before shader compilation is complete.
Public function FOptimusGraphCompileMessageDelegate & Returns a multicast delegate that can be subscribed to listen compilation results.
Public function Const UFunction blueprintgetter const TArray< UOptimusComponentSourceBinding * > &  
Public function Const TArray< UOptimusNode * >  
Public function Const TArray< UOptimusNode * >  
Public function Const TArray< UOptimusNode * >  
Public function FOptimusGlobalNotifyDelegate & Returns the global delegate used to notify on global operations (e.g. graph, variable, resource lifecycle events).
Public function Const UFunction blueprintgetter const TArray< UOptimusResourceDescription * > &  
Public function Const EOptimusDeformerStatus Returns the current compilation/error status of the deformer
Public function Const UOptimusNodeGraph * Returns the update graph. The update graph will always exist, and there is only one.
Public function Const UFunction blueprintgetter const TArray< UOptimusVariableDescription * > &  
Public function void Mark the deformer as modified.
Protected function Const void

Notify ( EOptimusGlobalNotifyType InNotifyType,
UObject* InObject
)

  
Public function bool  
Protected function bool  
Public function bool Remove a graph and delete it.
Public function bool  
Protected function bool  
Public function bool  
Protected function bool  
Public function bool

RenameComponentBinding ( UOptimusComponentSourceBinding* InBinding,
FName InNewName,
bool bInForceChange
)

  
Protected function bool  
Public function bool

RenameResource ( UOptimusResourceDescription* InResourceDesc,
FName InNewName,
bool bInForceChange
)

  
Protected function bool

RenameResourceDirect ( UOptimusResourceDescription* InResourceDesc,
FName InNewName
)

  
Public function bool

RenameVariable ( UOptimusVariableDescription* InVariableDesc,
FName InNewName,
bool bInForceChange
)

  
Protected function bool

RenameVariableDirect ( UOptimusVariableDescription* InVariableDesc,
FName InNewName
)

  
Public function Const void

SetAllInstancesCanbeActive ( bool bInCanBeActive
)

  
Public function bool

SetComponentBindingSource ( UOptimusComponentSourceBinding* InBinding,
const UOptimusComponentSource* InComponentSource,
bool bInForceChange
)

  
Protected function bool  
Public function bool

SetResourceDataDomain ( UOptimusResourceDescription* InResourceDesc,
const FOptimusDataDomain& InDataDomain,
bool bInForceChange
)

  
Protected function bool  
Public function bool

SetResourceDataType ( UOptimusResourceDescription* InResourceDesc,
FOptimusDataTypeRef InDataType,
bool bInForceChange
)

  
Protected function bool  
Protected function void  
Public function bool

SetVariableDataType ( UOptimusVariableDescription* InVariableDesc,
FOptimusDataTypeRef InDataType,
bool bInForceChange
)

  
Protected function bool  

Overridden from UMeshDeformer

  Type Name Description
Public function Virtual UMeshDeformerInstance *

CreateInstance ( UMeshComponent* InMeshComponent,
UMeshDeformerInstanceSettings* InSettings
)

 Create an instance of the mesh deformer.
Public function Virtual UMeshDeformerInstanceSettings *

CreateSettingsInstance ( UMeshComponent* InMeshComponent
)

 Create persistent settings for the mesh deformer instance

Overridden from UObject

  Type Name Description
Public function Virtual void Called before destroying the object.
Public function Virtual Const void Gathers a list of asset registry searchable tags which are name/value pairs with some type information This only needs to be implemented for asset objects
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.
Public function Virtual void

PostRename ( UObject* OldOuter,
const FName OldName
)

 Whenever the asset is renamed/moved, generated classes parented to the old package are not moved to the new package automatically (see FAssetRenameManager), so we have to manually perform the move/rename, to avoid invalid reference to the old package
Public function Virtual void UObject overrides.

Overridden from IInterface_PreviewMeshProvider

  Type Name Description
Public function Virtual Const USkeletalMesh * Get the preview mesh for this asset
Public function Virtual void

SetPreviewMesh ( USkeletalMesh* PreviewMesh,
bool bMarkAsDirty
)

 Set the preview mesh for this asset

Overridden from IOptimusPathResolver

  Type Name Description
Public function Virtual IOptimusNodeGraphCollectionOwner *

ResolveCollectionPath ( const FString& InPath
)

 Takes a collection path string and attempts to resolve it to a specific graph collection.
Public function Virtual Const UOptimusComponentSourceBinding *

ResolveComponentBinding ( FName InBindingName
)

  
Public function Virtual UOptimusNodeGraph *

ResolveGraphPath ( const FString& InPath
)

 Takes a graph path string and attempts to resolve it to a specific graph
Public function Virtual UOptimusNode *

ResolveNodePath ( const FString& InPath
)

 Takes a node path string and attempts to resolve it to a specific node
Public function Virtual UOptimusNodePin *

ResolvePinPath ( const FString& InPinPath
)

 Takes a dot-separated path string and attempts to resolve it to a specific pin on a node.
Public function Virtual Const UOptimusResourceDescription *

ResolveResource ( FName InResourceName
)

  
Public function Virtual Const UOptimusVariableDescription *

ResolveVariable ( FName InVariableName
)

  

Overridden from IOptimusNodeGraphCollectionOwner

  Type Name Description
Public function Virtual bool

AddGraph ( UOptimusNodeGraph* InGraph,
int32 InInsertBefore
)

 Takes an existing graph and adds it to this graph collection. If the graph cannot be added, the object remains unchanged and this function returns false.
Public function Virtual UOptimusNodeGraph *

CreateGraph ( EOptimusNodeGraphType InType,
FName InName,
TOptional< int32 > InInsertBefore
)

 Create a new graph of a given type, with an optional name.
Public function Virtual Const IOptimusNodeGraphCollectionOwner * Returns the collection that owns this collection, or nullptr if this is the root collection
Public function Virtual Const FString Returns the path to this graph collection owner.
Public function Virtual Const IOptimusNodeGraphCollectionOwner * Returns root collection that owns all the collections
Public function Virtual Const const TArray< UOptimusNodeGraph * > & Returns all immediately owned node graphs.
Public function Virtual bool

MoveGraph ( UOptimusNodeGraph* InGraph,
int32 InInsertBefore
)

 Re-order the graph relative to the other graphs.
Public function Virtual bool

RemoveGraph ( UOptimusNodeGraph* InGraph,
bool bDeleteGraph
)

 Remove the given graph.
Public function Virtual bool

RenameGraph ( UOptimusNodeGraph* InGraph,
const FString& InNewName
)

 Rename the given graph, subject to validation of the name.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page