BpBroadPhase.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 BP_BROADPHASE_H
#define BP_BROADPHASE_H
 
#include "foundation/PxUserAllocated.h"
#include "PxBroadPhase.h"
#include "BpBroadPhaseUpdate.h"
 
namespace physx
{
    class PxcScratchAllocator;
    class PxBaseTask;
 
namespace Bp
{
 
class BroadPhaseUpdateData;
 
class BroadPhaseBase : public PxBroadPhaseRegions, public PxUserAllocated
{
    public:
                BroadPhaseBase()    {}
    virtual     ~BroadPhaseBase()   {}
 
    virtual void    getCaps(PxBroadPhaseCaps& caps) const 
    {
        caps.mMaxNbRegions = 0;
    }
 
    // PxBroadPhaseRegions
    virtual PxU32           getNbRegions()                                                      const   PX_OVERRIDE { return 0;         }
    virtual PxU32           getRegions(PxBroadPhaseRegionInfo*, PxU32, PxU32)                   const   PX_OVERRIDE { return 0;         }
    virtual PxU32           addRegion(const PxBroadPhaseRegion&, bool, const PxBounds3*, const PxReal*) PX_OVERRIDE { return 0xffffffff;}
    virtual bool            removeRegion(PxU32)                                                         PX_OVERRIDE { return false;     }
    virtual PxU32           getNbOutOfBoundsObjects()                                           const   PX_OVERRIDE { return 0;         }
    virtual const PxU32*    getOutOfBoundsObjects()                                             const   PX_OVERRIDE { return NULL;      }
    //~PxBroadPhaseRegions
};
 
/*
\brief Structure used to report created and deleted broadphase pairs
\note The indices mVolA and mVolB correspond to the bounds indices 
BroadPhaseUpdateData::mCreated used by BroadPhase::update
@see BroadPhase::getCreatedPairs, BroadPhase::getDeletedPairs
*/
struct BroadPhasePair
{
    BroadPhasePair(ShapeHandle volA, ShapeHandle volB) :
        mVolA       (PxMin(volA, volB)),
        mVolB       (PxMax(volA, volB))
    {
    }
    BroadPhasePair() :
        mVolA       (BP_INVALID_BP_HANDLE),
        mVolB       (BP_INVALID_BP_HANDLE)
    {
    }
 
    ShapeHandle     mVolA;      // NB: mVolA < mVolB
    ShapeHandle     mVolB;
};
 
class BroadPhase : public BroadPhaseBase
{
public:
 
    static BroadPhase* create(
        const PxBroadPhaseType::Enum bpType,
        const PxU32 maxNbRegions,
        const PxU32 maxNbBroadPhaseOverlaps,
        const PxU32 maxNbStaticShapes,
        const PxU32 maxNbDynamicShapes,
        PxU64 contextID);
 
    virtual PxBroadPhaseType::Enum  getType() const = 0;
 
    virtual void    release() = 0;
 
    virtual void    update(PxcScratchAllocator* scratchAllocator, const BroadPhaseUpdateData& updateData, physx::PxBaseTask* continuation) = 0;
 
    virtual void    preBroadPhase(const Bp::BroadPhaseUpdateData& updateData) = 0;
 
    virtual void    fetchBroadPhaseResults() = 0;
 
    /*
    \brief  Get created pairs.
 
    Note that each overlap pair is reported only on the frame when the overlap first occurs. The overlap persists
    until the pair appears in the list of deleted pairs or either of the bounds in the pair is removed from the broadphase.  
    A created overlap must involve at least one of the bounds of the overlap pair appearing in either the created or updated list.
    It is impossible for the same pair to appear simultaneously in the list of created and deleted overlap pairs.
    An overlap is defined as a pair of bounds that overlap on all three axes; that is when maxA > minB and maxB > minA for all three axes. 
 
    \param  nbCreatedPairs [out]    The number of created aabb overlap pairs computed in the execution of update() that has just completed.
    \return The array of created aabb overlap pairs computed in the execution of update() that has just completed.
    */
    virtual const BroadPhasePair*   getCreatedPairs(PxU32& nbCreatedPairs)  const   = 0;
 
    virtual const BroadPhasePair*   getDeletedPairs(PxU32& nbDeletedPairs)  const   = 0;
 
    virtual void    freeBuffers()   = 0;
 
    virtual void    shiftOrigin(const PxVec3& shift, const PxBounds3* boundsArray, const PxReal* contactDistances) = 0;
 
#if PX_CHECKED
    virtual bool    isValid(const BroadPhaseUpdateData& updateData) const = 0;
#endif
};
 
} //namespace Bp
 
} //namespace physx
 
#endif //BP_BROADPHASE_H