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, ozantonkal@gmail.com
42 //  * Anatoly Baksheev, Itseez Inc.  myname.mysurname <> mycompany.com
43 //
44 //M*/
45 
46 #ifndef __OPENCV_VIZ_WIDGET_ACCESSOR_HPP__
47 #define __OPENCV_VIZ_WIDGET_ACCESSOR_HPP__
48 
49 #include <opencv2/core/cvdef.h>
50 #include <vtkSmartPointer.h>
51 #include <vtkProp.h>
52 
53 namespace cv
54 {
55     namespace viz
56     {
57 
58 //! @addtogroup viz_widget
59 //! @{
60 
61         class Widget;
62 
63         /** @brief This class is for users who want to develop their own widgets using VTK library API. :
64         */
65         struct CV_EXPORTS WidgetAccessor
66         {
67             /** @brief Returns vtkProp of a given widget.
68 
69             @param widget Widget whose vtkProp is to be returned.
70 
71             @note vtkProp has to be down cast appropriately to be modified.
72                 @code
73                 vtkActor * actor = vtkActor::SafeDownCast(viz::WidgetAccessor::getProp(widget));
74                 @endcode
75              */
76             static vtkSmartPointer<vtkProp> getProp(const Widget &widget);
77             /** @brief Sets vtkProp of a given widget.
78 
79             @param widget Widget whose vtkProp is to be set. @param prop A vtkProp.
80              */
81             static void setProp(Widget &widget, vtkSmartPointer<vtkProp> prop);
82         };
83 
84 //! @}
85 
86     }
87 }
88 
89 #endif
90