embedded_display_frame.h

Go to the documentation of this file.

/*! \file
 \brief  disti::EmbeddedDisplayFrame class.  The class for creating standalone executables for EGL.
 
 \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 EMBEDDED_DISPLAY_H
#define EMBEDDED_DISPLAY_H
 
#include "events.h"
#include "gls_include.h"
#include "runtime_display_frame.h"
 
namespace disti
{
///< Unused, remains for backward compatibility.
enum FL_Flags
{
    FL_RGB,
    FL_DOUBLE,
    FL_DEPTH
};
 
/**
 * Base class for all embedded (openGL ES) display frame classes
 */
class EmbeddedDisplayFrame : public RuntimeDisplayFrame
{
protected:
    /// Unused in ES, remains for backward compatibility.
    void WindowFlags( int ) {}
 
    /** Builds a DisplayEvent for passing to the handle method
     * \param x X device coordinate
     * \param y Y device coordinate
     * \param pressure Touchscreen pressure 
     * \param eventType  Touch event type (e.g. MOUSE_UP,MOUSE_DOWN,MOUSE_DRAG
     */
    virtual GLS_EXPORT void BuildAndSendEvent( int x, int y, int pressure, unsigned int eventType );
 
    virtual GLS_EXPORT EventCompressor<DisplayFrame>* GetEventCompressor() DISTI_METHOD_OVERRIDE { return &eventCompressor; }
 
public:
    ///< Unused, remains for backward compatibility.
    enum iDeviceOrientation
    {
        ORIENTATION_UNKNOWN              = 0,
        ORIENTATION_PORTRAIT             = 1,
        ORIENTATION_PORTRAIT_UPSIDE_DOWN = 2,
        ORIENTATION_LANDSCAPE_LEFT       = 3,
        ORIENTATION_LANDSCAPE_RIGHT      = 4,
        ORIENTATION_FACE_UP              = 5,
        ORIENTATION_FACE_DOWN            = 6
    };
 
    /// Create a new EmbeddedDisplayFrame object
    /// \param name name displayed on the title bar, if supported by the platform
    /// \param width the width of the window in pixels
    /// \param height the height of the window in pixels
    GLS_EXPORT EmbeddedDisplayFrame( const char* name, int width, int height );
 
    virtual GLS_EXPORT ~EmbeddedDisplayFrame();
 
    /** Used for event compression.  Not for general use by users. */
    EventCompressor<DisplayFrame> eventCompressor;
 
    /** Removes (hides) the spash screen
     *  Note on iOS the AppDelegate presents the splash screen for us, so this is just a stub
     */
    virtual GLS_EXPORT void RemoveSplash()
    {
    }
 
    /** Creates the spash screen
     *  Note on iOS the AppDelegate presents the splash screen for us, so this is just a stub
     */
    virtual GLS_EXPORT void CreateSplash()
    {
    }
 
    /// Sets up the default Orthographic projection (which supports things like pan and zoom).
    /// \param projMatrix The returned projection matrix.
    /// \param model The returned modelview matrix.
    virtual GLS_EXPORT void SetProjection( GlsMatrixType& projMatrix, GlsMatrixType& model );
 
    GLS_EXPORT void Paint() DISTI_METHOD_OVERRIDE;
 
    /** Set a flag that UpdateAnimate can test to see if the window needs redrawing.
      * \deprecated Use Invalidate() from the GlsPainter interface to trigger a redraw.  SetRedraw behaves differently on ES and Desktop platforms.
     */
    GLS_EXPORT void SetRedraw() DISTI_METHOD_OVERRIDE;
 
    /** Redraw the window now.  
     * This actually calls the OpenGL Drawing routines. 
     */
    virtual GLS_EXPORT void Redraw();
};
 
} // namespace disti
 
#endif