PxBVHDesc.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_BVH_DESC_H
#define PX_BVH_DESC_H
#include "common/PxCoreUtilityTypes.h"
#include "foundation/PxTransform.h"
#include "foundation/PxBounds3.h"
#include "geometry/PxBVHBuildStrategy.h"
 
#if !PX_DOXYGEN
namespace physx
{
#endif
 
class PxBVHDesc
{
public:
    PX_INLINE PxBVHDesc();
 
    PxBoundedData bounds;
 
    float   enlargement;
 
    PxU32   numPrimsPerLeaf;
 
    PxBVHBuildStrategy::Enum    buildStrategy;
 
    PX_INLINE void setToDefault();
 
    PX_INLINE bool isValid() const;
 
protected:  
};
 
PX_INLINE PxBVHDesc::PxBVHDesc() : enlargement(0.01f), numPrimsPerLeaf(4), buildStrategy(PxBVHBuildStrategy::eDEFAULT)
{
}
 
PX_INLINE void PxBVHDesc::setToDefault()
{
    *this = PxBVHDesc();
}
 
PX_INLINE bool PxBVHDesc::isValid() const
{
    // Check BVH desc data
    if(!bounds.data)
        return false;
    if(bounds.stride < sizeof(PxBounds3))   //should be at least one bounds' worth of data
        return false;
 
    if(bounds.count == 0)
        return false;
 
    if(enlargement<0.0f)
        return false;
 
    if(numPrimsPerLeaf>=16)
        return false;
 
    return true;
}
 
    typedef PX_DEPRECATED PxBVHDesc PxBVHStructureDesc;
 
#if !PX_DOXYGEN
} // namespace physx
#endif
 
#endif