| 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 | #ifndef GU_RAYCAST_TESTS_H |
|---|
| 31 | #define GU_RAYCAST_TESTS_H |
|---|
| 32 | |
|---|
| 33 | #include "foundation/PxSimpleTypes.h" |
|---|
| 34 | #include "geometry/PxGeometry.h" |
|---|
| 35 | #include "PxQueryReport.h" |
|---|
| 36 | #include "CmPhysXCommon.h" |
|---|
| 37 | |
|---|
| 38 | namespace physx |
|---|
| 39 | { |
|---|
| 40 | // PT: TODO: why is PxHitFlag::eMESH_MULTIPLE used in the ray-vs-hf function, but not in the ray-vs-mesh function? |
|---|
| 41 | |
|---|
| 42 | // PT: we use a define to be able to quickly change the signature of all raycast functions. |
|---|
| 43 | // (this also ensures they all use consistent names for passed parameters). |
|---|
| 44 | // \param[in] geom geometry object to raycast against |
|---|
| 45 | // \param[in] pose pose of geometry object |
|---|
| 46 | // \param[in] rayOrigin ray's origin |
|---|
| 47 | // \param[in] rayDir ray's unit dir |
|---|
| 48 | // \param[in] maxDist ray's length/max distance |
|---|
| 49 | // \param[in] hitFlags query behavior flags |
|---|
| 50 | // \param[in] maxHits max number of hits = size of 'hits' buffer |
|---|
| 51 | // \param[out] hits result buffer where to write raycast hits |
|---|
| 52 | #define GU_RAY_FUNC_PARAMS const PxGeometry& geom, const PxTransform& pose, \ |
|---|
| 53 | const PxVec3& rayOrigin, const PxVec3& rayDir, PxReal maxDist, \ |
|---|
| 54 | PxHitFlags hitFlags, PxU32 maxHits, PxRaycastHit* PX_RESTRICT hits |
|---|
| 55 | namespace Gu |
|---|
| 56 | { |
|---|
| 57 | // PT: function pointer for Geom-indexed raycast functions |
|---|
| 58 | // See GU_RAY_FUNC_PARAMS for function parameters details. |
|---|
| 59 | // \return number of hits written to 'hits' result buffer |
|---|
| 60 | // \note there's no mechanism to report overflow. Returned number of hits is just clamped to maxHits. |
|---|
| 61 | typedef PxU32 (*RaycastFunc) (GU_RAY_FUNC_PARAMS); |
|---|
| 62 | |
|---|
| 63 | // PT: typedef for a bundle of all raycast functions, i.e. the function table itself (indexed by geom-type). |
|---|
| 64 | typedef RaycastFunc GeomRaycastTable[PxGeometryType::eGEOMETRY_COUNT]; |
|---|
| 65 | |
|---|
| 66 | // PT: retrieves the raycast function table (for access by external non-Gu modules) |
|---|
| 67 | PX_PHYSX_COMMON_API const GeomRaycastTable& getRaycastFuncTable(); |
|---|
| 68 | |
|---|
| 69 | } // namespace Gu |
|---|
| 70 | } |
|---|
| 71 | |
|---|
| 72 | #endif |
|---|
| 73 | |
|---|
