1/**
2 * Copyright (c) 2006-2023 LOVE Development Team
3 *
4 * This software is provided 'as-is', without any express or implied
5 * warranty. In no event will the authors be held liable for any damages
6 * arising from the use of this software.
7 *
8 * Permission is granted to anyone to use this software for any purpose,
9 * including commercial applications, and to alter it and redistribute it
10 * freely, subject to the following restrictions:
11 *
12 * 1. The origin of this software must not be misrepresented; you must not
13 * claim that you wrote the original software. If you use this software
14 * in a product, an acknowledgment in the product documentation would be
15 * appreciated but is not required.
16 * 2. Altered source versions must be plainly marked as such, and must not be
17 * misrepresented as being the original software.
18 * 3. This notice may not be removed or altered from any source distribution.
19 **/
20
21#ifndef LOVE_PHYSICS_BOX2D_WELD_JOINT_H
22#define LOVE_PHYSICS_BOX2D_WELD_JOINT_H
23
24// Module
25#include "Joint.h"
26
27namespace love
28{
29namespace physics
30{
31namespace box2d
32{
33
34/**
35 * A WeldJoint essentially glues two bodies together.
36 **/
37class WeldJoint : public Joint
38{
39public:
40
41 static love::Type type;
42
43 /**
44 * Creates a new WeldJoint connecting body1 and body2.
45 **/
46 WeldJoint(Body *body1, Body *body2, float xA, float yA, float xB, float yB, bool collideConnected);
47
48 WeldJoint(Body *body1, Body *body2, float xA, float yA, float xB, float yB, bool collideConnected, float referenceAngle);
49
50 virtual ~WeldJoint();
51
52 /**
53 * Sets the response speed.
54 **/
55 void setFrequency(float hz);
56
57 /**
58 * Gets the response speed.
59 **/
60 float getFrequency() const;
61
62 /**
63 * Sets the damping ratio.
64 * 0 = no damping, 1 = critical damping.
65 **/
66 void setDampingRatio(float d);
67
68 /**
69 * Gets the damping ratio.
70 * 0 = no damping, 1 = critical damping.
71 **/
72 float getDampingRatio() const;
73
74 /**
75 * Gets the reference angle.
76 **/
77 float getReferenceAngle() const;
78
79private:
80
81 // The Box2D weld joint object.
82 b2WeldJoint *joint;
83
84 void init(b2WeldJointDef &def, Body *body1, Body *body2, float xA, float yA, float xB, float yB, bool collideConnected);
85};
86
87} // box2d
88} // physics
89} // love
90
91#endif // LOVE_PHYSICS_BOX2D_WELD_JOINT_H
92