| 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_PLANE_GEOMETRY |
|---|
| 32 | #define PX_PHYSICS_NX_PLANE_GEOMETRY |
|---|
| 33 | /** \addtogroup geomutils |
|---|
| 34 | @{ |
|---|
| 35 | */ |
|---|
| 36 | #include "foundation/PxPlane.h" |
|---|
| 37 | #include "foundation/PxTransform.h" |
|---|
| 38 | #include "geometry/PxGeometry.h" |
|---|
| 39 | #include "foundation/PxFoundationConfig.h" |
|---|
| 40 | |
|---|
| 41 | #if !PX_DOXYGEN |
|---|
| 42 | namespace physx |
|---|
| 43 | { |
|---|
| 44 | #endif |
|---|
| 45 | |
|---|
| 46 | /** |
|---|
| 47 | \brief Class describing a plane geometry. |
|---|
| 48 | |
|---|
| 49 | The plane geometry specifies the half-space volume x<=0. As with other geometry types, |
|---|
| 50 | when used in a PxShape the collision volume is obtained by transforming the halfspace |
|---|
| 51 | by the shape local pose and the actor global pose. |
|---|
| 52 | |
|---|
| 53 | To generate a PxPlane from a PxTransform, transform PxPlane(1,0,0,0). |
|---|
| 54 | |
|---|
| 55 | To generate a PxTransform from a PxPlane, use PxTransformFromPlaneEquation. |
|---|
| 56 | |
|---|
| 57 | @see PxShape.setGeometry() PxShape.getPlaneGeometry() PxTransformFromPlaneEquation |
|---|
| 58 | */ |
|---|
| 59 | class PxPlaneGeometry : public PxGeometry |
|---|
| 60 | { |
|---|
| 61 | public: |
|---|
| 62 | PX_INLINE PxPlaneGeometry() : PxGeometry(PxGeometryType::ePLANE) {} |
|---|
| 63 | |
|---|
| 64 | /** |
|---|
| 65 | \brief Returns true if the geometry is valid. |
|---|
| 66 | |
|---|
| 67 | \return True if the current settings are valid |
|---|
| 68 | */ |
|---|
| 69 | PX_INLINE bool isValid() const; |
|---|
| 70 | }; |
|---|
| 71 | |
|---|
| 72 | PX_INLINE bool PxPlaneGeometry::isValid() const |
|---|
| 73 | { |
|---|
| 74 | if (mType != PxGeometryType::ePLANE) |
|---|
| 75 | return false; |
|---|
| 76 | |
|---|
| 77 | return true; |
|---|
| 78 | } |
|---|
| 79 | |
|---|
| 80 | #if !PX_DOXYGEN |
|---|
| 81 | } // namespace physx |
|---|
| 82 | #endif |
|---|
| 83 | |
|---|
| 84 | /** @} */ |
|---|
| 85 | #endif |
|---|
| 86 | |
|---|
