ClothingSimulationInterface.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
#pragma once
 
#include "ClothingSystemRuntimeTypes.h"
#include "Containers/Map.h"
#include "CoreTypes.h"
#include "Math/MathFwd.h"
 
#define UE_API CLOTHINGSYSTEMRUNTIMEINTERFACE_API
 
class UClothingAssetBase;
class USkeletalMeshComponent;
class USkinnedMeshComponent;
class UE_DEPRECATED(5.7, "Use IClothingSimulationInterface instead.") IClothingSimulation;
struct FClothCollisionData;
struct FClothSimulData;
 
class IClothingSimulationContext
{
public:
    UE_API IClothingSimulationContext();
    UE_API virtual ~IClothingSimulationContext();
};
 
class IClothingSimulationInterface
{
public:
    UE_API IClothingSimulationInterface();
    UE_API virtual ~IClothingSimulationInterface();
 
protected:
 
    friend struct FClothingSimulationInstance;
 
    virtual void CreateActor(USkeletalMeshComponent* InOwnerComponent, const UClothingAssetBase* InAsset, int32 SimDataIndex) = 0;
 
    virtual void EndCreateActor() = 0;
 
    virtual IClothingSimulationContext* CreateContext() = 0;
 
    virtual void FillContextAndPrepareTick(const USkeletalMeshComponent* InComponent, float InDeltaTime, IClothingSimulationContext* InOutContext, bool bIsInitialization, bool bForceTeleportResetOnly) = 0;
 
    virtual void Initialize() = 0;
 
    virtual void Shutdown() = 0;
 
    virtual bool ShouldSimulateLOD(int32 OwnerLODIndex) const = 0;
 
    virtual void Simulate_AnyThread(const IClothingSimulationContext* InContext) = 0;
 
    virtual void ForceClothNextUpdateTeleportAndReset_AnyThread() = 0;
 
    virtual void HardResetSimulation(const IClothingSimulationContext* InContext) = 0;
 
    virtual void DestroyActors() = 0;
 
    virtual void DestroyContext(IClothingSimulationContext* InContext) = 0;
 
    virtual void AppendSimulationData(TMap<int32, FClothSimulData>& InOutData, const USkeletalMeshComponent* OwnerComponent, const USkinnedMeshComponent* OverrideComponent) const = 0;
 
    virtual FBoxSphereBounds GetBounds(const USkeletalMeshComponent* InOwnerComponent) const = 0;
 
    virtual void AddExternalCollisions(const FClothCollisionData& InData) = 0;
 
    virtual void ClearExternalCollisions() = 0;
 
    virtual void GetCollisions(FClothCollisionData& OutCollisions, bool bIncludeExternal = true) const = 0;
 
public:
PRAGMA_DISABLE_DEPRECATION_WARNINGS
    UE_DEPRECATED(5.7, "This method is used to ease transition between the new and old interface and will be removed.")
    inline const IClothingSimulation* DynamicCastToIClothingSimulation() const;
 
    UE_DEPRECATED(5.7, "This method is used to ease transition between the new and old interface and will be removed.")
    inline IClothingSimulation* DynamicCastToIClothingSimulation();
PRAGMA_ENABLE_DEPRECATION_WARNINGS
 
    virtual int32 GetNumCloths() const { return 0; }
    virtual int32 GetNumKinematicParticles() const { return 0; }
    virtual int32 GetNumDynamicParticles() const { return 0; }
    virtual int32 GetNumIterations() const { return 0; }
    virtual int32 GetNumSubsteps() const { return 0; }
    virtual float GetSimulationTime() const { return 0.f; }
    virtual bool IsTeleported() const { return false; }
 
private:
PRAGMA_DISABLE_DEPRECATION_WARNINGS
    friend class IClothingSimulation;  // For bIsLegacyInterface
PRAGMA_ENABLE_DEPRECATION_WARNINGS
    bool bIsLegacyInterface = false;  // UE_DEPRECATED(5.7, "Use IClothingSimulationInterface instead.")
};
 
class UE_DEPRECATED(5.7, "Use IClothingSimulationInterface instead.") IClothingSimulation : public IClothingSimulationInterface
{
public:
    UE_API IClothingSimulation();
    UE_API virtual ~IClothingSimulation();
 
    // The majority of the API for this class is protected. The required objects (skel meshes and the parallel task)
    // are friends so they can use the functionality. For the most part the simulation is not designed to be used
    // outside of the skeletal mesh component as its parallel simulation is tied to the skel mesh tick and
    // dependents.
    // Any method that is available in the public section below should consider that it may be called while
    // the simulation is running.
    // Currently only a const pointer is exposed externally to the skeletal mesh component, so barring that
    // being cast away external callers can't call non-const methods. The debug skel mesh component exposes a
    // mutable version for editor use
protected:
 
    friend class USkeletalMeshComponent;
    friend class FParallelClothTask;
    friend struct FClothingSimulationInstance;
    friend struct FEnvironmentalCollisions;
 
    virtual void CreateActor(USkeletalMeshComponent* InOwnerComponent, const UClothingAssetBase* InAsset, int32 SimDataIndex) override
    {
PRAGMA_DISABLE_DEPRECATION_WARNINGS
        return CreateActor(InOwnerComponent, const_cast<UClothingAssetBase*>(InAsset), SimDataIndex);
PRAGMA_ENABLE_DEPRECATION_WARNINGS
    }
 
    UE_DEPRECATED(5.7, "Use const arguments version instead,")
    virtual void CreateActor(USkeletalMeshComponent* InOwnerComponent, UClothingAssetBase* InAsset, int32 SimDataIndex) {}
 
    virtual void FillContextAndPrepareTick(const USkeletalMeshComponent* InComponent, float InDeltaTime, IClothingSimulationContext* InOutContext, bool bIsInitialization, bool bForceTeleportResetOnly) override
    {
PRAGMA_DISABLE_DEPRECATION_WARNINGS
        return FillContext(const_cast<USkeletalMeshComponent*>(InComponent), InDeltaTime, InOutContext, bIsInitialization);
PRAGMA_ENABLE_DEPRECATION_WARNINGS
    }
 
    UE_DEPRECATED(5.7, "Use FillContextAndPrepareTick instead.")
    virtual void FillContext(USkeletalMeshComponent* InComponent, float InDeltaTime, IClothingSimulationContext* InOutContext, bool bIsInitialization)
    {
PRAGMA_DISABLE_DEPRECATION_WARNINGS
        return FillContext(InComponent, InDeltaTime, InOutContext);
PRAGMA_ENABLE_DEPRECATION_WARNINGS
    }
    UE_DEPRECATED(5.7, "Use FillContextAndPrepareTick instead.")
    virtual void FillContext(USkeletalMeshComponent* InComponent, float InDeltaTime, IClothingSimulationContext* InOutContext) {}
 
    UE_DEPRECATED(5.7, "This method has not been used consistently and has been replaced with ShouldSimulateLOD")
    virtual bool ShouldSimulate() const
    {
        return true;
    }
 
    virtual bool ShouldSimulateLOD(int32 OwnerLODIndex) const override
    {
PRAGMA_DISABLE_DEPRECATION_WARNINGS
        return ShouldSimulate();
PRAGMA_ENABLE_DEPRECATION_WARNINGS
    }
 
    virtual void Simulate_AnyThread(const IClothingSimulationContext* InContext) override
    {
PRAGMA_DISABLE_DEPRECATION_WARNINGS
        return Simulate(const_cast<IClothingSimulationContext*>(InContext));
PRAGMA_ENABLE_DEPRECATION_WARNINGS
    }
    
    UE_DEPRECATED(5.7, "Use Simulate_AnyThread instead,")
    virtual void Simulate(IClothingSimulationContext* InContext) {}
 
    virtual void ForceClothNextUpdateTeleportAndReset_AnyThread() override {}
 
    virtual void HardResetSimulation(const IClothingSimulationContext* InContext) override {}
 
    virtual void AppendSimulationData(TMap<int32, FClothSimulData>& InOutData, const USkeletalMeshComponent* OwnerComponent, const USkinnedMeshComponent* OverrideComponent) const override
    {
PRAGMA_DISABLE_DEPRECATION_WARNINGS
        GetSimulationData(InOutData, const_cast<USkeletalMeshComponent*>(OwnerComponent), const_cast<USkinnedMeshComponent*>(OverrideComponent));
PRAGMA_ENABLE_DEPRECATION_WARNINGS
    }
 
    UE_DEPRECATED(5.7, "Use AppendSimulationData instead.")
    virtual void GetSimulationData(TMap<int32, FClothSimulData>& OutData, USkeletalMeshComponent* InOwnerComponent, USkinnedMeshComponent* InOverrideComponent) const {}
 
public:
    UE_DEPRECATED(5.7, "GatherStats is unused and will be removed from future interfaces. Do not override.")
    virtual void GatherStats() const {}
 
    UE_DEPRECATED(5.7, "Use a clothing simulation interactor to set this simulation property instead.")
    virtual void SetNumIterations(int32 NumIterations) {}
    UE_DEPRECATED(5.7, "Use a clothing simulation interactor to set this simulation property instead.")
    virtual void SetMaxNumIterations(int32 MaxNumIterations) {}
    UE_DEPRECATED(5.7, "Use a clothing simulation interactor to set this simulation property instead.")
    virtual void SetNumSubsteps(int32 NumSubsteps) {}
 
    UE_DEPRECATED(5.7, "Use FillContextAndPrepareTick instead.")
    virtual void UpdateWorldForces(const USkeletalMeshComponent* OwnerComponent) {}
};
 
PRAGMA_DISABLE_DEPRECATION_WARNINGS
inline const class IClothingSimulation* IClothingSimulationInterface::DynamicCastToIClothingSimulation() const
{
    return bIsLegacyInterface ? static_cast<const class IClothingSimulation*>(this) : nullptr;
}
 
inline IClothingSimulation* IClothingSimulationInterface::DynamicCastToIClothingSimulation()
{
    return bIsLegacyInterface ? static_cast<class IClothingSimulation*>(this) : nullptr;
}
PRAGMA_ENABLE_DEPRECATION_WARNINGS
 
#undef UE_API