Zivid C++ API  1.8.1+6967bc1b-1
Defining the Future of 3D Machine Vision
PointCloud.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 
47 #include "Zivid/APIExport.h"
48 #include "Zivid/Point.h"
49 
50 #include <memory>
51 #include <string>
52 
53 namespace Zivid
54 {
55  class PointCloudImpl;
56 
58  class PointCloud
59  {
60  public:
63 
65  ZIVID_API_EXPORT PointCloud(size_t rows, size_t cols);
66 
68  ZIVID_API_EXPORT bool isEmpty() const;
69 
71  ZIVID_API_EXPORT size_t width() const;
72 
74  ZIVID_API_EXPORT size_t height() const;
75 
77  ZIVID_API_EXPORT size_t size() const;
78 
81  ZIVID_API_EXPORT Point &operator()(size_t idx);
82 
85  ZIVID_API_EXPORT const Point &operator()(size_t idx) const;
86 
90  ZIVID_API_EXPORT Point &operator()(size_t i, size_t j);
91 
95  ZIVID_API_EXPORT const Point &operator()(size_t i, size_t j) const;
96 
98  ZIVID_API_EXPORT void resize(size_t rows, size_t cols);
99 
101  ZIVID_API_EXPORT Point *dataPtr();
102 
104  ZIVID_API_EXPORT const Point *dataPtr() const;
105 
108 
111  ZIVID_API_EXPORT std::string toString() const;
112 
113  private:
114  explicit PointCloud(const PointCloudImpl &other);
115 
116  private:
117  std::shared_ptr<PointCloudImpl> m_impl;
118  };
119 } // namespace Zivid
Zivid::PointCloud::resize
ZIVID_API_EXPORT void resize(size_t rows, size_t cols)
Resize the point cloud to the given number of rows and columns
Point.h
Zivid::PointCloud::dataPtr
ZIVID_API_EXPORT Point * dataPtr()
Obtain a pointer to the first point in the point cloud
Zivid::PointCloud::toString
ZIVID_API_EXPORT std::string toString() const
Get string representation of the point cloud
Zivid::PointCloud::operator()
ZIVID_API_EXPORT Point & operator()(size_t idx)
Obtain a reference to a point given by a 1D linear index
Zivid::PointCloud::height
ZIVID_API_EXPORT size_t height() const
Return height (number of rows) of point cloud
Zivid::PointCloud::width
ZIVID_API_EXPORT size_t width() const
Return width (number of columns) of point cloud
Zivid::PointCloud::PointCloud
ZIVID_API_EXPORT PointCloud()
Construct an empty point cloud
APIExport.h
Zivid::PointCloud::isEmpty
ZIVID_API_EXPORT bool isEmpty() const
Return whether point cloud is empty
Zivid::PointCloud::clone
ZIVID_API_EXPORT PointCloud clone()
Make a deep copy of the point cloud
Zivid::PointCloud::size
ZIVID_API_EXPORT size_t size() const
Return number of points in point cloud
Zivid
The main Zivid namespace. All Zivid code is found here
Definition: Application.h:52
ZIVID_API_EXPORT
#define ZIVID_API_EXPORT
Definition: APIExport.h:56