urho3d/Engine/Graphics/View.h

//
// Urho3D Engine
// Copyright (c) 2008-2011 Lasse Öörni
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
//

#pragma once

#include "Batch.h"
#include "HashSet.h"
#include "Object.h"
#include "Set.h"

class Camera;
class DebugRenderer;
class Light;
class Drawable;
class OcclusionBuffer;
class RenderSurface;
class Zone;
struct Viewport;

static const int MAX_LIGHT_SPLITS = 6;

/// Geometry view space depth minimum and maximum values
struct GeometryDepthBounds
{
    float min_;
    float max_;
};

/// Helper structure for checking whether a transparent object is already lit by a certain light
struct LitTransparencyCheck
{
    /// Construct undefined
    LitTransparencyCheck()
    {
    }
    
    /// Construct
    LitTransparencyCheck(Light* light, Drawable* drawable, unsigned batchIndex) :
        light_(light),
        drawable_(drawable),
        batchIndex_(batchIndex)
    {
    }
    
    /// Test for equality with another lit transparency check
    bool operator == (const LitTransparencyCheck& rhs) const { return (light_ == rhs.light_) && (drawable_ == rhs.drawable_) && (batchIndex_ == rhs.batchIndex_); }
    /// Test for inequality with another lit transparency check
    bool operator != (const LitTransparencyCheck& rhs) const { return (light_ != rhs.light_) || (drawable_ != rhs.drawable_) || (batchIndex_ != rhs.batchIndex_); }
    /// Return hash value for HashSet & HashMap
    unsigned ToHash() const { return ((unsigned)light_) / sizeof(Light) + ((unsigned)drawable_) / sizeof(Drawable) + batchIndex_; }
    
    Light* light_;
    Drawable* drawable_;
    unsigned batchIndex_;
};

/// A rendering view. Includes the main view(s) and any auxiliary views, but not shadow cameras
class View : public Object
{
    OBJECT(View);
    
public:
    /// Construct
    View(Context* context);
    /// Destruct
    virtual ~View();
    
    /// Define with rendertarget and viewport. Return true if successful
    bool Define(RenderSurface* renderTarget, const Viewport& viewport);
    /// Update culling and construct rendering batches
    void Update(const FrameInfo& frame);
    /// Render batches
    void Render();
    
    /// Return octree
    Octree* GetOctree() const { return octree_; }
    /// Return camera
    Camera* GetCamera() const { return camera_; }
    /// Return zone
    Zone* GetZone() const { return zone_; }
    /// Return the render target. 0 if using the backbuffer
    RenderSurface* GetRenderTarget() const { return renderTarget_; }
    /// Return the depth stencil. 0 if using the backbuffer's depth stencil
    RenderSurface* GetDepthStencil() const { return depthStencil_; }
    /// Return geometry objects
    const PODVector<Drawable*>& GetGeometries() const { return geometries_; }
    /// Return occluder objects
    const PODVector<Drawable*>& GetOccluders() const { return occluders_; }
    /// Return directional light shadow rendering occluders
    const PODVector<Drawable*>& GetShadowOccluders() const { return shadowOccluders_; }
    /// Return lights
    const PODVector<Light*>& GetLights() const { return lights_; }
    /// Return light batch queues
    const Vector<LightBatchQueue>& GetLightQueues() const { return lightQueues_; }
    
private:
    /// Query the octree for scene nodes
    void GetDrawables();
    /// Construct batches from the scene nodes
    void GetBatches();
    /// Get lit batches for a certain light and drawable
    void GetLitBatches(Drawable* drawable, Light* light, Light* SplitLight, LightBatchQueue* lightQueue, HashSet<LitTransparencyCheck>& litTransparencies, PassType gBufferPass);
    /// Render batches, forward mode
    void RenderBatchesForward();
    /// Render batches, deferred mode
    void RenderBatchesDeferred();
    /// Query for occluders as seen from a camera
    void UpdateOccluders(PODVector<Drawable*>& occluders, Camera* camera);
    /// Draw occluders to occlusion buffer
    void DrawOccluders(OcclusionBuffer* buffer, const PODVector<Drawable*>& occluders);
    /// Query for lit geometries and shadow casters for a light
    unsigned ProcessLight(Light* light);
    /// Generate combined bounding boxes for lit geometries and shadow casters and check shadow caster visibility
    void ProcessLightQuery(unsigned splitIndex, const PODVector<Drawable*>& result, BoundingBox& geometryBox, BoundingBox& shadowSpaceBox, bool getLitGeometries, bool GetShadowCasters);
    /// Check visibility of one shadow caster
    bool IsShadowCasterVisible(Drawable* drawable, BoundingBox lightViewBox, Camera* shadowCamera, const Matrix3x4& lightView, const Frustum& lightViewFrustum, const BoundingBox& lightViewFrustumBox);
    /// Set up initial shadow camera view
    void SetupShadowCamera(Light* light, bool shadowOcclusion = false);
    /// Focus shadow camera to use shadow map texture space more optimally
    void FocusShadowCamera(Light* light, const BoundingBox& geometryBox, const BoundingBox& shadowCasterBox);
    /// Quantize the directional light shadow camera view to eliminate artefacts
    void QuantizeDirShadowCamera(Light* light, const BoundingBox& viewBox);
    /// Optimize light rendering by setting up a scissor rectangle
    void OptimizeLightByScissor(Light* light);
    /// Return scissor rectangle for a light
    const Rect& GetLightScissor(Light* light);
    /// Split directional or point light for shadow rendering
    unsigned SplitLight(Light* light);
    /// Return material technique, considering the drawable's LOD distance
    Technique* GetTechnique(Drawable* drawable, Material*& material);
    /// Check if material should render an auxiliary view (if it has a camera attached)
    void CheckMaterialForAuxView(Material* material);
    /// Sort all batches
    void SortBatches();
    /// Prepare instancing buffer by filling it with all instance transforms
    void PrepareInstancingBuffer();
    /// Calculate view-global shader parameters
    void CalculateShaderParameters();
    /// Draw a split light to stencil buffer
    void DrawSplitLightToStencil(Camera& camera, Light* light, bool clear = false);
    /// Draw everything in a batch queue, priority batches first
    void RenderBatchQueue(const BatchQueue& queue, bool useScissor = false, bool useLightBuffer = false, bool disableScissor = true);
    /// Draw a forward (shadowed) light batch queue
    void RenderForwardLightBatchQueue(const BatchQueue& queue, Light* forwardQueueLight);
    /// Render a shadow map
    void RenderShadowMap(const LightBatchQueue& queue);
    
    /// Graphics
    WeakPtr<Graphics> graphics_;
    /// Renderer
    WeakPtr<Renderer> renderer_;
    /// Octree to use
    Octree* octree_;
    /// Camera to use
    Camera* camera_;
    /// Zone to get global rendering settings from
    Zone* zone_;
    /// Color buffer to use
    RenderSurface* renderTarget_;
    /// Depth buffer to use
    RenderSurface* depthStencil_;
    /// Screen rectangle
    IntRect screenRect_;
    /// Render target width
    int width_;
    /// Render target height
    int height_;
    /// Rendering mode
    RenderMode mode_;
    /// Draw shadows flag
    bool drawShadows_;
    /// Material quality level
    int materialQuality_;
    /// Maximum number of occluder triangles
    int maxOccluderTriangles_;
    /// Jitter counter for temporal antialiasing
    int jitterCounter_;
    /// Previous view matrix for temporal antialiasing
    Matrix3x4 lastCameraView_;
    /// Information of the frame being rendered
    FrameInfo frame_;
    /// Combined bounding box of visible geometries
    BoundingBox sceneBox_;
    /// Combined bounding box of visible geometries in view space
    BoundingBox sceneViewBox_;
    /// Cache for light scissor queries
    Map<Light*, Rect> lightScissorCache_;
    /// Current split lights being processed
    Light* splitLights_[MAX_LIGHT_SPLITS];
    /// Current lit geometries being processed
    PODVector<Drawable*> litGeometries_[MAX_LIGHT_SPLITS];
    /// Current shadow casters being processed
    PODVector<Drawable*> shadowCasters_[MAX_LIGHT_SPLITS];
    /// Temporary drawable query result
    PODVector<Drawable*> tempDrawables_;
    /// Geometry objects
    PODVector<Drawable*> geometries_;
    /// Occluder objects
    PODVector<Drawable*> occluders_;
    /// Directional light shadow rendering occluders
    PODVector<Drawable*> shadowOccluders_;
    /// Depth minimum and maximum values for visible geometries
    PODVector<GeometryDepthBounds> geometryDepthBounds_;
    /// Lights
    PODVector<Light*> lights_;
    /// G-buffer size error displayed
    Set<RenderSurface*> gBufferErrorDisplayed_;
    /// View-global shader parameters
    HashMap<ShaderParameter, Vector4> shaderParameters_;
    
    /// G-buffer batches
    BatchQueue gBufferQueue_;
    /// Base pass batches
    BatchQueue baseQueue_;
    /// Extra pass batches
    BatchQueue extraQueue_;
    /// Transparent geometry batches
    BatchQueue transparentQueue_;
    /// Unshadowed light volume batches
    BatchQueue noShadowLightQueue_;
    /// Shadowed light queues
    Vector<LightBatchQueue> lightQueues_;
};