1. Epic GamesDeveloper
  3. UOptimusDeformerInstance

UOptimusDeformerInstance

Class representing an instance of an Optimus Mesh Deformer, used in a OptimusDeformerDynamicInstanceManager It contains the per instance deformer variable state and local state for each of the graphs in the deformer.

API > API/Plugins > API/Plugins/OptimusCore

Class representing an instance of an Optimus Mesh Deformer, used in a OptimusDeformerDynamicInstanceManager It contains the per instance deformer variable state and local state for each of the graphs in the deformer.

   
Name UOptimusDeformerInstance
Type class
Header File /Engine/Plugins/Animation/DeformerGraph/Source/OptimusCore/Public/OptimusDeformerInstance.h
Include Path #include "OptimusDeformerInstance.h"

Syntax

UCLASS (MinimalAPI, BlueprintType)  
class UOptimusDeformerInstance : public UMeshDeformerInstance

Inheritance Hierarchy

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
GraphSortPriorityOffset int32 Making sure compute graphs belong to this instance does not run before instances before it OptimusDeformerInstance.h  
OutputBuffersFromPreviousInstances EMeshDeformerOutputBuffer Used to see which buffers have valid data produced by dispatched instances and are safe to access for the current instance OptimusDeformerInstance.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
bCanBeActive bool   OptimusDeformerInstance.h  
BufferPool FOptimusPersistentBufferPoolPtr   OptimusDeformerInstance.h  
ComputeGraphExecInfos TArray< FOptimusDeformerInstanceExecInfo > An array of state. One for each graph owned by the deformer. OptimusDeformerInstance.h  
DataInterfacePropertyOverrideMap TMap< TWeakObjectPtr< const UComputeDataInterface >, FOptimusDataInterfacePropertyOverrideInfo >   OptimusDeformerInstance.h  
GraphsToRunOnNextTick TSet< FName > List of graphs that should be run on the next tick. OptimusDeformerInstance.h  
GraphsToRunOnNextTickLock FCriticalSection   OptimusDeformerInstance.h  
InstanceSettings TWeakObjectPtr< UOptimusDeformerInstanceSettings > The settings for this Mesh Deformer Instance. OptimusDeformerInstance.h  
MeshComponent TWeakObjectPtr< UMeshComponent > The Mesh Component that owns this Mesh Deformer Instance. OptimusDeformerInstance.h  
Scene FSceneInterface *   OptimusDeformerInstance.h  
ValueMap TMap< FOptimusValueIdentifier, FOptimusValueDescription >   OptimusDeformerInstance.h  
WeakBoundComponents TArray< TWeakObjectPtr< UActorComponent > >   OptimusDeformerInstance.h  
WeakComponentSources TArray< TWeakObjectPtr< const UOptimusComponentSource > >   OptimusDeformerInstance.h  
WeakGeometryReadbackProvider TWeakInterfacePtr< IOptimusDeformerGeometryReadbackProvider > Data provider responsible for reading back the final deformed geometry after the deformer runs, only assigned when WITH_EDITORONLY_DATA. OptimusDeformerInstance.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool EnqueueTriggerGraph ( FName InTriggerGraphName
)

 Trigger a named trigger graph to run on the next tick OptimusDeformerInstance.h
  • BlueprintCallable
  • Category="Deformer"

FOptimusPersistentBufferPoolPtr GetBufferPool()

   OptimusDeformerInstance.h  

FOptimusValueContainerStruct GetDataInterfacePropertyOverride ( const UComputeDataInterface* DataInterface,
FName PinName
)

   OptimusDeformerInstance.h  

const FShaderValueContainer & GetShaderValue ( const FOptimusValueIdentifier& InValueId
) const

   OptimusDeformerInstance.h  

bool SetBoolArrayVariable ( FName InVariableName,
const TArray< bool >& InValue
)

   OptimusDeformerInstance.h
  • BlueprintCallable
  • Category="Deformer"
  • Meta=(DisplayName="Set Variable (Boolean Array)")

bool SetBoolVariable ( FName InVariableName,
bool InValue
)

 Set the value of a boolean variable. OptimusDeformerInstance.h
  • BlueprintCallable
  • Category="Deformer"
  • Meta=(DisplayName="Set Variable (Boolean)")

void SetCanBeActive ( bool bInCanBeActive
)

   OptimusDeformerInstance.h  

void SetConstantValueDirect ( TSoftObjectPtr< UObject > InSourceObject,
FOptimusValueContainerStruct const& InValue
)

 Directly set a graph constant value. OptimusDeformerInstance.h  

bool SetFloatArrayVariable ( FName InVariableName,
const TArray< double >& InValue
)

   OptimusDeformerInstance.h
  • BlueprintCallable
  • Category="Deformer"
  • Meta=(DisplayName="Set Variable (Float Array)")

bool SetFloatVariable ( FName InVariableName,
double InValue
)

   OptimusDeformerInstance.h
  • BlueprintCallable
  • Category="Deformer"
  • Meta=(DisplayName="Set Variable (Float)")
Set the instance settings that control this deformer instance. OptimusDeformerInstance.h  

bool SetInt2ArrayVariable ( FName InVariableName,
const TArray< FIntPoint >& InValue
)

   OptimusDeformerInstance.h
  • BlueprintCallable
  • Category="Deformer"
  • Meta=(DisplayName="Set Variable (Integer2 Array)")

bool SetInt2Variable ( FName InVariableName,
const FIntPoint& InValue
)

   OptimusDeformerInstance.h
  • BlueprintCallable
  • Category="Deformer"
  • Meta=(DisplayName="Set Variable (Integer2)")

bool SetInt3ArrayVariable ( FName InVariableName,
const TArray< FIntVector >& InValue
)

   OptimusDeformerInstance.h
  • BlueprintCallable
  • Category="Deformer"
  • Meta=(DisplayName="Set Variable (Integer3 Array)")

bool SetInt3Variable ( FName InVariableName,
const FIntVector& InValue
)

   OptimusDeformerInstance.h
  • BlueprintCallable
  • Category="Deformer"
  • Meta=(DisplayName="Set Variable (Integer3)")

bool SetInt4ArrayVariable ( FName InVariableName,
const TArray< FIntVector4 >& InValue
)

   OptimusDeformerInstance.h
  • BlueprintCallable
  • Category="Deformer"
  • Meta=(DisplayName="Set Variable (Integer4 Array)")

bool SetInt4Variable ( FName InVariableName,
const FIntVector4& InValue
)

   OptimusDeformerInstance.h
  • BlueprintCallable
  • Category="Deformer"
  • Meta=(DisplayName="Set Variable (Integer4)")

bool SetIntArrayVariable ( FName InVariableName,
const TArray< int32 >& InValue
)

   OptimusDeformerInstance.h
  • BlueprintCallable
  • Category="Deformer"
  • Meta=(DisplayName="Set Variable (Integer Array)")

bool SetIntVariable ( FName InVariableName,
int32 InValue
)

 Set the value of an integer variable. OptimusDeformerInstance.h
  • BlueprintCallable
  • Category="Deformer"
  • Meta=(DisplayName="Set Variable (Integer)")

bool SetLinearColorArrayVariable ( FName InVariableName,
const TArray< FLinearColor >& InValue
)

   OptimusDeformerInstance.h
  • BlueprintCallable
  • Category="Deformer"
  • Meta=(DisplayName="Set Variable (LinearColor Array)")

bool SetLinearColorVariable ( FName InVariableName,
const FLinearColor& InValue
)

   OptimusDeformerInstance.h
  • BlueprintCallable
  • Category="Deformer"
  • Meta=(DisplayName="Set Variable (LinearColor)")

void SetMeshComponent ( UMeshComponent* InMeshComponent
)

 Set the Mesh Component that owns this instance. Call once before first call to SetupFromDeformer(). OptimusDeformerInstance.h  

bool SetNameArrayVariable ( FName InVariableName,
const TArray< FName >& InValue
)

   OptimusDeformerInstance.h
  • BlueprintCallable
  • Category="Deformer"
  • Meta=(DisplayName="Set Variable (Name Array)")

bool SetNameVariable ( FName InVariableName,
const FName& InValue
)

   OptimusDeformerInstance.h
  • BlueprintCallable
  • Category="Deformer"
  • Meta=(DisplayName="Set Variable (Name)")

bool SetQuatArrayVariable ( FName InVariableName,
const TArray< FQuat >& InValue
)

   OptimusDeformerInstance.h
  • BlueprintCallable
  • Category="Deformer"
  • Meta=(DisplayName="Set Variable (Quat Array)")

bool SetQuatVariable ( FName InVariableName,
const FQuat& InValue
)

   OptimusDeformerInstance.h
  • BlueprintCallable
  • Category="Deformer"
  • Meta=(DisplayName="Set Variable (Quat)")

bool SetRotatorArrayVariable ( FName InVariableName,
const TArray< FRotator >& InValue
)

   OptimusDeformerInstance.h
  • BlueprintCallable
  • Category="Deformer"
  • Meta=(DisplayName="Set Variable (Rotator Array)")

bool SetRotatorVariable ( FName InVariableName,
const FRotator& InValue
)

   OptimusDeformerInstance.h
  • BlueprintCallable
  • Category="Deformer"
  • Meta=(DisplayName="Set Variable (Rotator)")

bool SetTransformArrayVariable ( FName InVariableName,
const TArray< FTransform >& InValue
)

   OptimusDeformerInstance.h
  • BlueprintCallable
  • Category="Deformer"
  • Meta=(DisplayName="Set Variable (Transform Array)")

bool SetTransformVariable ( FName InVariableName,
const FTransform& InValue
)

 Set the value of a transform variable. OptimusDeformerInstance.h
  • BlueprintCallable
  • Category="Deformer"
  • Meta=(DisplayName="Set Variable (Transform)")

void SetupFromDeformer ( UOptimusDeformer* InDeformer
)

 Setup the instance. OptimusDeformerInstance.h  

bool SetVector2ArrayVariable ( FName InVariableName,
const TArray< FVector2D >& InValue
)

   OptimusDeformerInstance.h
  • BlueprintCallable
  • Category="Deformer"
  • Meta=(DisplayName="Set Variable (Vector2 Array)")

bool SetVector2Variable ( FName InVariableName,
const FVector2D& InValue
)

   OptimusDeformerInstance.h
  • BlueprintCallable
  • Category="Deformer"
  • Meta=(DisplayName="Set Variable (Vector2)")

bool SetVector4ArrayVariable ( FName InVariableName,
const TArray< FVector4 >& InValue
)

   OptimusDeformerInstance.h
  • BlueprintCallable
  • Category="Deformer"
  • Meta=(DisplayName="Set Variable (Vector4 Array)")

bool SetVector4Variable ( FName InVariableName,
const FVector4& InValue
)

   OptimusDeformerInstance.h
  • BlueprintCallable
  • Category="Deformer"
  • Meta=(DisplayName="Set Variable (Vector4)")

bool SetVectorArrayVariable ( FName InVariableName,
const TArray< FVector >& InValue
)

   OptimusDeformerInstance.h
  • BlueprintCallable
  • Category="Deformer"
  • Meta=(DisplayName="Set Variable (Vector Array)")

bool SetVectorVariable ( FName InVariableName,
const FVector& InValue
)

   OptimusDeformerInstance.h
  • BlueprintCallable
  • Category="Deformer"
  • Meta=(DisplayName="Set Variable (Vector)")

Protected

Name Remarks Include Path Unreal Specifiers

void AllocateResources()

   OptimusDeformerInstance.h  

void EnqueueWork ( FEnqueueWorkDesc const& InDesc
)

   OptimusDeformerInstance.h  

UMeshDeformerInstance * GetInstanceForSourceDeformer()

   OptimusDeformerInstance.h  

EMeshDeformerOutputBuffer GetOutputBuffers()

   OptimusDeformerInstance.h  

void ReleaseResources()

   OptimusDeformerInstance.h  

bool RequestReadbackDeformerGeometry ( TUniquePtr< FMeshDeformerGeometryReadbackRequest > InRequest
)

   OptimusDeformerInstance.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page