DistanceJointConf.hpp
Go to the documentation of this file.
1 /*
2  * Original work Copyright (c) 2006-2007 Erin Catto http://www.box2d.org
3  * Modified work Copyright (c) 2017 Louis Langholtz https://github.com/louis-langholtz/PlayRho
4  *
5  * This software is provided 'as-is', without any express or implied
6  * warranty. In no event will the authors be held liable for any damages
7  * arising from the use of this software.
8  *
9  * Permission is granted to anyone to use this software for any purpose,
10  * including commercial applications, and to alter it and redistribute it
11  * freely, subject to the following restrictions:
12  *
13  * 1. The origin of this software must not be misrepresented; you must not
14  * claim that you wrote the original software. If you use this software
15  * in a product, an acknowledgment in the product documentation would be
16  * appreciated but is not required.
17  * 2. Altered source versions must be plainly marked as such, and must not be
18  * misrepresented as being the original software.
19  * 3. This notice may not be removed or altered from any source distribution.
20  */
21 
22 #ifndef PLAYRHO_DYNAMICS_JOINTS_DISTANCEJOINTCONF_HPP
23 #define PLAYRHO_DYNAMICS_JOINTS_DISTANCEJOINTCONF_HPP
24 
25 #include <PlayRho/Dynamics/Joints/JointConf.hpp>
26 #include <PlayRho/Common/BoundedValue.hpp>
27 #include <PlayRho/Common/Math.hpp>
28 
29 namespace playrho {
30 namespace d2 {
31 
32 class Body;
33 class DistanceJoint;
34 
39 // saving and loading a game.
41 struct DistanceJointConf : public JointBuilder<DistanceJointConf>
42 {
43 
45  using super = JointBuilder<DistanceJointConf>;
46 
47  PLAYRHO_CONSTEXPR inline DistanceJointConf() noexcept: super{JointType::Distance} {}
48 
50  DistanceJointConf(const DistanceJointConf& copy) = default;
51 
54  DistanceJointConf(NonNull<Body*> bodyA, NonNull<Body*> bodyB,
55  Length2 anchorA = Length2{},
56  Length2 anchorB = Length2{}) noexcept;
57 
59  PLAYRHO_CONSTEXPR inline DistanceJointConf& UseLength(Length v) noexcept;
60 
62  PLAYRHO_CONSTEXPR inline DistanceJointConf& UseFrequency(NonNegative<Frequency> v) noexcept;
63 
65  PLAYRHO_CONSTEXPR inline DistanceJointConf& UseDampingRatio(Real v) noexcept;
66 
68  Length2 localAnchorA = Length2{};
69 
71  Length2 localAnchorB = Length2{};
72 
74  Length length = 1_m;
75 
78  NonNegative<Frequency> frequency = NonNegative<Frequency>{0_Hz};
79 
82  Real dampingRatio = 0;
83 };
84 
85 PLAYRHO_CONSTEXPR inline DistanceJointConf& DistanceJointConf::UseLength(Length v) noexcept
86 {
87  length = v;
88  return *this;
89 }
90 
91 PLAYRHO_CONSTEXPR inline DistanceJointConf& DistanceJointConf::UseFrequency(NonNegative<Frequency> v) noexcept
92 {
93  frequency = v;
94  return *this;
95 }
96 
97 PLAYRHO_CONSTEXPR inline DistanceJointConf& DistanceJointConf::UseDampingRatio(Real v) noexcept
98 {
99  dampingRatio = v;
100  return *this;
101 }
102 
105 DistanceJointConf GetDistanceJointConf(const DistanceJoint& joint) noexcept;
106 
107 } // namespace d2
108 } // namespace playrho
109 
110 #endif // PLAYRHO_DYNAMICS_JOINTS_DISTANCEJOINTCONF_HPP