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_MOTOR_JOINT_H
22#define LOVE_PHYSICS_BOX2D_MOTOR_JOINT_H
23
24// Module
25#include "Joint.h"
26
27namespace love
28{
29namespace physics
30{
31namespace box2d
32{
33
34/**
35 * A motor joint is used to control the relative motion
36 * between two bodies. A typical usage is to control the movement
37 * of a dynamic body with respect to the ground.
38 */
39class MotorJoint : public Joint
40{
41public:
42
43 static love::Type type;
44
45 MotorJoint(Body *body1, Body* body2);
46 MotorJoint(Body *body1, Body* body2, float correctionFactor, bool collideConnected);
47 virtual ~MotorJoint();
48
49 /// Set/get the target linear offset, in frame A, in meters.
50 void setLinearOffset(float x, float y);
51 int getLinearOffset(lua_State *L) const;
52
53 /// Set/get the target angular offset, in radians.
54 void setAngularOffset(float angularOffset);
55 float getAngularOffset() const;
56
57 /// Set the maximum friction force.
58 void setMaxForce(float force);
59
60 /// Get the maximum friction force.
61 float getMaxForce() const;
62
63 /// Set the maximum friction torque.
64 void setMaxTorque(float torque);
65
66 /// Get the maximum friction torque.
67 float getMaxTorque() const;
68
69 /// Set the position correction factor in the range [0,1].
70 void setCorrectionFactor(float factor);
71
72 /// Get the position correction factor in the range [0,1].
73 float getCorrectionFactor() const;
74
75private:
76
77 // The Box2D MotorJoint object.
78 b2MotorJoint *joint;
79
80}; // MotorJoint
81
82
83} // box2d
84} // physics
85} // love
86
87#endif // LOVE_PHYSICS_BOX2D_MOTOR_JOINT_H
88