ChaosRemovalEventFilter.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
#pragma once
 
#include "CoreMinimal.h"
#include "UObject/ObjectMacros.h"
#include "ChaosFilter.h"
#include "EventsData.h"
#include "ChaosRemovalEventFilter.generated.h"
 
// A Removal event data structure. 
USTRUCT(BlueprintType)
struct FChaosRemovalEventData
{
    GENERATED_USTRUCT_BODY()
 
    
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Filters")
    FVector Location;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Filters")
    float Mass;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Filters")
    int32 ParticleIndex;
 
    FChaosRemovalEventData()
        : Location(FVector::ZeroVector)
        , Mass(0.0f)
        , ParticleIndex(INDEX_NONE)
    {
    }
};
 
// Enumeration defining how to sort removal results
UENUM(BlueprintType)
enum class EChaosRemovalSortMethod : uint8
{
    SortNone,
    SortByHighestMass,
    SortByNearestFirst,
 
    Count UMETA(Hidden)
};
 
USTRUCT(BlueprintType)
struct FChaosRemovalEventRequestSettings
{
    GENERATED_USTRUCT_BODY()
 
    
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Filters")
    int32 MaxNumberOfResults;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Filters")
    float MinMass;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Filters")
    float MaxDistance;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Sort")
    EChaosRemovalSortMethod SortMethod;
 
    FChaosRemovalEventRequestSettings()
        : MaxNumberOfResults(0)
        , MinMass(0.0f)
        , MaxDistance(0.0f)
        , SortMethod(EChaosRemovalSortMethod::SortByHighestMass)
    {
    }
};
 
class FChaosRemovalEventFilter
    : public IChaosEventFilter<Chaos::FRemovalDataArray, TArray<FChaosRemovalEventData>, EChaosRemovalSortMethod>
{
public:
    FChaosRemovalEventFilter(FChaosRemovalEventRequestSettings* FilterSettingsIn) : RemovalEventRequestSettings(FilterSettingsIn) {}
 
    GEOMETRYCOLLECTIONENGINE_API virtual void FilterEvents(const FTransform& ChaosComponentTransform, const Chaos::FRemovalDataArray& RawRemovalDataArray) override;
 
    GEOMETRYCOLLECTIONENGINE_API virtual void SortEvents(TArray<FChaosRemovalEventData>& InOutRemovalEvents, EChaosRemovalSortMethod SortMethod, const FTransform& InTransform) override;
 
private:
    FChaosRemovalEventFilter() : RemovalEventRequestSettings(nullptr) {}
    const FChaosRemovalEventRequestSettings* RemovalEventRequestSettings;
};