WeldJointConf.hpp
Go to the documentation of this file.
1 /*
2  * Original work Copyright (c) 2006-2011 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_WELDJOINTCONF_HPP
23 #define PLAYRHO_DYNAMICS_JOINTS_WELDJOINTCONF_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 WeldJoint;
33 
41 struct WeldJointConf : public JointBuilder<WeldJointConf>
42 {
44  using super = JointBuilder<WeldJointConf>;
45 
46  PLAYRHO_CONSTEXPR inline WeldJointConf() noexcept: super{JointType::Weld} {}
47 
54  WeldJointConf(NonNull<Body*> bodyA, NonNull<Body*> bodyB, const Length2 anchor) noexcept;
55 
57  PLAYRHO_CONSTEXPR inline WeldJointConf& UseFrequency(Frequency v) noexcept;
58 
60  PLAYRHO_CONSTEXPR inline WeldJointConf& UseDampingRatio(Real v) noexcept;
61 
63  Length2 localAnchorA = Length2{};
64 
66  Length2 localAnchorB = Length2{};
67 
69  Angle referenceAngle = 0_deg;
70 
74  Frequency frequency = 0_Hz;
75 
78  Real dampingRatio = 0;
79 };
80 
81 PLAYRHO_CONSTEXPR inline WeldJointConf& WeldJointConf::UseFrequency(Frequency v) noexcept
82 {
83  frequency = v;
84  return *this;
85 }
86 
87 PLAYRHO_CONSTEXPR inline WeldJointConf& WeldJointConf::UseDampingRatio(Real v) noexcept
88 {
89  dampingRatio = v;
90  return *this;
91 }
92 
95 WeldJointConf GetWeldJointConf(const WeldJoint& joint) noexcept;
96 
97 } // namespace d2
98 } // namespace playrho
99 
100 #endif // PLAYRHO_DYNAMICS_JOINTS_WELDJOINTCONF_HPP