Polyline.hh
Go to the documentation of this file.
1 /*
2  * Copyright 2022 Open Source Robotics Foundation
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  *
16  */
17 #ifndef SDF_POLYLINE_HH_
18 #define SDF_POLYLINE_HH_
19 
20 #include <vector>
21 
22 #include <gz/math/Vector2.hh>
23 #include <sdf/Error.hh>
24 #include <sdf/Element.hh>
25 #include <sdf/sdf_config.h>
26 
27 namespace sdf
28 {
29  // Inline bracket to help doxygen filtering.
30  inline namespace SDF_VERSION_NAMESPACE {
31  //
32 
33  // Forward declare private data class.
34  class PolylinePrivate;
35 
38  {
40  public: Polyline();
41 
44  public: Polyline(const Polyline &_polyline);
45 
48  public: Polyline(Polyline &&_polyline) noexcept;
49 
51  public: virtual ~Polyline();
52 
56  public: Polyline &operator=(const Polyline &_polyline);
57 
61  public: Polyline &operator=(Polyline &&_polyline);
62 
69  public: Errors Load(ElementPtr _sdf);
70 
73  public: double Height() const;
74 
77  public: void SetHeight(const double _height);
78 
81  public: uint64_t PointCount() const;
82 
85  public: const gz::math::Vector2d *PointByIndex(uint64_t _index) const;
86 
89  public: gz::math::Vector2d *PointByIndex(uint64_t _index);
90 
94  public: bool AddPoint(const gz::math::Vector2d &_point);
95 
97  public: void ClearPoints();
98 
102  public: const std::vector<gz::math::Vector2d> &Points() const;
103 
108  public: sdf::ElementPtr Element() const;
109 
111  private: PolylinePrivate *dataPtr;
112  };
113  }
114 }
115 #endif
Error.hh
sdf
namespace for Simulation Description Format parser
Definition: Actor.hh:32
sdf::v9::Errors
std::vector< Error > Errors
A vector of Error.
Definition: Types.hh:89
SDFORMAT_VISIBLE
#define SDFORMAT_VISIBLE
Definition: system_util.hh:48
sdf::v9::ElementPtr
std::shared_ptr< Element > ElementPtr
Definition: Element.hh:53
sdf::v9::Element
class SDFORMAT_VISIBLE Element
Definition: Element.hh:49
sdf::v9::Polyline
Polyline represents a 2D path. Multiple polylines can be combined.
Definition: Polyline.hh:37
Element.hh