PhysicsEngine.hh
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2012-2016 Open Source Robotics Foundation
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  *
16 */
17 #ifndef _PHYSICSENGINE_HH_
18 #define _PHYSICSENGINE_HH_
19 
20 #include <boost/thread/recursive_mutex.hpp>
21 #include <string>
22 
24 #include "gazebo/msgs/msgs.hh"
25 
27 #include "gazebo/util/system.hh"
28 
29 namespace gazebo
30 {
31  namespace physics
32  {
33  class ContactManager;
34 
37 
40  class GZ_PHYSICS_VISIBLE PhysicsEngine
41  {
44  public: explicit PhysicsEngine(WorldPtr _world);
45 
47  public: virtual ~PhysicsEngine();
48 
51  public: virtual void Load(sdf::ElementPtr _sdf);
52 
54  public: virtual void Init() = 0;
55 
57  public: virtual void Fini();
58 
60  public: virtual void Reset() {}
61 
63  public: virtual void InitForThread() = 0;
64 
66  public: virtual void UpdateCollision() = 0;
67 
70  public: virtual std::string GetType() const = 0;
71 
74  public: virtual void SetSeed(uint32_t _seed) = 0;
75 
78  public: double GetUpdatePeriod();
79 
82  public: double GetTargetRealTimeFactor() const;
83 
86  public: double GetRealTimeUpdateRate() const;
87 
90  public: double GetMaxStepSize() const;
91 
94  public: void SetTargetRealTimeFactor(double _factor);
95 
98  public: void SetRealTimeUpdateRate(double _rate);
99 
102  public: void SetMaxStepSize(double _stepSize);
103 
105  public: virtual void UpdatePhysics() {}
106 
109  public: virtual ModelPtr CreateModel(BasePtr _base);
110 
113  public: virtual LinkPtr CreateLink(ModelPtr _parent) = 0;
114 
118  public: virtual CollisionPtr CreateCollision(
119  const std::string &_shapeType, LinkPtr _link) = 0;
120 
124  public: CollisionPtr CreateCollision(const std::string &_shapeType,
125  const std::string &_linkName);
126 
130  public: virtual ShapePtr CreateShape(const std::string &_shapeType,
131  CollisionPtr _collision) = 0;
132 
136  public: virtual JointPtr CreateJoint(const std::string &_type,
137  ModelPtr _parent = ModelPtr()) = 0;
138 
141  public: virtual math::Vector3 GetGravity() const;
142 
145  public: virtual void SetGravity(
146  const gazebo::math::Vector3 &_gravity) = 0;
147 
150  public: virtual ignition::math::Vector3d MagneticField() const;
151 
156  public: virtual void SetAutoDisableFlag(bool _autoDisable);
157 
162  public: virtual void SetMaxContacts(unsigned int _maxContacts);
163 
168  public: virtual bool GetAutoDisableFlag() {return 0;}
169 
201  public: virtual bool SetParam(const std::string &_key,
202  const boost::any &_value);
203 
208  public: virtual boost::any GetParam(const std::string &_key) const;
209 
215  public: virtual bool GetParam(const std::string &_key,
216  boost::any &_value) const;
217 
219  public: virtual void DebugPrint() const = 0;
220 
223  public: ContactManager *GetContactManager() const;
224 
227  public: boost::recursive_mutex *GetPhysicsUpdateMutex() const
228  {return this->physicsUpdateMutex;}
229 
232  public: sdf::ElementPtr GetSDF() const;
233 
236  protected: virtual void OnRequest(ConstRequestPtr &_msg);
237 
240  protected: virtual void OnPhysicsMsg(ConstPhysicsPtr &_msg);
241 
243  protected: WorldPtr world;
244 
246  protected: sdf::ElementPtr sdf;
247 
250 
253 
256 
259 
261  protected: boost::recursive_mutex *physicsUpdateMutex;
262 
266 
268  protected: double realTimeUpdateRate;
269 
271  protected: double targetRealTimeFactor;
272 
274  protected: double maxStepSize;
275  };
277  }
278 }
279 #endif
boost::shared_ptr< Link > LinkPtr
Definition: PhysicsTypes.hh:100
sdf::ElementPtr sdf
Our SDF values.
Definition: PhysicsEngine.hh:246
boost::shared_ptr< World > WorldPtr
Definition: PhysicsTypes.hh:84
Forward declarations for the common classes.
Definition: Animation.hh:33
The Vector3 class represents the generic vector containing 3 elements.
Definition: Vector3.hh:39
ContactManager * contactManager
Class that handles all contacts generated by the physics engine.
Definition: PhysicsEngine.hh:265
Base class for a physics engine.
Definition: PhysicsEngine.hh:40
Forward declarations for transport.
boost::shared_ptr< Publisher > PublisherPtr
Definition: TransportTypes.hh:49
boost::shared_ptr< Subscriber > SubscriberPtr
Definition: TransportTypes.hh:53
boost::shared_ptr< Joint > JointPtr
Definition: PhysicsTypes.hh:108
transport::SubscriberPtr physicsSub
Subscribe to the physics topic.
Definition: PhysicsEngine.hh:255
virtual bool GetAutoDisableFlag()
: Remove this function, and replace it with a more generic property map
Definition: PhysicsEngine.hh:168
boost::shared_ptr< Node > NodePtr
Definition: TransportTypes.hh:57
transport::SubscriberPtr requestSub
Subscribe to the request topic.
Definition: PhysicsEngine.hh:258
default namespace for gazebo
virtual void Reset()
Rest the physics engine.
Definition: PhysicsEngine.hh:60
double realTimeUpdateRate
Real time update rate.
Definition: PhysicsEngine.hh:268
WorldPtr world
Pointer to the world.
Definition: PhysicsEngine.hh:243
double targetRealTimeFactor
Target real time factor.
Definition: PhysicsEngine.hh:271
virtual void UpdatePhysics()
Update the physics engine.
Definition: PhysicsEngine.hh:105
transport::PublisherPtr responsePub
Response publisher.
Definition: PhysicsEngine.hh:252
boost::shared_ptr< Shape > ShapePtr
Definition: PhysicsTypes.hh:132
boost::recursive_mutex * GetPhysicsUpdateMutex() const
returns a pointer to the PhysicsEngine::physicsUpdateMutex.
Definition: PhysicsEngine.hh:227
boost::shared_ptr< Model > ModelPtr
Definition: PhysicsTypes.hh:88
GAZEBO_VISIBLE void Init(google::protobuf::Message &_message, const std::string &_id="")
Initialize a message.
boost::recursive_mutex * physicsUpdateMutex
Mutex to protect the update cycle.
Definition: PhysicsEngine.hh:261
double maxStepSize
Real time update rate.
Definition: PhysicsEngine.hh:274
transport::NodePtr node
Node for communication.
Definition: PhysicsEngine.hh:249
Aggregates all the contact information generated by the collision detection engine.
Definition: ContactManager.hh:65
boost::shared_ptr< Collision > CollisionPtr
Definition: PhysicsTypes.hh:104
boost::shared_ptr< Base > BasePtr
Definition: PhysicsTypes.hh:72