Ignition Gazebo

API Reference

3.3.0
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 IGNITION_GAZEBO_SYSTEMS_PHYSICS_HH_
18 #define IGNITION_GAZEBO_SYSTEMS_PHYSICS_HH_
19 
20 #include <memory>
21 #include <unordered_map>
22 #include <utility>
24 
25 #include <ignition/gazebo/config.hh>
26 #include <ignition/gazebo/Export.hh>
28 
29 namespace ignition
30 {
31 namespace gazebo
32 {
33 // Inline bracket to help doxygen filtering.
34 inline namespace IGNITION_GAZEBO_VERSION_NAMESPACE {
35 namespace systems
36 {
37  // Forward declarations.
38  class PhysicsPrivate;
39 
42  class IGNITION_GAZEBO_VISIBLE Physics:
43  public System,
44  public ISystemConfigure,
45  public ISystemUpdate
46  {
48  public: explicit Physics();
49 
51  public: ~Physics() override;
52 
53  // Documentation inherited
54  public: void Configure(const Entity &_entity,
57  EventManager &_eventMgr) final;
58 
60  public: void Update(const UpdateInfo &_info,
61  EntityComponentManager &_ecm) final;
62 
64  private: std::unique_ptr<PhysicsPrivate> dataPtr;
65  };
66 
80  template <
81  typename PolicyT,
82  typename ToFeatureList,
83  typename MinimumFeatureList,
84  template <typename, typename> class ToEntity,
85  template <typename, typename> class MinimumEntity>
87  Entity _entity,
88  const physics::EntityPtr<MinimumEntity<PolicyT, MinimumFeatureList>>
89  &_minimumEntity,
91  ToEntity<PolicyT, ToFeatureList>>> &_castMap)
92  {
93  // Has already been cast
94  auto castIt = _castMap.find(_entity);
95  if (castIt != _castMap.end())
96  {
97  return castIt->second;
98  }
99 
101 
102  // Cast
103  castEntity =
105 
106  if (castEntity)
107  {
108  _castMap.insert(std::make_pair(_entity, castEntity));
109  }
110 
111  return castEntity;
112  }
113 }
114 }
115 }
116 }
117 #endif
Interface for a system that uses the Update phase.
Definition: System.hh:101
Information passed to systems on the update callback.
Definition: Types.hh:37
The EntityComponentManager constructs, deletes, and returns components and entities. A component can be of any class which inherits from components::BaseComponent.
Definition: EntityComponentManager.hh:64
The EventManager is used to send/receive notifications of simulator events.
Definition: EventManager.hh:50
physics::EntityPtr< ToEntity< PolicyT, ToFeatureList > > entityCast(Entity _entity, const physics::EntityPtr< MinimumEntity< PolicyT, MinimumFeatureList >> &_minimumEntity, std::unordered_map< Entity, physics::EntityPtr< ToEntity< PolicyT, ToFeatureList >>> &_castMap)
Helper function to cast from an entity type with minimum features to an entity with a different set o...
Definition: Physics.hh:86
T make_pair(T... args)
Interface for a system that implements optional configuration.
Definition: System.hh:77
Base class for a System.
Definition: Physics.hh:42
static EntityPtr< EntityT< PolicyT, ToFeatureList > > From(const EntityPtr< EntityT< PolicyT, FromFeatureList >> &_from)
This library is part of the Ignition Robotics project.
uint64_t Entity
An Entity identifies a single object in simulation such as a model, link, or light. At its core, an Entity is just an identifier.
Definition: Entity.hh:59
Base class for a System.
Definition: System.hh:62