CollisionQueryFilterCallback.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CollisionQueryFilterCallbackCore.h"
#include "CollisionQueryParams.h"
#include "Physics/PhysicsInterfaceTypes.h"
 
#define ENABLE_PREFILTER_LOGGING 0
 
struct FBodyInstance;
 
typedef FCollisionQueryParams::IgnoreComponentsArrayType FilterIgnoreComponentsArrayType;
 
typedef FCollisionQueryParams::IgnoreActorsArrayType FilterIgnoreActorsArrayType;
 
class FCollisionQueryFilterCallback : public ICollisionQueryFilterCallbackBase
{
public:
    ECollisionQueryHitType PreFilterReturnValue;
 
    const FilterIgnoreComponentsArrayType& IgnoreComponents;
 
    //~ TODO: It would be nice to rename this to IgnoreSourceObjects, because these might not be actors in
    //~ non-actor workflows (requires deprecation).
    const FilterIgnoreActorsArrayType& IgnoreActors;
 
    bool bIsOverlapQuery;
 
    bool bIgnoreTouches;
 
    bool bIgnoreBlocks;
 
    FCollisionQueryFilterCallback(const FCollisionQueryParams& InQueryParams, bool bInIsSweep)
        : IgnoreComponents(InQueryParams.GetIgnoredComponents())
        , IgnoreActors(InQueryParams.GetIgnoredSourceObjects())
#if DETECT_SQ_HITCHES
        , bRecordHitches(false)
#endif
        , bIsSweep(bInIsSweep)
    {
        PreFilterReturnValue = ECollisionQueryHitType::None;
        bIsOverlapQuery = false;
        bIgnoreTouches = InQueryParams.bIgnoreTouches;
        bIgnoreBlocks = InQueryParams.bIgnoreBlocks;
        bDiscardInitialOverlaps = !InQueryParams.bFindInitialOverlaps;
    }
    ~FCollisionQueryFilterCallback() {}
 
 
    static ECollisionQueryHitType CalcQueryHitType(const FCollisionFilterData& QueryFilter, const FCollisionFilterData& ShapeFilter, bool bPreFilter = false);
 
    ECollisionQueryHitType PreFilterImp(const FCollisionFilterData& FilterData, const FCollisionFilterData& ShapeFilterData, uint32 ComponentID, const FBodyInstance* BodyInstance);
 
    ECollisionQueryHitType PostFilterImp(const FCollisionFilterData& FilterData, bool bIsOverlap);
 
    ECollisionQueryHitType PreFilterImp(const FCollisionFilterData& FilterData, const Chaos::FPerShapeData& Shape, const Chaos::FGeometryParticle& Actor);
    ECollisionQueryHitType PreFilterImp(const FCollisionFilterData& FilterData, const Chaos::FPerShapeData& Shape, const Chaos::FGeometryParticleHandle& Actor);
 
    ECollisionQueryHitType PostFilterImp(const FCollisionFilterData& FilterData, const ChaosInterface::FQueryHit& Hit);
    ECollisionQueryHitType PostFilterImp(const FCollisionFilterData& FilterData, const ChaosInterface::FPTQueryHit& Hit);
 
    virtual ECollisionQueryHitType PostFilter(const FCollisionFilterData& FilterData, const ChaosInterface::FQueryHit& Hit) override
    {
        return PostFilterImp(FilterData, Hit);
    }
 
    virtual ECollisionQueryHitType PostFilter(const FCollisionFilterData& FilterData, const ChaosInterface::FPTQueryHit& Hit) override
    {
        return PostFilterImp(FilterData, Hit);
    }
 
    virtual ECollisionQueryHitType PreFilter(const FCollisionFilterData& FilterData, const Chaos::FPerShapeData& Shape, const Chaos::FGeometryParticle& Actor) override
    {
        return PreFilterImp(FilterData, Shape, Actor);
    }
 
    virtual ECollisionQueryHitType PreFilter(const FCollisionFilterData& FilterData, const Chaos::FPerShapeData& Shape, const Chaos::FGeometryParticleHandle& Actor) override
    {
        return PreFilterImp(FilterData, Shape, Actor);
    }
 
#if DETECT_SQ_HITCHES
    // Util struct to record what preFilter was called with
    struct FPreFilterRecord
    {
        FString OwnerComponentReadableName;
        ECollisionQueryHitType Result;
    };
 
    TArray<FPreFilterRecord> PreFilterHitchInfo;
    bool bRecordHitches;
#endif
    bool bDiscardInitialOverlaps;
    bool bIsSweep;
 
private:
    template <typename TParticle>
    ECollisionQueryHitType PreFilterBaseImp(const FCollisionFilterData& FilterData, const Chaos::FPerShapeData& Shape, const TParticle& Actor);
};