164 lines
6.5 KiB
C++
164 lines
6.5 KiB
C++
// 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 "ClothingSimulationInteractor.generated.h"
|
|
|
|
class FName;
|
|
class IClothingSimulation;
|
|
class IClothingSimulationContext;
|
|
class UClothingAssetBase;
|
|
struct FFrame;
|
|
template <typename T> struct TObjectPtr;
|
|
|
|
/**
|
|
* Abstract class to control clothing specific interaction.
|
|
* Must be cast to the end used clothing simulation object before use.
|
|
*/
|
|
UCLASS(Abstract, BlueprintType, MinimalAPI)
|
|
class UClothingInteractor : public UObject
|
|
{
|
|
GENERATED_BODY()
|
|
|
|
protected:
|
|
friend class UClothingSimulationInteractor;
|
|
|
|
virtual void Sync(IClothingSimulation* Simulation) {}
|
|
|
|
protected:
|
|
int32 ClothingId = -1; // Clothing Asset slot as passed to the CreateActor function
|
|
};
|
|
|
|
/**
|
|
* If a clothing simulation is able to be interacted with at runtime then a derived
|
|
* interactor should be created, and at least the basic API implemented for that
|
|
* simulation.
|
|
* Only write to the simulation and context during the call to Sync, as that is
|
|
* guaranteed to be a safe place to access this data.
|
|
*/
|
|
UCLASS(Abstract, BlueprintType, MinimalAPI)
|
|
class UClothingSimulationInteractor : public UObject
|
|
{
|
|
GENERATED_BODY()
|
|
|
|
public:
|
|
/** Create a cloth specific interactor. */
|
|
CLOTHINGSYSTEMRUNTIMEINTERFACE_API void CreateClothingInteractor(const UClothingAssetBase* ClothingAsset, int32 ClothingId);
|
|
|
|
/** Destroy all interactors. */
|
|
CLOTHINGSYSTEMRUNTIMEINTERFACE_API void DestroyClothingInteractors();
|
|
|
|
// Basic interface that clothing simulations are required to support
|
|
|
|
/**
|
|
* Sync the interactor to the provided context for the clothing simulation to use
|
|
* on its next update. This will be called at a time that is guaranteed to
|
|
* never overlap with the running simulation. The simulation will have to be
|
|
* written in a way to pick up these changes on the next update.
|
|
* Any inherited class must call this function to also Sync the ClothingInteractors.
|
|
*/
|
|
CLOTHINGSYSTEMRUNTIMEINTERFACE_API virtual void Sync(IClothingSimulation* Simulation, IClothingSimulationContext* Context);
|
|
|
|
/** Called to update collision status without restarting the simulation. */
|
|
UFUNCTION(BlueprintCallable, Category=ClothingSimulation)
|
|
CLOTHINGSYSTEMRUNTIMEINTERFACE_API virtual void PhysicsAssetUpdated()
|
|
PURE_VIRTUAL(UClothingSimulationInteractor::PhysicsAssetUpdated, );
|
|
|
|
/** Called to update the cloth config without restarting the simulation. */
|
|
UFUNCTION(BlueprintCallable, Category=ClothingSimulation)
|
|
CLOTHINGSYSTEMRUNTIMEINTERFACE_API virtual void ClothConfigUpdated()
|
|
PURE_VIRTUAL(UClothingSimulationInteractor::ClothConfigUpdated, );
|
|
|
|
/** Set the stiffness of the spring force for the animation drive. */
|
|
UFUNCTION(BlueprintCallable, Category = ClothingSimulation)
|
|
CLOTHINGSYSTEMRUNTIMEINTERFACE_API virtual void SetAnimDriveSpringStiffness(float InStiffness)
|
|
PURE_VIRTUAL(UClothingSimulationInteractor::SetAnimDriveSpringStiffness, );
|
|
|
|
/** Set a new gravity override and enable the override. */
|
|
UFUNCTION(BlueprintCallable, Category = ClothingSimulation)
|
|
CLOTHINGSYSTEMRUNTIMEINTERFACE_API virtual void EnableGravityOverride(const FVector& InVector)
|
|
PURE_VIRTUAL(UClothingSimulationInteractor::EnableGravityOverride, );
|
|
|
|
/** Disable any currently set gravity override. */
|
|
UFUNCTION(BlueprintCallable, Category = ClothingSimulation)
|
|
CLOTHINGSYSTEMRUNTIMEINTERFACE_API virtual void DisableGravityOverride()
|
|
PURE_VIRTUAL(UClothingSimulationInteractor::DisableGravityOverride, );
|
|
|
|
/** Set the number of time dependent solver iterations. */
|
|
UFUNCTION(BlueprintCallable, Category = ClothingSimulation)
|
|
CLOTHINGSYSTEMRUNTIMEINTERFACE_API virtual void SetNumIterations(int32 NumIterations = 1)
|
|
PURE_VIRTUAL(UClothingSimulationInteractor::SetNumIterations, );
|
|
|
|
/** Set the maximum number of solver iterations. */
|
|
UFUNCTION(BlueprintCallable, Category = ClothingSimulation)
|
|
CLOTHINGSYSTEMRUNTIMEINTERFACE_API virtual void SetMaxNumIterations(int32 MaxNumIterations = 10)
|
|
PURE_VIRTUAL(UClothingSimulationInteractor::SetMaxNumIterations, );
|
|
|
|
/** Set the number of substeps or subdivisions. */
|
|
UFUNCTION(BlueprintCallable, Category = ClothingSimulation, Meta = (Keywords = "Subdivisions"))
|
|
CLOTHINGSYSTEMRUNTIMEINTERFACE_API virtual void SetNumSubsteps(int32 NumSubsteps = 1)
|
|
PURE_VIRTUAL(UClothingSimulationInteractor::SetNumSubsteps, );
|
|
|
|
// Base clothing simulations interface
|
|
|
|
/** Return the number of cloths run by the simulation. */
|
|
UFUNCTION(BlueprintCallable, Category = ClothingSimulation)
|
|
int32 GetNumCloths() const { return LastNumCloths; }
|
|
|
|
/** Return the number of kinematic (animated) particles. */
|
|
UFUNCTION(BlueprintCallable, Category = ClothingSimulation)
|
|
int32 GetNumKinematicParticles() const { return LastNumKinematicParticles; }
|
|
|
|
/** Return the number of dynamic (simulated) particles. */
|
|
UFUNCTION(BlueprintCallable, Category = ClothingSimulation)
|
|
int32 GetNumDynamicParticles() const { return LastNumDynamicParticles; }
|
|
|
|
/**
|
|
* Return the solver number of iterations.
|
|
* This could be different from the number set if the simulation hasn't updated yet.
|
|
*/
|
|
UFUNCTION(BlueprintCallable, Category = ClothingSimulation)
|
|
int32 GetNumIterations() const { return LastNumIterations; }
|
|
|
|
/**
|
|
* Return the solver number of subdivisions./
|
|
* This could be different from the number set if the simulation hasn't updated yet.
|
|
*/
|
|
UFUNCTION(BlueprintCallable, Category = ClothingSimulation)
|
|
int32 GetNumSubsteps() const { return LastNumSubsteps; }
|
|
|
|
/** Return the instant average simulation time in ms. */
|
|
UFUNCTION(BlueprintCallable, Category = ClothingSimulation)
|
|
float GetSimulationTime() const { return LastSimulationTime; }
|
|
|
|
/**Return a cloth interactor for this simulation. */
|
|
UFUNCTION(BlueprintCallable, Category = ClothingSimulation)
|
|
CLOTHINGSYSTEMRUNTIMEINTERFACE_API UClothingInteractor* GetClothingInteractor(const FString& ClothingAssetName) const;
|
|
|
|
/** Cloth interactors currently created. */
|
|
UPROPERTY()
|
|
TMap<FName, TObjectPtr<UClothingInteractor>> ClothingInteractors;
|
|
|
|
protected:
|
|
CLOTHINGSYSTEMRUNTIMEINTERFACE_API virtual UClothingInteractor* CreateClothingInteractor()
|
|
PURE_VIRTUAL(UClothingSimulationInteractor::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;
|
|
};
|