CameraSensor.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2017 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 IGNITION_SENSORS_CAMERASENSOR_HH_
#define IGNITION_SENSORS_CAMERASENSOR_HH_

#include <cstdint>
#include <memory>
#include <string>

#include <sdf/sdf.hh>

#include <ignition/common/SuppressWarning.hh>

#ifdef _WIN32
#pragma warning(push)
#pragma warning(disable: 4005)
#pragma warning(disable: 4251)
#endif
#include <ignition/msgs.hh>
#ifdef _WIN32
#pragma warning(pop)
#endif

// TODO(louise) Remove these pragmas once ign-rendering is disabling the
// warnings
#ifdef _WIN32
#pragma warning(push)
#pragma warning(disable: 4251)
#endif
#include <ignition/rendering/Camera.hh>
#ifdef _WIN32
#pragma warning(pop)
#endif

#include "ignition/sensors/camera/Export.hh"
#include "ignition/sensors/config.hh"
#include "ignition/sensors/Export.hh"
#include "ignition/sensors/RenderingSensor.hh"

namespace ignition
{
  namespace sensors
  {
    // Inline bracket to help doxygen filtering.
    inline namespace IGNITION_SENSORS_VERSION_NAMESPACE {
    //
    class CameraSensorPrivate;

    class IGNITION_SENSORS_CAMERA_VISIBLE CameraSensor : public RenderingSensor
    {
      public: CameraSensor();

      public: virtual ~CameraSensor();

      public: virtual bool Load(const sdf::Sensor &_sdf) override;

      public: virtual bool Load(sdf::ElementPtr _sdf) override;

      public: virtual bool Init() override;

      public: virtual bool Update(
        const std::chrono::steady_clock::duration &_now) override;

      public: ignition::common::ConnectionPtr ConnectImageCallback(
                  std::function<
                  void(const ignition::msgs::Image &)> _callback);

      public: virtual void SetScene(
                  ignition::rendering::ScenePtr _scene) override;

      public: virtual unsigned int ImageWidth() const;

      public: virtual unsigned int ImageHeight() const;

      public: rendering::CameraPtr RenderingCamera() const;

      public: std::string InfoTopic() const;

      public: void SetBaseline(double _baseline);

      public: double Baseline() const;

      protected: bool AdvertiseInfo();

      protected: bool AdvertiseInfo(const std::string &_topic);

      protected: void PopulateInfo(const sdf::Camera *_cameraSdf);

      protected: void PublishInfo(
        const std::chrono::steady_clock::duration &_now);

      private: bool CreateCamera();

      private: void OnSceneChange(ignition::rendering::ScenePtr /*_scene*/);

      IGN_COMMON_WARN_IGNORE__DLL_INTERFACE_MISSING
      private: std::unique_ptr<CameraSensorPrivate> dataPtr;
      IGN_COMMON_WARN_RESUME__DLL_INTERFACE_MISSING
    };
    }
  }
}

#endif