Ogre2Camera.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2018 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_RENDERING_OGRE2_OGRE2CAMERA_HH_
#define IGNITION_RENDERING_OGRE2_OGRE2CAMERA_HH_

#include <memory>

#include "ignition/rendering/base/BaseCamera.hh"
#include "ignition/rendering/ogre2/Ogre2RenderTypes.hh"
#include "ignition/rendering/ogre2/Ogre2Sensor.hh"

namespace Ogre
{
  class Camera;
}

namespace ignition
{
  namespace rendering
  {
    inline namespace IGNITION_RENDERING_VERSION_NAMESPACE {
    //
    // forward declaration
    class Ogre2CameraPrivate;
    class Ogre2SelectionBuffer;

    class IGNITION_RENDERING_OGRE2_VISIBLE Ogre2Camera :
      public BaseCamera<Ogre2Sensor>
    {
      protected: Ogre2Camera();

      public: virtual ~Ogre2Camera();

      // Documentation inherited.
      public: virtual void SetHFOV(const math::Angle &_angle) override;

      // Documentation inherited.
      public: virtual double AspectRatio() const override;

      // Documentation inherited.
      public: virtual void SetAspectRatio(const double _ratio) override;

      // Documentation inherited.
      public: virtual unsigned int AntiAliasing() const override;

      // Documentation inherited.
      public: virtual void SetAntiAliasing(const unsigned int _aa) override;

      // Documentation inherited.
      public: virtual void SetFarClipPlane(const double _far) override;

      // Documentation inherited.
      public: virtual void SetNearClipPlane(const double _near) override;

      public: virtual math::Color BackgroundColor() const;

      public: virtual void SetBackgroundColor(const math::Color &_color);

      public: virtual MaterialPtr BackgroundMaterial() const;

      public: virtual void SetBackgroundMaterial(MaterialPtr _material);

      // Documentation inherited.
      public: virtual void Render() override;

      // Documentation inherited.
      public: virtual RenderWindowPtr CreateRenderWindow() override;

      // Documentation inherited.
      public: virtual math::Matrix4d ProjectionMatrix() const override;

      // Documentation inherited.
      public: virtual math::Matrix4d ViewMatrix() const override;

      // Documentation inherited
      public: virtual VisualPtr VisualAt(const ignition::math::Vector2i
                  &_mousePos) override;

      // Documentation Inherited.
      // \sa Camera::SetMaterial(const MaterialPtr &)
      public: virtual void SetMaterial(
                  const MaterialPtr &_material) override;

      // Documentation inherited.
      public: virtual unsigned int RenderTextureGLId() const override;

      // Documentation inherited.
      // TODO(anyone): this function should be virtual, declared in 'Camera'
      // and 'BaseCamera'. We didn't do it to preserve ABI.
      // Looks in commit history for '#SetShadowsNodeDefDirtyABI' to
      // see changes made and revert
      public: void SetShadowsNodeDefDirty();

      // Documentation inherited.
      public: virtual void Destroy() override;

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

      // Documentation inherited.
      public: virtual void SetVisibilityMask(uint32_t _mask) override;

      // Documentation inherited.
      protected: virtual RenderTargetPtr RenderTarget() const override;

      // Documentation inherited.
      protected: virtual void Init() override;

      protected: virtual void CreateRenderTexture();

      protected: virtual void SetSelectionBuffer();

      private: void CreateCamera();

      protected: Ogre::Camera *ogreCamera = nullptr;

      protected: Ogre2SelectionBuffer *selectionBuffer = nullptr;

      protected: Ogre2RenderTargetPtr renderTexture;

      protected: math::Color backgroundColor;

      private: std::unique_ptr<Ogre2CameraPrivate> dataPtr;

      private: friend class Ogre2Scene;

      private: friend class Ogre2RayQuery;
    };
    }
  }
}
#endif