revolute_joint_description.h
1 /*
2 ** ClanLib SDK
3 ** Copyright (c) 1997-2013 The ClanLib Team
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 ** Note: Some of the libraries ClanLib may link to may have additional
22 ** requirements or restrictions.
23 **
24 ** File Author(s):
25 **
26 ** Arkadiusz Kalinowski
27 */
28 
29 
30 
31 #pragma once
32 
33 #include "../../api_physics2d.h"
34 #include "../../../Core/Math/vec2.h"
35 #include <memory>
36 
37 namespace clan
38 {
41 
42  class PhysicsWorld;
43  class Body;
44  class RevoluteJointDescription_Impl;
45 
47 class CL_API_PHYSICS RevoluteJointDescription
48 {
49 
52 public:
55 
60 
61  virtual ~RevoluteJointDescription();
62 
66 public:
67 
69  bool is_null() const { return !impl; }
70 
72  void throw_if_null() const;
73 
75  bool is_active() const;
76 
77  bool is_motor() const;
78 
79  float get_motor_speed() const;
80 
81  Angle get_reference_angle() const;
82 
83  Angle get_lower_angle() const;
84 
85  Angle get_upper_angle() const;
86 
87  //Body get_body_a();
88 
89  //Body get_body_b();
90 
91  //Vec2f get_anchor_a();
92 
93  //Vec2f get_anchor_b();
94 
98 
100  RevoluteJointDescription &operator =(const RevoluteJointDescription &copy);
101 
107  void set_bodies(const Body &bodyA, const Body &bodyB, const Vec2f &anchor);
108 
113  void set_body_a(const Body &body,const Vec2f &anchor);
114 
119  void set_body_b(const Body &body,const Vec2f &anchor);
120 
122  void set_as_motor(const bool value = true);
123 
125  void set_motor_speed(const Angle speed);
126 
128  void set_reference_angle(const Angle angle);
129 
131  void set_max_motor_torque(const float value);
132 
134  void set_angle_limit(const Angle lower, const Angle upper);
135 
137  void set_lower_angle(const Angle angle);
138 
140  void set_upper_angle(const Angle angle);
141 
145 protected:
146 
147  std::shared_ptr<RevoluteJointDescription_Impl> impl;
148 
150 
151  friend class RevoluteJoint;
152 
153 };
154 
155 }
156 
157 /// \}
Angle class.
Definition: angle.h:63
std::shared_ptr< RevoluteJointDescription_Impl > impl
Definition: revolute_joint_description.h:147
Top-level world class.
Definition: physics_world.h:52
Body class.
Definition: body.h:52
RevoluteJointDescription class.
Definition: revolute_joint_description.h:47
bool is_null() const
Returns true if this object is invalid.
Definition: revolute_joint_description.h:69
RevoluteJoint class.
Definition: revolute_joint.h:47