1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: Miscellaneous OGL support functions
4 // Author: Julian Smart
8 // Copyright: (c) Julian Smart
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
13 #pragma implementation "misc.h"
16 // For compilers that support precompilation, includes "wx.h".
17 #include "wx/wxprec.h"
27 #include <wx/wxexpr.h>
39 #include <wx/ogl/basic.h>
40 #include <wx/ogl/basicp.h>
41 #include <wx/ogl/misc.h>
42 #include <wx/ogl/constrnt.h>
43 #include <wx/ogl/composit.h>
45 wxFont
* g_oglNormalFont
;
47 wxPen
* g_oglWhiteBackgroundPen
;
48 wxPen
* g_oglTransparentPen
;
49 wxBrush
* g_oglWhiteBackgroundBrush
;
50 wxPen
* g_oglBlackForegroundPen
;
51 wxCursor
* g_oglBullseyeCursor
= NULL
;
53 char* oglBuffer
= NULL
;
55 wxList
oglObjectCopyMapping(wxKEY_INTEGER
);
59 void wxOGLInitialize()
61 g_oglBullseyeCursor
= new wxCursor(wxCURSOR_BULLSEYE
);
63 g_oglNormalFont
= new wxFont(10, wxSWISS
, wxNORMAL
, wxNORMAL
);
65 g_oglBlackPen
= new wxPen("BLACK", 1, wxSOLID
);
67 g_oglWhiteBackgroundPen
= new wxPen("WHITE", 1, wxSOLID
);
68 g_oglTransparentPen
= new wxPen("WHITE", 1, wxTRANSPARENT
);
69 g_oglWhiteBackgroundBrush
= new wxBrush("WHITE", wxSOLID
);
70 g_oglBlackForegroundPen
= new wxPen("BLACK", 1, wxSOLID
);
72 OGLInitializeConstraintTypes();
74 // Initialize big buffer used when writing images
75 oglBuffer
= new char[3000];
87 if (g_oglBullseyeCursor
)
89 delete g_oglBullseyeCursor
;
90 g_oglBullseyeCursor
= NULL
;
95 delete g_oglNormalFont
;
96 g_oglNormalFont
= NULL
;
100 delete g_oglBlackPen
;
101 g_oglBlackPen
= NULL
;
103 if (g_oglWhiteBackgroundPen
)
105 delete g_oglWhiteBackgroundPen
;
106 g_oglWhiteBackgroundPen
= NULL
;
108 if (g_oglTransparentPen
)
110 delete g_oglTransparentPen
;
111 g_oglTransparentPen
= NULL
;
113 if (g_oglWhiteBackgroundBrush
)
115 delete g_oglWhiteBackgroundBrush
;
116 g_oglWhiteBackgroundBrush
= NULL
;
118 if (g_oglBlackForegroundPen
)
120 delete g_oglBlackForegroundPen
;
121 g_oglBlackForegroundPen
= NULL
;
124 OGLCleanUpConstraintTypes();
127 wxFont
*oglMatchFont(int point_size
)
129 wxFont
*font
= wxTheFontList
->FindOrCreateFont(point_size
, wxSWISS
, wxNORMAL
, wxNORMAL
);
143 font
= swiss_font_12
;
146 font
= swiss_font_14
;
149 font
= swiss_font_18
;
152 font
= swiss_font_24
;
156 font
= swiss_font_10
;
163 int FontSizeDialog(wxFrame
*parent
, int old_size
)
168 sprintf(buf
, "%d", old_size
);
169 wxString ans
= wxGetTextFromUser("Enter point size", "Font size", buf
, parent
);
173 int new_size
= atoi(ans
);
174 if ((new_size
<= 0) || (new_size
> 40))
176 wxMessageBox("Invalid point size!", "Error", wxOK
);
190 char *ans = wxGetSingleChoice("Choose", "Choose a font size", 8, strings, parent);
194 sscanf(ans, "%d", &size);
195 return oglMatchFont(size);
201 // Centre a list of strings in the given box. xOffset and yOffset are the
202 // the positions that these lines should be relative to, and this might be
203 // the same as m_xpos, m_ypos, but might be zero if formatting from left-justifying.
204 void oglCentreText(wxDC
& dc
, wxList
*text_list
,
205 double m_xpos
, double m_ypos
, double width
, double height
,
208 int n
= text_list
->Number();
210 if (!text_list
|| (n
== 0))
213 // First, get maximum dimensions of box enclosing text
215 long char_height
= 0;
217 long current_width
= 0;
219 // Store text extents for speed
220 double *widths
= new double[n
];
222 wxNode
*current
= text_list
->First();
226 wxShapeTextLine
*line
= (wxShapeTextLine
*)current
->Data();
227 dc
.GetTextExtent(line
->GetText(), ¤t_width
, &char_height
);
228 widths
[i
] = current_width
;
230 if (current_width
> max_width
)
231 max_width
= current_width
;
232 current
= current
->Next();
236 double max_height
= n
*char_height
;
238 double xoffset
, yoffset
, xOffset
, yOffset
;
240 if (formatMode
& FORMAT_CENTRE_VERT
)
242 if (max_height
< height
)
243 yoffset
= (double)(m_ypos
- (height
/2.0) + (height
- max_height
)/2.0);
245 yoffset
= (double)(m_ypos
- (height
/2.0));
254 if (formatMode
& FORMAT_CENTRE_HORIZ
)
256 xoffset
= (double)(m_xpos
- width
/2.0);
265 current
= text_list
->First();
270 wxShapeTextLine
*line
= (wxShapeTextLine
*)current
->Data();
273 if ((formatMode
& FORMAT_CENTRE_HORIZ
) && (widths
[i
] < width
))
274 x
= (double)((width
- widths
[i
])/2.0 + xoffset
);
277 double y
= (double)(i
*char_height
+ yoffset
);
279 line
->SetX( x
- xOffset
); line
->SetY( y
- yOffset
);
280 current
= current
->Next();
287 // Centre a list of strings in the given box
288 void oglCentreTextNoClipping(wxDC
& dc
, wxList
*text_list
,
289 double m_xpos
, double m_ypos
, double width
, double height
)
291 int n
= text_list
->Number();
293 if (!text_list
|| (n
== 0))
296 // First, get maximum dimensions of box enclosing text
298 long char_height
= 0;
300 long current_width
= 0;
302 // Store text extents for speed
303 double *widths
= new double[n
];
305 wxNode
*current
= text_list
->First();
309 wxShapeTextLine
*line
= (wxShapeTextLine
*)current
->Data();
310 dc
.GetTextExtent(line
->GetText(), ¤t_width
, &char_height
);
311 widths
[i
] = current_width
;
313 if (current_width
> max_width
)
314 max_width
= current_width
;
315 current
= current
->Next();
319 double max_height
= n
*char_height
;
321 double yoffset
= (double)(m_ypos
- (height
/2.0) + (height
- max_height
)/2.0);
323 double xoffset
= (double)(m_xpos
- width
/2.0);
325 current
= text_list
->First();
330 wxShapeTextLine
*line
= (wxShapeTextLine
*)current
->Data();
332 double x
= (double)((width
- widths
[i
])/2.0 + xoffset
);
333 double y
= (double)(i
*char_height
+ yoffset
);
335 line
->SetX( x
- m_xpos
); line
->SetY( y
- m_ypos
);
336 current
= current
->Next();
342 void oglGetCentredTextExtent(wxDC
& dc
, wxList
*text_list
,
343 double m_xpos
, double m_ypos
, double width
, double height
,
344 double *actual_width
, double *actual_height
)
346 int n
= text_list
->Number();
348 if (!text_list
|| (n
== 0))
355 // First, get maximum dimensions of box enclosing text
357 long char_height
= 0;
359 long current_width
= 0;
361 wxNode
*current
= text_list
->First();
365 wxShapeTextLine
*line
= (wxShapeTextLine
*)current
->Data();
366 dc
.GetTextExtent(line
->GetText(), ¤t_width
, &char_height
);
368 if (current_width
> max_width
)
369 max_width
= current_width
;
370 current
= current
->Next();
374 *actual_height
= n
*char_height
;
375 *actual_width
= max_width
;
378 // Format a string to a list of strings that fit in the given box.
379 // Interpret %n and 10 or 13 as a new line.
380 wxStringList
*oglFormatText(wxDC
& dc
, const wxString
& text
, double width
, double height
, int formatMode
)
382 // First, parse the string into a list of words
383 wxStringList word_list
;
385 // Make new lines into NULL strings at this point
386 int i
= 0; int j
= 0; int len
= strlen(text
);
387 char word
[200]; word
[0] = 0;
388 bool end_word
= FALSE
; bool new_line
= FALSE
;
397 { word
[j
] = '%'; j
++; }
401 { new_line
= TRUE
; end_word
= TRUE
; i
++; }
403 { word
[j
] = '%'; j
++; word
[j
] = text
[i
]; j
++; i
++; }
409 new_line
= TRUE
; end_word
= TRUE
; i
++;
414 new_line
= TRUE
; end_word
= TRUE
; i
++;
429 if (i
== len
) end_word
= TRUE
;
439 word_list
.Append(NULL
);
443 // Now, make a list of strings which can fit in the box
444 wxStringList
*string_list
= new wxStringList
;
448 wxNode
*node
= word_list
.First();
453 wxString
oldBuffer(buffer
);
455 char *s
= (char *)node
->Data();
459 if (strlen(buffer
) > 0)
460 string_list
->Add(buffer
);
470 dc
.GetTextExtent(buffer
, &x
, &y
);
472 // Don't fit within the bounding box if we're fitting shape to contents
473 if ((x
> width
) && !(formatMode
& FORMAT_SIZE_TO_CONTENTS
))
475 // Deal with first word being wider than box
476 if (oldBuffer
.Length() > 0)
477 string_list
->Add(oldBuffer
);
487 string_list
->Add(buffer
);
492 void oglDrawFormattedText(wxDC
& dc
, wxList
*text_list
,
493 double m_xpos
, double m_ypos
, double width
, double height
,
496 double xoffset
, yoffset
;
497 if (formatMode
& FORMAT_CENTRE_HORIZ
)
500 xoffset
= (double)(m_xpos
- (width
/ 2.0));
502 if (formatMode
& FORMAT_CENTRE_VERT
)
505 yoffset
= (double)(m_ypos
- (height
/ 2.0));
507 dc
.SetClippingRegion(
508 (long)(m_xpos
- width
/2.0), (long)(m_ypos
- height
/2.0),
509 (long)width
, (long)height
);
511 wxNode
*current
= text_list
->First();
514 wxShapeTextLine
*line
= (wxShapeTextLine
*)current
->Data();
516 dc
.DrawText(line
->GetText(), WXROUND(xoffset
+ line
->GetX()), WXROUND(yoffset
+ line
->GetY()));
517 current
= current
->Next();
520 dc
.DestroyClippingRegion();
524 * Find centroid given list of points comprising polyline
528 void oglFindPolylineCentroid(wxList
*points
, double *x
, double *y
)
533 wxNode
*node
= points
->First();
536 wxRealPoint
*point
= (wxRealPoint
*)node
->Data();
542 *x
= (xcount
/points
->Number());
543 *y
= (ycount
/points
->Number());
547 * Check that (x1, y1) -> (x2, y2) hits (x3, y3) -> (x4, y4).
548 * If so, ratio1 gives the proportion along the first line
549 * that the intersection occurs (or something like that).
550 * Used by functions below.
553 void oglCheckLineIntersection(double x1
, double y1
, double x2
, double y2
,
554 double x3
, double y3
, double x4
, double y4
,
555 double *ratio1
, double *ratio2
)
557 double denominator_term
= (y4
- y3
)*(x2
- x1
) - (y2
- y1
)*(x4
- x3
);
558 double numerator_term
= (x3
- x1
)*(y4
- y3
) + (x4
- x3
)*(y1
- y3
);
560 double line_constant
;
561 double length_ratio
= 1.0;
564 // Check for parallel lines
565 if ((denominator_term
< 0.005) && (denominator_term
> -0.005))
566 line_constant
= -1.0;
568 line_constant
= numerator_term
/denominator_term
;
570 // Check for intersection
571 if ((line_constant
< 1.0) && (line_constant
> 0.0))
573 // Now must check that other line hits
574 if (((y4
- y3
) < 0.005) && ((y4
- y3
) > -0.005))
575 k_line
= ((x1
- x3
) + line_constant
*(x2
- x1
))/(x4
- x3
);
577 k_line
= ((y1
- y3
) + line_constant
*(y2
- y1
))/(y4
- y3
);
579 if ((k_line
>= 0.0) && (k_line
< 1.0))
580 length_ratio
= line_constant
;
584 *ratio1
= length_ratio
;
589 * Find where (x1, y1) -> (x2, y2) hits one of the lines in xvec, yvec.
590 * (*x3, *y3) is the point where it hits.
593 void oglFindEndForPolyline(double n
, double xvec
[], double yvec
[],
594 double x1
, double y1
, double x2
, double y2
, double *x3
, double *y3
)
597 double lastx
= xvec
[0];
598 double lasty
= yvec
[0];
600 double min_ratio
= 1.0;
604 for (i
= 1; i
< n
; i
++)
606 oglCheckLineIntersection(x1
, y1
, x2
, y2
, lastx
, lasty
, xvec
[i
], yvec
[i
],
607 &line_ratio
, &other_ratio
);
611 if (line_ratio
< min_ratio
)
612 min_ratio
= line_ratio
;
615 // Do last (implicit) line if last and first doubles are not identical
616 if (!(xvec
[0] == lastx
&& yvec
[0] == lasty
))
618 oglCheckLineIntersection(x1
, y1
, x2
, y2
, lastx
, lasty
, xvec
[0], yvec
[0],
619 &line_ratio
, &other_ratio
);
621 if (line_ratio
< min_ratio
)
622 min_ratio
= line_ratio
;
625 *x3
= (x1
+ (x2
- x1
)*min_ratio
);
626 *y3
= (y1
+ (y2
- y1
)*min_ratio
);
631 * Find where the line hits the box.
635 void oglFindEndForBox(double width
, double height
,
636 double x1
, double y1
, // Centre of box (possibly)
637 double x2
, double y2
, // other end of line
638 double *x3
, double *y3
) // End on box edge
643 xvec
[0] = (double)(x1
- width
/2.0);
644 yvec
[0] = (double)(y1
- height
/2.0);
645 xvec
[1] = (double)(x1
- width
/2.0);
646 yvec
[1] = (double)(y1
+ height
/2.0);
647 xvec
[2] = (double)(x1
+ width
/2.0);
648 yvec
[2] = (double)(y1
+ height
/2.0);
649 xvec
[3] = (double)(x1
+ width
/2.0);
650 yvec
[3] = (double)(y1
- height
/2.0);
651 xvec
[4] = (double)(x1
- width
/2.0);
652 yvec
[4] = (double)(y1
- height
/2.0);
654 oglFindEndForPolyline(5, xvec
, yvec
, x2
, y2
, x1
, y1
, x3
, y3
);
658 * Find where the line hits the circle.
662 void oglFindEndForCircle(double radius
,
663 double x1
, double y1
, // Centre of circle
664 double x2
, double y2
, // Other end of line
665 double *x3
, double *y3
)
667 double H
= (double)sqrt((x2
- x1
)*(x2
- x1
) + (y2
- y1
)*(y2
- y1
));
676 *y3
= radius
* (y2
- y1
)/H
+ y1
;
677 *x3
= radius
* (x2
- x1
)/H
+ x1
;
682 * Given the line (x1, y1) -> (x2, y2), and an arrow size of given length and width,
683 * return the position of the tip of the arrow and the left and right vertices of the arrow.
687 void oglGetArrowPoints(double x1
, double y1
, double x2
, double y2
,
688 double length
, double width
,
689 double *tip_x
, double *tip_y
,
690 double *side1_x
, double *side1_y
,
691 double *side2_x
, double *side2_y
)
693 double l
= (double)sqrt((x2
- x1
)*(x2
- x1
) + (y2
- y1
)*(y2
- y1
));
698 double i_bar
= (x2
- x1
)/l
;
699 double j_bar
= (y2
- y1
)/l
;
701 double x3
= (- length
*i_bar
) + x2
;
702 double y3
= (- length
*j_bar
) + y2
;
704 *side1_x
= width
*(-j_bar
) + x3
;
705 *side1_y
= width
*i_bar
+ y3
;
707 *side2_x
= -width
*(-j_bar
) + x3
;
708 *side2_y
= -width
*i_bar
+ y3
;
710 *tip_x
= x2
; *tip_y
= y2
;
714 * Given an ellipse and endpoints of a line, returns the point at which
715 * the line touches the ellipse in values x4, y4.
716 * This function assumes that the centre of the ellipse is at x1, y1, and the
717 * ellipse has a width of width1 and a height of height1. It also assumes you are
718 * wanting to draw an arc FROM point x2, y2 TOWARDS point x3, y3.
719 * This function calculates the x,y coordinates of the intersection point of
720 * the arc with the ellipse.
721 * Author: Ian Harrison
724 void oglDrawArcToEllipse(double x1
, double y1
, double width1
, double height1
, double x2
, double y2
, double x3
, double y3
,
725 double *x4
, double *y4
)
727 double a1
= (double)(width1
/2.0);
728 double b1
= (double)(height1
/2.0);
730 // These are required to give top left x and y coordinates for DrawEllipse
731 // double top_left_x1 = (double)(x1 - a1);
732 // double top_left_y1 = (double)(y1 - b1);
734 // Check for vertical line
735 if (fabs(x2 - x3) < 0.05)
739 *y4 = (double)(y1 - b1);
741 *y4 = (double)(y1 + b1);
745 // Check that x2 != x3
746 if (fabs(x2
- x3
) < 0.05)
750 *y4
= (double)(y1
- sqrt((b1
*b1
- (((x2
-x1
)*(x2
-x1
))*(b1
*b1
)/(a1
*a1
)))));
752 *y4
= (double)(y1
+ sqrt((b1
*b1
- (((x2
-x1
)*(x2
-x1
))*(b1
*b1
)/(a1
*a1
)))));
756 // Calculate the x and y coordinates of the point where arc intersects ellipse
758 double A
, B
, C
, D
, E
, F
, G
, H
, K
;
759 double ellipse1_x
, ellipse1_y
;
761 A
= (double)(1/(a1
* a1
));
762 B
= (double)((y3
- y2
) * (y3
- y2
)) / ((x3
- x2
) * (x3
- x2
) * b1
* b1
);
763 C
= (double)(2 * (y3
- y2
) * (y2
- y1
)) / ((x3
- x2
) * b1
* b1
);
764 D
= (double)((y2
- y1
) * (y2
- y1
)) / (b1
* b1
);
766 F
= (double)(C
- (2 * A
* x1
) - (2 * B
* x2
));
767 G
= (double)((A
* x1
* x1
) + (B
* x2
* x2
) - (C
* x2
) + D
- 1);
768 H
= (double)((y3
- y2
) / (x3
- x2
));
769 K
= (double)((F
* F
) - (4 * E
* G
));
772 // In this case the line intersects the ellipse, so calculate intersection
776 ellipse1_x
= (double)(((F
* -1) + sqrt(K
)) / (2 * E
));
777 ellipse1_y
= (double)((H
* (ellipse1_x
- x2
)) + y2
);
781 ellipse1_x
= (double)(((F
* -1) - sqrt(K
)) / (2 * E
));
782 ellipse1_y
= (double)((H
* (ellipse1_x
- x2
)) + y2
);
786 // in this case, arc does not intersect ellipse, so just draw arc
795 // Draw a little circle (radius = 2) at the end of the arc where it hits
798 double circle_x = ellipse1_x - 2.0;
799 double circle_y = ellipse1_y - 2.0;
800 m_canvas->DrawEllipse(circle_x, circle_y, 4.0, 4.0);
804 // Update a list item from a list of strings
805 void UpdateListBox(wxListBox
*item
, wxList
*list
)
811 wxNode
*node
= list
->First();
814 char *s
= (char *)node
->Data();
820 bool oglRoughlyEqual(double val1
, double val2
, double tol
)
822 return ( (val1
< (val2
+ tol
)) && (val1
> (val2
- tol
)) &&
823 (val2
< (val1
+ tol
)) && (val2
> (val1
- tol
)));
827 * Hex<->Dec conversion
830 // Array used in DecToHex conversion routine.
831 static char sg_HexArray
[] = { '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'A', 'B',
832 'C', 'D', 'E', 'F' };
834 // Convert 2-digit hex number to decimal
835 unsigned int oglHexToDec(char* buf
)
837 int firstDigit
, secondDigit
;
840 firstDigit
= buf
[0] - 'A' + 10;
842 firstDigit
= buf
[0] - '0';
845 secondDigit
= buf
[1] - 'A' + 10;
847 secondDigit
= buf
[1] - '0';
849 return firstDigit
* 16 + secondDigit
;
852 // Convert decimal integer to 2-character hex string
853 void oglDecToHex(unsigned int dec
, char *buf
)
855 int firstDigit
= (int)(dec
/16.0);
856 int secondDigit
= (int)(dec
- (firstDigit
*16.0));
857 buf
[0] = sg_HexArray
[firstDigit
];
858 buf
[1] = sg_HexArray
[secondDigit
];
862 // 3-digit hex to wxColour
863 wxColour
oglHexToColour(const wxString
& hex
)
865 if (hex
.Length() == 6)
868 strncpy(buf
, hex
, 7);
869 unsigned int r
= oglHexToDec((char *)buf
);
870 unsigned int g
= oglHexToDec((char *)(buf
+2));
871 unsigned int b
= oglHexToDec((char *)(buf
+4));
872 return wxColour(r
, g
, b
);
875 return wxColour(0,0,0);
878 // RGB to 3-digit hex
879 wxString
oglColourToHex(const wxColour
& colour
)
882 unsigned int red
= colour
.Red();
883 unsigned int green
= colour
.Green();
884 unsigned int blue
= colour
.Blue();
886 oglDecToHex(red
, buf
);
887 oglDecToHex(green
, buf
+2);
888 oglDecToHex(blue
, buf
+4);
890 return wxString(buf
);