PxQueryFiltering.h

// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
//  * Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//  * Redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
//  * Neither the name of NVIDIA CORPORATION nor the names of its
//    contributors may be used to endorse or promote products derived
//    from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ''AS IS'' AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
// OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Copyright (c) 2008-2022 NVIDIA Corporation. All rights reserved.
// Copyright (c) 2004-2008 AGEIA Technologies, Inc. All rights reserved.
// Copyright (c) 2001-2004 NovodeX AG. All rights reserved.
 
#ifndef PX_QUERY_FILTERING_H
#define PX_QUERY_FILTERING_H
#include "PxPhysXConfig.h"
#include "PxFiltering.h"
#include "PxQueryReport.h"
#include "PxClient.h"
 
#if !PX_DOXYGEN
namespace physx
{
#endif
 
class PxShape;
class PxRigidActor;
struct PxQueryHit;
 
struct PxQueryFlag
{
    enum Enum
    {
        eSTATIC                         = (1<<0),   
 
        eDYNAMIC                        = (1<<1),   
 
        ePREFILTER                      = (1<<2),   
 
        ePOSTFILTER                     = (1<<3),   
 
        eANY_HIT                        = (1<<4),   
 
        eNO_BLOCK                       = (1<<5),   
        
        eBATCH_QUERY_LEGACY_BEHAVIOUR   = (1<<6),   
 
        eDISABLE_HARDCODED_FILTER       = (1<<6),   
 
        eRESERVED                       = (1<<15)   
    };
};
PX_COMPILE_TIME_ASSERT(PxQueryFlag::eSTATIC==(1<<0));
PX_COMPILE_TIME_ASSERT(PxQueryFlag::eDYNAMIC==(1<<1));
PX_COMPILE_TIME_ASSERT(PxQueryFlag::eBATCH_QUERY_LEGACY_BEHAVIOUR==PxQueryFlag::eDISABLE_HARDCODED_FILTER);
 
typedef PxFlags<PxQueryFlag::Enum,PxU16> PxQueryFlags;
PX_FLAGS_OPERATORS(PxQueryFlag::Enum,PxU16)
 
 
struct PxQueryHitType
{
    enum Enum
    {
        eNONE   = 0,    
        eTOUCH  = 1,    
        eBLOCK  = 2     
    };
};
 
struct PxQueryFilterData
{
    explicit PX_INLINE PxQueryFilterData() : flags(PxQueryFlag::eDYNAMIC | PxQueryFlag::eSTATIC)        {}
 
    explicit PX_INLINE PxQueryFilterData(const PxFilterData& fd, PxQueryFlags f) : data(fd), flags(f)   {}
 
    explicit PX_INLINE PxQueryFilterData(PxQueryFlags f) : flags(f)                                     {}
 
    PxFilterData    data;       
    PxQueryFlags    flags;      
};
 
class PxQueryFilterCallback
{
public:
 
    virtual PxQueryHitType::Enum preFilter(
        const PxFilterData& filterData, const PxShape* shape, const PxRigidActor* actor, PxHitFlags& queryFlags) = 0;
 
    PX_DEPRECATED virtual PxQueryHitType::Enum postFilter(const PxFilterData& filterData, const PxQueryHit& hit)
    {
        PX_UNUSED(filterData);
        PX_UNUSED(hit);
        return PxQueryHitType::eBLOCK;
    }
 
    virtual PxQueryHitType::Enum postFilter(const PxFilterData& filterData, const PxQueryHit& hit, const PxShape* shape, const PxRigidActor* actor)
    {
        PX_UNUSED(shape);
        PX_UNUSED(actor);
        return postFilter(filterData, hit);
    }
 
    virtual ~PxQueryFilterCallback() {}
};
 
 
#if !PX_DOXYGEN
} // namespace physx
#endif
 
#endif