splash_display.h

Go to the documentation of this file.

/*! \file
  \brief The SplashDisplay class.
 
  \par Copyright Information
 
  Copyright (c) 2019 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.
 
*/
 
///////////////////////////////////////////////////////////////////////////////
// This file is generated by GL Studio.  DO NOT EDIT.
// To modify, run "glstudio splashtemp.gls", edit, then select Code/Generate All.
// Generated from splashtemp.gls using GL Studio 8.0.0
///////////////////////////////////////////////////////////////////////////////
#ifndef _splash_display_h_
#define _splash_display_h_
 
#include "callback_caller.h"
#include "display.h"
#include "display_frame.h"
#include "gls_include.h"
 
#include "dynamic_library.h"
 
// Fonts referenced by design and at run-time
 
#include "component_base.h"
#include "glpolygon.h"
 
/// Provides support for creating DLLs.
#if( defined( GLSGEN_EXPORT_SplashDisplay ) || defined( GLSGEN_IMPORT_SplashDisplay ) || defined( GLS_EXPORT_GENERATED ) || defined( GLS_IMPORT_GENERATED ) ) \
    && defined( _MSC_VER )
#    if defined( GLSGEN_EXPORT_SplashDisplay ) || defined( GLS_EXPORT_GENERATED )
#        define GLSGEN_SplashDisplay_EXPORT __declspec( dllexport )
#    else
#        define GLSGEN_SplashDisplay_EXPORT __declspec( dllimport )
#    endif
#else
#    define GLSGEN_SplashDisplay_EXPORT
#endif
///////////////////////////////////////////////////////////////////////////////
 
//////////////////// User Code from section: "file splash_display.h" ////////////
 
///////////////////////////////////////////////////////////////////////////////
namespace disti
{
/// \details The SplashDisplay class. Handles the visuals for the runtime splash screen.
class SplashDisplay : public ComponentBase
{
public:
    DISTI_DEPRECATED( "This identifier is forbidden by the C++ standard. Use BaseClass instead." )
    typedef ComponentBase _BaseClass; ///< Deprecated typedef for the base class.
    typedef ComponentBase BaseClass;  ///< Typedef for the base class.
 
    /// Constructor
    /// \param name Unused, kept for backward compatibility.
    GLSGEN_SplashDisplay_EXPORT SplashDisplay( const char* name = NULL );
 
    /// Creates the geometry for this object.
    GLSGEN_SplashDisplay_EXPORT void CreateObjects();
 
    typedef CallbackMethodCallerTemplate<SplashDisplay> CallbackMethodCaller; ///< Typedef for callback methods associated with this object.
 
    // Object creators
    // Textures
    static unsigned char* rgb_data_1[]; ///< Inline data for splash texture.
    static glsInlineImage image_data_1; ///< Inline image detail structure for splash texture.
 
    // Geometry
 
private:
protected:
public:
    GLPolygon* Background; ///< The splash background object.
    //////////////////// User Code from section: "Class Declaration" //////////////
 
    ///////////////////////////////////////////////////////////////////////////////
public:
    // Methods
    /** 
 */
    virtual GLSGEN_SplashDisplay_EXPORT void Initialize();
    /** 
 */
    virtual GLSGEN_SplashDisplay_EXPORT void Calculate( double time );
    /** 
 */
 
    /// Inner method to adjust the splash image to fit on the screen.
    /// \param screenW The screen width in pixels.
    /// \param screenH The screen height in pixels.
    /// \param boxW The image width in pixels.
    /// \param boxH The image height in pixels.
    /// \param newW The returned width in pixels.
    /// \param newH The returned height in pixels.
    virtual GLSGEN_SplashDisplay_EXPORT void FitOnScreen( float screenW, float screenH, float boxW, float boxH, float& newW, float& newH );
 
    /// Adjust the splash image to fit on the screen.
    /// \param width The screen width in pixels.
    /// \param height The screen height in pixels.
    virtual GLSGEN_SplashDisplay_EXPORT void AdjustToFit( int width, int height );
 
    /// \return A pointer to a new copy of this object.
    /// \param generateNames Whether or not to generate an instance name for this object.
    virtual GLSGEN_SplashDisplay_EXPORT DisplayObject* CloneObject( bool generateNames = false );
 
#ifndef GLES
    /** Get the details of the Cpp Interface
      * The actual interface is exposed in compiled code.
      * \param addToThisList A list to add to and then return.  Creates a new one if NULL.
      * \return A templated list.
      * The caller must call the corresponding free method to
      * safely free the memory.
      */
 
    virtual GLSGEN_SplashDisplay_EXPORT InterfaceListType* GetCppInterfaceDescription( InterfaceListType* addToThisList = NULL );
    virtual GLSGEN_SplashDisplay_EXPORT void               GetCppInterfaceDescriptionFree( InterfaceListType* array );
#endif
};
} //namespace disti
 
#endif