libjuce-doc 4.3.0~repack-1 / usr / share / doc / libjuce / apiref / classRectanglePlacement.html

This file is indexed.

/usr/share/doc/libjuce/apiref/classRectanglePlacement.html is in libjuce-doc 4.3.0~repack-1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  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
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.12"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>JUCE: RectanglePlacement Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">JUCE
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.12 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classRectanglePlacement-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">RectanglePlacement Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Defines the method used to postion some kind of rectangular object within a rectangular viewport.  
 <a href="classRectanglePlacement.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:afd5464553fd6bb41d697f3fc1d7427ed"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRectanglePlacement.html#afd5464553fd6bb41d697f3fc1d7427ed">Flags</a> { <br />
&#160;&#160;<a class="el" href="classRectanglePlacement.html#afd5464553fd6bb41d697f3fc1d7427edae2539f35e48e3c7396cffeb8079e27dd">xLeft</a> = 1, 
<a class="el" href="classRectanglePlacement.html#afd5464553fd6bb41d697f3fc1d7427eda72a92773894d10ec3b4ff55b56d08915">xRight</a> = 2, 
<a class="el" href="classRectanglePlacement.html#afd5464553fd6bb41d697f3fc1d7427edad1348e06780084037a29fc0621d10392">xMid</a> = 4, 
<a class="el" href="classRectanglePlacement.html#afd5464553fd6bb41d697f3fc1d7427eda1b650115227b059f9eb2c07ecdfcb3ad">yTop</a> = 8, 
<br />
&#160;&#160;<a class="el" href="classRectanglePlacement.html#afd5464553fd6bb41d697f3fc1d7427eda467435011959541ca61cc362640db547">yBottom</a> = 16, 
<a class="el" href="classRectanglePlacement.html#afd5464553fd6bb41d697f3fc1d7427eda8bfb9c8cceb359b4f00a9839168a7769">yMid</a> = 32, 
<a class="el" href="classRectanglePlacement.html#afd5464553fd6bb41d697f3fc1d7427eda592b34ff9ad1d85db16f2e02c6252b8b">stretchToFit</a> = 64, 
<a class="el" href="classRectanglePlacement.html#afd5464553fd6bb41d697f3fc1d7427edaace05e9cfe83bb3dbbef781d3622cd62">fillDestination</a> = 128, 
<br />
&#160;&#160;<a class="el" href="classRectanglePlacement.html#afd5464553fd6bb41d697f3fc1d7427eda32d2c8f0142b82c188af878548f4d238">onlyReduceInSize</a> = 256, 
<a class="el" href="classRectanglePlacement.html#afd5464553fd6bb41d697f3fc1d7427eda54aea49f09ca4f2ac6e5c81859067b7d">onlyIncreaseInSize</a> = 512, 
<a class="el" href="classRectanglePlacement.html#afd5464553fd6bb41d697f3fc1d7427eda1b4035a6dd90fd7ecf4b2014f33bf16f">doNotResize</a> = (onlyIncreaseInSize | onlyReduceInSize), 
<a class="el" href="classRectanglePlacement.html#afd5464553fd6bb41d697f3fc1d7427edadf52ee04f4f43cfcc6049d49833dd946">centred</a> = 4 + 32
<br />
 }<tr class="memdesc:afd5464553fd6bb41d697f3fc1d7427ed"><td class="mdescLeft">&#160;</td><td class="mdescRight">Flag values that can be combined and used in the constructor.  <a href="classRectanglePlacement.html#afd5464553fd6bb41d697f3fc1d7427ed">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:afd5464553fd6bb41d697f3fc1d7427ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:af614522b9cccb64e01cec1d369883327"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRectanglePlacement.html#af614522b9cccb64e01cec1d369883327">RectanglePlacement</a> (int placementFlags) noexcept</td></tr>
<tr class="memdesc:af614522b9cccb64e01cec1d369883327"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a <a class="el" href="classRectanglePlacement.html" title="Defines the method used to postion some kind of rectangular object within a rectangular viewport...">RectanglePlacement</a> object using a combination of flags from the Flags enum.  <a href="#af614522b9cccb64e01cec1d369883327">More...</a><br /></td></tr>
<tr class="separator:af614522b9cccb64e01cec1d369883327"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a056e798a9bd29ece5ca308fd0dd05311"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRectanglePlacement.html#a056e798a9bd29ece5ca308fd0dd05311">RectanglePlacement</a> () noexcept</td></tr>
<tr class="memdesc:a056e798a9bd29ece5ca308fd0dd05311"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a default <a class="el" href="classRectanglePlacement.html" title="Defines the method used to postion some kind of rectangular object within a rectangular viewport...">RectanglePlacement</a> object, which is equivalent to using the 'centred' flag.  <a href="#a056e798a9bd29ece5ca308fd0dd05311">More...</a><br /></td></tr>
<tr class="separator:a056e798a9bd29ece5ca308fd0dd05311"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a014706d22f3c06af57a2f839056dede3"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRectanglePlacement.html#a014706d22f3c06af57a2f839056dede3">RectanglePlacement</a> (const <a class="el" href="classRectanglePlacement.html">RectanglePlacement</a> &amp;) noexcept</td></tr>
<tr class="memdesc:a014706d22f3c06af57a2f839056dede3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a copy of another <a class="el" href="classRectanglePlacement.html" title="Defines the method used to postion some kind of rectangular object within a rectangular viewport...">RectanglePlacement</a> object.  <a href="#a014706d22f3c06af57a2f839056dede3">More...</a><br /></td></tr>
<tr class="separator:a014706d22f3c06af57a2f839056dede3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa99d3307746ed7b0c4ccae4b9d6d4563"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classRectanglePlacement.html">RectanglePlacement</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRectanglePlacement.html#aa99d3307746ed7b0c4ccae4b9d6d4563">operator=</a> (const <a class="el" href="classRectanglePlacement.html">RectanglePlacement</a> &amp;) noexcept</td></tr>
<tr class="memdesc:aa99d3307746ed7b0c4ccae4b9d6d4563"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copies another <a class="el" href="classRectanglePlacement.html" title="Defines the method used to postion some kind of rectangular object within a rectangular viewport...">RectanglePlacement</a> object.  <a href="#aa99d3307746ed7b0c4ccae4b9d6d4563">More...</a><br /></td></tr>
<tr class="separator:aa99d3307746ed7b0c4ccae4b9d6d4563"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3e64ce2434904316db91dee5d1029673"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRectanglePlacement.html#a3e64ce2434904316db91dee5d1029673">operator==</a> (const <a class="el" href="classRectanglePlacement.html">RectanglePlacement</a> &amp;) const noexcept</td></tr>
<tr class="separator:a3e64ce2434904316db91dee5d1029673"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad3ac2e1667bc4a2e618782101051f03e"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRectanglePlacement.html#ad3ac2e1667bc4a2e618782101051f03e">operator!=</a> (const <a class="el" href="classRectanglePlacement.html">RectanglePlacement</a> &amp;) const noexcept</td></tr>
<tr class="separator:ad3ac2e1667bc4a2e618782101051f03e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa1e343a06d0a81d560093dd27ecd560f"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRectanglePlacement.html#aa1e343a06d0a81d560093dd27ecd560f">getFlags</a> () const noexcept</td></tr>
<tr class="memdesc:aa1e343a06d0a81d560093dd27ecd560f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the raw flags that are set for this object.  <a href="#aa1e343a06d0a81d560093dd27ecd560f">More...</a><br /></td></tr>
<tr class="separator:aa1e343a06d0a81d560093dd27ecd560f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa1e542a01a80f5f7a53399dd2ee385a6"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRectanglePlacement.html#aa1e542a01a80f5f7a53399dd2ee385a6">testFlags</a> (int flagsToTest) const noexcept</td></tr>
<tr class="memdesc:aa1e542a01a80f5f7a53399dd2ee385a6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tests a set of flags for this object.  <a href="#aa1e542a01a80f5f7a53399dd2ee385a6">More...</a><br /></td></tr>
<tr class="separator:aa1e542a01a80f5f7a53399dd2ee385a6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1d2340aa383cee6dc141805ae680369d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRectanglePlacement.html#a1d2340aa383cee6dc141805ae680369d">applyTo</a> (double &amp;sourceX, double &amp;sourceY, double &amp;sourceW, double &amp;sourceH, double destinationX, double destinationY, double destinationW, double destinationH) const noexcept</td></tr>
<tr class="memdesc:a1d2340aa383cee6dc141805ae680369d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adjusts the position and size of a rectangle to fit it into a space.  <a href="#a1d2340aa383cee6dc141805ae680369d">More...</a><br /></td></tr>
<tr class="separator:a1d2340aa383cee6dc141805ae680369d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9ff073c34db65b921d8202300b9c115c"><td class="memTemplParams" colspan="2">template&lt;typename ValueType &gt; </td></tr>
<tr class="memitem:a9ff073c34db65b921d8202300b9c115c"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classRectangle.html">Rectangle</a>&lt; ValueType &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classRectanglePlacement.html#a9ff073c34db65b921d8202300b9c115c">appliedTo</a> (const <a class="el" href="classRectangle.html">Rectangle</a>&lt; ValueType &gt; &amp;source, const <a class="el" href="classRectangle.html">Rectangle</a>&lt; ValueType &gt; &amp;destination) const noexcept</td></tr>
<tr class="memdesc:a9ff073c34db65b921d8202300b9c115c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the rectangle that should be used to fit the given source rectangle into the destination rectangle using the current flags.  <a href="#a9ff073c34db65b921d8202300b9c115c">More...</a><br /></td></tr>
<tr class="separator:a9ff073c34db65b921d8202300b9c115c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a27ee84d4a5b441246af03be6c20763df"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classAffineTransform.html">AffineTransform</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRectanglePlacement.html#a27ee84d4a5b441246af03be6c20763df">getTransformToFit</a> (const <a class="el" href="classRectangle.html">Rectangle</a>&lt; float &gt; &amp;source, const <a class="el" href="classRectangle.html">Rectangle</a>&lt; float &gt; &amp;destination) const noexcept</td></tr>
<tr class="memdesc:a27ee84d4a5b441246af03be6c20763df"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the transform that should be applied to these source coordinates to fit them into the destination rectangle using the current flags.  <a href="#a27ee84d4a5b441246af03be6c20763df">More...</a><br /></td></tr>
<tr class="separator:a27ee84d4a5b441246af03be6c20763df"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Defines the method used to postion some kind of rectangular object within a rectangular viewport. </p>
<p>Although similar to <a class="el" href="classJustification.html" title="Represents a type of justification to be used when positioning graphical items. ">Justification</a>, this is more specific, and has some extra options. </p>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a id="afd5464553fd6bb41d697f3fc1d7427ed"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afd5464553fd6bb41d697f3fc1d7427ed">&sect;&nbsp;</a></span>Flags</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="classRectanglePlacement.html#afd5464553fd6bb41d697f3fc1d7427ed">RectanglePlacement::Flags</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Flag values that can be combined and used in the constructor. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="afd5464553fd6bb41d697f3fc1d7427edae2539f35e48e3c7396cffeb8079e27dd"></a>xLeft&#160;</td><td class="fielddoc"><p>Indicates that the source rectangle's left edge should be aligned with the left edge of the target rectangle. </p>
</td></tr>
<tr><td class="fieldname"><a id="afd5464553fd6bb41d697f3fc1d7427eda72a92773894d10ec3b4ff55b56d08915"></a>xRight&#160;</td><td class="fielddoc"><p>Indicates that the source rectangle's right edge should be aligned with the right edge of the target rectangle. </p>
</td></tr>
<tr><td class="fieldname"><a id="afd5464553fd6bb41d697f3fc1d7427edad1348e06780084037a29fc0621d10392"></a>xMid&#160;</td><td class="fielddoc"><p>Indicates that the source should be placed in the centre between the left and right sides of the available space. </p>
</td></tr>
<tr><td class="fieldname"><a id="afd5464553fd6bb41d697f3fc1d7427eda1b650115227b059f9eb2c07ecdfcb3ad"></a>yTop&#160;</td><td class="fielddoc"><p>Indicates that the source's top edge should be aligned with the top edge of the destination rectangle. </p>
</td></tr>
<tr><td class="fieldname"><a id="afd5464553fd6bb41d697f3fc1d7427eda467435011959541ca61cc362640db547"></a>yBottom&#160;</td><td class="fielddoc"><p>Indicates that the source's bottom edge should be aligned with the bottom edge of the destination rectangle. </p>
</td></tr>
<tr><td class="fieldname"><a id="afd5464553fd6bb41d697f3fc1d7427eda8bfb9c8cceb359b4f00a9839168a7769"></a>yMid&#160;</td><td class="fielddoc"><p>Indicates that the source should be placed in the centre between the top and bottom sides of the available space. </p>
</td></tr>
<tr><td class="fieldname"><a id="afd5464553fd6bb41d697f3fc1d7427eda592b34ff9ad1d85db16f2e02c6252b8b"></a>stretchToFit&#160;</td><td class="fielddoc"><p>If this flag is set, then the source rectangle will be resized to completely fill the destination rectangle, and all other flags are ignored. </p>
</td></tr>
<tr><td class="fieldname"><a id="afd5464553fd6bb41d697f3fc1d7427edaace05e9cfe83bb3dbbef781d3622cd62"></a>fillDestination&#160;</td><td class="fielddoc"><p>If this flag is set, then the source rectangle will be resized so that it is the minimum size to completely fill the destination rectangle, without changing its aspect ratio. </p>
<p>This means that some of the source rectangle may fall outside the destination.</p>
<p>If this flag is not set, the source will be given the maximum size at which none of it falls outside the destination rectangle. </p>
</td></tr>
<tr><td class="fieldname"><a id="afd5464553fd6bb41d697f3fc1d7427eda32d2c8f0142b82c188af878548f4d238"></a>onlyReduceInSize&#160;</td><td class="fielddoc"><p>Indicates that the source rectangle can be reduced in size if required, but should never be made larger than its original size. </p>
</td></tr>
<tr><td class="fieldname"><a id="afd5464553fd6bb41d697f3fc1d7427eda54aea49f09ca4f2ac6e5c81859067b7d"></a>onlyIncreaseInSize&#160;</td><td class="fielddoc"><p>Indicates that the source rectangle can be enlarged if required, but should never be made smaller than its original size. </p>
</td></tr>
<tr><td class="fieldname"><a id="afd5464553fd6bb41d697f3fc1d7427eda1b4035a6dd90fd7ecf4b2014f33bf16f"></a>doNotResize&#160;</td><td class="fielddoc"><p>Indicates that the source rectangle's size should be left unchanged. </p>
</td></tr>
<tr><td class="fieldname"><a id="afd5464553fd6bb41d697f3fc1d7427edadf52ee04f4f43cfcc6049d49833dd946"></a>centred&#160;</td><td class="fielddoc"><p>A shorthand value that is equivalent to (xMid | yMid). </p>
</td></tr>
</table>

</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="af614522b9cccb64e01cec1d369883327"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af614522b9cccb64e01cec1d369883327">&sect;&nbsp;</a></span>RectanglePlacement() <span class="overload">[1/3]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">RectanglePlacement::RectanglePlacement </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>placementFlags</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Creates a <a class="el" href="classRectanglePlacement.html" title="Defines the method used to postion some kind of rectangular object within a rectangular viewport...">RectanglePlacement</a> object using a combination of flags from the Flags enum. </p>

</div>
</div>
<a id="a056e798a9bd29ece5ca308fd0dd05311"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a056e798a9bd29ece5ca308fd0dd05311">&sect;&nbsp;</a></span>RectanglePlacement() <span class="overload">[2/3]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">RectanglePlacement::RectanglePlacement </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Creates a default <a class="el" href="classRectanglePlacement.html" title="Defines the method used to postion some kind of rectangular object within a rectangular viewport...">RectanglePlacement</a> object, which is equivalent to using the 'centred' flag. </p>

<p>References <a class="el" href="juce__Variant_8h.html#a558cef5eaa37c85f916d0b6e7cdea20b">operator!=()</a>, and <a class="el" href="juce__Variant_8h.html#a6cfbc139216a6498771c6b8212d9d175">operator==()</a>.</p>

</div>
</div>
<a id="a014706d22f3c06af57a2f839056dede3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a014706d22f3c06af57a2f839056dede3">&sect;&nbsp;</a></span>RectanglePlacement() <span class="overload">[3/3]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">RectanglePlacement::RectanglePlacement </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classRectanglePlacement.html">RectanglePlacement</a> &amp;&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Creates a copy of another <a class="el" href="classRectanglePlacement.html" title="Defines the method used to postion some kind of rectangular object within a rectangular viewport...">RectanglePlacement</a> object. </p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="aa99d3307746ed7b0c4ccae4b9d6d4563"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa99d3307746ed7b0c4ccae4b9d6d4563">&sect;&nbsp;</a></span>operator=()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classRectanglePlacement.html">RectanglePlacement</a>&amp; RectanglePlacement::operator= </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classRectanglePlacement.html">RectanglePlacement</a> &amp;&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Copies another <a class="el" href="classRectanglePlacement.html" title="Defines the method used to postion some kind of rectangular object within a rectangular viewport...">RectanglePlacement</a> object. </p>

</div>
</div>
<a id="a3e64ce2434904316db91dee5d1029673"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3e64ce2434904316db91dee5d1029673">&sect;&nbsp;</a></span>operator==()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool RectanglePlacement::operator== </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classRectanglePlacement.html">RectanglePlacement</a> &amp;&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a id="ad3ac2e1667bc4a2e618782101051f03e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad3ac2e1667bc4a2e618782101051f03e">&sect;&nbsp;</a></span>operator!=()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool RectanglePlacement::operator!= </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classRectanglePlacement.html">RectanglePlacement</a> &amp;&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a id="aa1e343a06d0a81d560093dd27ecd560f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa1e343a06d0a81d560093dd27ecd560f">&sect;&nbsp;</a></span>getFlags()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">int RectanglePlacement::getFlags </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Returns the raw flags that are set for this object. </p>

</div>
</div>
<a id="aa1e542a01a80f5f7a53399dd2ee385a6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa1e542a01a80f5f7a53399dd2ee385a6">&sect;&nbsp;</a></span>testFlags()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool RectanglePlacement::testFlags </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>flagsToTest</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Tests a set of flags for this object. </p>
<dl class="section return"><dt>Returns</dt><dd>true if any of the flags passed in are set on this object. </dd></dl>

</div>
</div>
<a id="a1d2340aa383cee6dc141805ae680369d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1d2340aa383cee6dc141805ae680369d">&sect;&nbsp;</a></span>applyTo()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void RectanglePlacement::applyTo </td>
          <td>(</td>
          <td class="paramtype">double &amp;&#160;</td>
          <td class="paramname"><em>sourceX</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double &amp;&#160;</td>
          <td class="paramname"><em>sourceY</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double &amp;&#160;</td>
          <td class="paramname"><em>sourceW</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double &amp;&#160;</td>
          <td class="paramname"><em>sourceH</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>destinationX</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>destinationY</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>destinationW</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>destinationH</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Adjusts the position and size of a rectangle to fit it into a space. </p>
<p>The source rectangle coordinates will be adjusted so that they fit into the destination rectangle based on this object's flags. </p>

</div>
</div>
<a id="a9ff073c34db65b921d8202300b9c115c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9ff073c34db65b921d8202300b9c115c">&sect;&nbsp;</a></span>appliedTo()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename ValueType &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classRectangle.html">Rectangle</a>&lt;ValueType&gt; RectanglePlacement::appliedTo </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classRectangle.html">Rectangle</a>&lt; ValueType &gt; &amp;&#160;</td>
          <td class="paramname"><em>source</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classRectangle.html">Rectangle</a>&lt; ValueType &gt; &amp;&#160;</td>
          <td class="paramname"><em>destination</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Returns the rectangle that should be used to fit the given source rectangle into the destination rectangle using the current flags. </p>

</div>
</div>
<a id="a27ee84d4a5b441246af03be6c20763df"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a27ee84d4a5b441246af03be6c20763df">&sect;&nbsp;</a></span>getTransformToFit()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classAffineTransform.html">AffineTransform</a> RectanglePlacement::getTransformToFit </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classRectangle.html">Rectangle</a>&lt; float &gt; &amp;&#160;</td>
          <td class="paramname"><em>source</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classRectangle.html">Rectangle</a>&lt; float &gt; &amp;&#160;</td>
          <td class="paramname"><em>destination</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Returns the transform that should be applied to these source coordinates to fit them into the destination rectangle using the current flags. </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="juce__RectanglePlacement_8h.html">juce_RectanglePlacement.h</a></li>
</ul>
</div><!-- contents -->
<hr class="footer"/>
<address class="footer"><small>All content &copy ROLI Ltd.</small></address><br/>
</body>
</html>

APT Browse - Built by Thomas Orozco.