render_target.h

Go to the documentation of this file.

/*
 * Copyright (c) 2010, Willow Garage, Inc.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the Willow Garage, Inc. nor the names of its
 *       contributors may be used to endorse or promote products derived from
 *       this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef RVE_RENDER_SERVER_RENDER_TARGET_H
#define RVE_RENDER_SERVER_RENDER_TARGET_H

#include <rve_common/uuid.h>

#include <OGRE/OgreTexture.h>
#include <OGRE/OgreMaterial.h>

#include <rve_msgs/RenderTargetFrameStats.h>

#include <boost/shared_array.hpp>
#include <boost/function.hpp>

namespace Ogre
{
class RenderTarget;
class RenderTexture;
class RenderTarget;
class MultiRenderTarget;
class Rectangle2D;
class SceneNode;
class PlaneBoundedVolumeListSceneQuery;
}

namespace rve_render_server
{

class Camera;
class Renderer;
class RenderTargetToROSImage;
class PickRenderValues;
typedef std::vector<PickRenderValues> V_PickRenderValues;
class ScreenRect;

class RenderTarget
{
public:
  enum Type
  {
    Texture,
    Window
  };

  RenderTarget(const rve_common::UUID& id, Renderer* rend, uint32_t width, uint32_t height);
  virtual ~RenderTarget();

   const rve_common::UUID& getID();
   void attachCamera(Camera* cam);
   Camera* getCamera() { return cam_; }

  Ogre::RenderTarget* getOgreRenderTarget() { return final_target_; }
  const rve_msgs::RenderTargetFrameStats& getLastFrameStats() { return stats_; }

  typedef boost::function<void(V_PickRenderValues&)> PickCallback;
  void pick(uint32_t x0, uint32_t y0, uint32_t x1, uint32_t y1, const PickCallback& cb);

  bool renderNeeded() { return render_needed_; }
  void requestRender();

  virtual void beginRender();
  virtual void finishRender();

  virtual void resize(uint32_t width, uint32_t height) = 0;
  virtual Type getTargetType() = 0;

  uint32_t getWidth() { return width_; }
  uint32_t getHeight() { return height_; }

  ScreenRect* createScreenRect(const rve_common::UUID& id, uint32_t zorder, float x0, float y0, float x1, float y1);
  ScreenRect* getScreenRect(const rve_common::UUID& id);
  void destroyScreenRect(const rve_common::UUID& id);

protected:
  void setTarget(Ogre::RenderTarget* target);

private:

  struct PickRequest
  {
    PickRequest()
    : x0(0)
    , y0(0)
    , x1(0)
    , y1(0)
    {}

    PickRequest(uint32_t x0, uint32_t y0, uint32_t x1, uint32_t y1, const PickCallback& cb)
    : x0(x0)
    , y0(y0)
    , x1(x1)
    , y1(y1)
    , cb(cb)
    {}

    uint32_t x0;
    uint32_t y0;
    uint32_t x1;
    uint32_t y1;
    PickCallback cb;
  };
  typedef std::vector<PickRequest> V_PickRequest;

  typedef std::vector<Ogre::RenderTexture*> V_OgreRenderTexture;
  typedef std::vector<Ogre::TexturePtr> V_OgreTexture;
  typedef boost::shared_ptr<RenderTargetToROSImage> RenderTargetToROSImagePtr;
  typedef std::vector<RenderTargetToROSImagePtr> V_RenderTargetToROSImage;
  struct MRT
  {
    MRT()
    : mrt(0)
    {}

    Ogre::MultiRenderTarget* mrt;
    V_OgreRenderTexture rtts;
    V_OgreTexture textures;
    V_RenderTargetToROSImage ros_output;
  };

  void destroyResources();
  void createResources();

  void createMRT(MRT& mrt, const std::string& name, const std::string& scheme, uint32_t format);
  void destroyMRT(MRT& mrt);

  void setupRT(Ogre::RenderTarget* rt);

  void pick(const PickRequest& pr);
  void updatePickBuffer();
  void processPickRequests();

  rve_common::UUID id_;
  Ogre::RenderTarget* final_target_;
  RenderTargetToROSImagePtr final_target_out_;
  Renderer* renderer_;
  Camera* cam_;
  uint32_t width_;
  uint32_t height_;
  bool recreate_resources_;
  Ogre::Rectangle2D* screen_rect_;
  Ogre::MaterialPtr rect_material_;

  MRT gbuffer_target_;
  MRT weighted_average_alpha_target_;

  bool picked_;
  MRT picking_target_;
  bool pick_target_updated_this_frame_;
  bool pick_buffer_valid_;
  boost::shared_array<uint32_t> pick_buffer_;
  V_PickRequest pick_requests_;
  V_PickRequest new_pick_requests_;
  Ogre::PlaneBoundedVolumeListSceneQuery* pick_scene_query_;

  rve_msgs::RenderTargetFrameStats stats_;

  typedef std::vector<ScreenRect*> V_ScreenRect;
  V_ScreenRect screen_rects_;

  bool render_needed_;
  bool render_in_progress_;
};

} // namespace rve_render_server

#endif // RVE_RENDER_SERVER_RENDER_TARGET_H