OcclusionCullRenderer.hpp

Go to the documentation of this file.

/**************************************************************************************/
/*                                                                                    */
/*  Visualization Library                                                             */
/*  http://visualizationlibrary.org                                                   */
/*                                                                                    */
/*  Copyright (c) 2005-2020, Michele Bosi                                             */
/*  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.                                   */
/*                                                                                    */
/*  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 HOLDER 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 OcclusionCullRenderer_INCLUDE_ONCE
#define OcclusionCullRenderer_INCLUDE_ONCE

#include <vlGraphics/Renderer.hpp>

namespace vl
{
  //------------------------------------------------------------------------------
  // OcclusionCullRenderer
  //------------------------------------------------------------------------------
  class VLGRAPHICS_EXPORT OcclusionCullRenderer: public Renderer
  {
    VL_INSTRUMENT_CLASS(vl::OcclusionCullRenderer, Renderer)

  public:
    OcclusionCullRenderer();

    virtual const RenderQueue* render(const RenderQueue* in_render_queue, Camera* camera, real frame_clock);

    void setWrappedRenderer(Renderer* renderer);

    const Renderer* wrappedRenderer() const { return mWrappedRenderer.get(); }

    Renderer* wrappedRenderer() { return mWrappedRenderer.get(); }

    void setOcclusionThreshold(int threshold) { mOcclusionThreshold = threshold; }

    int occlusionThreshold() const { return mOcclusionThreshold; }

    const Framebuffer* framebuffer() const;

    Framebuffer* framebuffer();

    int statsTotalObjects() const { return mStatsTotalObjects; }

    int statsOccludedObjects() const { return mStatsOccludedObjects; }

    Shader* occlusionShader() { return mOcclusionShader.get(); }

    const Shader* occlusionShader() const { return mOcclusionShader.get(); }

    void setOcclusionShader(Shader* occ_sh) { mOcclusionShader = occ_sh; }

  protected:
    void render_pass1(const RenderQueue* in_render_queue);

    void render_pass2(const RenderQueue* in_render_queue, Camera* camera);

  protected:
    vl::ref<Renderer> mWrappedRenderer;
    ref<Shader> mOcclusionShader;
    ref<RenderQueue> mCulledRenderQueue;
    int mOcclusionThreshold;
    Renderer* mPrevWrapRenderer;
    int mStatsTotalObjects;
    int mStatsOccludedObjects;
  };
  //------------------------------------------------------------------------------
}

#endif