Point Cloud Library (PCL)  1.9.1-dev
area_picking_event.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  * Copyright (c) 2012-, Open Perception, Inc.
7  *
8  * All rights reserved.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  *
14  * * Redistributions of source code must retain the above copyright
15  * notice, this list of conditions and the following disclaimer.
16  * * Redistributions in binary form must reproduce the above
17  * copyright notice, this list of conditions and the following
18  * disclaimer in the documentation and/or other materials provided
19  * with the distribution.
20  * * Neither the name of the copyright holder(s) nor the names of its
21  * contributors may be used to endorse or promote products derived
22  * from this software without specific prior written permission.
23  *
24  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
25  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
26  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
27  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
28  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
29  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
30  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
31  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
32  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
33  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
34  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
35  * POSSIBILITY OF SUCH DAMAGE.
36  *
37  */
38 
39 #pragma once
40 
41 #include <pcl/pcl_macros.h>
42 
43 namespace pcl
44 {
45  namespace visualization
46  {
47  /** /brief Class representing 3D area picking events. */
49  {
50  public:
51  AreaPickingEvent (int nb_points, const std::vector<int>& indices)
52  : nb_points_ (nb_points)
53  , indices_ (indices)
54  {}
55 
56  /** \brief For situations where a whole are is selected, return the points indices.
57  * \param[out] indices indices of the points under the area selected by user.
58  * \return true, if the area selected by the user contains points, false otherwise
59  */
60  inline bool
61  getPointsIndices (std::vector<int>& indices) const
62  {
63  if (nb_points_ <= 0)
64  return (false);
65  indices = indices_;
66  return (true);
67  }
68 
69  private:
70  int nb_points_;
71  std::vector<int> indices_;
72  };
73  } //namespace visualization
74 } //namespace pcl
This file defines compatibility wrappers for low level I/O functions.
Definition: convolution.h:45
/brief Class representing 3D area picking events.
bool getPointsIndices(std::vector< int > &indices) const
For situations where a whole are is selected, return the points indices.
AreaPickingEvent(int nb_points, const std::vector< int > &indices)
#define PCL_EXPORTS
Definition: pcl_macros.h:241
Defines all the PCL and non-PCL macros used.