| GL Studio C++ Runtime API

gls_painter.h
Go to the documentation of this file.
1/*! \file
2 \brief The GlsPainter interface
3
4 \par Copyright Information
5
6 Copyright (c) 2018 by The DiSTI Corporation.<br>
7 11301 Corporate Blvd; Suite 100<br>
8 Orlando, Florida 32817<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#ifndef INCLUDED_GLS_PAINTER_H
41#define INCLUDED_GLS_PAINTER_H
42
43#include "disti_include.h"
44#include "gls_cpp_lang_support.h"
45
46 namespace disti
47{
48/// Interface that can be implemented by a class that is the owner of a frame buffer (e.g. DisplayFrame or GlsMimicGroup).
49/// Used to notify the owner of the frame buffer that the contents of the scene has changed and needs to be redrawn.
50 class GlsPainter
51{
52 public:
53 /// Notify the painter that the scene needs to be redrawn.
54 virtual void Invalidate() = 0;
55
56 /// \return Whether or not the painter has already been invalidated.
57 virtual bool IsInvalidated() const = 0;
58
59 protected:
60 GlsPainter() {}
61 virtual ~GlsPainter() {}
62
63 private:
64 // Disable copying
65 GlsPainter( const GlsPainter& ) DISTI_SPECIAL_MEM_FUN_DELETE;
66 void operator=( const GlsPainter& ) DISTI_SPECIAL_MEM_FUN_DELETE;
67};
68} // namespace disti
69
70#endif
disti::GlsPainter
Definition: gls_painter.h:51
disti::GlsPainter::IsInvalidated
virtual bool IsInvalidated() const =0
disti::GlsPainter::Invalidate
virtual void Invalidate()=0
Notify the painter that the scene needs to be redrawn.
disti_include.h
A file for all GL Studio files to include.
gls_cpp_lang_support.h
Macros and helper code to determine what subset of C++11/14/17 is available.
DISTI_SPECIAL_MEM_FUN_DELETE
#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:246
disti
Definition: bmpimage.h:47