Point Cloud Library (PCL)  1.11.0
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/common/common.h>
41 
42 #include <istream>
43 #include <ostream>
44 
45 namespace pcl {
46 
47 /** 2D point with integer x- and y-coordinates. */
48 class PCL_EXPORTS PointXY32i {
49 public:
50  /** Constructor. */
51  inline PointXY32i() : x(0), y(0) {}
52 
53  /** Destructor. */
54  inline virtual ~PointXY32i() {}
55 
56  /** Serializes the point to the specified stream.
57  *
58  * \param[out] stream the destination for the serialization
59  */
60  inline void
61  serialize(std::ostream& stream) const
62  {
63  stream.write(reinterpret_cast<const char*>(&x), sizeof(x));
64  stream.write(reinterpret_cast<const char*>(&y), sizeof(y));
65  }
66 
67  /** Deserializes the point from the specified stream.
68  *
69  * \param[in] stream the source for the deserialization
70  */
71  inline void
72  deserialize(std::istream& stream)
73  {
74  stream.read(reinterpret_cast<char*>(&x), sizeof(x));
75  stream.read(reinterpret_cast<char*>(&y), sizeof(y));
76  }
77 
78  /** Creates a random point within the specified window.
79  *
80  * \param[in] min_x the minimum value for the x-coordinate of the point
81  * \param[in] max_x the maximum value for the x-coordinate of the point
82  * \param[in] min_y the minimum value for the y-coordinate of the point
83  * \param[in] max_y the maximum value for the y-coordinate of the point
84  */
85  static PointXY32i
86  randomPoint(const int min_x, const int max_x, const int min_y, const int max_y);
87 
88 public:
89  /** The x-coordinate of the point. */
90  int x;
91  /** The y-coordinate of the point. */
92  int y;
93 };
94 
95 } // namespace pcl
int y
The y-coordinate of the point.
Definition: point_xy_32i.h:92
virtual ~PointXY32i()
Destructor.
Definition: point_xy_32i.h:54
void serialize(std::ostream &stream) const
Serializes the point to the specified stream.
Definition: point_xy_32i.h:61
PointXY32i()
Constructor.
Definition: point_xy_32i.h:51
2D point with integer x- and y-coordinates.
Definition: point_xy_32i.h:48
int x
The x-coordinate of the point.
Definition: point_xy_32i.h:90
void deserialize(std::istream &stream)
Deserializes the point from the specified stream.
Definition: point_xy_32i.h:72