Point Cloud Library (PCL) 1.13.0
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#include <map>
44
45namespace pcl
46{
47 namespace visualization
48 {
49 /** /brief Class representing 3D area picking events. */
51 {
52 public:
53 AreaPickingEvent (std::map<std::string, pcl::Indices> cloud_indices)
54 : cloud_indices_ (std::move(cloud_indices))
55 {}
56
57 PCL_DEPRECATED(1,16,"This constructor is deprecated!")
58 AreaPickingEvent(int /*nb_points*/, const pcl::Indices& indices)
59 : AreaPickingEvent ({{"",indices}}) {}
60
61 /** \brief For situations where a whole area is selected, return the points indices.
62 * \param[out] indices indices of the points under the area selected by user.
63 * \return true, if the area selected by the user contains points, false otherwise
64 */
65 inline bool
67 {
68 if (cloud_indices_.empty())
69 return (false);
70
71 for (const auto& i : cloud_indices_)
72 indices.insert(indices.cend (), i.second.cbegin (), i.second.cend ());
73
74 return (true);
75 }
76 /** \brief For situations where a whole area is selected, return the names
77 * of the selected point clouds.
78 * \return The names of selected point clouds
79 */
80 inline std::vector<std::string>
82 {
83 std::vector<std::string> names;
84 for (const auto& i : cloud_indices_)
85 names.push_back (i.first);
86 return names;
87 }
88 /** \brief For situations where a whole area is selected, return the points indices
89 * for a given point cloud
90 * \param[in] name of selected clouds.
91 * \return The indices for the selected cloud.
92 */
93 inline Indices
94 getPointsIndices (const std::string& name) const
95 {
96 const auto cloud = cloud_indices_.find (name);
97 if(cloud == cloud_indices_.cend ())
98 return Indices ();
99
100 return cloud->second;
101 }
102
103 private:
104 std::map<std::string, pcl::Indices> cloud_indices_;
105 };
106 } //namespace visualization
107} //namespace pcl
/brief Class representing 3D area picking events.
bool getPointsIndices(pcl::Indices &indices) const
For situations where a whole area is selected, return the points indices.
std::vector< std::string > getCloudNames() const
For situations where a whole area is selected, return the names of the selected point clouds.
AreaPickingEvent(std::map< std::string, pcl::Indices > cloud_indices)
Indices getPointsIndices(const std::string &name) const
For situations where a whole area is selected, return the points indices for a given point cloud.
IndicesAllocator<> Indices
Type used for indices in PCL.
Definition: types.h:133
Defines all the PCL and non-PCL macros used.
#define PCL_EXPORTS
Definition: pcl_macros.h:323
#define PCL_DEPRECATED(Major, Minor, Message)
macro for compatibility across compilers and help remove old deprecated items for the Major....
Definition: pcl_macros.h:156