Repository navigation
Expand file tree
/
Copy pathGeometry.hpp
More file actions
839 lines (679 loc) · 19.9 KB
/
Copy pathGeometry.hpp
File metadata and controls
839 lines (679 loc) · 19.9 KB
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
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
7
10000
68
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
/*
* DISTRHO Plugin Framework (DPF)
* Copyright (C) 2012-2021 Filipe Coelho <falktx@falktx.com>
*
* Permission to use, copy, modify, and/or distribute this software for any purpose with
* or without fee is hereby granted, provided that the above copyright notice and this
* permission notice appear in all copies.
*
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD
* TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN
* NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
* DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER
* IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
* CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
#ifndef DGL_GEOMETRY_HPP_INCLUDED
#define DGL_GEOMETRY_HPP_INCLUDED
#include "Base.hpp"
START_NAMESPACE_DGL
// --------------------------------------------------------------------------------------------------------------------
// Forward class names
template<typename> class Line;
template<typename> class Circle;
template<typename> class Triangle;
template<typename> class Rectangle;
// --------------------------------------------------------------------------------------------------------------------
/**
DGL Point class.
This class describes a single point in space, defined by an X and Y value.
*/
template<typename T>
class Point
{
public:
/**
Constructor for (0, 0) point.
*/
Point() noexcept;
/**
Constructor using custom X and Y values.
*/
Point(const T& x, const T& y) noexcept;
/**
Constructor using another Point class values.
*/
Point(const Point<T>& pos) noexcept;
/**
Get X value.
*/
const T& getX() const noexcept;
/**
Get Y value.
*/
const T& getY() const noexcept;
/**
Set X value to @a x.
*/
void setX(const T& x) noexcept;
/**
Set Y value to @a y.
*/
void setY(const T& y) noexcept;
/**
Set X and Y values to @a x and @a y respectively.
*/
void setPos(const T& x, const T& y) noexcept;
/**
Set X and Y values according to @a pos.
*/
void setPos(const Point<T>& pos) noexcept;
/**
Move this point by @a x and @a y values.
*/
void moveBy(const T& x, const T& y) noexcept;
/**
Move this point by @a pos.
*/
void moveBy(const Point<T>& pos) noexcept;
/**
Return true if point is (0, 0).
*/
bool isZero() const noexcept;
/**
Return true if point is not (0, 0).
*/
bool isNotZero() const noexcept;
Point<T> operator+(const Point<T>& pos) noexcept;
Point<T> operator-(const Point<T>& pos) noexcept;
Point<T>& operator=(const Point<T>& pos) noexcept;
Point<T>& operator+=(const Point<T>& pos) noexcept;
Point<T>& operator-=(const Point<T>& pos) noexcept;
bool operator==(const Point<T>& pos) const noexcept;
bool operator!=(const Point<T>& pos) const noexcept;
private:
T x, y;
template<typename> friend class Line;
template<typename> friend class Circle;
template<typename> friend class Triangle;
template<typename> friend class Rectangle;
};
// --------------------------------------------------------------------------------------------------------------------
/**
DGL Size class.
This class describes a size, defined by a width and height value.
*/
template<typename T>
class Size
{
public:
/**
Constructor for null size (0x0).
*/
Size() noexcept;
/**
Constructor using custom width and height values.
*/
Size(const T& width, const T& height) noexcept;
/**
Constructor using another Size class values.
*/
Size(const Size<T>& size) noexcept;
/**
Get width.
*/
const T& getWidth() const noexcept;
/**
Get height.
*/
const T& getHeight() const noexcept;
/**
Set width.
*/
void setWidth(const T& width) noexcept;
/**
Set height.
*/
void setHeight(const T& height) noexcept;
/**
Set size to @a width and @a height.
*/
void setSize(const T& width, const T& height) noexcept;
/**
Set size.
*/
void setSize(const Size<T>& size) noexcept;
/**
Grow size by @a multiplier.
*/
void growBy(double multiplier) noexcept;
/**
Shrink size by @a divider.
*/
void shrinkBy(double divider) noexcept;
/**
Return true if size is null (0x0).
An null size is also invalid.
*/
bool isNull() const noexcept;
/**
Return true if size is not null (0x0).
A non-null size is still invalid if its width or height are negative.
*/
bool isNotNull() const noexcept;
/**
Return true if size is valid (width and height are higher than zero).
*/
bool isValid() const noexcept;
/**
Return true if size is invalid (width or height are lower or equal to zero).
An invalid size might not be null under some circumstances.
*/
bool isInvalid() const noexcept;
Size<int> toInt() const noexcept;
Size<T> operator+(const Size<T>& size) noexcept;
Size<T> operator-(const Size<T>& size) noexcept;
Size<T>& operator=(const Size<T>& size) noexcept;
Size<T>& operator+=(const Size<T>& size) noexcept;
Size<T>& operator-=(const Size<T>& size) noexcept;
Size<T>& operator*=(double m) noexcept;
Size<T>& operator/=(double d) noexcept;
Size<T> operator*(double m) const noexcept;
Size<T> operator/(double m) const noexcept;
bool operator==(const Size<T>& size) const noexcept;
bool operator!=(const Size<T>& size) const noexcept;
private:
T fWidth, fHeight;
template<typename> friend class Rectangle;
};
// -----------------------------------------------------------------------
/**
DGL Line class.
This class describes a line, defined by two points.
*/
template<typename T>
class Line
{
public:
/**
Constructor for a null line ([0,0] to [0,0]).
*/
Line() noexcept;
/**
Constructor using custom start X, start Y, end X and end Y values.
*/
Line(const T& startX, const T& startY, const T& endX, const T& endY) noexcept;
/**
Constructor using custom start X, start Y and end pos values.
*/
Line(const T& startX, const T& startY, const Point<T>& endPos) noexcept;
/**
Constructor using custom start pos, end X and end Y values.
*/
Line(const Point<T>& startPos, const T& endX, const T& endY) noexcept;
/**
Constructor using custom start and end pos values.
*/
Line(const Point<T>& startPos, const Point<T>& endPos) noexcept;
/**
Constructor using another Line class values.
*/
Line(const Line<T>& line) noexcept;
/**
Get start X value.
*/
const T& getStartX() const noexcept;
/**
Get start Y value.
*/
const T& getStartY() const noexcept;
/**
Get end X value.
*/
const T& getEndX() const noexcept;
/**
Get end Y value.
*/
const T& getEndY() const noexcept;
/**
Get start position.
*/
const Point<T>& getStartPos() const noexcept;
/**
Get end position.
*/
const Point<T>& getEndPos() const noexcept;
/**
Set start X value to @a x.
*/
void setStartX(const T& x) noexcept;
/**
Set start Y value to @a y.
*/
void setStartY(const T& y) noexcept;
/**
Set start X and Y values to @a x and @a y respectively.
*/
void setStartPos(const T& x, const T& y) noexcept;
/**
Set start X and Y values according to @a pos.
*/
void setStartPos(const Point<T>& pos) noexcept;
/**
Set end X value to @a x.
*/
void setEndX(const T& x) noexcept;
/**
Set end Y value to @a y.
*/
void setEndY(const T& y) noexcept;
/**
Set end X and Y values to @a x and @a y respectively.
*/
void setEndPos(const T& x, const T& y) noexcept;
/**
Set end X and Y values according to @a pos.
*/
void setEndPos(const Point<T>& pos) noexcept;
/**
Move this line by @a x and @a y values.
*/
void moveBy(const T& x, const T& y) noexcept;
/**
Move this line by @a pos.
*/
void moveBy(const Point<T>& pos) noexcept;
/**
Return true if line is null (start and end pos are equal).
*/
bool isNull() const noexcept;
/**
Return true if line is not null (start and end pos are different).
*/
bool isNotNull() const noexcept;
#ifndef DPF_TEST_POINT_CPP
/**
Draw this line using the provided graphics context, optionally specifying line width.
*/
void draw(const GraphicsContext& context, T width = 1);
#endif
Line<T>& operator=(const Line<T>& line) noexcept;
bool operator==(const Line<T>& line) const noexcept;
bool operator!=(const Line<T>& line) const noexcept;
#ifndef DPF_TEST_POINT_CPP
/**
Draw this line using the current OpenGL state.@n
DEPRECATED Please use draw(const GraphicsContext&) instead.
*/
DISTRHO_DEPRECATED_BY("draw(const GraphicsContext&)")
void draw();
#endif
private:
Point<T> posStart, posEnd;
};
// -----------------------------------------------------------------------
/**
DGL Circle class.
This class describes a circle, defined by position, size and a minimum of 3 segments.
TODO: report if circle starts at top-left, bottom-right or center.
and size grows from which point?
*/
template<typename T>
class Circle
{
public:
/**
Constructor for a null circle.
*/
Circle() noexcept;
/**
Constructor using custom X, Y and size values.
*/
Circle(const T& x, const T& y, const float size, const uint numSegments = 300);
/**
Constructor using custom position and size values.
*/
Circle(const Point<T>& pos, const float size, const uint numSegments = 300);
/**
Constructor using another Circle class values.
*/
Circle(const Circle<T>& cir) noexcept;
/**
Get X value.
*/
const T& getX() const noexcept;
/**
Get Y value.
*/
const T& getY() const noexcept;
/**
Get position.
*/
const Point<T>& getPos() const noexcept;
/**
Set X value to @a x.
*/
void setX(const T& x) noexcept;
/**
Set Y value to @a y.
*/
void setY(const T& y) noexcept;
/**
Set X and Y values to @a x and @a y respectively.
*/
void setPos(const T& x, const T& y) noexcept;
/**
Set X and Y values according to @a pos.
*/
void setPos(const Point<T>& pos) noexcept;
/**
Get size.
*/
float getSize() const noexcept;
/**
Set size.
@note Must always be > 0
*/
void setSize(const float size) noexcept;
/**
Get the current number of line segments that make this circle.
*/
uint getNumSegments() const noexcept;
/**
Set the number of line segments that will make this circle.
@note Must always be >= 3
*/
void setNumSegments(const uint num);
/**
Draw this circle using the provided graphics context.
*/
void draw(const GraphicsContext& context);
/**
Draw lines (outline of this circle) using the provided graphics context, optionally specifying line width.
*/
void drawOutline(const GraphicsContext& context, T lineWidth = 1);
Circle<T>& operator=(const Circle<T>& cir) noexcept;
bool operator==(const Circle<T>& cir) const noexcept;
bool operator!=(const Circle<T>& cir) const noexcept;
#ifndef DPF_TEST_POINT_CPP
/**
Draw this circle using the current OpenGL state.@n
DEPRECATED Please use draw(const GraphicsContext&) instead.
*/
DISTRHO_DEPRECATED_BY("draw(const GraphicsContext&)")
void draw();
/**
Draw lines (outline of this circle) using the current OpenGL state.@n
DEPRECATED Please use drawOutline(const GraphicsContext&,T) instead.
*/
DISTRHO_DEPRECATED_BY("drawOutline(const GraphicsContext&)")
void drawOutline();
#endif
private:
Point<T> fPos;
float fSize;
uint fNumSegments;
// cached values
float fTheta, fCos, fSin;
};
// -----------------------------------------------------------------------
/**
DGL Triangle class.
This class describes a triangle, defined by 3 points.
*/
template<typename T>
class Triangle
{
public:
/**
Constructor for a null triangle.
*/
Triangle() noexcept;
/**
Constructor using custom X and Y values.
*/
Triangle(const T& x1, const T& y1, const T& x2, const T& y2, const T& x3, const T& y3) noexcept;
/**
Constructor using custom position values.
*/
Triangle(const Point<T>& pos1, const Point<T>& pos2, const Point<T>& pos3) noexcept;
/**
Constructor using another Triangle class values.
*/
Triangle(const Triangle<T>& tri) noexcept;
/**
Return true if triangle is null (all its points are equal).
An null triangle is also invalid.
*/
bool isNull() const noexcept;
/**
Return true if triangle is not null (one its points is different from the others).
A non-null triangle is still invalid if two of its points are equal.
*/
bool isNotNull() const noexcept;
/**
Return true if triangle is valid (all its points are different).
*/
bool isValid() const noexcept;
/**
Return true if triangle is invalid (one or two of its points are equal).
An invalid triangle might not be null under some circumstances.
*/
bool isInvalid() const noexcept;
/**
Draw this triangle using the provided graphics context.
*/
void draw(const GraphicsContext& context);
/**
Draw lines (outline of this triangle) using the provided graphics context, optionally specifying line width.
*/
void drawOutline(const GraphicsContext& context, T lineWidth = 1);
Triangle<T>& operator=(const Triangle<T>& tri) noexcept;
bool operator==(const Triangle<T>& tri) const noexcept;
bool operator!=(const Triangle<T>& tri) const noexcept;
#ifndef DPF_TEST_POINT_CPP
/**
Draw this triangle using the current OpenGL state.@n
DEPRECATED Please use draw(const GraphicsContext&) instead.
*/
DISTRHO_DEPRECATED_BY("draw(const GraphicsContext&)")
void draw();
/**
Draw lines (outline of this triangle) using the current OpenGL state.@n
DEPRECATED Please use drawOutline(const GraphicsContext&,T) instead.
*/
DISTRHO_DEPRECATED_BY("drawOutline(const GraphicsContext&)")
void drawOutline();
#endif
private:
Point<T> pos1, pos2, pos3;
};
// -----------------------------------------------------------------------
/**
DGL Rectangle class.
This class describes a rectangle, defined by a starting point and a size.
*/
template<typename T>
class Rectangle
{
public:
/**
Constructor for a null rectangle.
*/
Rectangle() noexcept;
/**
Constructor using custom X, Y, width and height values.
*/
Rectangle(const T& x, const T& y, const T& width, const T& height) noexcept;
/**
Constructor using custom X, Y and size values.
*/
Rectangle(const T& x, const T& y, const Size<T>& size) noexcept;
/**
Constructor using custom pos, width and height values.
*/
Rectangle(const Point<T>& pos, const T& width, const T& height) noexcept;
/**
Constructor using custom position and size.
*/
Rectangle(const Point<T>& pos, const Size<T>& size) noexcept;
/**
Construct
EC2F
or using another Rectangle class values.
*/
Rectangle(const Rectangle<T>& rect) noexcept;
/**
Get X value.
*/
const T& getX() const noexcept;
/**
Get Y value.
*/
const T& getY() const noexcept;
/**
Get width.
*/
const T& getWidth() const noexcept;
/**
Get height.
*/
const T& getHeight() const noexcept;
/**
Get position.
*/
const Point<T>& getPos() const noexcept;
/**
Get size.
*/
const Size<T>& getSize() const noexcept;
/**
Set X value as @a x.
*/
void setX(const T& x) noexcept;
/**
Set Y value as @a y.
*/
void setY(const T& y) noexcept;
/**
Set X and Y values as @a x and @a y respectively.
*/
void setPos(const T& x, const T& y) noexcept;
/**
Set X and Y values according to @a pos.
*/
void setPos(const Point<T>& pos) noexcept;
/**
Move this rectangle by @a x and @a y values.
*/
void moveBy(const T& x, const T& y) noexcept;
/**
Move this rectangle by @a pos.
*/
void moveBy(const Point<T>& pos) noexcept;
/**
Set width.
*/
void setWidth(const T& width) noexcept;
/**
Set height.
*/
void setHeight(const T& height) noexcept;
/**
Set size using @a width and @a height.
*/
void setSize(const T& width, const T& height) noexcept;
/**
Set size.
*/
void setSize(const Size<T>& size) noexcept;
/**
Grow size by @a multiplier.
*/
void growBy(double multiplier) noexcept;
/**
Shrink size by @a divider.
*/
void shrinkBy(double divider) noexcept;
/**
Set rectangle using @a pos and @a size.
*/
void setRectangle(const Point<T>& pos, const Size<T>& size) noexcept;
/**
Set rectangle.
*/
void setRectangle(const Rectangle<T>& rect) noexcept;
/**
Check if this rectangle contains the point defined by @a X and @a Y.
*/
bool contains(const T& x, const T& y) const noexcept;
/**
Check if this rectangle contains the point @a pos.
*/
bool contains(const Point<T>& pos) const noexcept;
/**
Check if this rectangle contains the point @a pos affected by a custom scale.
*/
bool containsAfterScaling(const Point<T>& pos, double scaling) const noexcept;
/**
Check if this rectangle contains the point @a pos of another type.
*/
template<typename T2>
bool contains(const Point<T2>& pos) const noexcept;
/**
Check if this rectangle contains X.
*/
bool containsX(const T& x) const noexcept;
/**
Check if this rectangle contains Y.
*/
bool containsY(const T& y) const noexcept;
/**
Return true if size is null (0x0).
An null size is also invalid.
*/
bool isNull() const noexcept;
/**
Return true if size is not null (0x0).
A non-null size is still invalid if its width or height are negative.
*/
bool isNotNull() const noexcept;
/**
Return true if size is valid (width and height are higher than zero).
*/
bool isValid() const noexcept;
/**
Return true if size is invalid (width or height are lower or equal to zero).
An invalid size might not be null under some circumstances.
*/
bool isInvalid() const noexcept;
/**
Draw this rectangle using the provided graphics context.
*/
void draw(const GraphicsContext& context);
/**
Draw lines (outline of this rectangle) using the provided graphics context, optionally specifying line width.
*/
void drawOutline(const GraphicsContext& context, T lineWidth = 1);
Rectangle<T>& operator=(const Rectangle<T>& rect) noexcept;
Rectangle<T>& operator*=(double m) noexcept;
Rectangle<T>& operator/=(double d) noexcept;
bool operator==(const Rectangle<T>& size) const noexcept;
bool operator!=(const Rectangle<T>& size) const noexcept;
/**
Draw this rectangle using the current OpenGL state.@n
DEPRECATED Please use draw(const GraphicsContext&) instead.
*/
DISTRHO_DEPRECATED_BY("draw(const GraphicsContext&)")
void draw();
/**
Draw lines (outline of this rectangle) using the current OpenGL state.@n
DEPRECATED Please use drawOutline(const GraphicsContext&,T) instead.
*/
DISTRHO_DEPRECATED_BY("drawOutline(const GraphicsContext&)")
void drawOutline();
private:
Point<T> pos;
Size<T> size;
};
// -----------------------------------------------------------------------
END_NAMESPACE_DGL
#endif // DGL_GEOMETRY_HPP_INCLUDED