Point Cloud Library (PCL)  1.8.0
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 #ifndef PCL_ML_POINT_XY_32F_H_
39 #define PCL_ML_POINT_XY_32F_H_
40 
41 #include <pcl/common/common.h>
42 
43 #include <istream>
44 #include <ostream>
45 
46 namespace pcl
47 {
48 
49  /** \brief 2D point with float x- and y-coordinates. */
50  class PCL_EXPORTS PointXY32f
51  {
52  public:
53  /** \brief Constructor. */
54  inline PointXY32f () : x (0.0f), y (0.0f) {}
55  /** \brief Destructor. */
56  inline virtual ~PointXY32f () {}
57 
58  /** \brief Serializes the point to the specified stream.
59  * \param[out] stream The destination for the serialization.
60  */
61  inline void
62  serialize (std::ostream & stream) const
63  {
64  stream.write (reinterpret_cast<const char*> (&x), sizeof (x));
65  stream.write (reinterpret_cast<const char*> (&y), sizeof (y));
66  }
67 
68  /** \brief Deserializes the point from the specified stream.
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  /** \brief Creates a random point within the specified window.
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 PointXY32f
85  randomPoint (const int min_x, const int max_x, const int min_y, const int max_y);
86 
87  public:
88  /** \brief The x-coordinate of the point. */
89  float x;
90  /** \brief The y-coordinate of the point. */
91  float y;
92  };
93 
94 }
95 
96 #endif
PointXY32f()
Constructor.
Definition: point_xy_32f.h:54
void serialize(std::ostream &stream) const
Serializes the point to the specified stream.
Definition: point_xy_32f.h:62
float x
The x-coordinate of the point.
Definition: point_xy_32f.h:89
2D point with float x- and y-coordinates.
Definition: point_xy_32f.h:50
float y
The y-coordinate of the point.
Definition: point_xy_32f.h:91
virtual ~PointXY32f()
Destructor.
Definition: point_xy_32f.h:56
void deserialize(std::istream &stream)
Deserializes the point from the specified stream.
Definition: point_xy_32f.h:72