physxCAPI/physxCDLL/include/extensions/PxSceneQuerySystemExt.h
2023-08-11 10:55:58 +08:00

68 lines
2.9 KiB
C++

// 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-2023 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_SYSTEM_EXT_H
#define PX_SCENE_QUERY_SYSTEM_EXT_H
/** \addtogroup extensions
@{
*/
#include "PxSceneQuerySystem.h"
#if !PX_DOXYGEN
namespace physx
{
#endif
/**
\brief Creates an external scene query system.
An external SQ system is the part of a PxScene that deals with scene queries (SQ). This is usually taken care of
by an internal implementation inside PxScene, but it is also possible to re-route all SQ calls to an external
implementation, potentially opening the door to some customizations in behavior and features for advanced users.
The following external SQ system is an example of how an implementation would look like. It re-uses much of the
same code as the internal version, but it could be re-implemented in a completely different way to match users'
specific needs.
\param[in] desc Scene query descriptor
\param[in] contextID Context ID parameter, sent to the profiler
\return An external SQ system instance
@see PxSceneQuerySystem PxSceneQueryDesc
*/
PxSceneQuerySystem* PxCreateExternalSceneQuerySystem(const PxSceneQueryDesc& desc, PxU64 contextID);
#if !PX_DOXYGEN
} // namespace physx
#endif
/** @} */
#endif