ClothingSimulationInteractor.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Containers/Map.h"
#include "Containers/UnrealString.h"
#include "CoreTypes.h"
#include "Math/MathFwd.h"
#include "Misc/AssertionMacros.h"
#include "UObject/Object.h"
#include "UObject/ObjectMacros.h"
#include "UObject/UObjectGlobals.h"
#include "ClothingSimulationInterface.h"
 
#include "ClothingSimulationInteractor.generated.h"
 
#define UE_API CLOTHINGSYSTEMRUNTIMEINTERFACE_API
 
class FName;
class IClothingSimulationContext;
class UClothingAssetBase;
struct FFrame;
template <typename T> struct TObjectPtr;
 
UCLASS(Abstract, BlueprintType, MinimalAPI)
class UClothingInteractor : public UObject
{
    GENERATED_BODY()
 
protected:
    friend class UClothingSimulationInteractor;
 
    virtual void Sync(IClothingSimulationInterface* Simulation)
    {
PRAGMA_DISABLE_DEPRECATION_WARNINGS
        if (Simulation && Simulation->DynamicCastToIClothingSimulation())
        {
            Sync(Simulation->DynamicCastToIClothingSimulation());
        }
PRAGMA_ENABLE_DEPRECATION_WARNINGS
    }
 
PRAGMA_DISABLE_DEPRECATION_WARNINGS
    UE_DEPRECATED(5.7, "Use IClothingSimulationInterface instead.")
    virtual void Sync(IClothingSimulation* Simulation) {}
PRAGMA_ENABLE_DEPRECATION_WARNINGS
 
protected:
    int32 ClothingId = -1;  // Clothing Asset slot as passed to the CreateActor function
};
 
UCLASS(Abstract, BlueprintType, MinimalAPI)
class UClothingSimulationInteractor : public UObject
{
    GENERATED_BODY()
 
public:
    UE_API virtual void CreateClothingInteractor(const UClothingAssetBase* ClothingAsset, int32 ClothingId);
 
    UE_API void DestroyClothingInteractors();
 
    // Basic interface that clothing simulations are required to support
 
    UE_API virtual void Sync(IClothingSimulationInterface* Simulation, const IClothingSimulationContext* Context);
 
PRAGMA_DISABLE_DEPRECATION_WARNINGS
    UE_DEPRECATED(5.7, "Use IClothingSimulationInterface instead.")
    UE_API virtual void Sync(IClothingSimulation* Simulation, IClothingSimulationContext* Context);
PRAGMA_ENABLE_DEPRECATION_WARNINGS
 
    UFUNCTION(BlueprintCallable, Category=ClothingSimulation)
    virtual void PhysicsAssetUpdated()
    PURE_VIRTUAL(UClothingSimulationInteractor::PhysicsAssetUpdated, );
 
    UFUNCTION(BlueprintCallable, Category=ClothingSimulation)
    virtual void ClothConfigUpdated()
    PURE_VIRTUAL(UClothingSimulationInteractor::ClothConfigUpdated, );
 
    UFUNCTION(BlueprintCallable, Category = ClothingSimulation)
    virtual void SetAnimDriveSpringStiffness(float InStiffness)
    PURE_VIRTUAL(UClothingSimulationInteractor::SetAnimDriveSpringStiffness, );
 
    UFUNCTION(BlueprintCallable, Category = ClothingSimulation)
    virtual void EnableGravityOverride(const FVector& InVector)
    PURE_VIRTUAL(UClothingSimulationInteractor::EnableGravityOverride, );
 
    UFUNCTION(BlueprintCallable, Category = ClothingSimulation)
    virtual void DisableGravityOverride()
    PURE_VIRTUAL(UClothingSimulationInteractor::DisableGravityOverride, );
 
    UFUNCTION(BlueprintCallable, Category = ClothingSimulation)
    virtual void SetNumIterations(int32 NumIterations = 1)
    PURE_VIRTUAL(UClothingSimulationInteractor::SetNumIterations, );
 
    UFUNCTION(BlueprintCallable, Category = ClothingSimulation)
    virtual void SetMaxNumIterations(int32 MaxNumIterations = 10)
    PURE_VIRTUAL(UClothingSimulationInteractor::SetMaxNumIterations, );
 
    UFUNCTION(BlueprintCallable, Category = ClothingSimulation, Meta = (Keywords = "Subdivisions"))
    virtual void SetNumSubsteps(int32 NumSubsteps = 1)
    PURE_VIRTUAL(UClothingSimulationInteractor::SetNumSubsteps, );
 
    // Base clothing simulations interface
 
    UFUNCTION(BlueprintCallable, Category = ClothingSimulation)
    int32 GetNumCloths() const { return LastNumCloths; }
 
    UFUNCTION(BlueprintCallable, Category = ClothingSimulation)
    int32 GetNumKinematicParticles() const { return LastNumKinematicParticles; }
 
    UFUNCTION(BlueprintCallable, Category = ClothingSimulation)
    int32 GetNumDynamicParticles() const { return LastNumDynamicParticles; }
 
    UFUNCTION(BlueprintCallable, Category = ClothingSimulation)
    int32 GetNumIterations() const { return LastNumIterations; }
 
    UFUNCTION(BlueprintCallable, Category = ClothingSimulation)
    int32 GetNumSubsteps() const { return LastNumSubsteps; }
 
    UFUNCTION(BlueprintCallable, Category = ClothingSimulation)
    float GetSimulationTime() const { return LastSimulationTime; }
 
    UFUNCTION(BlueprintCallable, Category = ClothingSimulation)
    UE_API UClothingInteractor* GetClothingInteractor(const FName ClothingAssetName) const;
 
    UE_DEPRECATED(5.7, "Use FName version instead.")
    UClothingInteractor* GetClothingInteractor(const FString& ClothingAssetName) const
    {
        return GetClothingInteractor(FName(ClothingAssetName));
    }
 
    UPROPERTY()
    TMap<FName, TObjectPtr<UClothingInteractor>> ClothingInteractors;
 
protected:
    virtual UClothingInteractor* CreateClothingInteractor()
    {
        return nullptr;
    }
 
private:
    // Simulation infos updated during the sync
    int32 LastNumCloths = 0;
    int32 LastNumKinematicParticles = 0;
    int32 LastNumDynamicParticles = 0;
    int32 LastNumIterations = 0;
    int32 LastNumSubsteps = 0;
    float LastSimulationTime = 0.f;
};
 
#undef UE_API