prismatic_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 PrismaticJointDescription_Impl;
45 
47 class CL_API_PHYSICS PrismaticJointDescription
48 {
49 
52 public:
55 
60 
61  virtual ~PrismaticJointDescription();
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  //Body get_body_a();
78 
79  //Body get_body_b();
80 
81  //Vec2f get_anchor_a();
82 
83  //Vec2f get_anchor_b();
84 
88 
91 
98  void set_bodies(const Body &bodyA, const Body &bodyB, const Vec2f &anchorA, const Vec2f &anchorB);
99 
104  void set_body_a(const Body &body,const Vec2f &anchor);
105 
110  void set_body_b(const Body &body,const Vec2f &anchor);
111 
115  void set_axis_a(const Vec2f &axis);
116 
120  void set_reference_angle(const Angle &angle);
121 
123  void enable_limit(const bool value = true);
124 
126  void set_translation_limits(const float min, const float max);
127 
129  void set_translation_min(const float value);
130 
132  void set_translation_max(const float value);
133 
135  void set_as_motor(const bool value = true);
136 
138  void set_max_motor_force(const float value);
139 
141  void set_motor_speed(const Angle &angle);
142 
146 protected:
147 
148  std::shared_ptr<PrismaticJointDescription_Impl> impl;
149 
151 
152  friend class PrismaticJoint;
153 
154 };
155 
156 }
157 
158 /// \}
Angle class.
Definition: angle.h:63
A min(A a, B b)
Definition: cl_math.h:51
std::shared_ptr< PrismaticJointDescription_Impl > impl
Definition: prismatic_joint_description.h:148
Top-level world class.
Definition: physics_world.h:52
A max(A a, B b)
Definition: cl_math.h:52
PrismaticJointDescription class.
Definition: prismatic_joint_description.h:47
Body class.
Definition: body.h:52
bool is_null() const
Returns true if this object is invalid.
Definition: prismatic_joint_description.h:69
PrismaticJoint class.
Definition: prismatic_joint.h:47