Gazebo Gazebo

API Reference

3.15.1
src/systems/physics/Physics.hh
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2018 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 GZ_GAZEBO_SYSTEMS_PHYSICS_HH_
18 #define GZ_GAZEBO_SYSTEMS_PHYSICS_HH_
19 
20 #include <memory>
21 #include <unordered_map>
22 #include <utility>
23 #include <gz/physics/FindFeatures.hh>
24 #include <gz/physics/RequestFeatures.hh>
25 
26 // Features need to be defined ahead of entityCast
27 #include <gz/physics/BoxShape.hh>
28 #include <gz/physics/CylinderShape.hh>
29 #include <gz/physics/ForwardStep.hh>
30 #include <gz/physics/FrameSemantics.hh>
31 #include <gz/physics/FreeGroup.hh>
32 #include <gz/physics/FixedJoint.hh>
33 #include <gz/physics/GetContacts.hh>
34 #include <gz/physics/GetBoundingBox.hh>
35 #include <gz/physics/Joint.hh>
36 #include <gz/physics/Link.hh>
37 #include <gz/physics/RemoveEntities.hh>
38 #include <gz/physics/Shape.hh>
39 #include <gz/physics/SphereShape.hh>
40 #include <gz/physics/mesh/MeshShape.hh>
41 #include <gz/physics/sdf/ConstructCollision.hh>
42 #include <gz/physics/sdf/ConstructJoint.hh>
43 #include <gz/physics/sdf/ConstructLink.hh>
44 #include <gz/physics/sdf/ConstructModel.hh>
45 #include <gz/physics/sdf/ConstructNestedModel.hh>
46 #include <gz/physics/sdf/ConstructWorld.hh>
47 
48 #include <gz/sim/config.hh>
49 #include <gz/sim/System.hh>
50 
51 namespace ignition
52 {
53 namespace gazebo
54 {
55 // Inline bracket to help doxygen filtering.
56 inline namespace IGNITION_GAZEBO_VERSION_NAMESPACE {
57 namespace systems
58 {
59  // Forward declarations.
60  class PhysicsPrivate;
61 
64  class Physics:
65  public System,
66  public ISystemConfigure,
67  public ISystemUpdate
68  {
70  public: explicit Physics();
71 
73  public: ~Physics() override;
74 
75  // Documentation inherited
76  public: void Configure(const Entity &_entity,
79  EventManager &_eventMgr) final;
80 
82  public: void Update(const UpdateInfo &_info,
83  EntityComponentManager &_ecm) final;
84 
86  private: std::unique_ptr<PhysicsPrivate> dataPtr;
87  };
88 }
89 }
90 }
91 }
92 #endif
uint64_t Entity
An Entity identifies a single object in simulation such as a model, link, or light....
Definition: gz/sim/Entity.hh:59
This library is part of the Ignition Robotics project.
The EntityComponentManager constructs, deletes, and returns components and entities....
Definition: gz/sim/EntityComponentManager.hh:65
STL class.
Base class for a System.
Definition: src/systems/physics/Physics.hh:64
void Update(const UpdateInfo &_info, EntityComponentManager &_ecm) final
Documentation inherited.
The EventManager is used to send/receive notifications of simulator events.
Definition: gz/sim/EventManager.hh:50
Information passed to systems on the update callback.
Definition: include/gz/sim/Types.hh:37
Interface for a system that implements optional configuration.
Definition: gz/sim/System.hh:88
Base class for a System.
Definition: gz/sim/System.hh:73
Interface for a system that uses the Update phase.
Definition: gz/sim/System.hh:112
Component< sdf::Physics, class PhysicsTag, serializers::PhysicsSerializer > Physics
A component type that contains the physics properties of the World entity.
Definition: include/gz/sim/components/Physics.hh:48
void Configure(const Entity &_entity, const std::shared_ptr< const sdf::Element > &_sdf, EntityComponentManager &_ecm, EventManager &_eventMgr) final
Configure the system.