| 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 PX_VEHICLE_UTILHELPER_H |
|---|
| 31 | #define PX_VEHICLE_UTILHELPER_H |
|---|
| 32 | /** \addtogroup vehicle |
|---|
| 33 | @{ |
|---|
| 34 | */ |
|---|
| 35 | |
|---|
| 36 | #include "foundation/Px.h" |
|---|
| 37 | |
|---|
| 38 | #if !PX_DOXYGEN |
|---|
| 39 | namespace physx |
|---|
| 40 | { |
|---|
| 41 | #endif |
|---|
| 42 | |
|---|
| 43 | struct PxVehicleWheelQueryResult; |
|---|
| 44 | |
|---|
| 45 | /** |
|---|
| 46 | \brief Test if all wheels of a vehicle are in the air by querying the wheel query data |
|---|
| 47 | stored in the last call to PxVehicleUpdates. If all wheels are in the air then true is returned. |
|---|
| 48 | |
|---|
| 49 | \note False is returned if any wheel can reach to the ground. |
|---|
| 50 | |
|---|
| 51 | \note If vehWheelQueryResults.wheelQueryResults is NULL or vehWheelQueryResults.nbWheelQueryResults is 0 then true is returned. |
|---|
| 52 | This function does not account for wheels that have been disabled since the last execution of PxVehicleUpdates so it is possible |
|---|
| 53 | that wheels disabled more recently than the last call to PxVehicleUpdates report are treated as touching the ground. |
|---|
| 54 | |
|---|
| 55 | \return True if the vehicle is in the air, false if any wheel is touching the ground. |
|---|
| 56 | */ |
|---|
| 57 | bool PxVehicleIsInAir(const PxVehicleWheelQueryResult& vehWheelQueryResults); |
|---|
| 58 | |
|---|
| 59 | #if !PX_DOXYGEN |
|---|
| 60 | } // namespace physx |
|---|
| 61 | #endif |
|---|
| 62 | |
|---|
| 63 | /** @} */ |
|---|
| 64 | #endif //PX_VEHICLE_UTILHELPER_H |
|---|
| 65 | |
|---|
