gls_sorted_draw_group.h

Go to the documentation of this file.

///   \file
///   \brief  A sorted drawable group.
///
///   \par Copyright Information
///
///   Copyright (c) 2022 by The DiSTI Corporation.<br>
///   11301 Corporate Blvd; Suite 100<br>
///   Orlando, Florida 32817<br>
///   USA<br>
///   <br>
///   All rights reserved.<br>
///
///   This Software contains proprietary trade secrets of DiSTI and may not be
/// reproduced, in whole or part, in any form, or by any means of electronic,
/// mechanical, or otherwise, without the written permission of DiSTI.  Said
/// permission may be derived through the purchase of applicable DiSTI product
/// licenses which detail the distribution rights of this content and any
/// Derivative Works based on this or other copyrighted DiSTI Software.
///
///   NO WARRANTY. THE SOFTWARE IS PROVIDED "AS-IS," WITHOUT WARRANTY OF ANY KIND,
/// AND ANY USE OF THIS SOFTWARE PRODUCT IS AT YOUR OWN RISK. TO THE MAXIMUM EXTENT
/// PERMITTED BY APPLICABLE LAW, DISTI AND ITS SUPPLIERS DISCLAIM ALL WARRANTIES
/// AND CONDITIONS, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
/// IMPLIED WARRANTIES AND CONDITIONS OF MERCHANTABILITY AND/OR FITNESS FOR A
/// PARTICULAR PURPOSE, TITLE, AND NON-INFRINGEMENT, WITH REGARD TO THE SOFTWARE.
///
///   LIMITATION OF LIABILITY. TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW,
/// IN NO EVENT SHALL DISTI OR ITS SUPPLIERS BE LIABLE FOR ANY SPECIAL, INCIDENTAL,
/// INDIRECT, OR CONSEQUENTIAL DAMAGES WHATSOEVER (INCLUDING, WITHOUT LIMITATION,
/// DAMAGES FOR LOSS OF BUSINESS PROFITS, BUSINESS INTERRUPTION, LOSS OF BUSINESS
/// INFORMATION, OR ANY OTHER PECUNIARY LOSS) ARISING OUT OF THE USE OF OR
/// INABILITY TO USE THE SOFTWARE, EVEN IF DISTI HAS BEEN ADVISED OF THE POSSIBILITY
/// OF SUCH DAMAGES.  DISTI'S ENTIRE LIABILITY AND YOUR EXCLUSIVE REMEDY SHALL NOT
/// EXCEED FIVE DOLLARS (US$5.00).
///
///   The aforementioned terms and restrictions are governed by the laws of the
/// State of Florida and the United States of America.
 
#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;
 
/// \details 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; ///< Deprecated typedef for the base class.
    typedef Group BaseClass;  ///< Typedef for the base class.
 
    GLSGEN_GlsAdvancedMesh_EXPORT GlsSortedDrawGroup();
 
    /// \details The DrawList class. Holds a list of objects for sorting and drawing.
    class DrawList
    {
        friend class GlsSortedDrawGroup;
 
    public:
        /// Register the incoming drawable object with this list.
        /// \param obj The new object to register.
        void RegisterDrawable( GlsSortedDrawable* obj );
 
    protected:
        typedef std::vector<GlsSortedDrawable*>    EntryListT;                  ///< Typedef for a list of drawables.
        typedef std::vector<GlsDeferredDrawGroup*> DeferredDrawListT;           ///< Unused.
        EntryListT                                 drawEntryList;               ///< List of drawables in sorted order.
        EntryListT                                 orderPreservedDrawList;      ///< List of drawables in orginal order.
        DeferredDrawListT                          deferredDrawList;            ///< Unused.
        unsigned long                              drawEntryListCount;          ///< Number of elements in the entry list.
        unsigned long                              orderPreservedDrawListCount; ///< Number of elements in the original order list.
 
        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();
    };
 
    virtual GLSGEN_GlsAdvancedMesh_EXPORT void Draw() DISTI_METHOD_OVERRIDE;
 
    /// \return A pointer to the active GlsSortedDrawGroup::DrawList for the calling thread.
    /// \note 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.
    /// \param value The sorting draw flag to set.
    GLSGEN_GlsAdvancedMesh_EXPORT void DisableSortedDraw( bool value );
 
    /// \return Whether or not objects should be drawn sorted, or in original order.
    GLSGEN_GlsAdvancedMesh_EXPORT bool DisableSortedDraw();
 
protected:
    /// Set the active GlsSortedDrawGroup::DrawList for the calling thread.
    static GLSGEN_GlsAdvancedMesh_EXPORT void SetActiveDrawListPtr( DrawList* );
 
    bool     _sortedDrawDisabled; ///< If true, draw in original order rather than sorted order.
    DrawList _drawList;           ///< Holds sorting and object data.
};
 
} // end namespace disti
 
#endif