Ogre2RenderPass.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2019 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_OGRE2RENDERPASS_HH_
#define GZ_RENDERING_OGRE2_OGRE2RENDERPASS_HH_
 
#include <memory>
#include <string>
 
#include "gz/rendering/base/BaseRenderPass.hh"
#include "gz/rendering/ogre2/Export.hh"
#include "gz/rendering/ogre2/Ogre2Object.hh"
 
namespace Ogre
{
  class CompositorWorkspace;
}
 
namespace gz
{
  namespace rendering
  {
    inline namespace GZ_RENDERING_VERSION_NAMESPACE {
    //
    // forward declaration
    class Ogre2RenderPassPrivate;
 
    /* \class Ogre2RenderPass Ogre2RenderPass.hh \
     * gz/rendering/ogre2/Ogre2RenderPass.hh
     */
    class GZ_RENDERING_OGRE2_VISIBLE Ogre2RenderPass :
      public BaseRenderPass<Ogre2Object>
    {
      protected: Ogre2RenderPass();
 
      public: virtual ~Ogre2RenderPass();
 
      // Documentation inherited.
      public: void Destroy() override;
 
      public: std::string OgreCompositorNodeDefinitionName() const;
 
      public: virtual void WorkspaceAdded(
            Ogre::CompositorWorkspace *_workspace);
 
      public: virtual void WorkspaceRemoved(
            Ogre::CompositorWorkspace *_workspace);
 
      public: virtual void CreateRenderPass();
 
      protected: std::string ogreCompositorNodeDefName;
 
      private: std::unique_ptr<Ogre2RenderPassPrivate> dataPtr;
    };
    }
  }
}
#endif