summaryrefslogtreecommitdiff
path: root/NxWidgets/libnxwidgets/include/crectcache.hxx
blob: f38c2313bdf660a35b4584915bf19b1157c2637b (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
/****************************************************************************
 * NxWidgets/libnxwidgets/include/crectcache.hxx
 *
 *   Copyright (C) 2012 Gregory Nutt. All rights reserved.
 *   Author: Gregory Nutt <gnutt@nuttx.org>
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 * 3. Neither the name NuttX, NxWidgets, nor the names of its contributors
 *    me be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 ****************************************************************************
 *
 * Portions of this package derive from Woopsi (http://woopsi.org/) and
 * portions are original efforts.  It is difficult to determine at this
 * point what parts are original efforts and which parts derive from Woopsi.
 * However, in any event, the work of  Antony Dzeryn will be acknowledged
 * in most NxWidget files.  Thanks Antony!
 *
 *   Copyright (c) 2007-2011, Antony Dzeryn
 *   All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * * Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * * Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 * * Neither the names "Woopsi", "Simian Zombie" nor the
 *   names of its contributors may be used to endorse or promote products
 *   derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY Antony Dzeryn ``AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL Antony Dzeryn BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 ****************************************************************************/

#ifndef __INCLUDE_CRECTCACHE_HXX
#define __INCLUDE_CRECTCACHE_HXX

/****************************************************************************
 * Included Files
 ****************************************************************************/
 
#include <nuttx/config.h>

#include <stdint.h>
#include <stdbool.h>

#include <nuttx/nx/nxglib.h>

#include "cnxwidget.hxx"
#include "cwidgetstyle.hxx"
#include "tnxarray.hxx"

/****************************************************************************
 * Pre-Processor Definitions
 ****************************************************************************/
 
/****************************************************************************
 * Implementation Classes
 ****************************************************************************/
 
#if defined(__cplusplus)

namespace NXWidgets
{
  /**
   * Maintains a list of foreground (ie. above children) and background (with
   * child overlapped-rects removed) rectangles representing the visible portions
   * of a widget.
   */

  class CRectCache
  {
  private:
    TNxArray<CRect> m_foregroundRegions; /**< List of the widget's visible regions */
    TNxArray<CRect> m_backgroundRegions; /**< List of the widget's visible regions with child rects removed */
    const CNxWidget *m_widget;           /**< Owning widget */
    bool m_foregroundInvalid;            /**< True if the foreground cache needs refreshing */
    bool m_backgroundInvalid;            /**< True if the background cache needs refreshing */

    /**
     * Cache the foreground regions.
     */

    void cacheForegroundRegions(void);

    /**
     * Cache the background regions.
     */

    void cacheBackgroundRegions(void);

  public:

    /**
     * Constructor.
     *
     * @param widget Widget that contains the rect cache.
     */

    CRectCache(const CNxWidget *widget);

    /**
     * Destructor.
     */

    inline ~CRectCache() { }

    /**
     * Rebuild the cache if it is invalid.
     */

    void cache(void);

    /**
     * Invalidates the cache.
     */

    inline void invalidate(void)
    {
      m_foregroundInvalid = true;
      m_backgroundInvalid = true;
    };

    /**
     * Return the list of background regions.  These are regions that are not overlapped by
     * child widgets.
     *
     * @return The list of background regions.
     */

    inline TNxArray<CRect> *getBackgroundRegions(void)
    {
      return &m_backgroundRegions;
    }

    /**
     * Return the list of foreground regions.  These are regions that represent the entire
     * visible surface of the widget - that is, any regions not overlapped by ancestors or
     * sublings of the widget - including any regions that are actually overlapped by
     * child widgets.
     *
     * @return The list of foreground regions.
     */

    inline TNxArray<CRect> *getForegroundRegions(void)
    {
      return &m_foregroundRegions;
    }

    /**
     * Works out which rectangles in the invalidRects list overlap this
     * widget, then cuts the rectangles into smaller pieces.  The overlapping
     * pieces are pushed into validRects, and the non-overlapping pieces are
     * pushed back into the invalidRects vector.
     *
     * @param invalidRects A vector of regions that need to be tested
     * for collisions against this widget; they represent regions that need
     * to be redrawn.
     * @param validRects A vector of regions that represents areas of the
     * display that do not need to be redrawn.
     * @param sender Pointer to the widget that initiated the split.
     */

    void splitRectangles(TNxArray<CRect> *invalidRects,
                         TNxArray<CRect> *validRects,
                         FAR const CNxWidget *sender) const;

    /**
     * Move any rectangles from the visibleRects list that overlap this widget
     * into the invisibleRects list.  Used during visible region calculations.
     *
     * @param visibleRects A vector of regions that are not overlapped.
     * @param invisibleRects A vector of regions that are overlapped.
     * @param widget The widget that requested the lists.
     * @see splitRectangles()
     */

    void removeOverlappedRects(TNxArray<CRect> *visibleRects,
                               TNxArray<CRect> *invisibleRects,
                               FAR const CNxWidget* widget) const;
  };
}

#endif // __cplusplus

#endif // __INCLUDE_CRECTCACHE_HXX