gls_sorted_draw_group.h

#ifndef GLS_SORTED_RENDER_GROUP_H_INCLUDED
#define GLS_SORTED_RENDER_GROUP_H_INCLUDED

#include "gls_sorted_drawable.h"
#include "group.h"

//////////////////// Provides support for creating DLLs ////////////////////////
#if( defined( GLSGEN_EXPORT_GLSADVANCEDMESH ) || defined( GLSGEN_IMPORT_GLSADVANCEDMESH ) || defined( GLS_EXPORT_GENERATED ) || defined( GLS_IMPORT_GENERATED ) ) \
    && defined( _MSC_VER )
#    if defined( GLSGEN_EXPORT_GLSADVANCEDMESH ) || defined( GLS_EXPORT_GENERATED )
#        define GLSGEN_GlsAdvancedMesh_EXPORT __declspec( dllexport )
#    else
#        define GLSGEN_GlsAdvancedMesh_EXPORT __declspec( dllimport )
#    endif
#else
#    define GLSGEN_GlsAdvancedMesh_EXPORT
#endif
///////////////////////////////////////////////////////////////////////////////

namespace disti
{
class GlsRenderEffect;
class GlsGeometryResource;
class GlsSortedDrawable;
class GlsDeferredDrawGroup;

// This Group allows it's children to register into
// a list during Draw.  The Group then sorts the list
// and draws the children.
class GlsSortedDrawGroup : public Group
{
public:
    DISTI_DEPRECATED( "This identifier is forbidden by the C++ standard. Use BaseClass instead." )
    typedef Group _BaseClass;
    typedef Group BaseClass;

    GLSGEN_GlsAdvancedMesh_EXPORT GlsSortedDrawGroup();

    class DrawList
    {
        friend class GlsSortedDrawGroup;

    public:
        void RegisterDrawable( GlsSortedDrawable* obj );

    protected:
        typedef std::vector<GlsSortedDrawable*>    EntryListT;
        typedef std::vector<GlsDeferredDrawGroup*> DeferredDrawListT;
        EntryListT                                 drawEntryList;
        EntryListT                                 orderPreservedDrawList;
        DeferredDrawListT                          deferredDrawList;
        unsigned long                              drawEntryListCount;
        unsigned long                              orderPreservedDrawListCount;

        DrawList()
            : drawEntryListCount( 0 )
            , orderPreservedDrawListCount( 0 )
        {}

        // Sort the list using GlsSortedDrawable::SortedDraw_Compare
        void Sort();

        // Optimize the nodes using GlsSortedDrawable::SortedDraw_MergeEffects
        // Should only be called after the list is sorted
        void Optimize();

        // Draw the nodes
        void Draw();

        // Clear the list
        void Clear();
    };

    /* See base class */
    virtual GLSGEN_GlsAdvancedMesh_EXPORT void Draw( void );

    // Returns pointer to the active GlsSortedDrawGroup::DrawList for the calling thread
    // This will be NULL if there is no active DrawList.
    static GLSGEN_GlsAdvancedMesh_EXPORT DrawList* GetActiveDrawListPtr();

    // Disable sorted draw to render normally
    // Toggling this value between frames is a good way to debug any rendering issues
    GLSGEN_GlsAdvancedMesh_EXPORT void DisableSortedDraw( bool value );
    GLSGEN_GlsAdvancedMesh_EXPORT bool DisableSortedDraw();

protected:
    // Set the active GlsSortedDrawGroup::DrawList for the calling thread
    static GLSGEN_GlsAdvancedMesh_EXPORT void SetActiveDrawListPtr( DrawList* );

    bool     _sortedDrawDisabled;
    DrawList _drawList;
};

} // end namespace disti

#endif