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_SCALE_H |
32 | #define PX_SCALE_H |
33 | |
34 | /** \addtogroup common |
35 | @{ |
36 | */ |
37 | |
38 | #include "common/PxPhysXCommonConfig.h" |
39 | |
40 | #if !PX_DOXYGEN |
41 | namespace physx |
42 | { |
43 | #endif |
44 | |
45 | class PxPhysics; |
46 | |
47 | /** |
48 | \brief Class to define the scale at which simulation runs. Most simulation tolerances are |
49 | calculated in terms of the values here. |
50 | |
51 | \note if you change the simulation scale, you will probablly also wish to change the scene's |
52 | default value of gravity, and stable simulation will probably require changes to the scene's |
53 | bounceThreshold also. |
54 | */ |
55 | |
56 | class PxTolerancesScale |
57 | { |
58 | public: |
59 | |
60 | /** brief |
61 | The approximate size of objects in the simulation. |
62 | |
63 | For simulating roughly human-sized in metric units, 1 is a good choice. |
64 | If simulation is done in centimetres, use 100 instead. This is used to |
65 | estimate certain length-related tolerances. |
66 | */ |
67 | PxReal length; |
68 | |
69 | /** brief |
70 | The typical magnitude of velocities of objects in simulation. This is used to estimate |
71 | whether a contact should be treated as bouncing or resting based on its impact velocity, |
72 | and a kinetic energy threshold below which the simulation may put objects to sleep. |
73 | |
74 | For normal physical environments, a good choice is the approximate speed of an object falling |
75 | under gravity for one second. |
76 | */ |
77 | PxReal speed; |
78 | |
79 | /** |
80 | \brief constructor sets to default |
81 | */ |
82 | PX_INLINE PxTolerancesScale(); |
83 | |
84 | /** |
85 | \brief Returns true if the descriptor is valid. |
86 | \return true if the current settings are valid (returns always true). |
87 | */ |
88 | PX_INLINE bool isValid() const; |
89 | |
90 | }; |
91 | |
92 | PX_INLINE PxTolerancesScale::PxTolerancesScale(): |
93 | length(1.0f), |
94 | speed(10.0f) |
95 | { |
96 | } |
97 | |
98 | PX_INLINE bool PxTolerancesScale::isValid() const |
99 | { |
100 | return length>0.0f; |
101 | } |
102 | |
103 | #if !PX_DOXYGEN |
104 | } // namespace physx |
105 | #endif |
106 | |
107 | /** @} */ |
108 | #endif |
109 | |