|
| 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) 2013, OpenCV Foundation, all rights reserved. |
| 14 | +// Third party copyrights are property of their respective owners. |
| 15 | +// |
| 16 | +// Redistribution and use in source and binary forms, with or without modification, |
| 17 | +// are permitted provided that the following conditions are met: |
| 18 | +// |
| 19 | +// * Redistribution's of source code must retain the above copyright notice, |
| 20 | +// this list of conditions and the following disclaimer. |
| 21 | +// |
| 22 | +// * Redistribution's in binary form must reproduce the above copyright notice, |
| 23 | +// this list of conditions and the following disclaimer in the documentation |
| 24 | +// and/or other materials provided with the distribution. |
| 25 | +// |
| 26 | +// * The name of the copyright holders may not be used to endorse or promote products |
| 27 | +// derived from this software without specific prior written permission. |
| 28 | +// |
| 29 | +// This software is provided by the copyright holders and contributors "as is" and |
| 30 | +// any express or implied warranties, including, but not limited to, the implied |
| 31 | +// warranties of merchantability and fitness for a particular purpose are disclaimed. |
| 32 | +// In no event shall the Intel Corporation or contributors be liable for any direct, |
| 33 | +// indirect, incidental, special, exemplary, or consequential damages |
| 34 | +// (including, but not limited to, procurement of substitute goods or services; |
| 35 | +// loss of use, data, or profits; or business interruption) however caused |
| 36 | +// and on any theory of liability, whether in contract, strict liability, |
| 37 | +// or tort (including negligence or otherwise) arising in any way out of |
| 38 | +// the use of this software, even if advised of the possibility of such damage. |
| 39 | +// |
| 40 | +// Authors: |
| 41 | +// * Ozan Tonkal, [email protected] |
| 42 | +// * Anatoly Baksheev, Itseez Inc. myname.mysurname <> mycompany.com |
| 43 | +// |
| 44 | +//M*/ |
| 45 | + |
| 46 | +#ifndef OPENCV_VIZ_HPP |
| 47 | +#define OPENCV_VIZ_HPP |
| 48 | + |
| 49 | +#include <opencv2/viz/types.hpp> |
| 50 | +#include <opencv2/viz/widgets.hpp> |
| 51 | +#include <opencv2/viz/viz3d.hpp> |
| 52 | +#include <opencv2/viz/vizcore.hpp> |
| 53 | + |
| 54 | +/** |
| 55 | + @defgroup viz 3D Visualizer |
| 56 | +
|
| 57 | +This section describes 3D visualization window as well as classes and methods that are used to |
| 58 | +interact with it. |
| 59 | +
|
| 60 | +3D visualization window (see Viz3d) is used to display widgets (see Widget), and it provides several |
| 61 | +methods to interact with scene and widgets. |
| 62 | +
|
| 63 | + @{ |
| 64 | + @defgroup viz_widget Widget |
| 65 | +
|
| 66 | +In this section, the widget framework is explained. Widgets represent 2D or 3D objects, varying from |
| 67 | +simple ones such as lines to complex ones such as point clouds and meshes. |
| 68 | +
|
| 69 | +Widgets are **implicitly shared**. Therefore, one can add a widget to the scene, and modify the |
| 70 | +widget without re-adding the widget. |
| 71 | +
|
| 72 | +@code |
| 73 | +// Create a cloud widget |
| 74 | +viz::WCloud cw(cloud, viz::Color::red()); |
| 75 | +// Display it in a window |
| 76 | +myWindow.showWidget("CloudWidget1", cw); |
| 77 | +// Modify it, and it will be modified in the window. |
| 78 | +cw.setColor(viz::Color::yellow()); |
| 79 | +@endcode |
| 80 | +
|
| 81 | + @} |
| 82 | +*/ |
| 83 | + |
| 84 | +#endif /* OPENCV_VIZ_HPP */ |
0 commit comments