TargetJointConf.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_MOUSEJOINTCONF_HPP
23 #define PLAYRHO_DYNAMICS_JOINTS_MOUSEJOINTCONF_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 TargetJoint;
33 class Body;
34 
37 struct TargetJointConf : public JointBuilder<TargetJointConf>
38 {
40  using super = JointBuilder<TargetJointConf>;
41 
42  PLAYRHO_CONSTEXPR inline TargetJointConf() noexcept: super{JointType::Target} {}
43 
45  PLAYRHO_CONSTEXPR inline TargetJointConf(NonNull<Body*> b) noexcept: super{super{JointType::Target}.UseBodyB(b)}
46  {
47  // Intentionally empty.
48  }
49 
51  PLAYRHO_CONSTEXPR inline TargetJointConf& UseTarget(Length2 v) noexcept;
52 
54  PLAYRHO_CONSTEXPR inline TargetJointConf& UseMaxForce(NonNegative<Force> v) noexcept;
55 
57  PLAYRHO_CONSTEXPR inline TargetJointConf& UseFrequency(NonNegative<Frequency> v) noexcept;
58 
60  PLAYRHO_CONSTEXPR inline TargetJointConf& UseDampingRatio(NonNegative<Real> v) noexcept;
61 
64  Length2 target = Length2{};
65 
72  NonNegative<Force> maxForce = NonNegative<Force>{0_N};
73 
77  NonNegative<Frequency> frequency = NonNegative<Frequency>(5_Hz);
78 
80  NonNegative<Real> dampingRatio = NonNegative<Real>(0.7f);
81 };
82 
83 PLAYRHO_CONSTEXPR inline TargetJointConf& TargetJointConf::UseTarget(Length2 v) noexcept
84 {
85  target = v;
86  return *this;
87 }
88 
89 PLAYRHO_CONSTEXPR inline TargetJointConf& TargetJointConf::UseMaxForce(NonNegative<Force> v) noexcept
90 {
91  maxForce = v;
92  return *this;
93 }
94 
95 PLAYRHO_CONSTEXPR inline TargetJointConf& TargetJointConf::UseFrequency(NonNegative<Frequency> v) noexcept
96 {
97  frequency = v;
98  return *this;
99 }
100 
101 PLAYRHO_CONSTEXPR inline TargetJointConf& TargetJointConf::UseDampingRatio(NonNegative<Real> v) noexcept
102 {
103  dampingRatio = v;
104  return *this;
105 }
106 
109 TargetJointConf GetTargetJointConf(const TargetJoint& joint) noexcept;
110 
111 } // namespace d2
112 } // namespace playrho
113 
114 #endif // PLAYRHO_DYNAMICS_JOINTS_MOUSEJOINTCONF_HPP