1 /*M/////////////////////////////////////////////////////////////////////////////////////// 2 // 3 // IMPORTANT: READ BEFORE DOWNLOADING, COPYING, INSTALLING OR USING. 4 // 5 // By downloading, copying, installing or using the software you agree to this license. 6 // If you do not agree to this license, do not download, install, 7 // copy or use the software. 8 // 9 // 10 // License Agreement 11 // For Open Source Computer Vision Library 12 // 13 // Copyright (C) 2000-2008, Intel Corporation, all rights reserved. 14 // Copyright (C) 2009, Willow Garage Inc., all rights reserved. 15 // Third party copyrights are property of their respective owners. 16 // 17 // Redistribution and use in source and binary forms, with or without modification, 18 // are permitted provided that the following conditions are met: 19 // 20 // * Redistribution's of source code must retain the above copyright notice, 21 // this list of conditions and the following disclaimer. 22 // 23 // * Redistribution's in binary form must reproduce the above copyright notice, 24 // this list of conditions and the following disclaimer in the documentation 25 // and/or other materials provided with the distribution. 26 // 27 // * The name of the copyright holders may not be used to endorse or promote products 28 // derived from this software without specific prior written permission. 29 // 30 // This software is provided by the copyright holders and contributors "as is" and 31 // any express or implied warranties, including, but not limited to, the implied 32 // warranties of merchantability and fitness for a particular purpose are disclaimed. 33 // In no event shall the Intel Corporation or contributors be liable for any direct, 34 // indirect, incidental, special, exemplary, or consequential damages 35 // (including, but not limited to, procurement of substitute goods or services; 36 // loss of use, data, or profits; or business interruption) however caused 37 // and on any theory of liability, whether in contract, strict liability, 38 // or tort (including negligence or otherwise) arising in any way out of 39 // the use of this software, even if advised of the possibility of such damage. 40 // 41 //M*/ 42 43 #ifndef OPENCV_HIGHGUI_HPP 44 #define OPENCV_HIGHGUI_HPP 45 46 #include "opencv2/core.hpp" 47 #ifdef HAVE_OPENCV_IMGCODECS 48 #include "opencv2/imgcodecs.hpp" 49 #endif 50 #ifdef HAVE_OPENCV_VIDEOIO 51 #include "opencv2/videoio.hpp" 52 #endif 53 54 /** 55 @defgroup highgui High-level GUI 56 57 While OpenCV was designed for use in full-scale applications and can be used within functionally 58 rich UI frameworks (such as Qt\*, WinForms\*, or Cocoa\*) or without any UI at all, sometimes there 59 it is required to try functionality quickly and visualize the results. This is what the HighGUI 60 module has been designed for. 61 62 It provides easy interface to: 63 64 - Create and manipulate windows that can display images and "remember" their content (no need to 65 handle repaint events from OS). 66 - Add trackbars to the windows, handle simple mouse events as well as keyboard commands. 67 68 @{ 69 @defgroup highgui_opengl OpenGL support 70 @defgroup highgui_qt Qt New Functions 71 72  73 74 This figure explains new functionality implemented with Qt\* GUI. The new GUI provides a statusbar, 75 a toolbar, and a control panel. The control panel can have trackbars and buttonbars attached to it. 76 If you cannot see the control panel, press Ctrl+P or right-click any Qt window and select **Display 77 properties window**. 78 79 - To attach a trackbar, the window name parameter must be NULL. 80 81 - To attach a buttonbar, a button must be created. If the last bar attached to the control panel 82 is a buttonbar, the new button is added to the right of the last button. If the last bar 83 attached to the control panel is a trackbar, or the control panel is empty, a new buttonbar is 84 created. Then, a new button is attached to it. 85 86 See below the example used to generate the figure: 87 @code 88 int main(int argc, char *argv[]) 89 { 90 91 int value = 50; 92 int value2 = 0; 93 94 95 namedWindow("main1",WINDOW_NORMAL); 96 namedWindow("main2",WINDOW_AUTOSIZE | CV_GUI_NORMAL); 97 createTrackbar( "track1", "main1", &value, 255, NULL); 98 99 String nameb1 = "button1"; 100 String nameb2 = "button2"; 101 102 createButton(nameb1,callbackButton,&nameb1,QT_CHECKBOX,1); 103 createButton(nameb2,callbackButton,NULL,QT_CHECKBOX,0); 104 createTrackbar( "track2", NULL, &value2, 255, NULL); 105 createButton("button5",callbackButton1,NULL,QT_RADIOBOX,0); 106 createButton("button6",callbackButton2,NULL,QT_RADIOBOX,1); 107 108 setMouseCallback( "main2",on_mouse,NULL ); 109 110 Mat img1 = imread("files/flower.jpg"); 111 VideoCapture video; 112 video.open("files/hockey.avi"); 113 114 Mat img2,img3; 115 116 while( waitKey(33) != 27 ) 117 { 118 img1.convertTo(img2,-1,1,value); 119 video >> img3; 120 121 imshow("main1",img2); 122 imshow("main2",img3); 123 } 124 125 destroyAllWindows(); 126 127 return 0; 128 } 129 @endcode 130 131 132 @defgroup highgui_winrt WinRT support 133 134 This figure explains new functionality implemented with WinRT GUI. The new GUI provides an Image control, 135 and a slider panel. Slider panel holds trackbars attached to it. 136 137 Sliders are attached below the image control. Every new slider is added below the previous one. 138 139 See below the example used to generate the figure: 140 @code 141 void sample_app::MainPage::ShowWindow() 142 { 143 static cv::String windowName("sample"); 144 cv::winrt_initContainer(this->cvContainer); 145 cv::namedWindow(windowName); // not required 146 147 cv::Mat image = cv::imread("Assets/sample.jpg"); 148 cv::Mat converted = cv::Mat(image.rows, image.cols, CV_8UC4); 149 cv::cvtColor(image, converted, COLOR_BGR2BGRA); 150 cv::imshow(windowName, converted); // this will create window if it hasn't been created before 151 152 int state = 42; 153 cv::TrackbarCallback callback = [](int pos, void* userdata) 154 { 155 if (pos == 0) { 156 cv::destroyWindow(windowName); 157 } 158 }; 159 cv::TrackbarCallback callbackTwin = [](int pos, void* userdata) 160 { 161 if (pos >= 70) { 162 cv::destroyAllWindows(); 163 } 164 }; 165 cv::createTrackbar("Sample trackbar", windowName, &state, 100, callback); 166 cv::createTrackbar("Twin brother", windowName, &state, 100, callbackTwin); 167 } 168 @endcode 169 170 @defgroup highgui_c C API 171 @} 172 */ 173 174 ///////////////////////// graphical user interface ////////////////////////// 175 namespace cv 176 { 177 178 //! @addtogroup highgui 179 //! @{ 180 181 //! Flags for cv::namedWindow 182 enum WindowFlags { 183 WINDOW_NORMAL = 0x00000000, //!< the user can resize the window (no constraint) / also use to switch a fullscreen window to a normal size. 184 WINDOW_AUTOSIZE = 0x00000001, //!< the user cannot resize the window, the size is constrainted by the image displayed. 185 WINDOW_OPENGL = 0x00001000, //!< window with opengl support. 186 187 WINDOW_FULLSCREEN = 1, //!< change the window to fullscreen. 188 WINDOW_FREERATIO = 0x00000100, //!< the image expends as much as it can (no ratio constraint). 189 WINDOW_KEEPRATIO = 0x00000000, //!< the ratio of the image is respected. 190 WINDOW_GUI_EXPANDED=0x00000000, //!< status bar and tool bar 191 WINDOW_GUI_NORMAL = 0x00000010, //!< old fashious way 192 }; 193 194 //! Flags for cv::setWindowProperty / cv::getWindowProperty 195 enum WindowPropertyFlags { 196 WND_PROP_FULLSCREEN = 0, //!< fullscreen property (can be WINDOW_NORMAL or WINDOW_FULLSCREEN). 197 WND_PROP_AUTOSIZE = 1, //!< autosize property (can be WINDOW_NORMAL or WINDOW_AUTOSIZE). 198 WND_PROP_ASPECT_RATIO = 2, //!< window's aspect ration (can be set to WINDOW_FREERATIO or WINDOW_KEEPRATIO). 199 WND_PROP_OPENGL = 3, //!< opengl support. 200 WND_PROP_VISIBLE = 4 //!< checks whether the window exists and is visible 201 }; 202 203 //! Mouse Events see cv::MouseCallback 204 enum MouseEventTypes { 205 EVENT_MOUSEMOVE = 0, //!< indicates that the mouse pointer has moved over the window. 206 EVENT_LBUTTONDOWN = 1, //!< indicates that the left mouse button is pressed. 207 EVENT_RBUTTONDOWN = 2, //!< indicates that the right mouse button is pressed. 208 EVENT_MBUTTONDOWN = 3, //!< indicates that the middle mouse button is pressed. 209 EVENT_LBUTTONUP = 4, //!< indicates that left mouse button is released. 210 EVENT_RBUTTONUP = 5, //!< indicates that right mouse button is released. 211 EVENT_MBUTTONUP = 6, //!< indicates that middle mouse button is released. 212 EVENT_LBUTTONDBLCLK = 7, //!< indicates that left mouse button is double clicked. 213 EVENT_RBUTTONDBLCLK = 8, //!< indicates that right mouse button is double clicked. 214 EVENT_MBUTTONDBLCLK = 9, //!< indicates that middle mouse button is double clicked. 215 EVENT_MOUSEWHEEL = 10,//!< positive and negative values mean forward and backward scrolling, respectively. 216 EVENT_MOUSEHWHEEL = 11 //!< positive and negative values mean right and left scrolling, respectively. 217 }; 218 219 //! Mouse Event Flags see cv::MouseCallback 220 enum MouseEventFlags { 221 EVENT_FLAG_LBUTTON = 1, //!< indicates that the left mouse button is down. 222 EVENT_FLAG_RBUTTON = 2, //!< indicates that the right mouse button is down. 223 EVENT_FLAG_MBUTTON = 4, //!< indicates that the middle mouse button is down. 224 EVENT_FLAG_CTRLKEY = 8, //!< indicates that CTRL Key is pressed. 225 EVENT_FLAG_SHIFTKEY = 16,//!< indicates that SHIFT Key is pressed. 226 EVENT_FLAG_ALTKEY = 32 //!< indicates that ALT Key is pressed. 227 }; 228 229 //! Qt font weight 230 enum QtFontWeights { 231 QT_FONT_LIGHT = 25, //!< Weight of 25 232 QT_FONT_NORMAL = 50, //!< Weight of 50 233 QT_FONT_DEMIBOLD = 63, //!< Weight of 63 234 QT_FONT_BOLD = 75, //!< Weight of 75 235 QT_FONT_BLACK = 87 //!< Weight of 87 236 }; 237 238 //! Qt font style 239 enum QtFontStyles { 240 QT_STYLE_NORMAL = 0, //!< Normal font. 241 QT_STYLE_ITALIC = 1, //!< Italic font. 242 QT_STYLE_OBLIQUE = 2 //!< Oblique font. 243 }; 244 245 //! Qt "button" type 246 enum QtButtonTypes { 247 QT_PUSH_BUTTON = 0, //!< Push button. 248 QT_CHECKBOX = 1, //!< Checkbox button. 249 QT_RADIOBOX = 2, //!< Radiobox button. 250 QT_NEW_BUTTONBAR = 1024 //!< Button should create a new buttonbar 251 }; 252 253 /** @brief Callback function for mouse events. see cv::setMouseCallback 254 @param event one of the cv::MouseEventTypes constants. 255 @param x The x-coordinate of the mouse event. 256 @param y The y-coordinate of the mouse event. 257 @param flags one of the cv::MouseEventFlags constants. 258 @param userdata The optional parameter. 259 */ 260 typedef void (*MouseCallback)(int event, int x, int y, int flags, void* userdata); 261 262 /** @brief Callback function for Trackbar see cv::createTrackbar 263 @param pos current position of the specified trackbar. 264 @param userdata The optional parameter. 265 */ 266 typedef void (*TrackbarCallback)(int pos, void* userdata); 267 268 /** @brief Callback function defined to be called every frame. See cv::setOpenGlDrawCallback 269 @param userdata The optional parameter. 270 */ 271 typedef void (*OpenGlDrawCallback)(void* userdata); 272 273 /** @brief Callback function for a button created by cv::createButton 274 @param state current state of the button. It could be -1 for a push button, 0 or 1 for a check/radio box button. 275 @param userdata The optional parameter. 276 */ 277 typedef void (*ButtonCallback)(int state, void* userdata); 278 279 /** @brief Creates a window. 280 281 The function namedWindow creates a window that can be used as a placeholder for images and 282 trackbars. Created windows are referred to by their names. 283 284 If a window with the same name already exists, the function does nothing. 285 286 You can call cv::destroyWindow or cv::destroyAllWindows to close the window and de-allocate any associated 287 memory usage. For a simple program, you do not really have to call these functions because all the 288 resources and windows of the application are closed automatically by the operating system upon exit. 289 290 @note 291 292 Qt backend supports additional flags: 293 - **WINDOW_NORMAL or WINDOW_AUTOSIZE:** WINDOW_NORMAL enables you to resize the 294 window, whereas WINDOW_AUTOSIZE adjusts automatically the window size to fit the 295 displayed image (see imshow ), and you cannot change the window size manually. 296 - **WINDOW_FREERATIO or WINDOW_KEEPRATIO:** WINDOW_FREERATIO adjusts the image 297 with no respect to its ratio, whereas WINDOW_KEEPRATIO keeps the image ratio. 298 - **WINDOW_GUI_NORMAL or WINDOW_GUI_EXPANDED:** WINDOW_GUI_NORMAL is the old way to draw the window 299 without statusbar and toolbar, whereas WINDOW_GUI_EXPANDED is a new enhanced GUI. 300 By default, flags == WINDOW_AUTOSIZE | WINDOW_KEEPRATIO | WINDOW_GUI_EXPANDED 301 302 @param winname Name of the window in the window caption that may be used as a window identifier. 303 @param flags Flags of the window. The supported flags are: (cv::WindowFlags) 304 */ 305 CV_EXPORTS_W void namedWindow(const String& winname, int flags = WINDOW_AUTOSIZE); 306 307 /** @brief Destroys the specified window. 308 309 The function destroyWindow destroys the window with the given name. 310 311 @param winname Name of the window to be destroyed. 312 */ 313 CV_EXPORTS_W void destroyWindow(const String& winname); 314 315 /** @brief Destroys all of the HighGUI windows. 316 317 The function destroyAllWindows destroys all of the opened HighGUI windows. 318 */ 319 CV_EXPORTS_W void destroyAllWindows(); 320 321 CV_EXPORTS_W int startWindowThread(); 322 323 /** @brief Similar to #waitKey, but returns full key code. 324 325 @note 326 327 Key code is implementation specific and depends on used backend: QT/GTK/Win32/etc 328 329 */ 330 CV_EXPORTS_W int waitKeyEx(int delay = 0); 331 332 /** @brief Waits for a pressed key. 333 334 The function waitKey waits for a key event infinitely (when \f$\texttt{delay}\leq 0\f$ ) or for delay 335 milliseconds, when it is positive. Since the OS has a minimum time between switching threads, the 336 function will not wait exactly delay ms, it will wait at least delay ms, depending on what else is 337 running on your computer at that time. It returns the code of the pressed key or -1 if no key was 338 pressed before the specified time had elapsed. 339 340 @note 341 342 This function is the only method in HighGUI that can fetch and handle events, so it needs to be 343 called periodically for normal event processing unless HighGUI is used within an environment that 344 takes care of event processing. 345 346 @note 347 348 The function only works if there is at least one HighGUI window created and the window is active. 349 If there are several HighGUI windows, any of them can be active. 350 351 @param delay Delay in milliseconds. 0 is the special value that means "forever". 352 */ 353 CV_EXPORTS_W int waitKey(int delay = 0); 354 355 /** @brief Displays an image in the specified window. 356 357 The function imshow displays an image in the specified window. If the window was created with the 358 cv::WINDOW_AUTOSIZE flag, the image is shown with its original size, however it is still limited by the screen resolution. 359 Otherwise, the image is scaled to fit the window. The function may scale the image, depending on its depth: 360 361 - If the image is 8-bit unsigned, it is displayed as is. 362 - If the image is 16-bit unsigned or 32-bit integer, the pixels are divided by 256. That is, the 363 value range [0,255\*256] is mapped to [0,255]. 364 - If the image is 32-bit or 64-bit floating-point, the pixel values are multiplied by 255. That is, the 365 value range [0,1] is mapped to [0,255]. 366 367 If window was created with OpenGL support, cv::imshow also support ogl::Buffer , ogl::Texture2D and 368 cuda::GpuMat as input. 369 370 If the window was not created before this function, it is assumed creating a window with cv::WINDOW_AUTOSIZE. 371 372 If you need to show an image that is bigger than the screen resolution, you will need to call namedWindow("", WINDOW_NORMAL) before the imshow. 373 374 @note This function should be followed by cv::waitKey function which displays the image for specified 375 milliseconds. Otherwise, it won't display the image. For example, **waitKey(0)** will display the window 376 infinitely until any keypress (it is suitable for image display). **waitKey(25)** will display a frame 377 for 25 ms, after which display will be automatically closed. (If you put it in a loop to read 378 videos, it will display the video frame-by-frame) 379 380 @note 381 382 [__Windows Backend Only__] Pressing Ctrl+C will copy the image to the clipboard. 383 384 [__Windows Backend Only__] Pressing Ctrl+S will show a dialog to save the image. 385 386 @param winname Name of the window. 387 @param mat Image to be shown. 388 */ 389 CV_EXPORTS_W void imshow(const String& winname, InputArray mat); 390 391 /** @brief Resizes window to the specified size 392 393 @note 394 395 - The specified window size is for the image area. Toolbars are not counted. 396 - Only windows created without cv::WINDOW_AUTOSIZE flag can be resized. 397 398 @param winname Window name. 399 @param width The new window width. 400 @param height The new window height. 401 */ 402 CV_EXPORTS_W void resizeWindow(const String& winname, int width, int height); 403 404 /** @overload 405 @param winname Window name. 406 @param size The new window size. 407 */ 408 CV_EXPORTS_W void resizeWindow(const String& winname, const cv::Size& size); 409 410 /** @brief Moves window to the specified position 411 412 @param winname Name of the window. 413 @param x The new x-coordinate of the window. 414 @param y The new y-coordinate of the window. 415 */ 416 CV_EXPORTS_W void moveWindow(const String& winname, int x, int y); 417 418 /** @brief Changes parameters of a window dynamically. 419 420 The function setWindowProperty enables changing properties of a window. 421 422 @param winname Name of the window. 423 @param prop_id Window property to edit. The supported operation flags are: (cv::WindowPropertyFlags) 424 @param prop_value New value of the window property. The supported flags are: (cv::WindowFlags) 425 */ 426 CV_EXPORTS_W void setWindowProperty(const String& winname, int prop_id, double prop_value); 427 428 /** @brief Updates window title 429 @param winname Name of the window. 430 @param title New title. 431 */ 432 CV_EXPORTS_W void setWindowTitle(const String& winname, const String& title); 433 434 /** @brief Provides parameters of a window. 435 436 The function getWindowProperty returns properties of a window. 437 438 @param winname Name of the window. 439 @param prop_id Window property to retrieve. The following operation flags are available: (cv::WindowPropertyFlags) 440 441 @sa setWindowProperty 442 */ 443 CV_EXPORTS_W double getWindowProperty(const String& winname, int prop_id); 444 445 /** @brief Provides rectangle of image in the window. 446 447 The function getWindowImageRect returns the client screen coordinates, width and height of the image rendering area. 448 449 @param winname Name of the window. 450 451 @sa resizeWindow moveWindow 452 */ 453 CV_EXPORTS_W Rect getWindowImageRect(const String& winname); 454 455 /** @brief Sets mouse handler for the specified window 456 457 @param winname Name of the window. 458 @param onMouse Mouse callback. See OpenCV samples, such as 459 <https://github.com/opencv/opencv/tree/master/samples/cpp/ffilldemo.cpp>, on how to specify and 460 use the callback. 461 @param userdata The optional parameter passed to the callback. 462 */ 463 CV_EXPORTS void setMouseCallback(const String& winname, MouseCallback onMouse, void* userdata = 0); 464 465 /** @brief Gets the mouse-wheel motion delta, when handling mouse-wheel events cv::EVENT_MOUSEWHEEL and 466 cv::EVENT_MOUSEHWHEEL. 467 468 For regular mice with a scroll-wheel, delta will be a multiple of 120. The value 120 corresponds to 469 a one notch rotation of the wheel or the threshold for action to be taken and one such action should 470 occur for each delta. Some high-precision mice with higher-resolution freely-rotating wheels may 471 generate smaller values. 472 473 For cv::EVENT_MOUSEWHEEL positive and negative values mean forward and backward scrolling, 474 respectively. For cv::EVENT_MOUSEHWHEEL, where available, positive and negative values mean right and 475 left scrolling, respectively. 476 477 With the C API, the macro CV_GET_WHEEL_DELTA(flags) can be used alternatively. 478 479 @note 480 481 Mouse-wheel events are currently supported only on Windows. 482 483 @param flags The mouse callback flags parameter. 484 */ 485 CV_EXPORTS int getMouseWheelDelta(int flags); 486 487 /** @brief Selects ROI on the given image. 488 Function creates a window and allows user to select a ROI using mouse. 489 Controls: use `space` or `enter` to finish selection, use key `c` to cancel selection (function will return the zero cv::Rect). 490 491 @param windowName name of the window where selection process will be shown. 492 @param img image to select a ROI. 493 @param showCrosshair if true crosshair of selection rectangle will be shown. 494 @param fromCenter if true center of selection will match initial mouse position. In opposite case a corner of 495 selection rectangle will correspont to the initial mouse position. 496 @return selected ROI or empty rect if selection canceled. 497 498 @note The function sets it's own mouse callback for specified window using cv::setMouseCallback(windowName, ...). 499 After finish of work an empty callback will be set for the used window. 500 */ 501 CV_EXPORTS_W Rect selectROI(const String& windowName, InputArray img, bool showCrosshair = true, bool fromCenter = false); 502 503 /** @overload 504 */ 505 CV_EXPORTS_W Rect selectROI(InputArray img, bool showCrosshair = true, bool fromCenter = false); 506 507 /** @brief Selects ROIs on the given image. 508 Function creates a window and allows user to select a ROIs using mouse. 509 Controls: use `space` or `enter` to finish current selection and start a new one, 510 use `esc` to terminate multiple ROI selection process. 511 512 @param windowName name of the window where selection process will be shown. 513 @param img image to select a ROI. 514 @param boundingBoxes selected ROIs. 515 @param showCrosshair if true crosshair of selection rectangle will be shown. 516 @param fromCenter if true center of selection will match initial mouse position. In opposite case a corner of 517 selection rectangle will correspont to the initial mouse position. 518 519 @note The function sets it's own mouse callback for specified window using cv::setMouseCallback(windowName, ...). 520 After finish of work an empty callback will be set for the used window. 521 */ 522 CV_EXPORTS_W void selectROIs(const String& windowName, InputArray img, 523 CV_OUT std::vector<Rect>& boundingBoxes, bool showCrosshair = true, bool fromCenter = false); 524 525 /** @brief Creates a trackbar and attaches it to the specified window. 526 527 The function createTrackbar creates a trackbar (a slider or range control) with the specified name 528 and range, assigns a variable value to be a position synchronized with the trackbar and specifies 529 the callback function onChange to be called on the trackbar position change. The created trackbar is 530 displayed in the specified window winname. 531 532 @note 533 534 [__Qt Backend Only__] winname can be empty (or NULL) if the trackbar should be attached to the 535 control panel. 536 537 Clicking the label of each trackbar enables editing the trackbar values manually. 538 539 @param trackbarname Name of the created trackbar. 540 @param winname Name of the window that will be used as a parent of the created trackbar. 541 @param value Optional pointer to an integer variable whose value reflects the position of the 542 slider. Upon creation, the slider position is defined by this variable. 543 @param count Maximal position of the slider. The minimal position is always 0. 544 @param onChange Pointer to the function to be called every time the slider changes position. This 545 function should be prototyped as void Foo(int,void\*); , where the first parameter is the trackbar 546 position and the second parameter is the user data (see the next parameter). If the callback is 547 the NULL pointer, no callbacks are called, but only value is updated. 548 @param userdata User data that is passed as is to the callback. It can be used to handle trackbar 549 events without using global variables. 550 */ 551 CV_EXPORTS int createTrackbar(const String& trackbarname, const String& winname, 552 int* value, int count, 553 TrackbarCallback onChange = 0, 554 void* userdata = 0); 555 556 /** @brief Returns the trackbar position. 557 558 The function returns the current position of the specified trackbar. 559 560 @note 561 562 [__Qt Backend Only__] winname can be empty (or NULL) if the trackbar is attached to the control 563 panel. 564 565 @param trackbarname Name of the trackbar. 566 @param winname Name of the window that is the parent of the trackbar. 567 */ 568 CV_EXPORTS_W int getTrackbarPos(const String& trackbarname, const String& winname); 569 570 /** @brief Sets the trackbar position. 571 572 The function sets the position of the specified trackbar in the specified window. 573 574 @note 575 576 [__Qt Backend Only__] winname can be empty (or NULL) if the trackbar is attached to the control 577 panel. 578 579 @param trackbarname Name of the trackbar. 580 @param winname Name of the window that is the parent of trackbar. 581 @param pos New position. 582 */ 583 CV_EXPORTS_W void setTrackbarPos(const String& trackbarname, const String& winname, int pos); 584 585 /** @brief Sets the trackbar maximum position. 586 587 The function sets the maximum position of the specified trackbar in the specified window. 588 589 @note 590 591 [__Qt Backend Only__] winname can be empty (or NULL) if the trackbar is attached to the control 592 panel. 593 594 @param trackbarname Name of the trackbar. 595 @param winname Name of the window that is the parent of trackbar. 596 @param maxval New maximum position. 597 */ 598 CV_EXPORTS_W void setTrackbarMax(const String& trackbarname, const String& winname, int maxval); 599 600 /** @brief Sets the trackbar minimum position. 601 602 The function sets the minimum position of the specified trackbar in the specified window. 603 604 @note 605 606 [__Qt Backend Only__] winname can be empty (or NULL) if the trackbar is attached to the control 607 panel. 608 609 @param trackbarname Name of the trackbar. 610 @param winname Name of the window that is the parent of trackbar. 611 @param minval New minimum position. 612 */ 613 CV_EXPORTS_W void setTrackbarMin(const String& trackbarname, const String& winname, int minval); 614 615 //! @addtogroup highgui_opengl OpenGL support 616 //! @{ 617 618 /** @brief Displays OpenGL 2D texture in the specified window. 619 620 @param winname Name of the window. 621 @param tex OpenGL 2D texture data. 622 */ 623 CV_EXPORTS void imshow(const String& winname, const ogl::Texture2D& tex); 624 625 /** @brief Sets a callback function to be called to draw on top of displayed image. 626 627 The function setOpenGlDrawCallback can be used to draw 3D data on the window. See the example of 628 callback function below: 629 @code 630 void on_opengl(void* param) 631 { 632 glLoadIdentity(); 633 634 glTranslated(0.0, 0.0, -1.0); 635 636 glRotatef( 55, 1, 0, 0 ); 637 glRotatef( 45, 0, 1, 0 ); 638 glRotatef( 0, 0, 0, 1 ); 639 640 static const int coords[6][4][3] = { 641 { { +1, -1, -1 }, { -1, -1, -1 }, { -1, +1, -1 }, { +1, +1, -1 } }, 642 { { +1, +1, -1 }, { -1, +1, -1 }, { -1, +1, +1 }, { +1, +1, +1 } }, 643 { { +1, -1, +1 }, { +1, -1, -1 }, { +1, +1, -1 }, { +1, +1, +1 } }, 644 { { -1, -1, -1 }, { -1, -1, +1 }, { -1, +1, +1 }, { -1, +1, -1 } }, 645 { { +1, -1, +1 }, { -1, -1, +1 }, { -1, -1, -1 }, { +1, -1, -1 } }, 646 { { -1, -1, +1 }, { +1, -1, +1 }, { +1, +1, +1 }, { -1, +1, +1 } } 647 }; 648 649 for (int i = 0; i < 6; ++i) { 650 glColor3ub( i*20, 100+i*10, i*42 ); 651 glBegin(GL_QUADS); 652 for (int j = 0; j < 4; ++j) { 653 glVertex3d(0.2 * coords[i][j][0], 0.2 * coords[i][j][1], 0.2 * coords[i][j][2]); 654 } 655 glEnd(); 656 } 657 } 658 @endcode 659 660 @param winname Name of the window. 661 @param onOpenGlDraw Pointer to the function to be called every frame. This function should be 662 prototyped as void Foo(void\*) . 663 @param userdata Pointer passed to the callback function.(__Optional__) 664 */ 665 CV_EXPORTS void setOpenGlDrawCallback(const String& winname, OpenGlDrawCallback onOpenGlDraw, void* userdata = 0); 666 667 /** @brief Sets the specified window as current OpenGL context. 668 669 @param winname Name of the window. 670 */ 671 CV_EXPORTS void setOpenGlContext(const String& winname); 672 673 /** @brief Force window to redraw its context and call draw callback ( See cv::setOpenGlDrawCallback ). 674 675 @param winname Name of the window. 676 */ 677 CV_EXPORTS void updateWindow(const String& winname); 678 679 //! @} highgui_opengl 680 681 //! @addtogroup highgui_qt 682 //! @{ 683 684 /** @brief QtFont available only for Qt. See cv::fontQt 685 */ 686 struct QtFont 687 { 688 const char* nameFont; //!< Name of the font 689 Scalar color; //!< Color of the font. Scalar(blue_component, green_component, red_component[, alpha_component]) 690 int font_face; //!< See cv::QtFontStyles 691 const int* ascii; //!< font data and metrics 692 const int* greek; 693 const int* cyrillic; 694 float hscale, vscale; 695 float shear; //!< slope coefficient: 0 - normal, >0 - italic 696 int thickness; //!< See cv::QtFontWeights 697 float dx; //!< horizontal interval between letters 698 int line_type; //!< PointSize 699 }; 700 701 /** @brief Creates the font to draw a text on an image. 702 703 The function fontQt creates a cv::QtFont object. This cv::QtFont is not compatible with putText . 704 705 A basic usage of this function is the following: : 706 @code 707 QtFont font = fontQt("Times"); 708 addText( img1, "Hello World !", Point(50,50), font); 709 @endcode 710 711 @param nameFont Name of the font. The name should match the name of a system font (such as 712 *Times*). If the font is not found, a default one is used. 713 @param pointSize Size of the font. If not specified, equal zero or negative, the point size of the 714 font is set to a system-dependent default value. Generally, this is 12 points. 715 @param color Color of the font in BGRA where A = 255 is fully transparent. Use the macro CV_RGB 716 for simplicity. 717 @param weight Font weight. Available operation flags are : cv::QtFontWeights You can also specify a positive integer for better control. 718 @param style Font style. Available operation flags are : cv::QtFontStyles 719 @param spacing Spacing between characters. It can be negative or positive. 720 */ 721 CV_EXPORTS QtFont fontQt(const String& nameFont, int pointSize = -1, 722 Scalar color = Scalar::all(0), int weight = QT_FONT_NORMAL, 723 int style = QT_STYLE_NORMAL, int spacing = 0); 724 725 /** @brief Draws a text on the image. 726 727 The function addText draws *text* on the image *img* using a specific font *font* (see example cv::fontQt 728 ) 729 730 @param img 8-bit 3-channel image where the text should be drawn. 731 @param text Text to write on an image. 732 @param org Point(x,y) where the text should start on an image. 733 @param font Font to use to draw a text. 734 */ 735 CV_EXPORTS void addText( const Mat& img, const String& text, Point org, const QtFont& font); 736 737 /** @brief Draws a text on the image. 738 739 @param img 8-bit 3-channel image where the text should be drawn. 740 @param text Text to write on an image. 741 @param org Point(x,y) where the text should start on an image. 742 @param nameFont Name of the font. The name should match the name of a system font (such as 743 *Times*). If the font is not found, a default one is used. 744 @param pointSize Size of the font. If not specified, equal zero or negative, the point size of the 745 font is set to a system-dependent default value. Generally, this is 12 points. 746 @param color Color of the font in BGRA where A = 255 is fully transparent. 747 @param weight Font weight. Available operation flags are : cv::QtFontWeights You can also specify a positive integer for better control. 748 @param style Font style. Available operation flags are : cv::QtFontStyles 749 @param spacing Spacing between characters. It can be negative or positive. 750 */ 751 CV_EXPORTS_W void addText(const Mat& img, const String& text, Point org, const String& nameFont, int pointSize = -1, Scalar color = Scalar::all(0), 752 int weight = QT_FONT_NORMAL, int style = QT_STYLE_NORMAL, int spacing = 0); 753 754 /** @brief Displays a text on a window image as an overlay for a specified duration. 755 756 The function displayOverlay displays useful information/tips on top of the window for a certain 757 amount of time *delayms*. The function does not modify the image, displayed in the window, that is, 758 after the specified delay the original content of the window is restored. 759 760 @param winname Name of the window. 761 @param text Overlay text to write on a window image. 762 @param delayms The period (in milliseconds), during which the overlay text is displayed. If this 763 function is called before the previous overlay text timed out, the timer is restarted and the text 764 is updated. If this value is zero, the text never disappears. 765 */ 766 CV_EXPORTS_W void displayOverlay(const String& winname, const String& text, int delayms = 0); 767 768 /** @brief Displays a text on the window statusbar during the specified period of time. 769 770 The function displayStatusBar displays useful information/tips on top of the window for a certain 771 amount of time *delayms* . This information is displayed on the window statusbar (the window must be 772 created with the CV_GUI_EXPANDED flags). 773 774 @param winname Name of the window. 775 @param text Text to write on the window statusbar. 776 @param delayms Duration (in milliseconds) to display the text. If this function is called before 777 the previous text timed out, the timer is restarted and the text is updated. If this value is 778 zero, the text never disappears. 779 */ 780 CV_EXPORTS_W void displayStatusBar(const String& winname, const String& text, int delayms = 0); 781 782 /** @brief Saves parameters of the specified window. 783 784 The function saveWindowParameters saves size, location, flags, trackbars value, zoom and panning 785 location of the window windowName. 786 787 @param windowName Name of the window. 788 */ 789 CV_EXPORTS void saveWindowParameters(const String& windowName); 790 791 /** @brief Loads parameters of the specified window. 792 793 The function loadWindowParameters loads size, location, flags, trackbars value, zoom and panning 794 location of the window windowName. 795 796 @param windowName Name of the window. 797 */ 798 CV_EXPORTS void loadWindowParameters(const String& windowName); 799 800 CV_EXPORTS int startLoop(int (*pt2Func)(int argc, char *argv[]), int argc, char* argv[]); 801 802 CV_EXPORTS void stopLoop(); 803 804 /** @brief Attaches a button to the control panel. 805 806 The function createButton attaches a button to the control panel. Each button is added to a 807 buttonbar to the right of the last button. A new buttonbar is created if nothing was attached to the 808 control panel before, or if the last element attached to the control panel was a trackbar or if the 809 QT_NEW_BUTTONBAR flag is added to the type. 810 811 See below various examples of the cv::createButton function call: : 812 @code 813 createButton(NULL,callbackButton);//create a push button "button 0", that will call callbackButton. 814 createButton("button2",callbackButton,NULL,QT_CHECKBOX,0); 815 createButton("button3",callbackButton,&value); 816 createButton("button5",callbackButton1,NULL,QT_RADIOBOX); 817 createButton("button6",callbackButton2,NULL,QT_PUSH_BUTTON,1); 818 createButton("button6",callbackButton2,NULL,QT_PUSH_BUTTON|QT_NEW_BUTTONBAR);// create a push button in a new row 819 @endcode 820 821 @param bar_name Name of the button. 822 @param on_change Pointer to the function to be called every time the button changes its state. 823 This function should be prototyped as void Foo(int state,\*void); . *state* is the current state 824 of the button. It could be -1 for a push button, 0 or 1 for a check/radio box button. 825 @param userdata Pointer passed to the callback function. 826 @param type Optional type of the button. Available types are: (cv::QtButtonTypes) 827 @param initial_button_state Default state of the button. Use for checkbox and radiobox. Its 828 value could be 0 or 1. (__Optional__) 829 */ 830 CV_EXPORTS int createButton( const String& bar_name, ButtonCallback on_change, 831 void* userdata = 0, int type = QT_PUSH_BUTTON, 832 bool initial_button_state = false); 833 834 //! @} highgui_qt 835 836 //! @} highgui 837 838 } // cv 839 840 #ifndef DISABLE_OPENCV_24_COMPATIBILITY 841 #include "opencv2/highgui/highgui_c.h" 842 #endif 843 844 #endif 845
