Rendering.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 Rendering_INCLUDE_ONCE
#define Rendering_INCLUDE_ONCE

#include <vlGraphics/RenderingAbstract.hpp>
#include <vlGraphics/RenderQueueSorter.hpp>
#include <vlGraphics/Actor.hpp>
#include <vlGraphics/RenderQueue.hpp>
#include <vlGraphics/Renderer.hpp>
#include <vlGraphics/Camera.hpp>
#include <vlGraphics/SceneManager.hpp>
#include <vlCore/Transform.hpp>
#include <vlCore/Collection.hpp>

namespace vl
{
  class VLGRAPHICS_EXPORT Rendering: public RenderingAbstract
  {
    VL_INSTRUMENT_CLASS(vl::Rendering, RenderingAbstract)

  public:
    Rendering();

    Rendering(const Rendering& other): RenderingAbstract(other) { *this = other; }

    Rendering& operator=(const Rendering& other);

    virtual void render();

    void setRenderQueueSorter(RenderQueueSorter* render_queue_sorter) { mRenderQueueSorter = render_queue_sorter; }

    RenderQueueSorter* renderQueueSorter() { return mRenderQueueSorter.get(); }

    const Collection<Renderer>& renderers() const { return mRenderers; }

    Collection<Renderer>& renderers() { return mRenderers; }

    void setRenderer(Renderer* renderer)
    {
      renderers().clear();
      renderers().push_back(renderer);
    }

    const Renderer* renderer() const
    {
      if (renderers().empty())
        return NULL;
      else
        return renderers()[0].get();
    }

    Renderer* renderer()
    {
      if (renderers().empty())
        return NULL;
      else
        return renderers()[0].get();
    }

    void setCamera(Camera* camera) { mCamera = camera; }

    const Camera* camera() const { return mCamera.get(); }

    Camera* camera() { return mCamera.get(); }

    Collection<SceneManager>* sceneManagers() { return mSceneManagers.get(); }

    const Collection<SceneManager>* sceneManagers() const { return mSceneManagers.get(); }

    void setTransform(Transform* transform) { mTransform = transform; }

    const Transform* transform() const { return mTransform.get(); }

    Transform* transform() { return mTransform.get(); }

    void setEvaluateLOD(bool evaluate_lod) { mEvaluateLOD = evaluate_lod; }

    bool evaluateLOD() const { return mEvaluateLOD; }

    void setShaderAnimationEnabled(bool animate_shaders) { mShaderAnimationEnabled = animate_shaders; }

    bool shaderAnimationEnabled() const { return mShaderAnimationEnabled; }

    void setCullingEnabled(bool enabled) { mCullingEnabled = enabled; }

    bool cullingEnabled() const { return mCullingEnabled; }

    void setAutomaticResourceInit(bool enable) { mAutomaticResourceInit = enable; }

    bool automaticResourceInit() const { return mAutomaticResourceInit; }

    bool nearFarClippingPlanesOptimized() const { return mNearFarClippingPlanesOptimized; }

    void setNearFarClippingPlanesOptimized(bool enabled) { mNearFarClippingPlanesOptimized = enabled; }

    const std::map<unsigned int, ref<Effect> >& effectOverrideMask() const { return mEffectOverrideMask; }

    std::map<unsigned int, ref<Effect> >& effectOverrideMask() { return mEffectOverrideMask; }

  protected:
    // mic fixme: it would be nice to have a mechanism to request the visible actors at will and to
    // compile and save the render-queue for later renderings to be reused without recomputing the culling.
    // The user could be able to install actor-list or render-queue and use the flags READ|WRITE|TERMINATE
    // to define wether the list should be used for reading, filled, cleaned up after rendering.
    void fillRenderQueue( ActorCollection* actor_list );
    RenderQueue* renderQueue() { return mRenderQueue.get(); }
    ActorCollection* actorQueue() { return mActorQueue.get(); }

  protected:
    ref<RenderQueueSorter> mRenderQueueSorter;
    ref<ActorCollection> mActorQueue;
    ref<RenderQueue> mRenderQueue;
    Collection<Renderer> mRenderers;
    ref<Camera> mCamera;
    ref<Transform> mTransform;
    ref<Collection<SceneManager> > mSceneManagers;
    std::map<unsigned int, ref<Effect> > mEffectOverrideMask;

    bool mAutomaticResourceInit;
    bool mCullingEnabled;
    bool mEvaluateLOD;
    bool mShaderAnimationEnabled;
    bool mNearFarClippingPlanesOptimized;
  };
}

#endif