Point Cloud Library (PCL)  1.14.1-dev
point_xy_32i.h
1 /*
2  * Software License Agreement (BSD License)
3  *
4  * Point Cloud Library (PCL) - www.pointclouds.org
5  * Copyright (c) 2010-2011, Willow Garage, Inc.
6  *
7  * All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  *
13  * * Redistributions of source code must retain the above copyright
14  * notice, this list of conditions and the following disclaimer.
15  * * Redistributions in binary form must reproduce the above
16  * copyright notice, this list of conditions and the following
17  * disclaimer in the documentation and/or other materials provided
18  * with the distribution.
19  * * Neither the name of Willow Garage, Inc. nor the names of its
20  * contributors may be used to endorse or promote products derived
21  * from this software without specific prior written permission.
22  *
23  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
26  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
27  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
28  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
29  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
30  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
31  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
33  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
34  * POSSIBILITY OF SUCH DAMAGE.
35  *
36  */
37 
38 #pragma once
39 
40 #include <pcl/pcl_exports.h> // for PCL_EXPORTS
41 
42 #include <istream>
43 
44 namespace pcl {
45 
46 /** 2D point with integer x- and y-coordinates. */
48 public:
49  /** Constructor. */
50  inline PointXY32i() = default;
51 
52  /** Destructor. */
53  inline virtual ~PointXY32i() = default;
54 
55  /** Serializes the point to the specified stream.
56  *
57  * \param[out] stream the destination for the serialization
58  */
59  inline void
60  serialize(std::ostream& stream) const
61  {
62  stream.write(reinterpret_cast<const char*>(&x), sizeof(x));
63  stream.write(reinterpret_cast<const char*>(&y), sizeof(y));
64  }
65 
66  /** Deserializes the point from the specified stream.
67  *
68  * \param[in] stream the source for the deserialization
69  */
70  inline void
71  deserialize(std::istream& stream)
72  {
73  stream.read(reinterpret_cast<char*>(&x), sizeof(x));
74  stream.read(reinterpret_cast<char*>(&y), sizeof(y));
75  }
76 
77  /** Creates a random point within the specified window.
78  *
79  * \param[in] min_x the minimum value for the x-coordinate of the point
80  * \param[in] max_x the maximum value for the x-coordinate of the point
81  * \param[in] min_y the minimum value for the y-coordinate of the point
82  * \param[in] max_y the maximum value for the y-coordinate of the point
83  */
84  static PointXY32i
85  randomPoint(const int min_x, const int max_x, const int min_y, const int max_y);
86 
87 public:
88  /** The x-coordinate of the point. */
89  int x{0};
90  /** The y-coordinate of the point. */
91  int y{0};
92 };
93 
94 } // namespace pcl
2D point with integer x- and y-coordinates.
Definition: point_xy_32i.h:47
PointXY32i()=default
Constructor.
static PointXY32i randomPoint(const int min_x, const int max_x, const int min_y, const int max_y)
Creates a random point within the specified window.
virtual ~PointXY32i()=default
Destructor.
void serialize(std::ostream &stream) const
Serializes the point to the specified stream.
Definition: point_xy_32i.h:60
void deserialize(std::istream &stream)
Deserializes the point from the specified stream.
Definition: point_xy_32i.h:71
#define PCL_EXPORTS
Definition: pcl_macros.h:323