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>
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
);
58 void wxOGLInitialize()
60 g_oglBullseyeCursor
= new wxCursor(wxCURSOR_BULLSEYE
);
62 g_oglNormalFont
= new wxFont(10, wxSWISS
, wxNORMAL
, wxNORMAL
);
64 g_oglBlackPen
= new wxPen("BLACK", 1, wxSOLID
);
66 g_oglWhiteBackgroundPen
= new wxPen("WHITE", 1, wxSOLID
);
67 g_oglTransparentPen
= new wxPen("WHITE", 1, wxTRANSPARENT
);
68 g_oglWhiteBackgroundBrush
= new wxBrush("WHITE", wxSOLID
);
69 g_oglBlackForegroundPen
= new wxPen("BLACK", 1, wxSOLID
);
71 OGLInitializeConstraintTypes();
73 // Initialize big buffer used when writing images
74 oglBuffer
= new char[3000];
76 if (!oglPopupDivisionMenu
)
78 oglPopupDivisionMenu
= new wxMenu("", (wxFunction
)oglGraphicsDivisionMenuProc
);
79 oglPopupDivisionMenu
->Append(DIVISION_MENU_SPLIT_HORIZONTALLY
, "Split horizontally");
80 oglPopupDivisionMenu
->Append(DIVISION_MENU_SPLIT_VERTICALLY
, "Split vertically");
81 oglPopupDivisionMenu
->AppendSeparator();
82 oglPopupDivisionMenu
->Append(DIVISION_MENU_EDIT_LEFT_EDGE
, "Edit left edge");
83 oglPopupDivisionMenu
->Append(DIVISION_MENU_EDIT_TOP_EDGE
, "Edit top edge");
95 if (oglPopupDivisionMenu
)
97 delete oglPopupDivisionMenu
;
98 oglPopupDivisionMenu
= NULL
;
100 if (g_oglBullseyeCursor
)
102 delete g_oglBullseyeCursor
;
103 g_oglBullseyeCursor
= NULL
;
108 delete g_oglNormalFont
;
109 g_oglNormalFont
= NULL
;
113 delete g_oglBlackPen
;
114 g_oglBlackPen
= NULL
;
116 if (g_oglWhiteBackgroundPen
)
118 delete g_oglWhiteBackgroundPen
;
119 g_oglWhiteBackgroundPen
= NULL
;
121 if (g_oglTransparentPen
)
123 delete g_oglTransparentPen
;
124 g_oglTransparentPen
= NULL
;
126 if (g_oglWhiteBackgroundBrush
)
128 delete g_oglWhiteBackgroundBrush
;
129 g_oglWhiteBackgroundBrush
= NULL
;
131 if (g_oglBlackForegroundPen
)
133 delete g_oglBlackForegroundPen
;
134 g_oglBlackForegroundPen
= NULL
;
137 OGLCleanUpConstraintTypes();
140 wxFont
*oglMatchFont(int point_size
)
142 wxFont
*font
= wxTheFontList
->FindOrCreateFont(point_size
, wxSWISS
, wxNORMAL
, wxNORMAL
);
156 font
= swiss_font_12
;
159 font
= swiss_font_14
;
162 font
= swiss_font_18
;
165 font
= swiss_font_24
;
169 font
= swiss_font_10
;
176 int FontSizeDialog(wxFrame
*parent
, int old_size
)
181 sprintf(buf
, "%d", old_size
);
182 wxString ans
= wxGetTextFromUser("Enter point size", "Font size", buf
, parent
);
186 int new_size
= atoi(ans
);
187 if ((new_size
<= 0) || (new_size
> 40))
189 wxMessageBox("Invalid point size!", "Error", wxOK
);
203 char *ans = wxGetSingleChoice("Choose", "Choose a font size", 8, strings, parent);
207 sscanf(ans, "%d", &size);
208 return oglMatchFont(size);
214 // Centre a list of strings in the given box. xOffset and yOffset are the
215 // the positions that these lines should be relative to, and this might be
216 // the same as m_xpos, m_ypos, but might be zero if formatting from left-justifying.
217 void oglCentreText(wxDC
& dc
, wxList
*text_list
,
218 double m_xpos
, double m_ypos
, double width
, double height
,
221 int n
= text_list
->Number();
223 if (!text_list
|| (n
== 0))
226 // First, get maximum dimensions of box enclosing text
228 long char_height
= 0;
230 long current_width
= 0;
232 // Store text extents for speed
233 double *widths
= new double[n
];
235 wxNode
*current
= text_list
->First();
239 wxShapeTextLine
*line
= (wxShapeTextLine
*)current
->Data();
240 dc
.GetTextExtent(line
->GetText(), ¤t_width
, &char_height
);
241 widths
[i
] = current_width
;
243 if (current_width
> max_width
)
244 max_width
= current_width
;
245 current
= current
->Next();
249 double max_height
= n
*char_height
;
251 double xoffset
, yoffset
, xOffset
, yOffset
;
253 if (formatMode
& FORMAT_CENTRE_VERT
)
255 if (max_height
< height
)
256 yoffset
= (double)(m_ypos
- (height
/2.0) + (height
- max_height
)/2.0);
258 yoffset
= (double)(m_ypos
- (height
/2.0));
267 if (formatMode
& FORMAT_CENTRE_HORIZ
)
269 xoffset
= (double)(m_xpos
- width
/2.0);
278 current
= text_list
->First();
283 wxShapeTextLine
*line
= (wxShapeTextLine
*)current
->Data();
286 if ((formatMode
& FORMAT_CENTRE_HORIZ
) && (widths
[i
] < width
))
287 x
= (double)((width
- widths
[i
])/2.0 + xoffset
);
290 double y
= (double)(i
*char_height
+ yoffset
);
292 line
->SetX( x
- xOffset
); line
->SetY( y
- yOffset
);
293 current
= current
->Next();
300 // Centre a list of strings in the given box
301 void oglCentreTextNoClipping(wxDC
& dc
, wxList
*text_list
,
302 double m_xpos
, double m_ypos
, double width
, double height
)
304 int n
= text_list
->Number();
306 if (!text_list
|| (n
== 0))
309 // First, get maximum dimensions of box enclosing text
311 long char_height
= 0;
313 long current_width
= 0;
315 // Store text extents for speed
316 double *widths
= new double[n
];
318 wxNode
*current
= text_list
->First();
322 wxShapeTextLine
*line
= (wxShapeTextLine
*)current
->Data();
323 dc
.GetTextExtent(line
->GetText(), ¤t_width
, &char_height
);
324 widths
[i
] = current_width
;
326 if (current_width
> max_width
)
327 max_width
= current_width
;
328 current
= current
->Next();
332 double max_height
= n
*char_height
;
334 double yoffset
= (double)(m_ypos
- (height
/2.0) + (height
- max_height
)/2.0);
336 double xoffset
= (double)(m_xpos
- width
/2.0);
338 current
= text_list
->First();
343 wxShapeTextLine
*line
= (wxShapeTextLine
*)current
->Data();
345 double x
= (double)((width
- widths
[i
])/2.0 + xoffset
);
346 double y
= (double)(i
*char_height
+ yoffset
);
348 line
->SetX( x
- m_xpos
); line
->SetY( y
- m_ypos
);
349 current
= current
->Next();
355 void oglGetCentredTextExtent(wxDC
& dc
, wxList
*text_list
,
356 double m_xpos
, double m_ypos
, double width
, double height
,
357 double *actual_width
, double *actual_height
)
359 int n
= text_list
->Number();
361 if (!text_list
|| (n
== 0))
368 // First, get maximum dimensions of box enclosing text
370 long char_height
= 0;
372 long current_width
= 0;
374 wxNode
*current
= text_list
->First();
378 wxShapeTextLine
*line
= (wxShapeTextLine
*)current
->Data();
379 dc
.GetTextExtent(line
->GetText(), ¤t_width
, &char_height
);
381 if (current_width
> max_width
)
382 max_width
= current_width
;
383 current
= current
->Next();
387 *actual_height
= n
*char_height
;
388 *actual_width
= max_width
;
391 // Format a string to a list of strings that fit in the given box.
392 // Interpret %n and 10 or 13 as a new line.
393 wxStringList
*oglFormatText(wxDC
& dc
, const wxString
& text
, double width
, double height
, int formatMode
)
395 // First, parse the string into a list of words
396 wxStringList word_list
;
398 // Make new lines into NULL strings at this point
399 int i
= 0; int j
= 0; int len
= strlen(text
);
400 char word
[200]; word
[0] = 0;
401 bool end_word
= FALSE
; bool new_line
= FALSE
;
410 { word
[j
] = '%'; j
++; }
414 { new_line
= TRUE
; end_word
= TRUE
; i
++; }
416 { word
[j
] = '%'; j
++; word
[j
] = text
[i
]; j
++; i
++; }
422 new_line
= TRUE
; end_word
= TRUE
; i
++;
427 new_line
= TRUE
; end_word
= TRUE
; i
++;
442 if (i
== len
) end_word
= TRUE
;
447 word_list
.Append((wxObject
*)copystring(word
));
452 word_list
.Append((wxObject
*)NULL
);
456 // Now, make a list of strings which can fit in the box
457 wxStringList
*string_list
= new wxStringList
;
461 wxNode
*node
= word_list
.First();
466 wxString
oldBuffer(buffer
);
468 char *s
= (char *)node
->Data();
472 if (strlen(buffer
) > 0)
473 string_list
->Add(buffer
);
483 dc
.GetTextExtent(buffer
, &x
, &y
);
485 // Don't fit within the bounding box if we're fitting shape to contents
486 if ((x
> width
) && !(formatMode
& FORMAT_SIZE_TO_CONTENTS
))
488 // Deal with first word being wider than box
489 if (oldBuffer
.Length() > 0)
490 string_list
->Add(oldBuffer
);
500 string_list
->Add(buffer
);
505 void oglDrawFormattedText(wxDC
& dc
, wxList
*text_list
,
506 double m_xpos
, double m_ypos
, double width
, double height
,
509 double xoffset
, yoffset
;
510 if (formatMode
& FORMAT_CENTRE_HORIZ
)
513 xoffset
= (double)(m_xpos
- (width
/ 2.0));
515 if (formatMode
& FORMAT_CENTRE_VERT
)
518 yoffset
= (double)(m_ypos
- (height
/ 2.0));
520 dc
.SetClippingRegion(
521 (long)(m_xpos
- width
/2.0), (long)(m_ypos
- height
/2.0),
522 (long)width
, (long)height
);
524 wxNode
*current
= text_list
->First();
527 wxShapeTextLine
*line
= (wxShapeTextLine
*)current
->Data();
529 dc
.DrawText(line
->GetText(), WXROUND(xoffset
+ line
->GetX()), WXROUND(yoffset
+ line
->GetY()));
530 current
= current
->Next();
533 dc
.DestroyClippingRegion();
537 * Find centroid given list of points comprising polyline
541 void oglFindPolylineCentroid(wxList
*points
, double *x
, double *y
)
546 wxNode
*node
= points
->First();
549 wxRealPoint
*point
= (wxRealPoint
*)node
->Data();
555 *x
= (xcount
/points
->Number());
556 *y
= (ycount
/points
->Number());
560 * Check that (x1, y1) -> (x2, y2) hits (x3, y3) -> (x4, y4).
561 * If so, ratio1 gives the proportion along the first line
562 * that the intersection occurs (or something like that).
563 * Used by functions below.
566 void oglCheckLineIntersection(double x1
, double y1
, double x2
, double y2
,
567 double x3
, double y3
, double x4
, double y4
,
568 double *ratio1
, double *ratio2
)
570 double denominator_term
= (y4
- y3
)*(x2
- x1
) - (y2
- y1
)*(x4
- x3
);
571 double numerator_term
= (x3
- x1
)*(y4
- y3
) + (x4
- x3
)*(y1
- y3
);
573 double line_constant
;
574 double length_ratio
= 1.0;
577 // Check for parallel lines
578 if ((denominator_term
< 0.005) && (denominator_term
> -0.005))
579 line_constant
= -1.0;
581 line_constant
= numerator_term
/denominator_term
;
583 // Check for intersection
584 if ((line_constant
< 1.0) && (line_constant
> 0.0))
586 // Now must check that other line hits
587 if (((y4
- y3
) < 0.005) && ((y4
- y3
) > -0.005))
588 k_line
= ((x1
- x3
) + line_constant
*(x2
- x1
))/(x4
- x3
);
590 k_line
= ((y1
- y3
) + line_constant
*(y2
- y1
))/(y4
- y3
);
592 if ((k_line
>= 0.0) && (k_line
< 1.0))
593 length_ratio
= line_constant
;
597 *ratio1
= length_ratio
;
602 * Find where (x1, y1) -> (x2, y2) hits one of the lines in xvec, yvec.
603 * (*x3, *y3) is the point where it hits.
606 void oglFindEndForPolyline(double n
, double xvec
[], double yvec
[],
607 double x1
, double y1
, double x2
, double y2
, double *x3
, double *y3
)
610 double lastx
= xvec
[0];
611 double lasty
= yvec
[0];
613 double min_ratio
= 1.0;
617 for (i
= 1; i
< n
; i
++)
619 oglCheckLineIntersection(x1
, y1
, x2
, y2
, lastx
, lasty
, xvec
[i
], yvec
[i
],
620 &line_ratio
, &other_ratio
);
624 if (line_ratio
< min_ratio
)
625 min_ratio
= line_ratio
;
628 // Do last (implicit) line if last and first doubles are not identical
629 if (!(xvec
[0] == lastx
&& yvec
[0] == lasty
))
631 oglCheckLineIntersection(x1
, y1
, x2
, y2
, lastx
, lasty
, xvec
[0], yvec
[0],
632 &line_ratio
, &other_ratio
);
634 if (line_ratio
< min_ratio
)
635 min_ratio
= line_ratio
;
638 *x3
= (x1
+ (x2
- x1
)*min_ratio
);
639 *y3
= (y1
+ (y2
- y1
)*min_ratio
);
644 * Find where the line hits the box.
648 void oglFindEndForBox(double width
, double height
,
649 double x1
, double y1
, // Centre of box (possibly)
650 double x2
, double y2
, // other end of line
651 double *x3
, double *y3
) // End on box edge
656 xvec
[0] = (double)(x1
- width
/2.0);
657 yvec
[0] = (double)(y1
- height
/2.0);
658 xvec
[1] = (double)(x1
- width
/2.0);
659 yvec
[1] = (double)(y1
+ height
/2.0);
660 xvec
[2] = (double)(x1
+ width
/2.0);
661 yvec
[2] = (double)(y1
+ height
/2.0);
662 xvec
[3] = (double)(x1
+ width
/2.0);
663 yvec
[3] = (double)(y1
- height
/2.0);
664 xvec
[4] = (double)(x1
- width
/2.0);
665 yvec
[4] = (double)(y1
- height
/2.0);
667 oglFindEndForPolyline(5, xvec
, yvec
, x2
, y2
, x1
, y1
, x3
, y3
);
671 * Find where the line hits the circle.
675 void oglFindEndForCircle(double radius
,
676 double x1
, double y1
, // Centre of circle
677 double x2
, double y2
, // Other end of line
678 double *x3
, double *y3
)
680 double H
= (double)sqrt((x2
- x1
)*(x2
- x1
) + (y2
- y1
)*(y2
- y1
));
689 *y3
= radius
* (y2
- y1
)/H
+ y1
;
690 *x3
= radius
* (x2
- x1
)/H
+ x1
;
695 * Given the line (x1, y1) -> (x2, y2), and an arrow size of given length and width,
696 * return the position of the tip of the arrow and the left and right vertices of the arrow.
700 void oglGetArrowPoints(double x1
, double y1
, double x2
, double y2
,
701 double length
, double width
,
702 double *tip_x
, double *tip_y
,
703 double *side1_x
, double *side1_y
,
704 double *side2_x
, double *side2_y
)
706 double l
= (double)sqrt((x2
- x1
)*(x2
- x1
) + (y2
- y1
)*(y2
- y1
));
711 double i_bar
= (x2
- x1
)/l
;
712 double j_bar
= (y2
- y1
)/l
;
714 double x3
= (- length
*i_bar
) + x2
;
715 double y3
= (- length
*j_bar
) + y2
;
717 *side1_x
= width
*(-j_bar
) + x3
;
718 *side1_y
= width
*i_bar
+ y3
;
720 *side2_x
= -width
*(-j_bar
) + x3
;
721 *side2_y
= -width
*i_bar
+ y3
;
723 *tip_x
= x2
; *tip_y
= y2
;
727 * Given an ellipse and endpoints of a line, returns the point at which
728 * the line touches the ellipse in values x4, y4.
729 * This function assumes that the centre of the ellipse is at x1, y1, and the
730 * ellipse has a width of width1 and a height of height1. It also assumes you are
731 * wanting to draw an arc FROM point x2, y2 TOWARDS point x3, y3.
732 * This function calculates the x,y coordinates of the intersection point of
733 * the arc with the ellipse.
734 * Author: Ian Harrison
737 void oglDrawArcToEllipse(double x1
, double y1
, double width1
, double height1
, double x2
, double y2
, double x3
, double y3
,
738 double *x4
, double *y4
)
740 double a1
= (double)(width1
/2.0);
741 double b1
= (double)(height1
/2.0);
743 // These are required to give top left x and y coordinates for DrawEllipse
744 // double top_left_x1 = (double)(x1 - a1);
745 // double top_left_y1 = (double)(y1 - b1);
747 // Check for vertical line
748 if (fabs(x2 - x3) < 0.05)
752 *y4 = (double)(y1 - b1);
754 *y4 = (double)(y1 + b1);
758 // Check that x2 != x3
759 if (fabs(x2
- x3
) < 0.05)
763 *y4
= (double)(y1
- sqrt((b1
*b1
- (((x2
-x1
)*(x2
-x1
))*(b1
*b1
)/(a1
*a1
)))));
765 *y4
= (double)(y1
+ sqrt((b1
*b1
- (((x2
-x1
)*(x2
-x1
))*(b1
*b1
)/(a1
*a1
)))));
769 // Calculate the x and y coordinates of the point where arc intersects ellipse
771 double A
, B
, C
, D
, E
, F
, G
, H
, K
;
772 double ellipse1_x
, ellipse1_y
;
774 A
= (double)(1/(a1
* a1
));
775 B
= (double)((y3
- y2
) * (y3
- y2
)) / ((x3
- x2
) * (x3
- x2
) * b1
* b1
);
776 C
= (double)(2 * (y3
- y2
) * (y2
- y1
)) / ((x3
- x2
) * b1
* b1
);
777 D
= (double)((y2
- y1
) * (y2
- y1
)) / (b1
* b1
);
779 F
= (double)(C
- (2 * A
* x1
) - (2 * B
* x2
));
780 G
= (double)((A
* x1
* x1
) + (B
* x2
* x2
) - (C
* x2
) + D
- 1);
781 H
= (double)((y3
- y2
) / (x3
- x2
));
782 K
= (double)((F
* F
) - (4 * E
* G
));
785 // In this case the line intersects the ellipse, so calculate intersection
789 ellipse1_x
= (double)(((F
* -1) + sqrt(K
)) / (2 * E
));
790 ellipse1_y
= (double)((H
* (ellipse1_x
- x2
)) + y2
);
794 ellipse1_x
= (double)(((F
* -1) - sqrt(K
)) / (2 * E
));
795 ellipse1_y
= (double)((H
* (ellipse1_x
- x2
)) + y2
);
799 // in this case, arc does not intersect ellipse, so just draw arc
808 // Draw a little circle (radius = 2) at the end of the arc where it hits
811 double circle_x = ellipse1_x - 2.0;
812 double circle_y = ellipse1_y - 2.0;
813 m_canvas->DrawEllipse(circle_x, circle_y, 4.0, 4.0);
817 // Update a list item from a list of strings
818 void UpdateListBox(wxListBox
*item
, wxList
*list
)
824 wxNode
*node
= list
->First();
827 char *s
= (char *)node
->Data();
833 bool oglRoughlyEqual(double val1
, double val2
, double tol
)
835 return ( (val1
< (val2
+ tol
)) && (val1
> (val2
- tol
)) &&
836 (val2
< (val1
+ tol
)) && (val2
> (val1
- tol
)));
840 * Hex<->Dec conversion
843 // Array used in DecToHex conversion routine.
844 static char sg_HexArray
[] = { '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'A', 'B',
845 'C', 'D', 'E', 'F' };
847 // Convert 2-digit hex number to decimal
848 unsigned int oglHexToDec(char* buf
)
850 int firstDigit
, secondDigit
;
853 firstDigit
= buf
[0] - 'A' + 10;
855 firstDigit
= buf
[0] - '0';
858 secondDigit
= buf
[1] - 'A' + 10;
860 secondDigit
= buf
[1] - '0';
862 return firstDigit
* 16 + secondDigit
;
865 // Convert decimal integer to 2-character hex string
866 void oglDecToHex(unsigned int dec
, char *buf
)
868 int firstDigit
= (int)(dec
/16.0);
869 int secondDigit
= (int)(dec
- (firstDigit
*16.0));
870 buf
[0] = sg_HexArray
[firstDigit
];
871 buf
[1] = sg_HexArray
[secondDigit
];
875 // 3-digit hex to wxColour
876 wxColour
oglHexToColour(const wxString
& hex
)
878 if (hex
.Length() == 6)
881 strncpy(buf
, hex
, 7);
882 unsigned int r
= oglHexToDec((char *)buf
);
883 unsigned int g
= oglHexToDec((char *)(buf
+2));
884 unsigned int b
= oglHexToDec((char *)(buf
+4));
885 return wxColour(r
, g
, b
);
888 return wxColour(0,0,0);
891 // RGB to 3-digit hex
892 wxString
oglColourToHex(const wxColour
& colour
)
895 unsigned int red
= colour
.Red();
896 unsigned int green
= colour
.Green();
897 unsigned int blue
= colour
.Blue();
899 oglDecToHex(red
, buf
);
900 oglDecToHex(green
, buf
+2);
901 oglDecToHex(blue
, buf
+4);
903 return wxString(buf
);