gz/sim/World.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2020 Open Source Robotics Foundation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
*/
#ifndef GZ_SIM_WORLD_HH_
#define GZ_SIM_WORLD_HH_
 
#include <memory>
#include <optional>
#include <string>
#include <vector>
 
#include <sdf/Atmosphere.hh>
#include <gz/math/Vector3.hh>
#include <gz/math/SphericalCoordinates.hh>
 
#include "gz/sim/config.hh"
#include "gz/sim/EntityComponentManager.hh"
#include "gz/sim/Export.hh"
#include "gz/sim/Types.hh"
 
namespace gz
{
  namespace sim
  {
    // Inline bracket to help doxygen filtering.
    inline namespace GZ_SIM_VERSION_NAMESPACE {
    // Forward declarations.
    class GZ_SIM_HIDDEN WorldPrivate;
    //
    class GZ_SIM_VISIBLE World {
      public: explicit World(sim::Entity _entity = kNullEntity);
 
      public: World(const World &_world);
 
      public: World(World &&_world) noexcept;
 
      public: World &operator=(World &&_world) noexcept;
 
      public: World &operator=(const World &_world);
 
      public: virtual ~World();
 
      public: sim::Entity Entity() const;
 
      public: bool Valid(const EntityComponentManager &_ecm) const;
 
      public: std::optional<std::string> Name(
          const EntityComponentManager &_ecm) const;
 
      public: std::optional<math::Vector3d> Gravity(
          const EntityComponentManager &_ecm) const;
 
      public: std::optional<math::Vector3d> MagneticField(
          const EntityComponentManager &_ecm) const;
 
      public: std::optional<sdf::Atmosphere> Atmosphere(
          const EntityComponentManager &_ecm) const;
 
      public: std::optional<math::SphericalCoordinates> SphericalCoordinates(
          const EntityComponentManager &_ecm) const;
 
      public: void SetSphericalCoordinates(EntityComponentManager &_ecm,
          const math::SphericalCoordinates &_sphericalCoordinates);
 
      public: sim::Entity LightByName(const EntityComponentManager &_ecm,
          const std::string &_name) const;
 
      public: sim::Entity ActorByName(const EntityComponentManager &_ecm,
          const std::string &_name) const;
 
      public: sim::Entity ModelByName(const EntityComponentManager &_ecm,
          const std::string &_name) const;
 
      public: std::vector<sim::Entity> Lights(
          const EntityComponentManager &_ecm) const;
 
      public: std::vector<sim::Entity> Actors(
          const EntityComponentManager &_ecm) const;
 
      public: std::vector<sim::Entity> Models(
          const EntityComponentManager &_ecm) const;
 
      public: uint64_t LightCount(const EntityComponentManager &_ecm) const;
 
      public: uint64_t ActorCount(const EntityComponentManager &_ecm) const;
 
      public: uint64_t ModelCount(const EntityComponentManager &_ecm) const;
 
      private: std::unique_ptr<WorldPrivate> dataPtr;
    };
    }
  }
}
#endif