GL Studio C++ Runtime API
splash_display.h
Go to the documentation of this file.
1/// \file splash_display.h
2/// \brief The SplashDisplay class.
3///
4/// \par Copyright Information
5///
6/// Copyright (c) 2019 by The DiSTI Corporation.<br>
7/// 12249 Science Drive; Suite 300<br>
8/// Orlando, Florida 32826<br>
9/// USA<br>
10/// <br>
11/// All rights reserved.<br>
12///
13/// This Software contains proprietary trade secrets of DiSTI and may not be
14/// reproduced, in whole or part, in any form, or by any means of electronic,
15/// mechanical, or otherwise, without the written permission of DiSTI. Said
16/// permission may be derived through the purchase of applicable DiSTI product
17/// licenses which detail the distribution rights of this content and any
18/// Derivative Works based on this or other copyrighted DiSTI Software.
19///
20/// NO WARRANTY. THE SOFTWARE IS PROVIDED "AS-IS," WITHOUT WARRANTY OF ANY KIND,
21/// AND ANY USE OF THIS SOFTWARE PRODUCT IS AT YOUR OWN RISK. TO THE MAXIMUM EXTENT
22/// PERMITTED BY APPLICABLE LAW, DISTI AND ITS SUPPLIERS DISCLAIM ALL WARRANTIES
23/// AND CONDITIONS, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
24/// IMPLIED WARRANTIES AND CONDITIONS OF MERCHANTABILITY AND/OR FITNESS FOR A
25/// PARTICULAR PURPOSE, TITLE, AND NON-INFRINGEMENT, WITH REGARD TO THE SOFTWARE.
26///
27/// LIMITATION OF LIABILITY. TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW,
28/// IN NO EVENT SHALL DISTI OR ITS SUPPLIERS BE LIABLE FOR ANY SPECIAL, INCIDENTAL,
29/// INDIRECT, OR CONSEQUENTIAL DAMAGES WHATSOEVER (INCLUDING, WITHOUT LIMITATION,
30/// DAMAGES FOR LOSS OF BUSINESS PROFITS, BUSINESS INTERRUPTION, LOSS OF BUSINESS
31/// INFORMATION, OR ANY OTHER PECUNIARY LOSS) ARISING OUT OF THE USE OF OR
32/// INABILITY TO USE THE SOFTWARE, EVEN IF DISTI HAS BEEN ADVISED OF THE POSSIBILITY
33/// OF SUCH DAMAGES. DISTI'S ENTIRE LIABILITY AND YOUR EXCLUSIVE REMEDY SHALL NOT
34/// EXCEED FIVE DOLLARS (US$5.00).
35///
36/// The aforementioned terms and restrictions are governed by the laws of the
37/// State of Florida and the United States of America.
38
39///////////////////////////////////////////////////////////////////////////////
40// This file is generated by GL Studio. EDITED PORTIONS MARKED WITH "EDITED".
41// To modify, run "glstudio splashtemp.gls", edit, then select Code/Generate All.
42// Generated from splashtemp.gls using GL Studio 8.0.0
43///////////////////////////////////////////////////////////////////////////////
44#ifndef _splash_display_h_
45#define _splash_display_h_
46
47#include "callback_caller.h"
48#include "display.h"
49#include "display_frame.h"
50#include "gls_include.h"
51
52#include "dynamic_library.h"
53
54// Fonts referenced by design and at run-time
55
56#include "component_base.h"
57#include "glpolygon.h"
58
59////////////////////////////////// EDITED ////////////////////////////////////
60#include "editor_version.h"
61#include "gls_buildinfo.h"
62#include "group.h"
63////////////////////////////////// EDITED ////////////////////////////////////
64
65/// Provides support for creating DLLs.
66#if( defined( GLSGEN_EXPORT_SplashDisplay ) || defined( GLSGEN_IMPORT_SplashDisplay ) || defined( GLS_EXPORT_GENERATED ) || defined( GLS_IMPORT_GENERATED ) ) \
67 && defined( _MSC_VER )
68# if defined( GLSGEN_EXPORT_SplashDisplay ) || defined( GLS_EXPORT_GENERATED )
69# define GLSGEN_SplashDisplay_EXPORT __declspec( dllexport )
70# else
71# define GLSGEN_SplashDisplay_EXPORT __declspec( dllimport )
72# endif
73#else
74# define GLSGEN_SplashDisplay_EXPORT
75#endif
76///////////////////////////////////////////////////////////////////////////////
77
78//////////////////// User Code from section: "file splash_display.h" ////////////
79
80///////////////////////////////////////////////////////////////////////////////
81namespace disti
82{
83////////////////////////////////// EDITED ////////////////////////////////////
84#ifndef GLES
85/// \details Draws the build information text on the runtime splash screen.
86class SplashText : public Group
87{
88public:
92};
93#endif
94////////////////////////////////// EDITED ////////////////////////////////////
95
96/// \details The SplashDisplay class. Handles the visuals for the runtime splash screen.
98{
99public:
100 DISTI_DEPRECATED( "This identifier is forbidden by the C++ standard. Use BaseClass instead." )
101 typedef ComponentBase _BaseClass; ///< Deprecated typedef for the base class.
102 typedef ComponentBase BaseClass; ///< Typedef for the base class.
103
104 /// Constructor
105 /// \param name Unused, kept for backward compatibility.
106 GLSGEN_SplashDisplay_EXPORT SplashDisplay( const char* name = NULL );
107
108 /// Creates the geometry for this object.
110
111 typedef CallbackMethodCallerTemplate<SplashDisplay> CallbackMethodCaller; ///< Typedef for callback methods associated with this object.
112
113 // Object creators
114 // Textures
115 static unsigned char* rgb_data_1[]; ///< Inline data for splash texture.
116 static glsInlineImage image_data_1; ///< Inline image detail structure for splash texture.
117
118 // Geometry
119
120private:
121protected:
122public:
123 GLPolygon* Background; ///< The splash background object.
124
125 ////////////////////////////////// EDITED ////////////////////////////////////
126#ifndef GLES
127 SplashText* GLSBuildInfo; ///< The splash build information text object.
128#endif
129 ////////////////////////////////// EDITED ////////////////////////////////////
130
131 //////////////////// User Code from section: "Class Declaration" //////////////
132
133 ///////////////////////////////////////////////////////////////////////////////
134public:
135 // Methods
136 /**
137 */
139 /**
140 */
142 /**
143 */
144
145 /// Inner method to adjust the splash image to fit on the screen.
146 /// \param screenW The screen width in pixels.
147 /// \param screenH The screen height in pixels.
148 /// \param boxW The image width in pixels.
149 /// \param boxH The image height in pixels.
150 /// \param newW The returned width in pixels.
151 /// \param newH The returned height in pixels.
152 virtual GLSGEN_SplashDisplay_EXPORT void FitOnScreen( float screenW, float screenH, float boxW, float boxH, float& newW, float& newH );
153
154 /// Adjust the splash image to fit on the screen.
155 /// \param width The screen width in pixels.
156 /// \param height The screen height in pixels.
157 virtual GLSGEN_SplashDisplay_EXPORT void AdjustToFit( int width, int height );
158
159 /// \return A pointer to a new copy of this object.
160 /// \param generateNames Whether or not to generate an instance name for this object.
162
163#ifndef GLES
164 /** Get the details of the Cpp Interface
165 * The actual interface is exposed in compiled code.
166 * \param addToThisList A list to add to and then return. Creates a new one if NULL.
167 * \return A templated list.
168 * The caller must call the corresponding free method to
169 * safely free the memory.
170 */
171
174#endif
175};
176} //namespace disti
177
178#endif
The disti::CallbackMethodCallerTemplate class and global enumerations.
Definition: callback_caller.h:60
Definition: component_base.h:67
Definition: display.h:95
Definition: dynamic_array.h:79
The Polygon class. Implements Polygons.
Definition: glpolygon.h:55
Definition: group.h:52
void Calculate(double time) override
DisplayObject * CloneObject(bool generateNames=false) override
Definition: splash_display.h:98
void Initialize() override
InterfaceListType * GetCppInterfaceDescription(InterfaceListType *addToThisList=NULL) override
void GetCppInterfaceDescriptionFree(InterfaceListType *array) override
SplashText * GLSBuildInfo
The splash build information text object.
Definition: splash_display.h:127
Definition: splash_display.h:87
void Draw() override
The disti::ComponentBase class.
The disti::DisplayObject class and global enumerations.
The disti::DisplayFrame class.
A cross-platform class for loading dynamic link libraries and shared objects.
The disti::GLPolygon class. Implements Polygons.
SVN, status and date information for the runtime.
#define DISTI_DEPRECATED(msg)
Defines whether this compiler supports the C++14 deprecated attribute.
Definition: gls_cpp_lang_support.h:487
#define DISTI_METHOD_OVERRIDE
Macro to wrap the override keyword, removed on compilers that don't support it.
Definition: gls_cpp_lang_support.h:221
A file for all GL Studio files to include.
#define GLS_EXPORT
Macro denoting which functions should be visible from the runtime library.
Definition: gls_include.h:50
The disti::Group class. Implements groups of objects.
Definition: bmpimage.h:46
#define GLSGEN_SplashDisplay_EXPORT
Provides support for creating DLLs.
Definition: splash_display.h:74
Definition: image.h:80