gls_render_view_change_manager.h

Go to the documentation of this file.

/*! \file
  \brief RenderViewChangeManager to smooth updating of the render view

  \par Copyright Information

 Copyright (c) 2016 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. Use, distribution,
duplication, or disclosure by the U. S. Government is subject to
"Restricted Rights" as set forth in DFARS 252.227-7014(c)(1)(ii).

*/

#ifndef GLS_RENDER_VIEW_CHANGE_MANAGER_H
#define GLS_RENDER_VIEW_CHANGE_MANAGER_H

#include "dynamic_array.h"
#include "gls_include.h"
#include "gls_matrix.h"

namespace disti
{
/** Interface for listeners that need to perform specific actions once per frame for each "camera" rendering a view. */
class GlsRenderViewChangeListener
{
public:
    /** Called whenever a new view has been applied to OpenGL.
          * \param modelViewMatrix the matrix of the new view
          */
    GLS_EXPORT virtual void OnViewChanged( const GlsMatrixType& modelViewMatrix ) = 0;

protected:
    /** Protected destructor -- no polymorphic deletion */
    virtual ~GlsRenderViewChangeListener() {}
};

/** Singleton to keep a list of all listeners for changes in the render view. */
class GlsRenderViewChangeManager
{
public:
    /** Add a listener to the notification list for render views changing
          * Note: Does not take ownership of the listener
          * \param listener the listener to add
          */
    GLS_EXPORT static void AddRenderViewChangeListener( GlsRenderViewChangeListener* listener )
    {
        GetListeners().PushBack( listener );
    }

    /** Remove a listener from the notification list for render views changing
          * \param listener the listener to remove
          */
    GLS_EXPORT static void RemoveRenderViewChangeListener( GlsRenderViewChangeListener* listener )
    {
        GetListeners().Erase( listener );
    }

    /** Notify all listeners that a new view has been applied to OpenGL
          * \param modelViewMatrix the matrix of the new view
          */
    GLS_EXPORT static void NotifyRenderViewChanged( const GlsMatrixType& modelViewMatrix )
    {
        Listeners& listeners = GetListeners();
        for( unsigned int i = 0; i < listeners.Count(); ++i )
        {
            listeners[ i ]->OnViewChanged( modelViewMatrix );
        }
    }

private:
    // Member types
    typedef DynamicArray<GlsRenderViewChangeListener*> Listeners;

    // Disable construction for static class
    GlsRenderViewChangeManager(); // = delete

    static Listeners& GetListeners()
    {
        static Listeners s_renderViewChangeListeners;
        return s_renderViewChangeListeners;
    }
};

} // namespace disti

#endif