gls_sorted_drawable.h

Go to the documentation of this file.

///   \file
///   \brief  A sorted drawable group.
///
///   \par Copyright Information
///
///   Copyright (c) 2017 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_DRAWABLE_H
#define GLS_SORTED_DRAWABLE_H
 
#include <cstddef>
 
namespace disti
{
/// \details The GlsSortedDrawable class. An interface for an object that knows how to sort itself.
class GlsSortedDrawable
{
public:
    // virtual destructor
    virtual ~GlsSortedDrawable() {}
 
    /// Allows for static casting in compare functions.
    /// \see RegisterClassID
    /// \return The unique identifier for this object's class.
    virtual unsigned int SortedDraw_ClassID() = 0;
 
    /// Compare two GlsSortedDrawable objects to determine the sort order.
    /// \param other Object to compare to.
    /// \returns True if this object should draw before other.
    virtual bool SortedDraw_Compare( GlsSortedDrawable& other ) = 0;
 
    /// Comparison that should be used if the derived class is unsure.
    /// \param o The object to compare to.
    /// \return True if this object's id is less than the compared object.
    inline bool SortedDraw_CompareDefault( GlsSortedDrawable& o )
    {
        // Group objects by ClassID
        return SortedDraw_ClassID() < o.SortedDraw_ClassID();
    }
 
    /// Try to merge two adjecently-sorted GlsSortedDrawable nodes.
    /// \param lastObj Pointer to the previous GlsSortedDrawable in the sort order.
    virtual void SortedDraw_OptimizeMerge( GlsSortedDrawable& lastObj ) = 0;
 
    /// Draw the object using the current OpenGL context.
    /// Use lastDrawnObj to avoid redundant state changes.
    /// \param lastObj Pointer to the GlsSortedDrawable that was drawn (may be NULL).
    virtual void SortedDraw( GlsSortedDrawable* lastObj ) = 0;
 
    /// Tell an object to restore the OpenGLDefaultState after drawing.
    /// Objects should call this if lastDrawnObj has an unknown class.
    /// The Group will also call this after the last object is drawn.
    virtual void SortedDrawCleanup() = 0;
 
    /// \return Whether or not this can be re-ordered, or if it is part of an preserved order set.
    virtual bool SortedDraw_ReorderAtWill() { return true; }
 
    /// \return A new ClassID.
    /// Typically only called once by each GlsSortedDrawable implementation.
    /// \param debugStr Unused, kept for backward compatibility.
    static unsigned int RegisterNewClassID( const char* debugStr = NULL );
};
 
} // namespace disti
 
#endif