FieldSystemComponent.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Components/PrimitiveComponent.h"
#include "Field/FieldSystem.h"
#include "Field/FieldSystemObjects.h"
#include "Field/FieldSystemAsset.h"
#include "Field/FieldSystemComponentTypes.h"
#include "Chaos/ChaosSolverActor.h"
 
#include "FieldSystemComponent.generated.h"
 
struct FFieldSystemSampleData;
class FChaosSolversModule;
 
//*
//*/
//UENUM(BlueprintType)
//enum class EChaosObjectType
//{
//  Chaos_Destruction        UMETA(DisplayName = "Set Always", ToolTip = "The particle output value will be equal to Interior-value if the particle position is inside a sphere / Exterior-value otherwise."),
//  Chaos_Rigid, 
//
//  Chaos_Rban  UMETA(DisplayName = "Merge Interior", ToolTip = "The particle output value will be equal to Interior-value if the particle position is inside the sphere or if the particle input value is already Interior-Value / Exterior-value otherwise."),
//  Chaos_Cloth  UMETA(DisplayName = "Merge Exterior", ToolTip = "The particle output value will be equal to Exterior-value if the particle position is outside the sphere or if the particle input value is already Exterior-Value / Interior-value otherwise."),
//  //~~~
//  //256th entry
//  Chaos_Objects_Max                 UMETA(Hidden)
//};
 
UCLASS(meta = (BlueprintSpawnableComponent), MinimalAPI)
class UFieldSystemComponent : public UPrimitiveComponent
{
    GENERATED_UCLASS_BODY()
        friend class FFieldSystemEditorCommands;
 
public:
    //~ Begin USceneComponent Interface.
    virtual bool HasAnySockets() const override { return false; }
    //~ Begin USceneComponent Interface.
 
    //~ Begin UPrimitiveComponent Interface.
    FIELDSYSTEMENGINE_API virtual FPrimitiveSceneProxy* CreateSceneProxy() override;
    //~ End UPrimitiveComponent Interface.
 
    void SetFieldSystem(UFieldSystem* FieldSystemIn) { FieldSystem = FieldSystemIn; }
 
    inline const UFieldSystem* GetFieldSystem() const { return FieldSystem; }
 
    UPROPERTY(EditAnywhere, AdvancedDisplay, BlueprintReadOnly, Category = "Field", meta = (ToolTip = "Field system asset to be used to store the construction fields. This asset is not required anymore and will be deprecated soon."))
    TObjectPtr<UFieldSystem> FieldSystem;
 
    UPROPERTY(EditAnywhere, Category = "Field", meta = (ToolTip = "If enabled the field will be pushed to the world fields and will be available to materials and niagara"))
    bool bIsWorldField;
 
    UPROPERTY(EditAnywhere, Category = "Field", meta = (ToolTip = "If enabled the field will be used by all the chaos solvers"))
    bool bIsChaosField;
 
    UPROPERTY(EditAnywhere, Category = "Field", meta = (EditCondition = "bIsChaosField == true", ToolTip = "List of chaos solvers that will use the field"))
    TArray<TSoftObjectPtr<AChaosSolverActor>> SupportedSolvers;
 
    UPROPERTY()
    FFieldObjectCommands ConstructionCommands;
 
    UPROPERTY()
    FFieldObjectCommands BufferCommands;
 
    //
    // Blueprint based field interface
    //
 
    UFUNCTION(BlueprintCallable, Category = "Field", DisplayName = "Apply Uniform Force", meta = (UnsafeDuringActorConstruction = "true"))
    FIELDSYSTEMENGINE_API void ApplyLinearForce(UPARAM(DisplayName = "Enable Field") bool Enabled,
            UPARAM(DisplayName = "Uniform Direction") FVector Direction,
            UPARAM(DisplayName = "Field Magnitude") float Magnitude);
 
    UFUNCTION(BlueprintCallable, Category = "Field", DisplayName = "Set Dynamic State", meta = (UnsafeDuringActorConstruction = "true"))
    FIELDSYSTEMENGINE_API void ApplyStayDynamicField(UPARAM(DisplayName = "Enable Field") bool Enabled,
            UPARAM(DisplayName = "Center Position") FVector Position,
            UPARAM(DisplayName = "Field Radius") float Radius);
 
    UFUNCTION(BlueprintCallable, Category = "Field", DisplayName = "Apply Radial Force", meta = (UnsafeDuringActorConstruction = "true"))
    FIELDSYSTEMENGINE_API void ApplyRadialForce(UPARAM(DisplayName = "Enable Field") bool Enabled,
            UPARAM(DisplayName = "Center Position") FVector Position,
            UPARAM(DisplayName = "Field Magnitude") float Magnitude);
 
    UFUNCTION(BlueprintCallable, Category = "Field", DisplayName = "Falloff Radial Force", meta = (UnsafeDuringActorConstruction = "true"))
    FIELDSYSTEMENGINE_API void ApplyRadialVectorFalloffForce(UPARAM(DisplayName = "Enable Field") bool Enabled,
            UPARAM(DisplayName = "Center Position") FVector Position,
            UPARAM(DisplayName = "Falloff Radius") float Radius,
            UPARAM(DisplayName = "Field Magnitude") float Magnitude);
 
    UFUNCTION(BlueprintCallable, Category = "Field", DisplayName = "Falloff Uniform Force", meta = (UnsafeDuringActorConstruction = "true"))
    FIELDSYSTEMENGINE_API void ApplyUniformVectorFalloffForce(UPARAM(DisplayName = "Enable Field") bool Enabled,
            UPARAM(DisplayName = "Center Position") FVector Position,
            UPARAM(DisplayName = "Uniform Direction") FVector Direction,
            UPARAM(DisplayName = "Falloff Radius") float Radius,
            UPARAM(DisplayName = "Field Magnitude") float Magnitude);
 
    UFUNCTION(BlueprintCallable, Category = "Field", DisplayName = "Apply External Strain", meta = (UnsafeDuringActorConstruction = "true"))
    FIELDSYSTEMENGINE_API void ApplyStrainField(UPARAM(DisplayName = "Enable Field") bool Enabled,
            UPARAM(DisplayName = "Center Position") FVector Position,
            UPARAM(DisplayName = "Falloff Radius") float Radius,
            UPARAM(DisplayName = "Field Magnitude") float Magnitude,
            UPARAM(DisplayName = "Cluster Levels") int32 Iterations);
 
    UFUNCTION(BlueprintCallable, Category = "Field", DisplayName = "Add Transient Field", meta = (UnsafeDuringActorConstruction = "true"))
    FIELDSYSTEMENGINE_API void ApplyPhysicsField(UPARAM(DisplayName = "Enable Field") bool Enabled,
            UPARAM(DisplayName = "Physics Type") EFieldPhysicsType Target,
            UPARAM(DisplayName = "Meta Data") UFieldSystemMetaData* MetaData,
            UPARAM(DisplayName = "Field Node") UFieldNodeBase* Field);
 
    //
    // Blueprint persistent field interface
    //
 
    UFUNCTION(BlueprintCallable, Category = "Field", DisplayName = "Add Persistent Field", meta = (UnsafeDuringActorConstruction = "true"))
    FIELDSYSTEMENGINE_API void AddPersistentField(UPARAM(DisplayName = "Enable Field") bool Enabled,
            UPARAM(DisplayName = "Physics Type") EFieldPhysicsType Target,
            UPARAM(DisplayName = "Meta Data")  UFieldSystemMetaData* MetaData,
            UPARAM(DisplayName = "Field Node") UFieldNodeBase* Field);
 
    UFUNCTION(BlueprintCallable, Category = "Field", DisplayName = "Remove Persistent Fields", meta = (UnsafeDuringActorConstruction = "true"))
    FIELDSYSTEMENGINE_API void RemovePersistentFields();
 
    //
    // Blueprint construction field interface
    //
 
    UFUNCTION(BlueprintCallable, Category = "Field", DisplayName = "Add Construction Field")
    FIELDSYSTEMENGINE_API void AddFieldCommand(UPARAM(DisplayName = "Enable Field") bool Enabled,
            UPARAM(DisplayName = "Physics Type") EFieldPhysicsType Target,
            UPARAM(DisplayName = "Meta Data") UFieldSystemMetaData* MetaData,
            UPARAM(DisplayName = "Field Node") UFieldNodeBase* Field);
 
    UFUNCTION(BlueprintCallable, Category = "Field", DisplayName = "Remove Construction Fields")
    FIELDSYSTEMENGINE_API void ResetFieldSystem();
 
    const TArray< FFieldSystemCommand >& GetConstructionFields() const { return SetupConstructionFields; }
 
protected:
 
    FIELDSYSTEMENGINE_API TSet<FPhysScene_Chaos*> GetPhysicsScenes() const;
 
    FIELDSYSTEMENGINE_API TArray<Chaos::FPhysicsSolverBase*> GetPhysicsSolvers() const;
 
    FIELDSYSTEMENGINE_API void BuildFieldCommand(bool Enabled, EFieldPhysicsType Target, UFieldSystemMetaData* MetaData, UFieldNodeBase* Field, const bool IsTransient);
 
    FIELDSYSTEMENGINE_API void DispatchFieldCommand(const FFieldSystemCommand& InCommand, const bool IsTransient);
 
    FIELDSYSTEMENGINE_API void ClearFieldCommands();
 
    //~ Begin UActorComponent Interface.
    FIELDSYSTEMENGINE_API virtual void OnCreatePhysicsState() override;
    FIELDSYSTEMENGINE_API virtual void OnDestroyPhysicsState() override;
    FIELDSYSTEMENGINE_API virtual bool ShouldCreatePhysicsState() const override;
    FIELDSYSTEMENGINE_API virtual bool HasValidPhysicsState() const override;
    //~ End UActorComponent Interface.
 
    FChaosSolversModule* ChaosModule;
 
    bool bHasPhysicsState;
 
    TArray< FFieldSystemCommand > SetupConstructionFields;
 
    TArray< FFieldSystemCommand > ChaosPersistentFields;
 
    TArray< FFieldSystemCommand > WorldGPUPersistentFields;
 
    TArray< FFieldSystemCommand > WorldCPUPersistentFields;
};