mouse_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 MouseJointDescription_Impl;
45 
47 class CL_API_PHYSICS MouseJointDescription
48 {
49 
52 public:
55 
60 
61  virtual ~MouseJointDescription();
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 
81 
83  MouseJointDescription &operator =(const MouseJointDescription &copy);
84 
89  void set_bodies(const Body &bodyA, const Body &bodyB);
90 
94  void set_body_a(const Body &body);
95 
99  void set_body_b(const Body &body);
100 
102  void set_target(const Vec2f &target);
103 
105  void set_max_force(const float value);
106 
108  void set_damping_ratio(const float damping);
109 
111  void set_frequency(const float frequency);
112 
116 protected:
117 
118  std::shared_ptr<MouseJointDescription_Impl> impl;
119 
121 
122  friend class MouseJoint;
123 
124 };
125 
126 }
127 
128 /// \}
std::shared_ptr< MouseJointDescription_Impl > impl
Definition: mouse_joint_description.h:118
MouseJointDescription class.
Definition: mouse_joint_description.h:47
bool is_null() const
Returns true if this object is invalid.
Definition: mouse_joint_description.h:69
Top-level world class.
Definition: physics_world.h:52
Body class.
Definition: body.h:52
MouseJoint class.
Definition: mouse_joint.h:48