PxBatchQuery.h
Go to the documentation of this file.
1 //
2 // Redistribution and use in source and binary forms, with or without
3 // modification, are permitted provided that the following conditions
4 // are met:
5 // * Redistributions of source code must retain the above copyright
6 // notice, this list of conditions and the following disclaimer.
7 // * Redistributions in binary form must reproduce the above copyright
8 // notice, this list of conditions and the following disclaimer in the
9 // documentation and/or other materials provided with the distribution.
10 // * Neither the name of NVIDIA CORPORATION nor the names of its
11 // contributors may be used to endorse or promote products derived
12 // from this software without specific prior written permission.
13 //
14 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ''AS IS'' AND ANY
15 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
18 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
19 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
20 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
21 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
22 // OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25 //
26 // Copyright (c) 2008-2021 NVIDIA Corporation. All rights reserved.
27 // Copyright (c) 2004-2008 AGEIA Technologies, Inc. All rights reserved.
28 // Copyright (c) 2001-2004 NovodeX AG. All rights reserved.
29 
30 
31 #ifndef PX_PHYSICS_NX_SCENEQUERY
32 #define PX_PHYSICS_NX_SCENEQUERY
33 
36 #include "PxPhysXConfig.h"
37 #include "PxShape.h"
38 #include "PxBatchQueryDesc.h"
39 #include "PxQueryFiltering.h"
40 
41 #if !PX_DOXYGEN
42 namespace physx
43 {
44 #endif
45 
46 class PxBoxGeometry;
47 class PxSphereGeometry;
48 struct PxQueryCache;
49 
58 {
59  public:
60 
64  virtual void execute() = 0;
65 
73  virtual PxBatchQueryPreFilterShader getPreFilterShader() const = 0;
74 
82  virtual PxBatchQueryPostFilterShader getPostFilterShader() const = 0;
83 
84 
92  virtual const void* getFilterShaderData() const = 0;
93 
101  virtual PxU32 getFilterShaderDataSize() const = 0;
102 
110  virtual void setUserMemory(const PxBatchQueryMemory&) = 0;
111 
117  virtual const PxBatchQueryMemory& getUserMemory() = 0;
118 
124  virtual void release() = 0;
125 
149  virtual void raycast(
150  const PxVec3& origin, const PxVec3& unitDir, PxReal distance = PX_MAX_F32, PxU16 maxTouchHits = 0,
151  PxHitFlags hitFlags = PxHitFlag::eDEFAULT,
152  const PxQueryFilterData& filterData = PxQueryFilterData(),
153  void* userData = NULL, const PxQueryCache* cache = NULL) = 0;
154 
155 
178  virtual void overlap(
179  const PxGeometry& geometry, const PxTransform& pose, PxU16 maxTouchHits = 0,
180  const PxQueryFilterData& filterData = PxQueryFilterData(), void* userData=NULL, const PxQueryCache* cache = NULL) = 0;
181 
209  virtual void sweep(
210  const PxGeometry& geometry, const PxTransform& pose, const PxVec3& unitDir, const PxReal distance,
211  PxU16 maxTouchHits = 0, PxHitFlags hitFlags = PxHitFlag::eDEFAULT,
212  const PxQueryFilterData& filterData = PxQueryFilterData(), void* userData=NULL, const PxQueryCache* cache = NULL,
213  const PxReal inflation = 0.f) = 0;
214 
215 protected:
216  virtual ~PxBatchQuery() {}
217 };
218 
219 #if !PX_DOXYGEN
220 } // namespace physx
221 #endif
222 
224 #endif
Definition: GuContactBuffer.h:37
PX_DEPRECATED PxQueryHitType::Enum(* PxBatchQueryPreFilterShader)(PxFilterData queryFilterData, PxFilterData objectFilterData, const void *constantBlock, PxU32 constantBlockSize, PxHitFlags &hitFlags)
Batched query pre-filter shader.
Definition: PxQueryFiltering.h:233
Struct for PxBatchQuery memory pointers.
Definition: PxBatchQueryDesc.h:117
Batched queries object. This is used to perform several queries at the same time. ...
Definition: PxBatchQuery.h:57
float PxReal
Definition: PxSimpleTypes.h:78
A class representing the geometry of a sphere.
Definition: PxSphereGeometry.h:49
Scene query filtering data.
Definition: PxQueryFiltering.h:132
A geometry object.
Definition: PxGeometry.h:75
#define PX_DEPRECATED
Definition: PxPreprocessor.h:424
virtual ~PxBatchQuery()
Definition: PxBatchQuery.h:216
single hit cache for scene queries.
Definition: PxScene.h:143
PxU8 geometry[sizeof(PxGeometry)]
Definition: PxGeometryHelpers.h:215
#define PX_MAX_F32
Definition: PxSimpleTypes.h:86
Definition: PxQueryReport.h:82
class representing a rigid euclidean transform as a quaternion and a vector
Definition: PxTransform.h:48
PX_DEPRECATED PxQueryHitType::Enum(* PxBatchQueryPostFilterShader)(PxFilterData queryFilterData, PxFilterData objectFilterData, const void *constantBlock, PxU32 constantBlockSize, const PxQueryHit &hit)
Batched query post-filter shader.
Definition: PxQueryFiltering.h:266
uint16_t PxU16
Definition: PxSimpleTypes.h:73
uint32_t PxU32
Definition: Px.h:48
Class representing the geometry of a box.
Definition: PxBoxGeometry.h:50
3 Element vector class.
Definition: PxVec3.h:49