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"
28 #include <wx/deprecated/wxexpr.h>
41 #include "wx/ogl/ogl.h"
44 wxFont
* g_oglNormalFont
;
46 wxPen
* g_oglWhiteBackgroundPen
;
47 wxPen
* g_oglTransparentPen
;
48 wxBrush
* g_oglWhiteBackgroundBrush
;
49 wxPen
* g_oglBlackForegroundPen
;
50 wxCursor
* g_oglBullseyeCursor
= NULL
;
52 wxChar
* oglBuffer
= NULL
;
54 wxList
oglObjectCopyMapping(wxKEY_INTEGER
);
58 void wxOGLInitialize()
60 g_oglBullseyeCursor
= new wxCursor(wxCURSOR_BULLSEYE
);
62 g_oglNormalFont
= new wxFont(10, wxSWISS
, wxNORMAL
, wxNORMAL
);
64 g_oglBlackPen
= new wxPen(wxT("BLACK"), 1, wxSOLID
);
66 g_oglWhiteBackgroundPen
= new wxPen(wxT("WHITE"), 1, wxSOLID
);
67 g_oglTransparentPen
= new wxPen(wxT("WHITE"), 1, wxTRANSPARENT
);
68 g_oglWhiteBackgroundBrush
= new wxBrush(wxT("WHITE"), wxSOLID
);
69 g_oglBlackForegroundPen
= new wxPen(wxT("BLACK"), 1, wxSOLID
);
71 OGLInitializeConstraintTypes();
73 // Initialize big buffer used when writing images
74 oglBuffer
= new wxChar
[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
)
169 wxString ans
= wxGetTextFromUser(wxT("Enter point size"), wxT("Font size"), buf
, parent
);
170 if (ans
.Length() == 0)
174 ans
.ToLong(&new_size
);
175 if ((new_size
<= 0) || (new_size
> 40))
177 wxMessageBox(wxT("Invalid point size!"), wxT("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
->GetCount();
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 wxObjectList::compatibility_iterator current
= text_list
->GetFirst();
227 wxShapeTextLine
*line
= (wxShapeTextLine
*)current
->GetData();
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
->GetNext();
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
->GetFirst();
271 wxShapeTextLine
*line
= (wxShapeTextLine
*)current
->GetData();
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
->GetNext();
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
->GetCount();
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 wxObjectList::compatibility_iterator current
= text_list
->GetFirst();
310 wxShapeTextLine
*line
= (wxShapeTextLine
*)current
->GetData();
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
->GetNext();
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
->GetFirst();
331 wxShapeTextLine
*line
= (wxShapeTextLine
*)current
->GetData();
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
->GetNext();
343 void oglGetCentredTextExtent(wxDC
& dc
, wxList
*text_list
,
344 double WXUNUSED(m_xpos
), double WXUNUSED(m_ypos
), double WXUNUSED(width
), double WXUNUSED(height
),
345 double *actual_width
, double *actual_height
)
347 int n
= text_list
->GetCount();
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 wxObjectList::compatibility_iterator current
= text_list
->GetFirst();
365 wxShapeTextLine
*line
= (wxShapeTextLine
*)current
->GetData();
366 dc
.GetTextExtent(line
->GetText(), ¤t_width
, &char_height
);
368 if (current_width
> max_width
)
369 max_width
= current_width
;
370 current
= current
->GetNext();
373 *actual_height
= n
*char_height
;
374 *actual_width
= max_width
;
377 // Format a string to a list of strings that fit in the given box.
378 // Interpret %n and 10 or 13 as a new line.
379 wxStringList
*oglFormatText(wxDC
& dc
, const wxString
& text
, double width
, double WXUNUSED(height
), int formatMode
)
381 // First, parse the string into a list of words
382 wxStringList word_list
;
384 // Make new lines into NULL strings at this point
385 int i
= 0; int j
= 0; int len
= text
.Length();
386 wxChar word
[400]; word
[0] = 0;
387 bool end_word
= false; bool new_line
= false;
396 { word
[j
] = wxT('%'); j
++; }
399 if (text
[i
] == wxT('n'))
400 { new_line
= true; end_word
= true; i
++; }
402 { word
[j
] = wxT('%'); j
++; word
[j
] = text
[i
]; j
++; i
++; }
408 new_line
= true; end_word
= true; i
++;
413 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
;
447 wxStringList::compatibility_iterator node
= word_list
.GetFirst();
452 wxString
oldBuffer(buffer
);
454 wxString s
= node
->GetData();
458 if (buffer
.Length() > 0)
459 string_list
->Add(buffer
);
465 if (buffer
.Length() != 0)
469 dc
.GetTextExtent(buffer
, &x
, &y
);
471 // Don't fit within the bounding box if we're fitting shape to contents
472 if ((x
> width
) && !(formatMode
& FORMAT_SIZE_TO_CONTENTS
))
474 // Deal with first word being wider than box
475 if (oldBuffer
.Length() > 0)
476 string_list
->Add(oldBuffer
);
483 node
= node
->GetNext();
485 if (buffer
.Length() != 0)
486 string_list
->Add(buffer
);
491 void oglDrawFormattedText(wxDC
& dc
, wxList
*text_list
,
492 double m_xpos
, double m_ypos
, double width
, double height
,
495 double xoffset
, yoffset
;
496 if (formatMode
& FORMAT_CENTRE_HORIZ
)
499 xoffset
= (double)(m_xpos
- (width
/ 2.0));
501 if (formatMode
& FORMAT_CENTRE_VERT
)
504 yoffset
= (double)(m_ypos
- (height
/ 2.0));
506 dc
.SetClippingRegion(
507 (long)(m_xpos
- width
/2.0), (long)(m_ypos
- height
/2.0),
508 (long)width
+1, (long)height
+1); // +1 to allow for rounding errors
510 wxObjectList::compatibility_iterator current
= text_list
->GetFirst();
513 wxShapeTextLine
*line
= (wxShapeTextLine
*)current
->GetData();
515 dc
.DrawText(line
->GetText(), WXROUND(xoffset
+ line
->GetX()), WXROUND(yoffset
+ line
->GetY()));
516 current
= current
->GetNext();
519 dc
.DestroyClippingRegion();
523 * Find centroid given list of points comprising polyline
527 void oglFindPolylineCentroid(wxList
*points
, double *x
, double *y
)
532 wxObjectList::compatibility_iterator node
= points
->GetFirst();
535 wxRealPoint
*point
= (wxRealPoint
*)node
->GetData();
538 node
= node
->GetNext();
541 *x
= (xcount
/points
->GetCount());
542 *y
= (ycount
/points
->GetCount());
546 * Check that (x1, y1) -> (x2, y2) hits (x3, y3) -> (x4, y4).
547 * If so, ratio1 gives the proportion along the first line
548 * that the intersection occurs (or something like that).
549 * Used by functions below.
552 void oglCheckLineIntersection(double x1
, double y1
, double x2
, double y2
,
553 double x3
, double y3
, double x4
, double y4
,
554 double *ratio1
, double *ratio2
)
556 double denominator_term
= (y4
- y3
)*(x2
- x1
) - (y2
- y1
)*(x4
- x3
);
557 double numerator_term
= (x3
- x1
)*(y4
- y3
) + (x4
- x3
)*(y1
- y3
);
559 double line_constant
;
560 double length_ratio
= 1.0;
563 // Check for parallel lines
564 if ((denominator_term
< 0.005) && (denominator_term
> -0.005))
565 line_constant
= -1.0;
567 line_constant
= numerator_term
/denominator_term
;
569 // Check for intersection
570 if ((line_constant
< 1.0) && (line_constant
> 0.0))
572 // Now must check that other line hits
573 if (((y4
- y3
) < 0.005) && ((y4
- y3
) > -0.005))
574 k_line
= ((x1
- x3
) + line_constant
*(x2
- x1
))/(x4
- x3
);
576 k_line
= ((y1
- y3
) + line_constant
*(y2
- y1
))/(y4
- y3
);
578 if ((k_line
>= 0.0) && (k_line
< 1.0))
579 length_ratio
= line_constant
;
583 *ratio1
= length_ratio
;
588 * Find where (x1, y1) -> (x2, y2) hits one of the lines in xvec, yvec.
589 * (*x3, *y3) is the point where it hits.
592 void oglFindEndForPolyline(double n
, double xvec
[], double yvec
[],
593 double x1
, double y1
, double x2
, double y2
, double *x3
, double *y3
)
596 double lastx
= xvec
[0];
597 double lasty
= yvec
[0];
599 double min_ratio
= 1.0;
603 for (i
= 1; i
< n
; i
++)
605 oglCheckLineIntersection(x1
, y1
, x2
, y2
, lastx
, lasty
, xvec
[i
], yvec
[i
],
606 &line_ratio
, &other_ratio
);
610 if (line_ratio
< min_ratio
)
611 min_ratio
= line_ratio
;
614 // Do last (implicit) line if last and first doubles are not identical
615 if (!(xvec
[0] == lastx
&& yvec
[0] == lasty
))
617 oglCheckLineIntersection(x1
, y1
, x2
, y2
, lastx
, lasty
, xvec
[0], yvec
[0],
618 &line_ratio
, &other_ratio
);
620 if (line_ratio
< min_ratio
)
621 min_ratio
= line_ratio
;
624 *x3
= (x1
+ (x2
- x1
)*min_ratio
);
625 *y3
= (y1
+ (y2
- y1
)*min_ratio
);
630 * Find where the line hits the box.
634 void oglFindEndForBox(double width
, double height
,
635 double x1
, double y1
, // Centre of box (possibly)
636 double x2
, double y2
, // other end of line
637 double *x3
, double *y3
) // End on box edge
642 xvec
[0] = (double)(x1
- width
/2.0);
643 yvec
[0] = (double)(y1
- height
/2.0);
644 xvec
[1] = (double)(x1
- width
/2.0);
645 yvec
[1] = (double)(y1
+ height
/2.0);
646 xvec
[2] = (double)(x1
+ width
/2.0);
647 yvec
[2] = (double)(y1
+ height
/2.0);
648 xvec
[3] = (double)(x1
+ width
/2.0);
649 yvec
[3] = (double)(y1
- height
/2.0);
650 xvec
[4] = (double)(x1
- width
/2.0);
651 yvec
[4] = (double)(y1
- height
/2.0);
653 oglFindEndForPolyline(5, xvec
, yvec
, x2
, y2
, x1
, y1
, x3
, y3
);
657 * Find where the line hits the circle.
661 void oglFindEndForCircle(double radius
,
662 double x1
, double y1
, // Centre of circle
663 double x2
, double y2
, // Other end of line
664 double *x3
, double *y3
)
666 double H
= (double)sqrt((x2
- x1
)*(x2
- x1
) + (y2
- y1
)*(y2
- y1
));
675 *y3
= radius
* (y2
- y1
)/H
+ y1
;
676 *x3
= radius
* (x2
- x1
)/H
+ x1
;
681 * Given the line (x1, y1) -> (x2, y2), and an arrow size of given length and width,
682 * return the position of the tip of the arrow and the left and right vertices of the arrow.
686 void oglGetArrowPoints(double x1
, double y1
, double x2
, double y2
,
687 double length
, double width
,
688 double *tip_x
, double *tip_y
,
689 double *side1_x
, double *side1_y
,
690 double *side2_x
, double *side2_y
)
692 double l
= (double)sqrt((x2
- x1
)*(x2
- x1
) + (y2
- y1
)*(y2
- y1
));
697 double i_bar
= (x2
- x1
)/l
;
698 double j_bar
= (y2
- y1
)/l
;
700 double x3
= (- length
*i_bar
) + x2
;
701 double y3
= (- length
*j_bar
) + y2
;
703 *side1_x
= width
*(-j_bar
) + x3
;
704 *side1_y
= width
*i_bar
+ y3
;
706 *side2_x
= -width
*(-j_bar
) + x3
;
707 *side2_y
= -width
*i_bar
+ y3
;
709 *tip_x
= x2
; *tip_y
= y2
;
713 * Given an ellipse and endpoints of a line, returns the point at which
714 * the line touches the ellipse in values x4, y4.
715 * This function assumes that the centre of the ellipse is at x1, y1, and the
716 * ellipse has a width of width1 and a height of height1. It also assumes you are
717 * wanting to draw an arc FROM point x2, y2 TOWARDS point x3, y3.
718 * This function calculates the x,y coordinates of the intersection point of
719 * the arc with the ellipse.
720 * Author: Ian Harrison
723 void oglDrawArcToEllipse(double x1
, double y1
, double width1
, double height1
, double x2
, double y2
, double x3
, double y3
,
724 double *x4
, double *y4
)
726 double a1
= (double)(width1
/2.0);
727 double b1
= (double)(height1
/2.0);
729 // These are required to give top left x and y coordinates for DrawEllipse
730 // double top_left_x1 = (double)(x1 - a1);
731 // double top_left_y1 = (double)(y1 - b1);
733 // Check for vertical line
734 if (fabs(x2 - x3) < 0.05)
738 *y4 = (double)(y1 - b1);
740 *y4 = (double)(y1 + b1);
744 // Check that x2 != x3
745 if (fabs(x2
- x3
) < 0.05)
749 *y4
= (double)(y1
- sqrt((b1
*b1
- (((x2
-x1
)*(x2
-x1
))*(b1
*b1
)/(a1
*a1
)))));
751 *y4
= (double)(y1
+ sqrt((b1
*b1
- (((x2
-x1
)*(x2
-x1
))*(b1
*b1
)/(a1
*a1
)))));
755 // Calculate the x and y coordinates of the point where arc intersects ellipse
757 double A
, B
, C
, D
, E
, F
, G
, H
, K
;
758 double ellipse1_x
, ellipse1_y
;
760 A
= (double)(1/(a1
* a1
));
761 B
= (double)((y3
- y2
) * (y3
- y2
)) / ((x3
- x2
) * (x3
- x2
) * b1
* b1
);
762 C
= (double)(2 * (y3
- y2
) * (y2
- y1
)) / ((x3
- x2
) * b1
* b1
);
763 D
= (double)((y2
- y1
) * (y2
- y1
)) / (b1
* b1
);
765 F
= (double)(C
- (2 * A
* x1
) - (2 * B
* x2
));
766 G
= (double)((A
* x1
* x1
) + (B
* x2
* x2
) - (C
* x2
) + D
- 1);
767 H
= (double)((y3
- y2
) / (x3
- x2
));
768 K
= (double)((F
* F
) - (4 * E
* G
));
771 // In this case the line intersects the ellipse, so calculate intersection
775 ellipse1_x
= (double)(((F
* -1) + sqrt(K
)) / (2 * E
));
776 ellipse1_y
= (double)((H
* (ellipse1_x
- x2
)) + y2
);
780 ellipse1_x
= (double)(((F
* -1) - sqrt(K
)) / (2 * E
));
781 ellipse1_y
= (double)((H
* (ellipse1_x
- x2
)) + y2
);
785 // in this case, arc does not intersect ellipse, so just draw arc
794 // Draw a little circle (radius = 2) at the end of the arc where it hits
797 double circle_x = ellipse1_x - 2.0;
798 double circle_y = ellipse1_y - 2.0;
799 m_canvas->DrawEllipse(circle_x, circle_y, 4.0, 4.0);
803 // Update a list item from a list of strings
804 void UpdateListBox(wxListBox
*item
, wxList
*list
)
810 wxObjectList::compatibility_iterator node
= list
->GetFirst();
813 wxChar
*s
= (wxChar
*)node
->GetData();
815 node
= node
->GetNext();
819 bool oglRoughlyEqual(double val1
, double val2
, double tol
)
821 return ( (val1
< (val2
+ tol
)) && (val1
> (val2
- tol
)) &&
822 (val2
< (val1
+ tol
)) && (val2
> (val1
- tol
)));
826 * Hex<->Dec conversion
829 // Array used in DecToHex conversion routine.
830 static wxChar sg_HexArray
[] = { wxT('0'), wxT('1'), wxT('2'), wxT('3'),
831 wxT('4'), wxT('5'), wxT('6'), wxT('7'),
832 wxT('8'), wxT('9'), wxT('A'), wxT('B'),
833 wxT('C'), wxT('D'), wxT('E'), wxT('F')
836 // Convert 2-digit hex number to decimal
837 unsigned int oglHexToDec(wxChar
* buf
)
839 int firstDigit
, secondDigit
;
841 if (buf
[0] >= wxT('A'))
842 firstDigit
= buf
[0] - wxT('A') + 10;
844 firstDigit
= buf
[0] - wxT('0');
846 if (buf
[1] >= wxT('A'))
847 secondDigit
= buf
[1] - wxT('A') + 10;
849 secondDigit
= buf
[1] - wxT('0');
851 return firstDigit
* 16 + secondDigit
;
854 // Convert decimal integer to 2-character hex string
855 void oglDecToHex(unsigned int dec
, wxChar
*buf
)
857 int firstDigit
= (int)(dec
/16.0);
858 int secondDigit
= (int)(dec
- (firstDigit
*16.0));
859 buf
[0] = sg_HexArray
[firstDigit
];
860 buf
[1] = sg_HexArray
[secondDigit
];
864 // 3-digit hex to wxColour
865 wxColour
oglHexToColour(const wxString
& hex
)
867 if (hex
.Length() == 6)
871 hex
.Mid(0,2).ToLong(&r
, 16);
872 hex
.Mid(2,2).ToLong(&g
, 16);
873 hex
.Mid(4,2).ToLong(&b
, 16);
874 return wxColour(r
, g
, b
);
877 return wxColour(0,0,0);
880 // RGB to 3-digit hex
881 wxString
oglColourToHex(const wxColour
& colour
)
884 unsigned int red
= colour
.Red();
885 unsigned int green
= colour
.Green();
886 unsigned int blue
= colour
.Blue();
888 oglDecToHex(red
, buf
);
889 oglDecToHex(green
, buf
+2);
890 oglDecToHex(blue
, buf
+4);
892 return wxString(buf
);