GL Studio C++ Runtime API
gls_mimic_group.h
Go to the documentation of this file.
1/// \file gls_mimic_group.h
2/// \brief The disti::GlsMimicGroup class.
3///
4/// \par Copyright Information
5///
6/// Copyright (c) 2017 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#ifndef INCLUDED_GLS_MIMIC_GROUP_H
40#define INCLUDED_GLS_MIMIC_GROUP_H
41
43
45#include "group.h"
46#include "image.h"
47
48/// Provides support for creating DLLs.
49#if( defined( GLSGEN_EXPORT_GLSMIMICGROUP ) || defined( GLSGEN_IMPORT_GLSMIMICGROUP ) || defined( GLS_EXPORT_GENERATED ) || defined( GLS_IMPORT_GENERATED ) ) \
50 && defined( _MSC_VER )
51# if defined( GLSGEN_EXPORT_GLSMIMICGROUP ) || defined( GLS_EXPORT_GENERATED )
52# define GLSGEN_GLSMIMICGROUP_EXPORT __declspec( dllexport )
53# else
54# define GLSGEN_GLSMIMICGROUP_EXPORT __declspec( dllimport )
55# endif
56#else
57# define GLSGEN_GLSMIMICGROUP_EXPORT
58#endif
59///////////////////////////////////////////////////////////////////////////////
60
61/// Automatically link the runtime library plugin (on Windows).
62#define LIB_BASE_NAME "gls_mimic_group"
63#include "gls_auto_lib.h"
64#undef LIB_BASE_NAME
65
66namespace disti
67{
68#ifdef GLES
69class GlsGloFile;
70#endif
71
72// SetValue enumerations
73enum
74{
75 GLS_MIMIC_GROUP_STATE = GLS_LAST_INITIALIZER + 1,
76 GLS_MIMIC_GROUP_MIMIC_ACTIVE,
77 GLS_MIMIC_GROUP_BOTTOM_LEFT_CORNER,
78 GLS_MIMIC_GROUP_TOP_RIGHT_CORNER,
79 GLS_MIMIC_GROUP_SHOW_OUTLINE,
80 GLS_MIMIC_GROUP_TEXTURE_HEIGHT,
81 GLS_MIMIC_GROUP_TEXTURE_WIDTH,
82 GLS_MIMIC_GROUP_HAS_DEPTH_BUFFER,
83 GLS_MIMIC_GROUP_DEPTH_TEST,
84 GLS_MIMIC_GROUP_GENERATE_MIPMAPS,
85 GLS_MIMIC_GROUP_DRAW_MIMIC_POLYGON,
86 GLS_MIMIC_GROUP_ATTACHED_TEXTURE_INDEX,
87 GLS_MIMIC_GROUP_CLEAR_COLOR,
88 GLS_MIMIC_GROUP_USE_OPAQUE_TEXTURE,
89 GLS_MIMIC_GROUP_MIMIC_AUTO_REDRAW
90};
91
92/**
93* The GlsMimicGroup class provides a way to group objects that change
94* infrequently into a single textured polygon such that performance is increased due
95* to not having to render the objects every frame. Instead, since all of the objects
96* in the group are replaced with a single texture, performance is saved by updating the texture
97* ONLY through handling a display event of name "MimicGroupUpdate". Whenever an object
98* placed in this group is modified, you must write code to emit a "MimicGroupUpdate" ObjectEvent
99* so that any changes made to its appearance will be reflected in the rendered texture.
100*
101* For example:
102* EmitObjectEvent( objectThatChanged, "MimicGroupUpdate" );
103*
104* Picking and event handling for objects within the GlsMimicGroup work the same as
105* for a regular Group, so it can contain interactive objects such as buttons, switches, etc.
106* The GlsMimicGroup will only redraw the texture when it receives a "MimicGroupUpdate"
107* ObjectEvent so you must write code to emit these events whenever a
108* press, toggle, etc. affect the appearance of the object.
109*
110* The GlsMimicGroup can contain 2D or 3D objects. All of these objects will be replaced
111* with a 2D texture polygon so the GlsMimicGroup is best suited for use with panels that are mostly 2D.
112* The GlsMimicGroup can also be useful with a collection of 3D objects as long as the
113* GlsMimicGroup remains screen-aligned.
114*
115* On older hardware that does not support the render-to-texture capabilities required by the
116* GlsMimicGroup, the GlsMimicGroup will fall-back to rendering like a regular Group.
117*/
118class GlsMimicGroup : public Group
119 , virtual public GlsPainter
120{
121private:
124
125public:
126 friend class GlsMimicGroupEditor;
127 DISTI_DEPRECATED( "This identifier is forbidden by the C++ standard. Use BaseClass instead." )
128 typedef Group _BaseClass; ///< Deprecated typedef for the base class.
129 typedef Group BaseClass; ///< Typedef for the base class.
130
131 /// Constructor
132 /// \param generateInstance Whether or not to generate an instance name for this mimic group.
133 GLSGEN_GLSMIMICGROUP_EXPORT GlsMimicGroup( bool generateInstance = false );
134
135 /// Copy constructor
136 /// \param that The object to copy from.
137 /// \param generateNames Whether or not to generate an instance name for this mimic group.
138 GLSGEN_GLSMIMICGROUP_EXPORT GlsMimicGroup( const GlsMimicGroup& that, const bool generateNames );
139
140 /**
141 * Destructs a GlsMimicGroup object
142 */
144
145 /// \return A pointer to a new GlsMimicGroup object.
147
151
152#ifndef GLES
155#endif
156
159
160 //////////////////////////////////////////////////
161 // GlsMimicGroup specific operations
162 //////////////////////////////////////////////////
163
164 /**
165 * Accessor for the mimic texture width.
166 *
167 * \return the width, in pixels, of the mimic texture.
168 */
169 virtual unsigned int TextureWidth() const { return _textureWidth; }
170
171 /**
172 * Set the mimic texture width.
173 *
174 * \param textureWidth the width, in pixels, of the mimic texture.
175 */
176 virtual GLSGEN_GLSMIMICGROUP_EXPORT void TextureWidth( unsigned int textureWidth );
177
178 /**
179 * Accessor for the mimic texture height.
180 *
181 * \return the height, in pixels, of the mimic texture.
182 */
183 virtual unsigned int TextureHeight() const { return _textureHeight; }
184
185 /**
186 * Set the mimic texture height.
187 *
188 * \param textureHeight the height, in pixels, of the mimic texture.
189 */
190 virtual GLSGEN_GLSMIMICGROUP_EXPORT void TextureHeight( unsigned int textureHeight );
191
192 /**
193 * Whether or not the mimic will render a depth buffer.
194 *
195 * \return true if the mimic will render a depth buffer.
196 */
197 virtual bool HasDepthBuffer() const { return _hasDepthBuffer; }
198
199 /**
200 * Set whether or not the mimic will render a depth buffer.
201 *
202 * \param hasDepthBuffer true if the mimic will render a depth buffer.
203 */
204 virtual GLSGEN_GLSMIMICGROUP_EXPORT void HasDepthBuffer( bool hasDepthBuffer );
205
206 /**
207 * Whether or not the mimic will generate mip maps.
208 *
209 * \return true if the mimic will generate mip maps.
210 */
211 virtual bool GenerateMipMaps() const { return _generateMipMaps; }
212
213 /**
214 * Set whether or not the mimic will generate mip maps.
215 *
216 * \param generate true if the mimic will generate mip maps.
217 */
218 virtual GLSGEN_GLSMIMICGROUP_EXPORT void GenerateMipMaps( bool generate );
219
220 /**
221 * Whether or not a mimic polygon will be drawn.
222 *
223 * \return true if a mimic polygon will be drawn.
224 */
225 virtual bool DrawMimicGroupPolygon() const { return _drawMimicGroupPolygon; }
226
227 /**
228 * Set whether or not a mimic polygon will be drawn.
229 *
230 * \param draw true if a mimic polygon will be drawn.
231 */
233
234 /// Whether the mimic scene region should fit to the group's bounding box.
235 /// \return true if the mimic scene region should be fit to the group's bounding box
236 virtual bool FitToBoundingBox() const { return _fitToBoundingBox; }
237
238 /// Set whether the mimic scene region should fit to the group's bounding box.
239 /// \param fit true if the mimic scene region should fit to the group's bounding box
241
242 /**
243 * Accessor for the mimic depth test settings.
244 *
245 * \return the depth settings
246 */
247 virtual unsigned char MimicGroupDepthTest() const { return _mimicGroupDepthTest; }
248
249 /**
250 * Set the mimic depth test settings.
251 *
252 * \param depthSettings the depth settings
253 */
254 virtual GLSGEN_GLSMIMICGROUP_EXPORT void MimicGroupDepthTest( unsigned char depthSettings );
255
256 /**
257 * Accessor for the mimic auto-redraw for conditional rendering settings.
258 *
259 * \return the depth settings
260 */
261 virtual bool AutoRedraw() const { return _autoRedraw; }
262
263 /**
264 * Set the mimic auto-redraw for conditional rendering.
265 *
266 * \param autoRedrawSetting the enable to automatically update.
267 */
268 virtual GLSGEN_GLSMIMICGROUP_EXPORT void AutoRedraw( bool autoRedrawSetting );
269
270 /**
271 * Accessor for the mimic scene background clear color.
272 *
273 * \return the RGBA color that the mimic will use to clear mimic scene background with
274 */
275 virtual GlsColor ClearColor() const { return _clearColor; }
276
277 /**
278 * Set the mimic scene background clear color.
279 *
280 * \param color the RGBA color that the mimic will use to clear mimic scene background with
281 */
282 virtual GLSGEN_GLSMIMICGROUP_EXPORT void ClearColor( const GlsColor& color );
283
284 /**
285 * Accessor for the GL Studio texture index the mimic will generate into.
286 *
287 * \return the GL Studio texture index the mimic will generate into. If -1, then mimic will generate its own texture.
288 */
289 virtual int AttachedTextureIndex() const { return _attachedTextureIndex; }
290
291 /**
292 * Set the GL Studio texture index the mimic will generate into.
293 *
294 * \param textureIndex the GL Studio texture index to generate mimic into. If -1, then mimic will generate its own texture.
295 */
296 virtual GLSGEN_GLSMIMICGROUP_EXPORT void AttachedTextureIndex( int textureIndex );
297
298 /**
299 * Whether or not the mimic is active for this group.
300 * If not active, mimic group behaves as a normal group
301 *
302 * \return true if mimic is active for this group
303 */
305
306 /**
307 * Sets if mimic is active for this group
308 * If not active, mimic group behaves as a normal group
309 *
310 * \param activate whether or not to activate the mimic
311 */
313
314 /**
315 * Set the bottom left corner of mimic scene region
316 *
317 * \param bottomLeftCorner (in object coordinates)
318 */
319 GLSGEN_GLSMIMICGROUP_EXPORT void BottomLeftCorner( const Vector& bottomLeftCorner );
320
321 /**
322 * Accessor for the bottom left corner coordinate of the mimic scene region.
323 *
324 * \return the bottom left corner of mimic scene region (in object coordinates)
325 */
327
328 /**
329 * Set the top right corner of mimic scene region
330 *
331 * \param topRightCorner (in object coordinates)
332 */
333 GLSGEN_GLSMIMICGROUP_EXPORT void TopRightCorner( const Vector& topRightCorner );
334
335 /**
336 * Accessor for the top right corner coordinate of the mimic scene region.
337 *
338 * \return the top right corner of mimic scene region (in object coordinates)
339 */
341
342 /**
343 * Whether or not the outline of the mimic polygon region should be shown in the editor.
344 *
345 * \return true if region should always be drawn in the editor
346 */
347 bool ShowOutline() const { return _showOutline; }
348
349 /**
350 * Set whether or not the mimic polygon region should always be drawn in the editor.
351 *
352 * \param showOutline true if outline should always be drawn in editor
353 */
354 GLSGEN_GLSMIMICGROUP_EXPORT void ShowOutline( bool showOutline );
355
356 /**
357 * Whether or not the mimic group needs to redraw.
358 *
359 * \return true if the mimic group needs to redraw.
360 */
361 bool Redraw() const { return _redraw; }
362
363 /**
364 * Set whether or not the mimic group needs to redraw
365 *
366 * \param redraw the new redraw value
367 */
369
370 /**
371 * Whether or not the mimic group texture is RGB.
372 *
373 * \return true if the mimic group texture is RGB.
374 */
375 bool UseOpaqueTexture() const { return _useOpaqueTexture; }
376
377 /**
378 * Set whether the mimic group texture is RGB or RGBA
379 *
380 * \param opaque true for RGB, false for RGBA
381 */
383
385
387 GLSGEN_GLSMIMICGROUP_EXPORT void InsertObject( DisplayObject* obj, bool reparent = true, bool recalculateBoundingbox = true, int loc = -1 ) DISTI_METHOD_OVERRIDE;
389
392
393protected:
394 /**
395 * Set up the matrices for the root of the mimic scene. The mimic scene is drawn without regard to any
396 * parent matrices of the mimic group.
397 */
399
400 /// Predraw case for when the mimic scene redraws.
401 /// \note Not normally called by users.
402 /// \param parentMatrices The parent draw matrices for this object (as passed into PreDraw).
403 /// \param culler The culler state for this object (as passed into PreDraw).
404 virtual GLSGEN_GLSMIMICGROUP_EXPORT void PreDrawMimicGroupChildren( const OpenGLMatrices& parentMatrices, Culler& culler );
405
406 /**
407 * Set depth buffer settings when rendering the mimic polygon
408 */
410
411 /**
412 * Get the four corners of the region transformed by the current DCS and offset by the group's location
413 *
414 * \param topLeftCorner [out] receives top left corner
415 * \param topRightCorner [out] receives top right corner
416 * \param bottomRightCorner [out] receives bottom right corner
417 * \param bottomLeftCorner [out] receives bottom left corner
418 */
419 GLSGEN_GLSMIMICGROUP_EXPORT void GetRegionCorners( Vector& topLeftCorner, Vector& topRightCorner, Vector& bottomRightCorner, Vector& bottomLeftCorner );
420
421 /**
422 * Apply texture settings for mimic polygon
423 */
425
426 /**
427 * Allocate and create the diffuse texture map
428 */
430
431 /**
432 * Allocate and create the depth texture map
433 */
435
436 /// Allocate and create the mimic quad.
438
439 /// Update the vertices of the mimic quad.
441
442 /// Delete the mimic quad (if it has been allocated).
444
445 /**
446 * Allocate and create the frame buffer
447 */
449
450 /**
451 * Delete the frame buffer (if it has been bound)
452 */
454
455 /**
456 * Redraw the scene
457 */
459
460 /**
461 * Draw the polygon for the mimic
462 */
464
465 /**
466 * Regenerate the mip maps
467 */
469
471
472 /**
473 * The GlsMimicGroup requres specific extensions of OpenGL which are not required
474 * elsewhere in GL Studio. This method will check that those features are supported.
475 *
476 * \return True if the required features are supported.
477 */
479
480 /**
481 * Logs the unsupported features that the GlsMimicGroup class requires to function properly.
482 */
484
485 /**
486 * Determines if vertex buffer objects are supported on this platform.
487 *
488 * \return True if vertex buffer objects are supported on this platform.
489 */
491
492 /**
493 * Draw the mimic group. Care should be taken to call this method only when it is safe to draw
494 * the mimic group. The Draw() has the conditional structure necessary to
495 * make this decision.
496 *
497 */
499
500#ifdef GLES
501 /**
502 * Set a single attribute from the GLO file.
503 *
504 * \param data The attribute to set and its associated data.
505 */
507#endif
508
509 bool _mimicGroupActive; ///< Whether or not the mimic is active. If not active, mimic group behaves as a normal group.
510 bool _autoRedraw; ///< Whether or not the mimic group should automatically update via conditional rendering.
511 bool _redraw; ///< Whether or not the mimic scene needs to redraw.
512 bool _hasDepthBuffer; ///< Whether or not the mimic will render a depth buffer.
513 bool _generateMipMaps; ///< Whether or not the mimic will generate mip maps.
514 bool _showOutline; ///< Outline is only visible in editor.
515 bool _drawMimicGroupPolygon; ///< Whether or not a mimic polygon will be drawn.
516 bool _fitToBoundingBox; ///< Whether the mimic scene region should fit to the group's bounding box.
517 unsigned char _mimicGroupDepthTest; ///< Mimic depth test settings (affects whether or not the mimic polygon is depth tested).
518 bool _textureIndexChanged; ///< Unused, kept for backward compatibility.
519 GlsColor _clearColor; ///< RGBA color to clear mimic scene background with.
520 Vector _bottomLeftCorner; ///< Bottom Left Corner of the mimic scene region.
521 Vector _topRightCorner; ///< Top Right Corner of the mimic scene region.
522 int _attachedTextureIndex; ///< GL Studio texture index to generate mimic into. If -1, then mimic will generate its own texture.
523 unsigned int _textureWidth; ///< Width of the mimic texture in pixels.
524 unsigned int _textureHeight; ///< Height of the mimic texture in pixels.
525 unsigned int _frameBufferHandle; ///< Handle for frame buffer object.
526 unsigned int _depthBufferHandle; ///< Handle for depth buffer object.
527 Image* _mimicGroupTexture; ///< Image object for texture.
528 unsigned int _vertexBufferHandle; ///< Vertex buffer handle for mimic quad.
529 bool _frameBuffersEnabledAndAttached; ///< True when frame buffer support is detected and frame buffers were attached successfully.
530 bool _useOpaqueTexture; ///< True if the atached frame buffer texture should be crated as GL_RGB, False will create the texture as GL_RGBA.
531
532 static bool _unsupportedLogged; ///< True if a warning has been logged to users that the mimic group feature is not supported. This keeps us from spamming the user about not being supported.
533};
534
535} // namespace disti
536
537#endif
Definition: cull.h:49
Definition: events.h:111
Definition: display.h:95
Definition: dynamic_array.h:79
Definition: gls_color.h:53
Definition: gls_glo_file.h:1241
Definition: gls_mimic_group.h:120
bool _fitToBoundingBox
Whether the mimic scene region should fit to the group's bounding box.
Definition: gls_mimic_group.h:516
bool _frameBuffersEnabledAndAttached
True when frame buffer support is detected and frame buffers were attached successfully.
Definition: gls_mimic_group.h:529
virtual void TextureHeight(unsigned int textureHeight)
void InsertObject(DisplayObject *obj, bool reparent=true, bool recalculateBoundingbox=true, int loc=-1) DISTI_METHOD_OVERRIDE
unsigned int _textureHeight
Height of the mimic texture in pixels.
Definition: gls_mimic_group.h:524
bool RequiredGlFeaturesSupported()
void UseOpaqueTexture(bool opaque)
void PushObject(DisplayObject *obj) DISTI_METHOD_OVERRIDE
void ApplyMimicGroupTextureSettings()
void SetValue(int spec, va_list &args) DISTI_METHOD_OVERRIDE
bool ShowOutline() const
Definition: gls_mimic_group.h:347
unsigned int _depthBufferHandle
Handle for depth buffer object.
Definition: gls_mimic_group.h:526
bool _showOutline
Outline is only visible in editor.
Definition: gls_mimic_group.h:514
bool _hasDepthBuffer
Whether or not the mimic will render a depth buffer.
Definition: gls_mimic_group.h:512
virtual void GenerateMipMaps(bool generate)
void ShowOutline(bool showOutline)
virtual unsigned char MimicGroupDepthTest() const
Definition: gls_mimic_group.h:247
virtual void AttachedTextureIndex(int textureIndex)
virtual void ClearColor(const GlsColor &color)
void CopyProperties(DisplayObject *src) DISTI_METHOD_OVERRIDE
virtual void DrawMimicGroupPolygon(bool draw)
void CalculateBoundingBox() DISTI_METHOD_OVERRIDE
virtual void AutoRedraw(bool autoRedrawSetting)
virtual GlsColor ClearColor() const
Definition: gls_mimic_group.h:275
bool _redraw
Whether or not the mimic scene needs to redraw.
Definition: gls_mimic_group.h:511
virtual void TextureWidth(unsigned int textureWidth)
DisplayObject * handle(DisplayEvent *displayEvent) DISTI_METHOD_OVERRIDE
bool _generateMipMaps
Whether or not the mimic will generate mip maps.
Definition: gls_mimic_group.h:513
void Redraw(bool redraw)
unsigned int _frameBufferHandle
Handle for frame buffer object.
Definition: gls_mimic_group.h:525
void SetAvailableAttributes(unsigned int value) DISTI_METHOD_OVERRIDE
Vector _topRightCorner
Top Right Corner of the mimic scene region.
Definition: gls_mimic_group.h:521
void GetCppInterfaceDescriptionFree(InterfaceListType *array) DISTI_METHOD_OVERRIDE
bool _mimicGroupActive
Whether or not the mimic is active. If not active, mimic group behaves as a normal group.
Definition: gls_mimic_group.h:509
void GetRegionCorners(Vector &topLeftCorner, Vector &topRightCorner, Vector &bottomRightCorner, Vector &bottomLeftCorner)
virtual unsigned int TextureWidth() const
Definition: gls_mimic_group.h:169
Vector TopRightCorner() const
Definition: gls_mimic_group.h:340
bool _textureIndexChanged
Unused, kept for backward compatibility.
Definition: gls_mimic_group.h:518
virtual bool FitToBoundingBox() const
Definition: gls_mimic_group.h:236
virtual void PreDrawMimicGroupChildren(const OpenGLMatrices &parentMatrices, Culler &culler)
void DeleteMimicGroupQuad()
Delete the mimic quad (if it has been allocated).
virtual void SetMatrices()
int _attachedTextureIndex
GL Studio texture index to generate mimic into. If -1, then mimic will generate its own texture.
Definition: gls_mimic_group.h:522
virtual void HasDepthBuffer(bool hasDepthBuffer)
bool Redraw() const
Definition: gls_mimic_group.h:361
bool UseOpaqueTexture() const
Definition: gls_mimic_group.h:375
virtual int AttachedTextureIndex() const
Definition: gls_mimic_group.h:289
GlsColor _clearColor
RGBA color to clear mimic scene background with.
Definition: gls_mimic_group.h:519
void UpdateMimicGroupQuad()
Update the vertices of the mimic quad.
unsigned char _mimicGroupDepthTest
Mimic depth test settings (affects whether or not the mimic polygon is depth tested).
Definition: gls_mimic_group.h:517
void MimicGroupActive(bool activate)
void SetupMimicGroupDepthTest()
static DisplayObject * CreateInstance()
void Draw() DISTI_METHOD_OVERRIDE
void Invalidate() DISTI_METHOD_OVERRIDE
Notify the painter that the scene needs to be redrawn.
virtual bool GenerateMipMaps() const
Definition: gls_mimic_group.h:211
bool IsInvalidated() const DISTI_METHOD_OVERRIDE
Vector _bottomLeftCorner
Bottom Left Corner of the mimic scene region.
Definition: gls_mimic_group.h:520
virtual void FitToBoundingBox(bool fit)
bool MimicGroupActive()
Definition: gls_mimic_group.h:304
void SetPainter(GlsPainter *painter) DISTI_METHOD_OVERRIDE
bool _drawMimicGroupPolygon
Whether or not a mimic polygon will be drawn.
Definition: gls_mimic_group.h:515
virtual bool HasDepthBuffer() const
Definition: gls_mimic_group.h:197
void BottomLeftCorner(const Vector &bottomLeftCorner)
bool _autoRedraw
Whether or not the mimic group should automatically update via conditional rendering.
Definition: gls_mimic_group.h:510
Image * _mimicGroupTexture
Image object for texture.
Definition: gls_mimic_group.h:527
virtual unsigned int TextureHeight() const
Definition: gls_mimic_group.h:183
bool _useOpaqueTexture
True if the atached frame buffer texture should be crated as GL_RGB, False will create the texture as...
Definition: gls_mimic_group.h:530
virtual bool DrawMimicGroupPolygon() const
Definition: gls_mimic_group.h:225
void CreateMimicGroupQuad()
Allocate and create the mimic quad.
DisplayObject * CloneObject(bool generateNames=false) DISTI_METHOD_OVERRIDE
virtual void MimicGroupDepthTest(unsigned char depthSettings)
unsigned int _vertexBufferHandle
Vertex buffer handle for mimic quad.
Definition: gls_mimic_group.h:528
static bool _unsupportedLogged
True if a warning has been logged to users that the mimic group feature is not supported....
Definition: gls_mimic_group.h:532
void TopRightCorner(const Vector &topRightCorner)
InterfaceListType * GetCppInterfaceDescription(InterfaceListType *addToThisList=NULL) DISTI_METHOD_OVERRIDE
bool VertexBuffersAreSupported()
virtual bool AutoRedraw() const
Definition: gls_mimic_group.h:261
unsigned int _textureWidth
Width of the mimic texture in pixels.
Definition: gls_mimic_group.h:523
Vector BottomLeftCorner()
Definition: gls_mimic_group.h:326
Definition: gls_painter.h:50
Definition: group.h:52
Definition: image.h:176
Class to contain current OpenGL view, projection and draw matrices.
Definition: util.h:540
Definition: vertex.h:84
Utility for common frame buffer support.
The gls_auto_lib.
Macros and helper code to determine what subset of C++11/14/17 is available.
#define DISTI_SPECIAL_MEM_FUN_DELETE
Macro to wrap function deletion, removed on compilers that don't support it.
Definition: gls_cpp_lang_support.h:245
#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
#define GLSGEN_GLSMIMICGROUP_EXPORT
Provides support for creating DLLs.
Definition: gls_mimic_group.h:57
The disti::Group class. Implements groups of objects.
The Image class. All textures are converted internally into Images.
Definition: bmpimage.h:46