MeshDeformerInstance.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
 
#if WITH_EDITORONLY_DATA
#include "Animation/MeshDeformerGeometryReadback.h"
#endif // WITH_EDITORONLY_DATA
 
#include "MeshDeformerInstance.generated.h"
 
class FSceneInterface;
#if WITH_EDITORONLY_DATA
struct FMeshDescription;
#endif // WITH_EDITORONLY_DATA
 
enum class EMeshDeformerOutputBuffer : uint8
{
    None = 0,
    SkinnedMeshPosition = 1 << 0,
    SkinnedMeshTangents = 1 << 1,
    SkinnedMeshVertexColor = 1 << 2,
};
 
ENUM_CLASS_FLAGS(EMeshDeformerOutputBuffer);
 
UCLASS(Abstract, MinimalAPI)
class UMeshDeformerInstanceSettings : public UObject
{
    GENERATED_BODY()
};
 
 
UCLASS(Abstract, MinimalAPI)
class UMeshDeformerInstance : public UObject
{
    GENERATED_BODY()
 
public:
 
 
    virtual void AllocateResources() PURE_VIRTUAL(, );
 
    virtual void ReleaseResources() PURE_VIRTUAL(, );
 
    enum EWorkLoad
    {
        WorkLoad_Setup,
        WorkLoad_Trigger,
        WorkLoad_Update,
    };
 
    enum EExectutionGroup
    {
        ExecutionGroup_Default,
        ExecutionGroup_Immediate,
        ExecutionGroup_EndOfFrameUpdate,
        ExecutionGroup_BeginInitViews,
    };
 
    struct FEnqueueWorkDesc
    {
        FSceneInterface* Scene = nullptr;
        EWorkLoad WorkLoadType = WorkLoad_Update;
        EExectutionGroup ExecutionGroup = ExecutionGroup_Default;
        FName OwnerName;
        FSimpleDelegate FallbackDelegate;
    };
 
    virtual void EnqueueWork(FEnqueueWorkDesc const& InDesc) PURE_VIRTUAL(, );
    
    virtual EMeshDeformerOutputBuffer GetOutputBuffers() const PURE_VIRTUAL(, return EMeshDeformerOutputBuffer::None; );
 
#if WITH_EDITORONLY_DATA
    virtual bool RequestReadbackDeformerGeometry(TUniquePtr<FMeshDeformerGeometryReadbackRequest> InRequest) PURE_VIRTUAL(, return false; );
#endif // WITH_EDITORONLY_DATA
    
    virtual UMeshDeformerInstance* GetInstanceForSourceDeformer() PURE_VIRTUAL(, return this; ); 
};