Ignition Gazebo

API Reference

3.5.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>
25 
26 // Features need to be defined ahead of entityCast
36 #include <ignition/physics/Link.hh>
47 
48 #include <ignition/gazebo/config.hh>
49 #include <ignition/gazebo/Export.hh>
51 
52 namespace ignition
53 {
54 namespace gazebo
55 {
56 // Inline bracket to help doxygen filtering.
57 inline namespace IGNITION_GAZEBO_VERSION_NAMESPACE {
58 namespace systems
59 {
60  // Forward declarations.
61  class PhysicsPrivate;
62 
65  class IGNITION_GAZEBO_VISIBLE Physics:
66  public System,
67  public ISystemConfigure,
68  public ISystemUpdate
69  {
71  public: explicit Physics();
72 
74  public: ~Physics() override;
75 
76  // Documentation inherited
77  public: void Configure(const Entity &_entity,
80  EventManager &_eventMgr) final;
81 
83  public: void Update(const UpdateInfo &_info,
84  EntityComponentManager &_ecm) final;
85 
87  private: std::unique_ptr<PhysicsPrivate> dataPtr;
88  };
89 
103  template <
104  typename PolicyT,
105  typename ToFeatureList,
106  typename MinimumFeatureList,
107  template <typename, typename> class ToEntity,
108  template <typename, typename> class MinimumEntity>
110  Entity _entity,
111  const physics::EntityPtr<MinimumEntity<PolicyT, MinimumFeatureList>>
112  &_minimumEntity,
114  ToEntity<PolicyT, ToFeatureList>>> &_castMap)
115  {
116  // Has already been cast
117  auto castIt = _castMap.find(_entity);
118  if (castIt != _castMap.end())
119  {
120  return castIt->second;
121  }
122 
124 
125  // Cast
126  castEntity =
128 
129  if (castEntity)
130  {
131  _castMap.insert(std::make_pair(_entity, castEntity));
132  }
133 
134  return castEntity;
135  }
136 }
137 }
138 }
139 }
140 #endif
Interface for a system that uses the Update phase.
Definition: System.hh:112
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:109
T make_pair(T... args)
Interface for a system that implements optional configuration.
Definition: System.hh:88
Base class for a System.
Definition: Physics.hh:65
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:73