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