Camera.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2012-2016 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 _GAZEBO_RENDERING_CAMERA_HH_
#define _GAZEBO_RENDERING_CAMERA_HH_

#include <memory>
#include <functional>

#include <boost/enable_shared_from_this.hpp>
#include <string>
#include <utility>
#include <list>
#include <vector>
#include <deque>
#include <sdf/sdf.hh>
#include <ignition/math/Angle.hh>
#include <ignition/math/Vector3.hh>
#include <ignition/math/Quaternion.hh>
#include <ignition/math/Pose3.hh>

#include "gazebo/msgs/msgs.hh"

#include "gazebo/transport/Node.hh"
#include "gazebo/transport/Subscriber.hh"

#include "gazebo/common/Event.hh"
#include "gazebo/common/PID.hh"
#include "gazebo/common/Time.hh"

#include "gazebo/math/Angle.hh"
#include "gazebo/math/Pose.hh"
#include "gazebo/math/Plane.hh"
#include "gazebo/math/Vector2i.hh"

#include "gazebo/rendering/ogre_gazebo.h"
#include "gazebo/msgs/MessageTypes.hh"
#include "gazebo/rendering/RenderTypes.hh"
#include "gazebo/util/system.hh"

// Forward Declarations
namespace Ogre
{
  class Texture;
  class RenderTarget;
  class Camera;
  class Viewport;
  class SceneNode;
  class AnimationState;
}

namespace gazebo
{
  namespace rendering
  {
    class MouseEvent;
    class ViewController;
    class Scene;
    class CameraPrivate;


    class GZ_RENDERING_VISIBLE Camera :
      public boost::enable_shared_from_this<Camera>
    {
      public: Camera(const std::string &_namePrefix, ScenePtr _scene,
                     bool _autoRender = true);

      public: virtual ~Camera();

      public: virtual void Load(sdf::ElementPtr _sdf);

      public: virtual void Load();

      public: virtual void Init();

      public: void SetRenderRate(const double _hz);

      public: double GetRenderRate() const GAZEBO_DEPRECATED(7.0);

      public: double RenderRate() const;

      public: void Render(const bool _force = false);

      public: virtual void PostRender();

      public: virtual void Update();

      public: virtual void Fini();

      public: bool GetInitialized() const GAZEBO_DEPRECATED(7.0);

      public: bool Initialized() const;

      public: void SetWindowId(unsigned int _windowId);

      public: unsigned int GetWindowId() const GAZEBO_DEPRECATED(7.0);

      public: unsigned int WindowId() const;

      public: void SetScene(ScenePtr _scene);

      public: math::Vector3 GetWorldPosition() const GAZEBO_DEPRECATED(7.0);

      public: ignition::math::Vector3d WorldPosition() const;

      public: math::Quaternion GetWorldRotation() const GAZEBO_DEPRECATED(7.0);

      public: ignition::math::Quaterniond WorldRotation() const;

      public: virtual void SetWorldPose(const math::Pose &_pose)
              GAZEBO_DEPRECATED(7.0);

      public: virtual void SetWorldPose(const ignition::math::Pose3d &_pose);

      public: math::Pose GetWorldPose() const GAZEBO_DEPRECATED(7.0);

      public: ignition::math::Pose3d WorldPose() const;

      public: void SetWorldPosition(const math::Vector3 &_pos)
              GAZEBO_DEPRECATED(7.0);

      public: void SetWorldPosition(const ignition::math::Vector3d &_pos);

      public: void SetWorldRotation(const math::Quaternion &_quat)
              GAZEBO_DEPRECATED(7.0);

      public: void SetWorldRotation(const ignition::math::Quaterniond &_quat);

      public: void Translate(const math::Vector3 &_direction)
              GAZEBO_DEPRECATED(7.0);

      public: void Translate(const ignition::math::Vector3d &_direction);

      public: void Roll(const math::Angle &_angle,
                  Ogre::Node::TransformSpace _relativeTo =
                  Ogre::Node::TS_LOCAL) GAZEBO_DEPRECATED(7.0);

      public: void Roll(const ignition::math::Angle &_angle,
                  ReferenceFrame _relativeTo = RF_LOCAL);

      public: void Pitch(const math::Angle &_angle,
                  Ogre::Node::TransformSpace _relativeTo =
                  Ogre::Node::TS_LOCAL) GAZEBO_DEPRECATED(7.0);

      public: void Pitch(const ignition::math::Angle &_angle,
                  ReferenceFrame _relativeTo = RF_LOCAL);

      public: void Yaw(const math::Angle &_angle,
                  Ogre::Node::TransformSpace _relativeTo =
                  Ogre::Node::TS_WORLD) GAZEBO_DEPRECATED(7.0);

      public: void Yaw(const ignition::math::Angle &_angle,
                  ReferenceFrame _relativeTo = RF_WORLD);

      public: virtual void SetClipDist(const float _near, const float _far);

      public: void SetHFOV(math::Angle _angle) GAZEBO_DEPRECATED(7.0);

      public: void SetHFOV(const ignition::math::Angle &_angle);

      public: math::Angle GetHFOV() const GAZEBO_DEPRECATED(7.0);

      public: ignition::math::Angle HFOV() const;

      public: math::Angle GetVFOV() const GAZEBO_DEPRECATED(7.0);

      public: ignition::math::Angle VFOV() const;

      public: void SetImageSize(const unsigned int _w, const unsigned int _h);

      public: void SetImageWidth(const unsigned int _w);

      public: void SetImageHeight(const unsigned int _h);

      public: virtual unsigned int GetImageWidth() const GAZEBO_DEPRECATED(7.0);

      public: virtual unsigned int ImageWidth() const;

      public: unsigned int GetTextureWidth() const GAZEBO_DEPRECATED(7.0);

      public: unsigned int TextureWidth() const;

      public: virtual unsigned int GetImageHeight() const
          GAZEBO_DEPRECATED(7.0);

      public: virtual unsigned int ImageHeight() const;

      public: unsigned int GetImageDepth() const GAZEBO_DEPRECATED(7.0);

      public: unsigned int ImageDepth() const;

      public: std::string GetImageFormat() const GAZEBO_DEPRECATED(7.0);

      public: std::string ImageFormat() const;

      public: unsigned int GetTextureHeight() const GAZEBO_DEPRECATED(7.0);

      public: unsigned int TextureHeight() const;

      public: size_t GetImageByteSize() const GAZEBO_DEPRECATED(7.0);

      public: size_t ImageByteSize() const;

      public: static size_t GetImageByteSize(unsigned int _width,
                                             unsigned int _height,
                                             const std::string &_format)
                                             GAZEBO_DEPRECATED(7.0);

      public: static size_t ImageByteSize(const unsigned int _width,
                                          const unsigned int _height,
                                          const std::string &_format);

      public: double GetZValue(int _x, int _y) GAZEBO_DEPRECATED(7.0);

      public: double ZValue(const int _x, const int _y);

      public: double GetNearClip() GAZEBO_DEPRECATED(7.0);

      public: double NearClip() const;

      public: double GetFarClip() GAZEBO_DEPRECATED(7.0);

      public: double FarClip() const;

      public: void EnableSaveFrame(const bool _enable);

      public: bool GetCaptureData() const GAZEBO_DEPRECATED(7.0);

      public: bool CaptureData() const;

      public: void SetSaveFramePathname(const std::string &_pathname);

      public: bool SaveFrame(const std::string &_filename);

      public: Ogre::Camera *GetOgreCamera() const GAZEBO_DEPRECATED(7.0);

      public: Ogre::Camera *OgreCamera() const;

      public: Ogre::Viewport *GetViewport() const GAZEBO_DEPRECATED(7.0);

      public: Ogre::Viewport *OgreViewport() const;

      public: unsigned int GetViewportWidth() const GAZEBO_DEPRECATED(7.0);

      public: unsigned int ViewportWidth() const;

      public: unsigned int GetViewportHeight() const GAZEBO_DEPRECATED(7.0);

      public: unsigned int ViewportHeight() const;

      public: math::Vector3 GetUp() GAZEBO_DEPRECATED(7.0);

      public: ignition::math::Vector3d Up() const;

      public: math::Vector3 GetRight() GAZEBO_DEPRECATED(7.0);

      public: ignition::math::Vector3d Right() const;

      public: virtual float GetAvgFPS() const GAZEBO_DEPRECATED(7.0);

      public: virtual float AvgFPS() const;

      public: virtual unsigned int GetTriangleCount() const
          GAZEBO_DEPRECATED(7.0);

      public: virtual unsigned int TriangleCount() const;

      public: void SetAspectRatio(float _ratio);

      public: float GetAspectRatio() const GAZEBO_DEPRECATED(7.0);

      public: float AspectRatio() const;

      public: void SetSceneNode(Ogre::SceneNode *_node);

      public: Ogre::SceneNode *GetSceneNode() const GAZEBO_DEPRECATED(7.0);

      public: Ogre::SceneNode *SceneNode() const;

      public: virtual const unsigned char *GetImageData(unsigned int i = 0)
          GAZEBO_DEPRECATED(7.0);

      public: virtual const unsigned char *ImageData(const unsigned int i = 0)
          const;

      public: std::string GetName() const GAZEBO_DEPRECATED(7.0);

      public: std::string Name() const;

      public: std::string GetScopedName() const GAZEBO_DEPRECATED(7.0);

      public: std::string ScopedName() const;

      public: void SetName(const std::string &_name);

      public: void ToggleShowWireframe();

      public: void ShowWireframe(const bool _s);

      public: void GetCameraToViewportRay(int _screenx, int _screeny,
                  math::Vector3 &_origin, math::Vector3 &_dir)
                  GAZEBO_DEPRECATED(7.0);

      public: void CameraToViewportRay(const int _screenx, const int _screeny,
                  ignition::math::Vector3d &_origin,
                  ignition::math::Vector3d &_dir) const;

      public: void SetCaptureData(const bool _value);

      public: void SetCaptureDataOnce();

      public: void CreateRenderTexture(const std::string &_textureName);

      public: ScenePtr GetScene() const;

      public: bool GetWorldPointOnPlane(int _x, int _y,
                  const math::Plane &_plane, math::Vector3 &_result)
                  GAZEBO_DEPRECATED(7.0);

      public: bool WorldPointOnPlane(const int _x, const int _y,
                  const ignition::math::Planed &_plane,
                  ignition::math::Vector3d &_result);

      public: virtual void SetRenderTarget(Ogre::RenderTarget *_target);

      public: void AttachToVisual(const std::string &_visualName,
                  const bool _inheritOrientation,
                  const double _minDist = 0.0, const double _maxDist = 0.0);

      public: void AttachToVisual(uint32_t _id,
                  const bool _inheritOrientation,
                  const double _minDist = 0.0, const double _maxDist = 0.0);

      public: void TrackVisual(const std::string &_visualName);

      public: Ogre::Texture *GetRenderTexture() const GAZEBO_DEPRECATED(7.0);

      public: Ogre::Texture *RenderTexture() const;

      public: math::Vector3 GetDirection() const GAZEBO_DEPRECATED(7.0);

      public: ignition::math::Vector3d Direction() const;

      public: event::ConnectionPtr ConnectNewImageFrame(
          std::function<void (const unsigned char *, unsigned int, unsigned int,
          unsigned int, const std::string &)> _subscriber);

      public: void DisconnectNewImageFrame(event::ConnectionPtr &_c);

      public: static bool SaveFrame(const unsigned char *_image,
                  const unsigned int _width, const unsigned int _height,
                  const int _depth, const std::string &_format,
                  const std::string &_filename);

      public: common::Time GetLastRenderWallTime() GAZEBO_DEPRECATED(7.0);

      public: common::Time LastRenderWallTime() const;

      public: bool IsVisible(VisualPtr _visual);

      public: bool IsVisible(const std::string &_visualName);

      public: bool IsAnimating() const;

      public: virtual bool MoveToPosition(const math::Pose &_pose,
                                          double _time) GAZEBO_DEPRECATED(7.0);

      public: virtual bool MoveToPosition(const ignition::math::Pose3d &_pose,
                                          const double _time);

      public: bool MoveToPositions(const std::vector<math::Pose> &_pts,
                                   double _time,
                                   std::function<void()> _onComplete = NULL)
                                   GAZEBO_DEPRECATED(7.0);

      public: bool MoveToPositions(
                  const std::vector<ignition::math::Pose3d> &_pts,
                  const double _time,
                  std::function<void()> _onComplete = NULL);

      public: std::string GetScreenshotPath() const GAZEBO_DEPRECATED(7.0);

      public: std::string ScreenshotPath() const;

      public: DistortionPtr GetDistortion() const GAZEBO_DEPRECATED(7.0);

      public: DistortionPtr LensDistortion() const;

      public: virtual bool SetProjectionType(const std::string &_type);

      public: std::string GetProjectionType() const GAZEBO_DEPRECATED(7.0);

      public: std::string ProjectionType() const;

      public: VisualPtr TrackedVisual() const;

      public: bool TrackIsStatic() const;

      public: void SetTrackIsStatic(const bool _isStatic);

      public: bool TrackUseModelFrame() const;

      public: void SetTrackUseModelFrame(const bool _useModelFrame);

      public: ignition::math::Vector3d TrackPosition() const;

      public: void SetTrackPosition(const ignition::math::Vector3d &_pos);

      public: double TrackMinDistance() const;

      public: double TrackMaxDistance() const;

      public: void SetTrackMinDistance(const double _dist);

      public: void SetTrackMaxDistance(const double _dist);

      public: bool TrackInheritYaw() const;

      public: void SetTrackInheritYaw(const bool _inheritYaw);

      protected: virtual void RenderImpl();

      protected: void ReadPixelBuffer();

      protected: bool TrackVisualImpl(const std::string &_visualName);

      protected: virtual bool TrackVisualImpl(VisualPtr _visual);

      protected: virtual bool AttachToVisualImpl(const std::string &_name,
                     const bool _inheritOrientation,
                     const double _minDist = 0, const double _maxDist = 0);

      protected: virtual bool AttachToVisualImpl(uint32_t _id,
                     const bool _inheritOrientation,
                     const double _minDist = 0, const double _maxDist = 0);

      protected: virtual bool AttachToVisualImpl(VisualPtr _visual,
                     const bool _inheritOrientation,
                     const double _minDist = 0, const double _maxDist = 0);

      protected: std::string GetFrameFilename() GAZEBO_DEPRECATED(7.0);

      protected: std::string FrameFilename();

      protected: virtual void AnimationComplete();

      protected: virtual void UpdateFOV();

      private: void ConvertRGBToBAYER(unsigned char *_dst,
          const unsigned char *_src, const std::string &_format,
          const int _width, const int _height);

      private: virtual void SetClipDist();

      private: static int OgrePixelFormat(const std::string &_format);

      private: void OnCmdMsg(ConstCameraCmdPtr &_msg);

      private: void CreateCamera();

      protected: std::string name;

      protected: std::string scopedName;

      protected: std::string scopedUniqueName;

      protected: sdf::ElementPtr sdf;

      protected: unsigned int windowId;

      protected: unsigned int textureWidth;

      protected: unsigned int textureHeight;

      protected: Ogre::Camera *camera;

      protected: Ogre::Viewport *viewport;

      protected: Ogre::SceneNode *sceneNode;

      protected: unsigned char *saveFrameBuffer;

      protected: unsigned char *bayerFrameBuffer;

      protected: unsigned int saveCount;

      protected: std::string screenshotPath;

      protected: int imageFormat;

      protected: int imageWidth;

      protected: int imageHeight;

      protected: Ogre::RenderTarget *renderTarget;

      protected: Ogre::Texture *renderTexture;

      protected: bool captureData;

      protected: bool captureDataOnce;

      protected: bool newData;

      protected: common::Time lastRenderWallTime;

      protected: ScenePtr scene;

      protected: event::EventT<void(const unsigned char *,
                     unsigned int, unsigned int, unsigned int,
                     const std::string &)> newImageFrame;

      protected: std::vector<event::ConnectionPtr> connections;

      protected: std::list<msgs::Request> requests;

      protected: bool initialized;

      protected: Ogre::AnimationState *animState;

      protected: common::Time prevAnimTime;

      protected: std::function<void()> onAnimationComplete;

      private: std::unique_ptr<CameraPrivate> dataPtr;
    };
  }
}
#endif