| 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_BVH_33_MIDPHASE_DESC_H |
| 32 | #define PX_BVH_33_MIDPHASE_DESC_H |
| 33 | /** \addtogroup cooking |
| 34 | @{ |
| 35 | */ |
| 36 | |
| 37 | #include "foundation/PxPreprocessor.h" |
| 38 | #include "foundation/PxSimpleTypes.h" |
| 39 | |
| 40 | #if !PX_DOXYGEN |
| 41 | namespace physx |
| 42 | { |
| 43 | #endif |
| 44 | |
| 45 | /** \brief Enumeration for mesh cooking hints. */ |
| 46 | struct PxMeshCookingHint |
| 47 | { |
| 48 | enum Enum |
| 49 | { |
| 50 | eSIM_PERFORMANCE = 0, //!< Default value. Favors higher quality hierarchy with higher runtime performance over cooking speed. |
| 51 | eCOOKING_PERFORMANCE = 1 //!< Enables fast cooking path at the expense of somewhat lower quality hierarchy construction. |
| 52 | }; |
| 53 | }; |
| 54 | |
| 55 | /** |
| 56 | |
| 57 | \brief Structure describing parameters affecting BVH33 midphase mesh structure. |
| 58 | |
| 59 | @see PxCookingParams, PxMidphaseDesc |
| 60 | */ |
| 61 | struct PxBVH33MidphaseDesc |
| 62 | { |
| 63 | /** |
| 64 | \brief Controls the trade-off between mesh size and runtime performance. |
| 65 | |
| 66 | Using a value of 1.0 will produce a larger cooked mesh with generally higher runtime performance, |
| 67 | using 0.0 will produce a smaller cooked mesh, with generally lower runtime performance. |
| 68 | |
| 69 | Values outside of [0,1] range will be clamped and cause a warning when any mesh gets cooked. |
| 70 | |
| 71 | <b>Default value:</b> 0.55 |
| 72 | <b>Range:</b> [0.0f, 1.0f] |
| 73 | */ |
| 74 | PxF32 meshSizePerformanceTradeOff; |
| 75 | |
| 76 | /** |
| 77 | \brief Mesh cooking hint. Used to specify mesh hierarchy construction preference. |
| 78 | |
| 79 | <b>Default value:</b> PxMeshCookingHint::eSIM_PERFORMANCE |
| 80 | */ |
| 81 | PxMeshCookingHint::Enum meshCookingHint; |
| 82 | |
| 83 | /** |
| 84 | \brief Desc initialization to default value. |
| 85 | */ |
| 86 | void setToDefault() |
| 87 | { |
| 88 | meshSizePerformanceTradeOff = 0.55f; |
| 89 | meshCookingHint = PxMeshCookingHint::eSIM_PERFORMANCE; |
| 90 | } |
| 91 | |
| 92 | /** |
| 93 | \brief Returns true if the descriptor is valid. |
| 94 | \return true if the current settings are valid. |
| 95 | */ |
| 96 | bool isValid() const |
| 97 | { |
| 98 | if(meshSizePerformanceTradeOff < 0.0f || meshSizePerformanceTradeOff > 1.0f) |
| 99 | return false; |
| 100 | return true; |
| 101 | } |
| 102 | }; |
| 103 | |
| 104 | #if !PX_DOXYGEN |
| 105 | } // namespace physx |
| 106 | #endif |
| 107 | |
| 108 | |
| 109 | /** @} */ |
| 110 | #endif // PX_BVH_33_MIDPHASE_DESC_H |
| 111 | |