include/PxSceneQueryDesc.h

File members: include/PxSceneQueryDesc.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-2024 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_SCENE_QUERY_DESC_H
#define PX_SCENE_QUERY_DESC_H

#include "PxPhysXConfig.h"
#include "geometry/PxBVHBuildStrategy.h"

#if !PX_DOXYGEN
namespace physx
{
#endif

    class PxSceneQuerySystem;

struct PxPruningStructureType
{
    enum Enum
    {
        eNONE,
        eDYNAMIC_AABB_TREE,
        eSTATIC_AABB_TREE,

        eLAST
    };
};

struct PxDynamicTreeSecondaryPruner
{
    enum Enum
    {
        eNONE,
        eBUCKET ,
        eINCREMENTAL,
        eBVH,

        eLAST
    };
};

struct PxSceneQueryUpdateMode
{
    enum Enum
    {
        eBUILD_ENABLED_COMMIT_ENABLED,
        eBUILD_ENABLED_COMMIT_DISABLED,
        eBUILD_DISABLED_COMMIT_DISABLED
    };
};

class PxSceneQueryDesc
{
public:

    PxPruningStructureType::Enum    staticStructure;

    PxPruningStructureType::Enum    dynamicStructure;

    PxU32   dynamicTreeRebuildRateHint;

    PxDynamicTreeSecondaryPruner::Enum dynamicTreeSecondaryPruner;

    PxBVHBuildStrategy::Enum    staticBVHBuildStrategy;

    PxBVHBuildStrategy::Enum    dynamicBVHBuildStrategy;

    PxU32   staticNbObjectsPerNode;

    PxU32   dynamicNbObjectsPerNode;

    PxSceneQueryUpdateMode::Enum sceneQueryUpdateMode;

public:
    PX_INLINE PxSceneQueryDesc();

    PX_INLINE void setToDefault();

    PX_INLINE bool isValid() const;
};

PX_INLINE PxSceneQueryDesc::PxSceneQueryDesc():
    staticStructure             (PxPruningStructureType::eDYNAMIC_AABB_TREE),
    dynamicStructure            (PxPruningStructureType::eDYNAMIC_AABB_TREE),
    dynamicTreeRebuildRateHint  (100),
    dynamicTreeSecondaryPruner  (PxDynamicTreeSecondaryPruner::eINCREMENTAL),
    staticBVHBuildStrategy      (PxBVHBuildStrategy::eFAST),
    dynamicBVHBuildStrategy     (PxBVHBuildStrategy::eFAST),
    staticNbObjectsPerNode      (4),
    dynamicNbObjectsPerNode     (4),
    sceneQueryUpdateMode        (PxSceneQueryUpdateMode::eBUILD_ENABLED_COMMIT_ENABLED)
{
}

PX_INLINE void PxSceneQueryDesc::setToDefault()
{
    *this = PxSceneQueryDesc();
}

PX_INLINE bool PxSceneQueryDesc::isValid() const
{
    if(staticStructure!=PxPruningStructureType::eSTATIC_AABB_TREE && staticStructure!=PxPruningStructureType::eDYNAMIC_AABB_TREE)
        return false;

    if(dynamicTreeRebuildRateHint < 4)
        return false;

    return true;
}

#if !PX_DOXYGEN
} // namespace physx
#endif

#endif