File: launching_viz.markdown

package info (click to toggle)
opencv 4.5.1%2Bdfsg-5
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 268,248 kB
  • sloc: cpp: 969,170; xml: 682,525; python: 36,732; lisp: 30,170; java: 25,155; ansic: 7,927; javascript: 5,643; objc: 2,041; sh: 935; cs: 601; perl: 494; makefile: 145
file content (66 lines) | stat: -rw-r--r-- 1,868 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
Launching Viz {#tutorial_launching_viz}
=============

@next_tutorial{tutorial_widget_pose}

Goal
----

In this tutorial you will learn how to

-   Open a visualization window.
-   Access a window by its name.
-   Start event loop.
-   Start event loop for a given amount of time.

Code
----

You can download the code from [here ](https://github.com/opencv/opencv_contrib/tree/master/modules/viz/samples/launching_viz.cpp).
@include viz/samples/launching_viz.cpp

Explanation
-----------

Here is the general structure of the program:

-   Create a window.
    @code{.cpp}
    /// Create a window
    viz::Viz3d myWindow("Viz Demo");
    @endcode
-   Start event loop. This event loop will run until user terminates it by pressing **e**, **E**,
    **q**, **Q**.
    @code{.cpp}
    /// Start event loop
    myWindow.spin();
    @endcode
-   Access same window via its name. Since windows are implicitly shared, **sameWindow** is exactly
    the same with **myWindow**. If the name does not exist, a new window is created.
    @code{.cpp}
    /// Access window via its name
    viz::Viz3d sameWindow = viz::getWindowByName("Viz Demo");
    @endcode
-   Start a controlled event loop. Once it starts, **wasStopped** is set to false. Inside the while
    loop, in each iteration, **spinOnce** is called to prevent event loop from completely stopping.
    Inside the while loop, user can execute other statements including those which interact with the
    window.
    @code{.cpp}
    /// Event loop is over when pressed q, Q, e, E
    /// Start event loop once for 1 millisecond
    sameWindow.spinOnce(1, true);
    while(!sameWindow.wasStopped())
    {
        /// Interact with window

        /// Event loop for 1 millisecond
        sameWindow.spinOnce(1, true);
    }
    @endcode

Results
-------

Here is the result of the program.

![](images/window_demo.png)