Ogre2RenderTarget.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 GZ_RENDERING_OGRE2_OGRE2RENDERTARGET_HH_
#define GZ_RENDERING_OGRE2_OGRE2RENDERTARGET_HH_
 
#include <memory>
#include <string>
#include <vector>
#include <gz/math/Color.hh>
 
#include "gz/rendering/base/BaseRenderTypes.hh"
#include "gz/rendering/base/BaseRenderTarget.hh"
#include "gz/rendering/PixelBuffer.hh"
#include "gz/rendering/ogre2/Ogre2Object.hh"
#include "gz/rendering/ogre2/Ogre2RenderTargetMaterial.hh"
 
#ifdef _MSC_VER
  #pragma warning(push, 0)
#endif
#include <Compositor/OgreCompositorShadowNode.h>
#ifdef _MSC_VER
  #pragma warning(pop)
#endif
 
namespace Ogre
{
  class Camera;
  class RenderTarget;
  class Texture;
}
 
namespace gz
{
  namespace rendering
  {
    inline namespace GZ_RENDERING_VERSION_NAMESPACE {
    //
    // forward declaration
    class Ogre2RenderTargetPrivate;
 
    class GZ_RENDERING_OGRE2_VISIBLE Ogre2RenderTarget :
      public virtual BaseRenderTarget<Ogre2Object>
    {
      protected: Ogre2RenderTarget();
 
      public: virtual ~Ogre2RenderTarget();
 
      public: virtual unsigned int AntiAliasing() const;
 
      public: virtual void SetAntiAliasing(unsigned int _aa);
 
      public: virtual void Copy(Image &_image) const override;
 
      private: bool CopyToBuffer(const PixelBuffer &_dst) const;
 
      public: virtual Ogre::Camera *Camera() const;
 
      public: virtual void SetCamera(Ogre::Camera *_camera);
 
      // Documentation inherited
      public: virtual math::Color BackgroundColor() const override;
 
      public: virtual void SetBackgroundColor(math::Color _color);
 
      public: virtual void SetBackgroundMaterial(MaterialPtr _material);
 
      public: virtual MaterialPtr BackgroundMaterial() const;
 
      // Documentation inherited
      public: virtual void PreRender() override;
 
      // Documentation inherited
      public: virtual void PostRender() override;
 
      public: virtual void Render();
 
      public: virtual void Destroy() override = 0;
 
      public: void SetMaterial(MaterialPtr _material);
 
      public: void SetShadowsNodeDefDirty();
 
      protected: uint8_t TargetFSAA() const;
 
      public: static uint8_t TargetFSAA(uint8_t _fsaa);
 
      protected: Ogre::TextureGpu *RenderTargetImpl() const;
 
      public: virtual Ogre::TextureGpu *RenderTarget() const = 0;
 
      public: virtual bool IsRenderWindow() const;
 
      // Documentation inherited
      public: unsigned int GLIdImpl() const;
 
      // Documentation inherited
      public: void MetalIdImpl(void *_textureIdPtr) const;
 
      public: void PrepareForExternalSampling();
 
      protected: void DestroyTargetImpl();
 
      protected: void BuildTargetImpl();
 
      public: virtual uint32_t VisibilityMask() const;
 
      public: virtual void SetVisibilityMask(uint32_t _mask);
 
      public: static void UpdateRenderPassChain(
          Ogre::CompositorWorkspace *_workspace,
          const std::string &_workspaceDefName,
          const std::string &_baseNode, const std::string &_finalNode,
          const std::vector<RenderPassPtr> &_renderPasses,
          bool _recreateNodes,
          Ogre::TextureGpu *(*_ogreTextures)[2],
          bool _isRenderWindow);
 
      protected: virtual void UpdateBackgroundColor();
 
      protected: virtual void UpdateBackgroundMaterial();
 
      protected: virtual void UpdateRenderPassChain();
 
      protected: virtual void RebuildImpl() override;
 
      protected: virtual void RebuildTarget() = 0;
 
      protected: virtual void RebuildCompositor();
 
      protected: virtual void BuildCompositor();
 
      protected: virtual void DestroyCompositor();
 
      protected: void RebuildMaterial();
 
      protected: Ogre::Camera *ogreCamera = nullptr;
 
      protected: Ogre::CompositorWorkspace *ogreCompositorWorkspace = nullptr;
 
      protected: std::string ogreCompositorWorkspaceDefName;
 
      protected: Ogre::ColourValue ogreBackgroundColor;
 
      protected: MaterialPtr backgroundMaterial;
 
      protected: MaterialPtr material;
 
      protected: Ogre2RenderTargetMaterialPtr materialApplicator;
 
      protected: bool colorDirty = true;
 
      protected: bool backgroundMaterialDirty = false;
 
      protected: unsigned int antiAliasing = 4;
 
      protected: uint32_t visibilityMask = GZ_VISIBILITY_ALL;
 
      private: std::unique_ptr<Ogre2RenderTargetPrivate> dataPtr;
    };
 
    class GZ_RENDERING_OGRE2_VISIBLE Ogre2RenderTexture :
      public virtual BaseRenderTexture<Ogre2RenderTarget>
    {
      protected: Ogre2RenderTexture();
 
      public: virtual ~Ogre2RenderTexture();
 
      // Documentation inherited
      public: void AddRenderPass(const RenderPassPtr &_pass) override;
 
      // Documentation inherited
      public: void RemoveRenderPass(const RenderPassPtr &_pass) override;
 
      // Documentation inherited
      public: void RemoveAllRenderPasses() override;
 
      // Documentation inherited.
      public: virtual void Destroy() override;
 
      // Documentation inherited
      public: virtual void PreRender() override;
 
      // Documentation inherited
      public: virtual void PostRender() override;
 
      // Documentation inherited
      public: virtual unsigned int GLId() const override;
 
      // Documentation inherited
      public: virtual void MetalId(void *_textureIdPtr) const override;
 
      // Documentation inherited
      // TODO(anyone): this function should be removed.
      // We didn't do it to preserve ABI.
      public: virtual Ogre::TextureGpu *RenderTarget() const override;
 
      // Documentation inherited.
      protected: virtual void RebuildTarget() override;
 
      protected: virtual void DestroyTarget();
 
      protected: virtual void BuildTarget();
 
      private: friend class Ogre2Scene;
    };
 
    class GZ_RENDERING_OGRE2_VISIBLE Ogre2RenderWindow :
      public virtual BaseRenderWindow<Ogre2RenderTarget>
    {
      protected: Ogre2RenderWindow();
 
      public: virtual ~Ogre2RenderWindow();
 
      // Documentation inherited.
      public: virtual void Destroy() override;
 
      // Documentation inherited.
      public: virtual bool IsRenderWindow() const override;
 
      // Documentation inherited.
      public: virtual Ogre::TextureGpu *RenderTarget() const override;
 
      // Documentation inherited.
      protected: virtual void RebuildTarget() override;
 
      protected: virtual void BuildTarget();
 
      protected: Ogre::TextureGpu *ogreRenderWindow = nullptr;
 
      private: friend class Ogre2Scene;
    };
    }
  }
}
#endif