Zivid C++ API  2.3.1+1a22cbf1-1
Defining the Future of 3D Machine Vision
Visualizer.h
Go to the documentation of this file.
1 
2 /*******************************************************************************
3  * This file is part of the Zivid 3D Camera API
4  *
5  * Copyright 2015-2022 (C) Zivid AS
6  * All rights reserved.
7  *
8  * Zivid Software License, v1.0
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions are met:
12  *
13  * 1. Redistributions of source code must retain the above copyright notice,
14  * this list of conditions and the following disclaimer.
15  *
16  * 2. Redistributions in binary form must reproduce the above copyright notice,
17  * this list of conditions and the following disclaimer in the documentation
18  * and/or other materials provided with the distribution.
19  *
20  * 3. Neither the name of Zivid AS nor the names of its contributors may be used
21  * to endorse or promote products derived from this software without specific
22  * prior written permission.
23  *
24  * 4. This software, with or without modification, must not be used with any
25  * other 3D camera than from Zivid AS.
26  *
27  * 5. Any software provided in binary form under this license must not be
28  * reverse engineered, decompiled, modified and/or disassembled.
29  *
30  * THIS SOFTWARE IS PROVIDED BY ZIVID AS "AS IS" AND ANY EXPRESS OR IMPLIED
31  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
32  * MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
33  * DISCLAIMED. IN NO EVENT SHALL ZIVID AS OR CONTRIBUTORS BE LIABLE FOR ANY
34  * DIRECT, 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 AND
37  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
38  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
39  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
40  *
41  * Contact: Zivid Customer Success Team <customersuccess@zivid.com>
42  * Info: http://www.zivid.com
43  ******************************************************************************/
44 
45 #pragma once
46 #include "Zivid/Detail/Pimpl.h"
48 
49 #include <memory>
50 #include <string>
51 
52 namespace Zivid
53 {
54  class PointCloud;
55  class Frame;
56 
57  namespace Visualization
58  {
59  class VisualizerImpl;
60 
64  class Visualizer
65  {
66  ZIVID_PIMPL_MOVE_ONLY(Visualizer, ZIVID_VISUALIZATION_EXPORT);
67 
68  public:
71 
74 
77 
80 
82  ZIVID_VISUALIZATION_EXPORT void resize(int h, int w);
83 
86 
89 
92 
94  ZIVID_VISUALIZATION_EXPORT void setWindowTitle(std::string title);
95 
98 
101 
104 
107 
110 
113  };
114  } // namespace Visualization
115 } // namespace Zivid
#define ZIVID_VISUALIZATION_EXPORT
Definition: VisualizationExport.h:57
A frame captured by a Zivid camera
Definition: Frame.h:66
Point cloud with x, y, z, RGB color and SNR laid out on a 2D grid
Definition: PointCloud.h:70
Simple visualizer component for point clouds
Definition: Visualizer.h:65
ZIVID_VISUALIZATION_EXPORT bool colorsEnabled() const
Whether coloring of the points with their accompanying RGB colors is enabled
ZIVID_VISUALIZATION_EXPORT void show()
Show the visualization window
ZIVID_VISUALIZATION_EXPORT void setColorsEnabled(bool enabled)
Enable or disable coloring of the points with their accompanying RGB colors
ZIVID_VISUALIZATION_EXPORT void setWindowTitle(std::string title)
Set the window title
ZIVID_VISUALIZATION_EXPORT void show(const Frame &frame)
Show a frame
ZIVID_VISUALIZATION_EXPORT void setMeshingEnabled(bool enabled)
Enable or disable meshing
ZIVID_VISUALIZATION_EXPORT Visualizer()
Constructor
ZIVID_VISUALIZATION_EXPORT void showMaximized()
Show the window in maximized mode
ZIVID_VISUALIZATION_EXPORT void resetToFit()
Reset the camera so that the contents will fit in the window
ZIVID_VISUALIZATION_EXPORT void showFullScreen()
Show the window in full screen mode
ZIVID_VISUALIZATION_EXPORT void resize(int h, int w)
Resize the window to specified height and width
ZIVID_VISUALIZATION_EXPORT void show(const PointCloud &cloud)
Show a point cloud
ZIVID_VISUALIZATION_EXPORT void hide()
Hide the visualization window
ZIVID_VISUALIZATION_EXPORT bool isMeshingEnabled() const
Whether meshing is enabled
ZIVID_VISUALIZATION_EXPORT int run()
Run the event loop. Should be called to allow interaction with the point cloud
The main Zivid namespace. All Zivid code is found here
Definition: Application.h:55