Zivid C++ API 2.13.1+18e79e79-1
Visualizer.h
Go to the documentation of this file.
1/*******************************************************************************
2 * This file is part of the Zivid API
3 *
4 * Copyright 2015-2024 (C) Zivid AS
5 * All rights reserved.
6 *
7 * Zivid Software License, v1.0
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions are met:
11 *
12 * 1. Redistributions of source code must retain the above copyright notice,
13 * this list of conditions and the following disclaimer.
14 *
15 * 2. Redistributions in binary form must reproduce the above copyright notice,
16 * this list of conditions and the following disclaimer in the documentation
17 * and/or other materials provided with the distribution.
18 *
19 * 3. Neither the name of Zivid AS nor the names of its contributors may be used
20 * to endorse or promote products derived from this software without specific
21 * prior written permission.
22 *
23 * 4. This software, with or without modification, must not be used with any
24 * other 3D camera than from Zivid AS.
25 *
26 * 5. Any software provided in binary form under this license must not be
27 * reverse engineered, decompiled, modified and/or disassembled.
28 *
29 * THIS SOFTWARE IS PROVIDED BY ZIVID AS "AS IS" AND ANY EXPRESS OR IMPLIED
30 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
31 * MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
32 * DISCLAIMED. IN NO EVENT SHALL ZIVID AS OR CONTRIBUTORS BE LIABLE FOR ANY
33 * DIRECT, 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 AND
36 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
37 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
38 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
39 *
40 * Contact: Zivid Customer Success Team <customersuccess@zivid.com>
41 * Info: http://www.zivid.com
42 ******************************************************************************/
43
44#pragma once
45#include "Zivid/Detail/Pimpl.h"
47
48#include <memory>
49#include <string>
50
51namespace Zivid
52{
53 class PointCloud;
54 class Frame;
55
56 namespace Visualization
57 {
58 class VisualizerImpl;
59
64 {
66
67 public:
70
73
76
79
82
85
88
91
94
97
100
103
106
109
112 };
113 } // namespace Visualization
114} // namespace Zivid
#define ZIVID_PIMPL_MOVE_ONLY(ClassName, Attributes)
Definition Pimpl.h:104
#define ZIVID_VISUALIZATION_EXPORT
Definition VisualizationExport.h:56
A frame captured by a Zivid camera.
Definition Frame.h:70
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:64
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:56