Zivid C++ API  1.8.1+6967bc1b-1
Defining the Future of 3D Machine Vision
CloudVisualizer.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-2020 (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 Support <support@zivid.com>
42  * Info: http://www.zivid.com
43  ******************************************************************************/
44 
45 #pragma once
46 #include "Zivid/Pimpl.h"
47 #include "Zivid/Vis3DExport.h"
48 
49 #include <memory>
50 #include <string>
51 
52 namespace Zivid
53 {
54  class ComputeDevice;
55  class DeviceCloud;
56  class PointCloud;
57  class Frame;
58  class CloudVisualizerImpl;
59 
64  class CloudVisualizer
65  {
66  ZIVID_PIMPL_MOVE_ONLY(CloudVisualizer, ZIVID_VIS3D_EXPORT);
67 
68  public:
71 
73  ZIVID_VIS3D_EXPORT void show();
74 
76  ZIVID_VIS3D_EXPORT void hide();
77 
79  ZIVID_VIS3D_EXPORT int run();
80 
82  ZIVID_VIS3D_EXPORT void resize(int h, int w);
83 
86 
89 
92 
94  ZIVID_VIS3D_EXPORT void setWindowTitle(std::string title);
95 
100  ZIVID_VIS3D_EXPORT ComputeDevice computeDevice();
101 
103  ZIVID_VIS3D_EXPORT void show(const DeviceCloud &dCloud);
104 
106  ZIVID_VIS3D_EXPORT void show(const PointCloud &cloud);
107 
109  ZIVID_VIS3D_EXPORT void show(const Frame &frame);
110 
112  ZIVID_VIS3D_EXPORT void enableColors(bool enable);
113 
115  ZIVID_VIS3D_EXPORT bool colorsEnabled() const;
116 
118  ZIVID_VIS3D_EXPORT void enableMeshing(bool enable);
119 
122  };
123 } // namespace Zivid
Zivid::CloudVisualizer::enableMeshing
ZIVID_VIS3D_EXPORT void enableMeshing(bool enable)
Enable or disable meshing
Zivid::DeviceCloud
Point cloud on the Compute device
Definition: DeviceCloud.h:101
Zivid::CloudVisualizer::show
ZIVID_VIS3D_EXPORT void show()
Show the visualization window
Zivid::CloudVisualizer::enableColors
ZIVID_VIS3D_EXPORT void enableColors(bool enable)
Enable or disable coloring of the points with their accompanying RGB colors
ZIVID_VIS3D_EXPORT
#define ZIVID_VIS3D_EXPORT
Definition: Vis3DExport.h:56
Zivid::CloudVisualizer::showMaximized
ZIVID_VIS3D_EXPORT void showMaximized()
Show the window in maximized mode
Vis3DExport.h
Zivid::CloudVisualizer::hide
ZIVID_VIS3D_EXPORT void hide()
Hide the visualization window
Zivid::CloudVisualizer::resize
ZIVID_VIS3D_EXPORT void resize(int h, int w)
Resize the window to specified height and width
Zivid::CloudVisualizer::resetToFit
ZIVID_VIS3D_EXPORT void resetToFit()
Reset the camera so that the contents will fit in the window
Zivid::CloudVisualizer::setWindowTitle
ZIVID_VIS3D_EXPORT void setWindowTitle(std::string title)
Set the window title
Zivid::CloudVisualizer::showFullScreen
ZIVID_VIS3D_EXPORT void showFullScreen()
Show the window in full screen mode
Zivid::CloudVisualizer::computeDevice
ZIVID_VIS3D_EXPORT ComputeDevice computeDevice()
Get the compute device associated with this view
Zivid::CloudVisualizer::isMeshingEnabled
ZIVID_VIS3D_EXPORT bool isMeshingEnabled() const
Whether meshing is enabled
Zivid::CloudVisualizer::run
ZIVID_VIS3D_EXPORT int run()
Run the event loop. Should be called to allow interaction with the point cloud
Pimpl.h
Zivid::Frame
A frame captured by a Zivid camera
Definition: Frame.h:104
Zivid
The main Zivid namespace. All Zivid code is found here
Definition: Application.h:52
Zivid::PointCloud
A point cloud with x,y,z, contrast and color data laid out on a 2D grid.
Definition: PointCloud.h:97
Zivid::CloudVisualizer::CloudVisualizer
ZIVID_VIS3D_EXPORT CloudVisualizer()
Constructor
Zivid::CloudVisualizer::colorsEnabled
ZIVID_VIS3D_EXPORT bool colorsEnabled() const
Whether coloring of the points with their accompanying RGB colors is enabled