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>
40 #include <wx/ogl/basic.h>
41 #include <wx/ogl/basicp.h>
42 #include <wx/ogl/misc.h>
43 #include <wx/ogl/constrnt.h>
44 #include <wx/ogl/composit.h>
46 wxFont
* g_oglNormalFont
;
48 wxPen
* g_oglWhiteBackgroundPen
;
49 wxPen
* g_oglTransparentPen
;
50 wxBrush
* g_oglWhiteBackgroundBrush
;
51 wxPen
* g_oglBlackForegroundPen
;
52 wxCursor
* g_oglBullseyeCursor
= NULL
;
54 char* oglBuffer
= NULL
;
56 wxList
oglObjectCopyMapping(wxKEY_INTEGER
);
60 void wxOGLInitialize()
62 g_oglBullseyeCursor
= new wxCursor(wxCURSOR_BULLSEYE
);
64 g_oglNormalFont
= new wxFont(10, wxSWISS
, wxNORMAL
, wxNORMAL
);
66 g_oglBlackPen
= new wxPen("BLACK", 1, wxSOLID
);
68 g_oglWhiteBackgroundPen
= new wxPen("WHITE", 1, wxSOLID
);
69 g_oglTransparentPen
= new wxPen("WHITE", 1, wxTRANSPARENT
);
70 g_oglWhiteBackgroundBrush
= new wxBrush("WHITE", wxSOLID
);
71 g_oglBlackForegroundPen
= new wxPen("BLACK", 1, wxSOLID
);
73 OGLInitializeConstraintTypes();
75 // Initialize big buffer used when writing images
76 oglBuffer
= new char[3000];
88 if (g_oglBullseyeCursor
)
90 delete g_oglBullseyeCursor
;
91 g_oglBullseyeCursor
= NULL
;
96 delete g_oglNormalFont
;
97 g_oglNormalFont
= NULL
;
101 delete g_oglBlackPen
;
102 g_oglBlackPen
= NULL
;
104 if (g_oglWhiteBackgroundPen
)
106 delete g_oglWhiteBackgroundPen
;
107 g_oglWhiteBackgroundPen
= NULL
;
109 if (g_oglTransparentPen
)
111 delete g_oglTransparentPen
;
112 g_oglTransparentPen
= NULL
;
114 if (g_oglWhiteBackgroundBrush
)
116 delete g_oglWhiteBackgroundBrush
;
117 g_oglWhiteBackgroundBrush
= NULL
;
119 if (g_oglBlackForegroundPen
)
121 delete g_oglBlackForegroundPen
;
122 g_oglBlackForegroundPen
= NULL
;
125 OGLCleanUpConstraintTypes();
128 wxFont
*oglMatchFont(int point_size
)
130 wxFont
*font
= wxTheFontList
->FindOrCreateFont(point_size
, wxSWISS
, wxNORMAL
, wxNORMAL
);
144 font
= swiss_font_12
;
147 font
= swiss_font_14
;
150 font
= swiss_font_18
;
153 font
= swiss_font_24
;
157 font
= swiss_font_10
;
164 int FontSizeDialog(wxFrame
*parent
, int old_size
)
169 sprintf(buf
, "%d", old_size
);
170 wxString ans
= wxGetTextFromUser("Enter point size", "Font size", buf
, parent
);
174 int new_size
= atoi(ans
);
175 if ((new_size
<= 0) || (new_size
> 40))
177 wxMessageBox("Invalid point size!", "Error", wxOK
);
191 char *ans = wxGetSingleChoice("Choose", "Choose a font size", 8, strings, parent);
195 sscanf(ans, "%d", &size);
196 return oglMatchFont(size);
202 // Centre a list of strings in the given box. xOffset and yOffset are the
203 // the positions that these lines should be relative to, and this might be
204 // the same as m_xpos, m_ypos, but might be zero if formatting from left-justifying.
205 void oglCentreText(wxDC
& dc
, wxList
*text_list
,
206 double m_xpos
, double m_ypos
, double width
, double height
,
209 int n
= text_list
->Number();
211 if (!text_list
|| (n
== 0))
214 // First, get maximum dimensions of box enclosing text
216 long char_height
= 0;
218 long current_width
= 0;
220 // Store text extents for speed
221 double *widths
= new double[n
];
223 wxNode
*current
= text_list
->First();
227 wxShapeTextLine
*line
= (wxShapeTextLine
*)current
->Data();
228 dc
.GetTextExtent(line
->GetText(), ¤t_width
, &char_height
);
229 widths
[i
] = current_width
;
231 if (current_width
> max_width
)
232 max_width
= current_width
;
233 current
= current
->Next();
237 double max_height
= n
*char_height
;
239 double xoffset
, yoffset
, xOffset
, yOffset
;
241 if (formatMode
& FORMAT_CENTRE_VERT
)
243 if (max_height
< height
)
244 yoffset
= (double)(m_ypos
- (height
/2.0) + (height
- max_height
)/2.0);
246 yoffset
= (double)(m_ypos
- (height
/2.0));
255 if (formatMode
& FORMAT_CENTRE_HORIZ
)
257 xoffset
= (double)(m_xpos
- width
/2.0);
266 current
= text_list
->First();
271 wxShapeTextLine
*line
= (wxShapeTextLine
*)current
->Data();
274 if ((formatMode
& FORMAT_CENTRE_HORIZ
) && (widths
[i
] < width
))
275 x
= (double)((width
- widths
[i
])/2.0 + xoffset
);
278 double y
= (double)(i
*char_height
+ yoffset
);
280 line
->SetX( x
- xOffset
); line
->SetY( y
- yOffset
);
281 current
= current
->Next();
288 // Centre a list of strings in the given box
289 void oglCentreTextNoClipping(wxDC
& dc
, wxList
*text_list
,
290 double m_xpos
, double m_ypos
, double width
, double height
)
292 int n
= text_list
->Number();
294 if (!text_list
|| (n
== 0))
297 // First, get maximum dimensions of box enclosing text
299 long char_height
= 0;
301 long current_width
= 0;
303 // Store text extents for speed
304 double *widths
= new double[n
];
306 wxNode
*current
= text_list
->First();
310 wxShapeTextLine
*line
= (wxShapeTextLine
*)current
->Data();
311 dc
.GetTextExtent(line
->GetText(), ¤t_width
, &char_height
);
312 widths
[i
] = current_width
;
314 if (current_width
> max_width
)
315 max_width
= current_width
;
316 current
= current
->Next();
320 double max_height
= n
*char_height
;
322 double yoffset
= (double)(m_ypos
- (height
/2.0) + (height
- max_height
)/2.0);
324 double xoffset
= (double)(m_xpos
- width
/2.0);
326 current
= text_list
->First();
331 wxShapeTextLine
*line
= (wxShapeTextLine
*)current
->Data();
333 double x
= (double)((width
- widths
[i
])/2.0 + xoffset
);
334 double y
= (double)(i
*char_height
+ yoffset
);
336 line
->SetX( x
- m_xpos
); line
->SetY( y
- m_ypos
);
337 current
= current
->Next();
343 void oglGetCentredTextExtent(wxDC
& dc
, wxList
*text_list
,
344 double m_xpos
, double m_ypos
, double width
, double height
,
345 double *actual_width
, double *actual_height
)
347 int n
= text_list
->Number();
349 if (!text_list
|| (n
== 0))
356 // First, get maximum dimensions of box enclosing text
358 long char_height
= 0;
360 long current_width
= 0;
362 wxNode
*current
= text_list
->First();
366 wxShapeTextLine
*line
= (wxShapeTextLine
*)current
->Data();
367 dc
.GetTextExtent(line
->GetText(), ¤t_width
, &char_height
);
369 if (current_width
> max_width
)
370 max_width
= current_width
;
371 current
= current
->Next();
375 *actual_height
= n
*char_height
;
376 *actual_width
= max_width
;
379 // Format a string to a list of strings that fit in the given box.
380 // Interpret %n and 10 or 13 as a new line.
381 wxStringList
*oglFormatText(wxDC
& dc
, const wxString
& text
, double width
, double height
, int formatMode
)
383 // First, parse the string into a list of words
384 wxStringList word_list
;
386 // Make new lines into NULL strings at this point
387 int i
= 0; int j
= 0; int len
= strlen(text
);
388 char word
[200]; word
[0] = 0;
389 bool end_word
= FALSE
; bool new_line
= FALSE
;
398 { word
[j
] = '%'; j
++; }
402 { new_line
= TRUE
; end_word
= TRUE
; i
++; }
404 { word
[j
] = '%'; j
++; word
[j
] = text
[i
]; j
++; i
++; }
410 new_line
= TRUE
; end_word
= TRUE
; i
++;
415 new_line
= TRUE
; end_word
= TRUE
; i
++;
430 if (i
== len
) end_word
= TRUE
;
440 word_list
.Append(NULL
);
444 // Now, make a list of strings which can fit in the box
445 wxStringList
*string_list
= new wxStringList
;
449 wxNode
*node
= word_list
.First();
454 wxString
oldBuffer(buffer
);
456 char *s
= (char *)node
->Data();
460 if (strlen(buffer
) > 0)
461 string_list
->Add(buffer
);
471 dc
.GetTextExtent(buffer
, &x
, &y
);
473 // Don't fit within the bounding box if we're fitting shape to contents
474 if ((x
> width
) && !(formatMode
& FORMAT_SIZE_TO_CONTENTS
))
476 // Deal with first word being wider than box
477 if (oldBuffer
.Length() > 0)
478 string_list
->Add(oldBuffer
);
488 string_list
->Add(buffer
);
493 void oglDrawFormattedText(wxDC
& dc
, wxList
*text_list
,
494 double m_xpos
, double m_ypos
, double width
, double height
,
497 double xoffset
, yoffset
;
498 if (formatMode
& FORMAT_CENTRE_HORIZ
)
501 xoffset
= (double)(m_xpos
- (width
/ 2.0));
503 if (formatMode
& FORMAT_CENTRE_VERT
)
506 yoffset
= (double)(m_ypos
- (height
/ 2.0));
508 dc
.SetClippingRegion(
509 (long)(m_xpos
- width
/2.0), (long)(m_ypos
- height
/2.0),
510 (long)width
, (long)height
);
512 wxNode
*current
= text_list
->First();
515 wxShapeTextLine
*line
= (wxShapeTextLine
*)current
->Data();
517 dc
.DrawText(line
->GetText(), WXROUND(xoffset
+ line
->GetX()), WXROUND(yoffset
+ line
->GetY()));
518 current
= current
->Next();
521 dc
.DestroyClippingRegion();
525 * Find centroid given list of points comprising polyline
529 void oglFindPolylineCentroid(wxList
*points
, double *x
, double *y
)
534 wxNode
*node
= points
->First();
537 wxRealPoint
*point
= (wxRealPoint
*)node
->Data();
543 *x
= (xcount
/points
->Number());
544 *y
= (ycount
/points
->Number());
548 * Check that (x1, y1) -> (x2, y2) hits (x3, y3) -> (x4, y4).
549 * If so, ratio1 gives the proportion along the first line
550 * that the intersection occurs (or something like that).
551 * Used by functions below.
554 void oglCheckLineIntersection(double x1
, double y1
, double x2
, double y2
,
555 double x3
, double y3
, double x4
, double y4
,
556 double *ratio1
, double *ratio2
)
558 double denominator_term
= (y4
- y3
)*(x2
- x1
) - (y2
- y1
)*(x4
- x3
);
559 double numerator_term
= (x3
- x1
)*(y4
- y3
) + (x4
- x3
)*(y1
- y3
);
561 double line_constant
;
562 double length_ratio
= 1.0;
565 // Check for parallel lines
566 if ((denominator_term
< 0.005) && (denominator_term
> -0.005))
567 line_constant
= -1.0;
569 line_constant
= numerator_term
/denominator_term
;
571 // Check for intersection
572 if ((line_constant
< 1.0) && (line_constant
> 0.0))
574 // Now must check that other line hits
575 if (((y4
- y3
) < 0.005) && ((y4
- y3
) > -0.005))
576 k_line
= ((x1
- x3
) + line_constant
*(x2
- x1
))/(x4
- x3
);
578 k_line
= ((y1
- y3
) + line_constant
*(y2
- y1
))/(y4
- y3
);
580 if ((k_line
>= 0.0) && (k_line
< 1.0))
581 length_ratio
= line_constant
;
585 *ratio1
= length_ratio
;
590 * Find where (x1, y1) -> (x2, y2) hits one of the lines in xvec, yvec.
591 * (*x3, *y3) is the point where it hits.
594 void oglFindEndForPolyline(double n
, double xvec
[], double yvec
[],
595 double x1
, double y1
, double x2
, double y2
, double *x3
, double *y3
)
598 double lastx
= xvec
[0];
599 double lasty
= yvec
[0];
601 double min_ratio
= 1.0;
605 for (i
= 1; i
< n
; i
++)
607 oglCheckLineIntersection(x1
, y1
, x2
, y2
, lastx
, lasty
, xvec
[i
], yvec
[i
],
608 &line_ratio
, &other_ratio
);
612 if (line_ratio
< min_ratio
)
613 min_ratio
= line_ratio
;
616 // Do last (implicit) line if last and first doubles are not identical
617 if (!(xvec
[0] == lastx
&& yvec
[0] == lasty
))
619 oglCheckLineIntersection(x1
, y1
, x2
, y2
, lastx
, lasty
, xvec
[0], yvec
[0],
620 &line_ratio
, &other_ratio
);
622 if (line_ratio
< min_ratio
)
623 min_ratio
= line_ratio
;
626 *x3
= (x1
+ (x2
- x1
)*min_ratio
);
627 *y3
= (y1
+ (y2
- y1
)*min_ratio
);
632 * Find where the line hits the box.
636 void oglFindEndForBox(double width
, double height
,
637 double x1
, double y1
, // Centre of box (possibly)
638 double x2
, double y2
, // other end of line
639 double *x3
, double *y3
) // End on box edge
644 xvec
[0] = (double)(x1
- width
/2.0);
645 yvec
[0] = (double)(y1
- height
/2.0);
646 xvec
[1] = (double)(x1
- width
/2.0);
647 yvec
[1] = (double)(y1
+ height
/2.0);
648 xvec
[2] = (double)(x1
+ width
/2.0);
649 yvec
[2] = (double)(y1
+ height
/2.0);
650 xvec
[3] = (double)(x1
+ width
/2.0);
651 yvec
[3] = (double)(y1
- height
/2.0);
652 xvec
[4] = (double)(x1
- width
/2.0);
653 yvec
[4] = (double)(y1
- height
/2.0);
655 oglFindEndForPolyline(5, xvec
, yvec
, x2
, y2
, x1
, y1
, x3
, y3
);
659 * Find where the line hits the circle.
663 void oglFindEndForCircle(double radius
,
664 double x1
, double y1
, // Centre of circle
665 double x2
, double y2
, // Other end of line
666 double *x3
, double *y3
)
668 double H
= (double)sqrt((x2
- x1
)*(x2
- x1
) + (y2
- y1
)*(y2
- y1
));
677 *y3
= radius
* (y2
- y1
)/H
+ y1
;
678 *x3
= radius
* (x2
- x1
)/H
+ x1
;
683 * Given the line (x1, y1) -> (x2, y2), and an arrow size of given length and width,
684 * return the position of the tip of the arrow and the left and right vertices of the arrow.
688 void oglGetArrowPoints(double x1
, double y1
, double x2
, double y2
,
689 double length
, double width
,
690 double *tip_x
, double *tip_y
,
691 double *side1_x
, double *side1_y
,
692 double *side2_x
, double *side2_y
)
694 double l
= (double)sqrt((x2
- x1
)*(x2
- x1
) + (y2
- y1
)*(y2
- y1
));
699 double i_bar
= (x2
- x1
)/l
;
700 double j_bar
= (y2
- y1
)/l
;
702 double x3
= (- length
*i_bar
) + x2
;
703 double y3
= (- length
*j_bar
) + y2
;
705 *side1_x
= width
*(-j_bar
) + x3
;
706 *side1_y
= width
*i_bar
+ y3
;
708 *side2_x
= -width
*(-j_bar
) + x3
;
709 *side2_y
= -width
*i_bar
+ y3
;
711 *tip_x
= x2
; *tip_y
= y2
;
715 * Given an ellipse and endpoints of a line, returns the point at which
716 * the line touches the ellipse in values x4, y4.
717 * This function assumes that the centre of the ellipse is at x1, y1, and the
718 * ellipse has a width of width1 and a height of height1. It also assumes you are
719 * wanting to draw an arc FROM point x2, y2 TOWARDS point x3, y3.
720 * This function calculates the x,y coordinates of the intersection point of
721 * the arc with the ellipse.
722 * Author: Ian Harrison
725 void oglDrawArcToEllipse(double x1
, double y1
, double width1
, double height1
, double x2
, double y2
, double x3
, double y3
,
726 double *x4
, double *y4
)
728 double a1
= (double)(width1
/2.0);
729 double b1
= (double)(height1
/2.0);
731 // These are required to give top left x and y coordinates for DrawEllipse
732 // double top_left_x1 = (double)(x1 - a1);
733 // double top_left_y1 = (double)(y1 - b1);
735 // Check for vertical line
736 if (fabs(x2 - x3) < 0.05)
740 *y4 = (double)(y1 - b1);
742 *y4 = (double)(y1 + b1);
746 // Check that x2 != x3
747 if (fabs(x2
- x3
) < 0.05)
751 *y4
= (double)(y1
- sqrt((b1
*b1
- (((x2
-x1
)*(x2
-x1
))*(b1
*b1
)/(a1
*a1
)))));
753 *y4
= (double)(y1
+ sqrt((b1
*b1
- (((x2
-x1
)*(x2
-x1
))*(b1
*b1
)/(a1
*a1
)))));
757 // Calculate the x and y coordinates of the point where arc intersects ellipse
759 double A
, B
, C
, D
, E
, F
, G
, H
, K
;
760 double ellipse1_x
, ellipse1_y
;
762 A
= (double)(1/(a1
* a1
));
763 B
= (double)((y3
- y2
) * (y3
- y2
)) / ((x3
- x2
) * (x3
- x2
) * b1
* b1
);
764 C
= (double)(2 * (y3
- y2
) * (y2
- y1
)) / ((x3
- x2
) * b1
* b1
);
765 D
= (double)((y2
- y1
) * (y2
- y1
)) / (b1
* b1
);
767 F
= (double)(C
- (2 * A
* x1
) - (2 * B
* x2
));
768 G
= (double)((A
* x1
* x1
) + (B
* x2
* x2
) - (C
* x2
) + D
- 1);
769 H
= (double)((y3
- y2
) / (x3
- x2
));
770 K
= (double)((F
* F
) - (4 * E
* G
));
773 // In this case the line intersects the ellipse, so calculate intersection
777 ellipse1_x
= (double)(((F
* -1) + sqrt(K
)) / (2 * E
));
778 ellipse1_y
= (double)((H
* (ellipse1_x
- x2
)) + y2
);
782 ellipse1_x
= (double)(((F
* -1) - sqrt(K
)) / (2 * E
));
783 ellipse1_y
= (double)((H
* (ellipse1_x
- x2
)) + y2
);
787 // in this case, arc does not intersect ellipse, so just draw arc
796 // Draw a little circle (radius = 2) at the end of the arc where it hits
799 double circle_x = ellipse1_x - 2.0;
800 double circle_y = ellipse1_y - 2.0;
801 m_canvas->DrawEllipse(circle_x, circle_y, 4.0, 4.0);
805 // Update a list item from a list of strings
806 void UpdateListBox(wxListBox
*item
, wxList
*list
)
812 wxNode
*node
= list
->First();
815 char *s
= (char *)node
->Data();
821 bool oglRoughlyEqual(double val1
, double val2
, double tol
)
823 return ( (val1
< (val2
+ tol
)) && (val1
> (val2
- tol
)) &&
824 (val2
< (val1
+ tol
)) && (val2
> (val1
- tol
)));
828 * Hex<->Dec conversion
831 // Array used in DecToHex conversion routine.
832 static char sg_HexArray
[] = { '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'A', 'B',
833 'C', 'D', 'E', 'F' };
835 // Convert 2-digit hex number to decimal
836 unsigned int oglHexToDec(char* buf
)
838 int firstDigit
, secondDigit
;
841 firstDigit
= buf
[0] - 'A' + 10;
843 firstDigit
= buf
[0] - '0';
846 secondDigit
= buf
[1] - 'A' + 10;
848 secondDigit
= buf
[1] - '0';
850 return firstDigit
* 16 + secondDigit
;
853 // Convert decimal integer to 2-character hex string
854 void oglDecToHex(unsigned int dec
, char *buf
)
856 int firstDigit
= (int)(dec
/16.0);
857 int secondDigit
= (int)(dec
- (firstDigit
*16.0));
858 buf
[0] = sg_HexArray
[firstDigit
];
859 buf
[1] = sg_HexArray
[secondDigit
];
863 // 3-digit hex to wxColour
864 wxColour
oglHexToColour(const wxString
& hex
)
866 if (hex
.Length() == 6)
869 strncpy(buf
, hex
, 7);
870 unsigned int r
= oglHexToDec((char *)buf
);
871 unsigned int g
= oglHexToDec((char *)(buf
+2));
872 unsigned int b
= oglHexToDec((char *)(buf
+4));
873 return wxColour(r
, g
, b
);
876 return wxColour(0,0,0);
879 // RGB to 3-digit hex
880 wxString
oglColourToHex(const wxColour
& colour
)
883 unsigned int red
= colour
.Red();
884 unsigned int green
= colour
.Green();
885 unsigned int blue
= colour
.Blue();
887 oglDecToHex(red
, buf
);
888 oglDecToHex(green
, buf
+2);
889 oglDecToHex(blue
, buf
+4);
891 return wxString(buf
);