summaryrefslogtreecommitdiff
path: root/support/dktools/DkWxBufferedControl.cpt
blob: 3b78151c5b06c1a715e4f23a835015570be3e559 (plain)
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
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
%%	options

copyright owner	=	Dirk Krause
copyright year	=	2013-xxxx
license		=	bsd

%%	header

#include <dk3all.h>

#include <wx/wxprec.h>
#ifdef __BORLANDC__
#pragma hdrstop
#endif
#ifndef WX_PRECOMP
#include <wx/wx.h>
#endif

/**	This is a base class for triple-buffered views.
	Like double-buffering we write the windows contents
	to an image and finally transfer the entire image
	to the device context.
	Additionally we keep the image between the paint events
	and rebuild the image only if necessary (data to show
	has changed).

	When the frame containing your view becomes invisible
	(frame iconized or hidden) you should use the releaseBuffer()
	method to decrease the memory footprint of the program.

	In your derived class, call the DkWxBufferedControl constructors from
	the constructors.
	From Create() call DkWxBufferedControl::Create().

	You should also use DECLARE_DYNAMIC_CLASS() and
	IMPLEMENT_DYNAMIC_CLASS().
*/
class DkWxBufferedControl : public wxControl
{
  private:

    /**	Avoid simultaneous access from multiple threads.
    */
    wxMutex	 mxProtectData;

    /**	Bitmap for buffered drawing operations.
    */
    wxBitmap	*pBitmap;

    /**	Flag: Must redraw.
    */
    bool	 bMustDraw;

    /**	Bitmap width, window width.
    */
    int		 iWidth;

    /**	Bitmap height, window height.
    */
    int		 iHeight;

    /**	For RTTI.
    */
    DECLARE_DYNAMIC_CLASS(DkWxBufferedControl)

    /**	Event table.
    */
    DECLARE_EVENT_TABLE()

  protected:

    static wxChar const DkWxBufferedControlName[];

    /**	Internal method to paint.
    	This method saves some DC attributes and restores them
	before returning.
    	@param	pdc		Device context to draw to.
	@param	event		Paint event to process.
	@param	buffered	Flag: Operating on a memory DC.
	@param	clWidth		Client area width.
	@param	clHeight	Client area height.
    */
    void InternalPaint(
      wxDC &		pdc,
      wxPaintEvent &	event,
      bool		buffered,
      int		clWidth,
      int		clHeight
    );

  public:

    /**	Default constructor.
    */
    DkWxBufferedControl();

    /**	Constructor.
    	@param	pParent		Parent window.
	@param	wid		Window ID
	@param	pos		Window position.
	@param	size		Window size.
	@param	style		Window style.
	@param	validator	Validator for control.
	@param	name		Window type name.
    */
    DkWxBufferedControl(
      wxWindow 			*pParent,
      wxWindowID		 wid = wxID_ANY,
      const wxPoint &		 pos = wxDefaultPosition,
      const wxSize  &		 size = wxDefaultSize,
      long			 style = 0L,
      const wxValidator &	 validator = wxDefaultValidator,
      wxChar const		*name = DkWxBufferedControlName
    );

    /**	Create after using the default constructor.
    	@param	pParent		Parent window.
	@param	wid		Window ID
	@param	pos		Window position.
	@param	size		Window size.
	@param	style		Window style.
	@param	validator	Validator for control.
	@param	name		Window type name.
    */
    bool
    Create(
      wxWindow 			*pParent,
      wxWindowID		 wid = wxID_ANY,
      const wxPoint &		 pos = wxDefaultPosition,
      const wxSize  &		 size = wxDefaultSize,
      long			 style = 0L,
      const wxValidator	&	 validator = wxDefaultValidator,
      const wxChar		*name = DkWxBufferedControlName
    );

    /**	Destructor.
    */
    ~DkWxBufferedControl();

    /**	Indicate that data has changed so on next
    	paint we must rebuild the bitmap.
	@param	flag:	Flag to turn bMustDraw on or off.
    */
    void
    SetMustUpdate(bool flag = true);

    /**	Release bitmap buffer. This function should be called
    	when the frame or dialog containing this view is iconized
	or hidden.
    */
    void
    releaseBuffer(void);

    /**	Handler for erase background event.
    	@param	event	Event to process.
    */
    void
    OnErase(wxEraseEvent & event);

    /**	Handler for paint event.
    	@param	event	Event to process.
    */
    void
    OnPaint(wxPaintEvent & event);

    /**	Overwrite this method to do the real drawing.
    	@param	pdc		Device context to draw to.
				Normally a memory dc, but may be a direct
				dc in special situations (failed to allocate
				bitmap).
	@param	event		Paint event to process.
	@param	buffered	Flag: Operating on a memory DC.
	@param	clWidth		Client area width.
	@param	clHeight	Client area height.
    */
    virtual
    void PaintOperation(
      wxDC &		pdc,
      wxPaintEvent &	event,
      bool		buffered,
      int		clWidth,
      int		clHeight
    );

};

%%	module



#include "DkWxBufferedControl.h"


$!trace-include



wxChar const DkWxBufferedControl::DkWxBufferedControlName[] = {
  wxT("DkWxBufferedControl")
};


IMPLEMENT_DYNAMIC_CLASS(DkWxBufferedControl, wxControl)

BEGIN_EVENT_TABLE(DkWxBufferedControl,wxControl)
	EVT_ERASE_BACKGROUND(DkWxBufferedControl::OnErase)
	EVT_PAINT(DkWxBufferedControl::OnPaint)
END_EVENT_TABLE()



DkWxBufferedControl::DkWxBufferedControl()
{
  $? "+ DkWxBufferedControl::DkWxBufferedControl"
  pBitmap = NULL;
  iWidth = -1;
  iHeight = -1;
  bMustDraw = true;
  SetBackgroundStyle(wxBG_STYLE_CUSTOM);
  $? "- DkWxBufferedControl::DkWxBufferedControl"
}



bool
DkWxBufferedControl::Create(
  wxWindow 		*pParent,
  wxWindowID	 	 wid,
  const wxPoint &	 pos,
  const wxSize  &	 size,
  long		 	 style,
  const wxValidator &	 validator,
  wxChar const		*name
)
{
  bool back;
  back = wxControl::Create(
    pParent, wid, pos, size, style, validator, wxString(name)
  );
  pBitmap = NULL;
  iWidth = -1;
  iHeight = -1;
  bMustDraw = true;
  SetBackgroundStyle(wxBG_STYLE_CUSTOM);
  return back;
}



DkWxBufferedControl::DkWxBufferedControl(
  wxWindow 		*pParent,
  wxWindowID	 	 wid,
  const wxPoint &	 pos,
  const wxSize  &	 size,
  long		 	 style,
  const wxValidator &	 validator,
  wxChar const		*name
)
: wxControl(
  pParent,
  wid,
  pos,
  size,
  style,
  validator,
  wxString(name)
)
{
  $? "+ DkWxBufferedControl::DkWxBufferedControl"
  pBitmap = NULL;
  iWidth = -1;
  iHeight = -1;
  bMustDraw = true;
  SetBackgroundStyle(wxBG_STYLE_CUSTOM);
  $? "- DkWxBufferedControl::DkWxBufferedControl"
}



DkWxBufferedControl::~DkWxBufferedControl()
{
  $? "+ DkWxBufferedControl::~DkWxBufferedControl"
  {
    wxMutexLocker	lock(mxProtectData);
    if(NULL != pBitmap) {		$? ". delete bitmap buffer (destructor)"
      delete(pBitmap);
      pBitmap = NULL;
    }
    iWidth = -1;
    iHeight = -1;
    bMustDraw = false;
  }
  $? "- DkWxBufferedControl::~DkWxBufferedControl"
}



void
DkWxBufferedControl::OnErase(wxEraseEvent & event)
{
  $? "+ DkWxBufferedControl::OnErase"
  /* Do nothing here. */
  $? "- DkWxBufferedControl::OnErase"
}



void
DkWxBufferedControl::OnPaint(wxPaintEvent & event)
{
  bool		mustdraw = false;
  bool		done = false;
  int		w = 0;
  int		h = 0;
  $? "+ DkWxBufferedControl::OnPaint"
  wxPaintDC	paintDC(this);
  {
    wxMutexLocker lock(mxProtectData);
#if VERSION_BEFORE_20150821
    w = iWidth;
    h = iHeight;
#endif
    wxSize sz = GetClientSize();
    if(NULL != pBitmap) {
      if((iWidth != sz.x) || (iHeight != sz.y)) {
        delete(pBitmap);	$? ". delete bitmap buffer (size)"
	pBitmap = NULL;
	mustdraw = true;	$? ". bitmap size mismatch"
      }
    }
    w = iWidth = sz.x; h = iHeight = sz.y;
    if(NULL == pBitmap) {		$? ". allocate bitmap buffer"
      pBitmap = new wxBitmap(iWidth, iHeight);
      mustdraw = true;		$? ". new bitmap PTR=%d", TR_IPTR(pBitmap)
    }
    if(NULL != pBitmap) {	$? ". have bitmap"
      if(false == mustdraw) {
        if(bMustDraw) {		$? ". must redraw, requested"
	  mustdraw = true;
	}
      }
      if(mustdraw) {		$? ". must redraw, use bitmap"
	wxMemoryDC	memDC;
	memDC.SelectObject(*pBitmap);
	InternalPaint(memDC, event, true, w, h);
	memDC.SelectObject(wxNullBitmap);
        bMustDraw = false;	$? ". result saved in bitmap"
      } else {			$? ". simply use existing bitmap"
      }
      paintDC.DrawBitmap(*pBitmap, 0, 0, false);
      done = true;
    }
  }
  if(!(done)) {			$? ". paint unbuffered"
    InternalPaint(paintDC, event, false, w, h);
  } $? "- DkWxBufferedControl::OnPaint"
}



void
DkWxBufferedControl::PaintOperation(
  wxDC &		pdc,
  wxPaintEvent &	event,
  bool			buffered,
  int			clWidth,
  int			clHeight
)
{
  /* The default implementation intentionally does nothing. */
}



void
DkWxBufferedControl::InternalPaint(
  wxDC &		pdc,
  wxPaintEvent &	event,
  bool			buffered,
  int			clWidth,
  int			clHeight
)
{
  wxBrush	const	br	=	pdc.GetBrush();
  wxBrush	const	bg	=	pdc.GetBackground();
  wxFont	const	fn	=	pdc.GetFont();
  wxPen		const	pn	=	pdc.GetPen();
  wxColour	const	tbg	=	pdc.GetTextBackground();
  wxColour	const	tfg	=	pdc.GetTextForeground();
  int			bgm	=	pdc.GetBackgroundMode();
  $? "+ DkWxBufferedControl::InternalPaint"
  PaintOperation(pdc, event, buffered, clWidth, clHeight);

  pdc.SetBackgroundMode(bgm);
  pdc.SetTextForeground(tfg);
  pdc.SetTextBackground(tbg);
  pdc.SetPen(pn);
  pdc.SetFont(fn);
  pdc.SetBackground(bg);
  pdc.SetBrush(br);
  $? "- DkWxBufferedControl::InternalPaint"
}



void
DkWxBufferedControl::SetMustUpdate(bool flag)
{
  $? "+ DkWxBufferedControl::SetMustUpdate"
  {
    wxMutexLocker	lock(mxProtectData);
    bMustDraw = flag;
  }
  $? "- DkWxBufferedControl::SetMustUpdate"
}



void
DkWxBufferedControl::releaseBuffer(void)
{
  $? "+ DkWxBufferedControl::releaseBuffer"
  {
    wxMutexLocker	lock(mxProtectData);
    if(pBitmap) {		$? ". delete bitmap buffer (explicit release)"
      delete(pBitmap);
      pBitmap = NULL;
    }
  } $? "- DkWxBufferedControl::releaseBuffer"
}