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 <gz/utils/ImplPtr.hh>
24#include <sdf/Error.hh>
25#include <sdf/Element.hh>
26#include <sdf/sdf_config.h>
27
28namespace sdf
29{
30 // Inline bracket to help doxygen filtering.
31 inline namespace SDF_VERSION_NAMESPACE {
32 //
33
36 {
38 public: Polyline();
39
46 public: Errors Load(ElementPtr _sdf);
47
50 public: double Height() const;
51
54 public: void SetHeight(const double _height);
55
58 public: uint64_t PointCount() const;
59
62 public: const gz::math::Vector2d *PointByIndex(uint64_t _index) const;
63
66 public: gz::math::Vector2d *PointByIndex(uint64_t _index);
67
71 public: bool AddPoint(const gz::math::Vector2d &_point);
72
74 public: void ClearPoints();
75
79 public: const std::vector<gz::math::Vector2d> &Points() const;
80
85 public: sdf::ElementPtr Element() const;
86
92 public: sdf::ElementPtr ToElement() const;
93
100 public: sdf::ElementPtr ToElement(sdf::Errors &_errors) const;
101
103 GZ_UTILS_IMPL_PTR(dataPtr)
104 };
105 }
106}
107#endif
Polyline represents a 2D path. Multiple polylines can be combined.
Definition: Polyline.hh:36
sdf::ElementPtr ToElement() const
Create and return an SDF element filled with data from this polyline.
double Height() const
Get the polyline's height in meters.
bool AddPoint(const gz::math::Vector2d &_point)
Add a point to the polyline.
Errors Load(ElementPtr _sdf)
Load the polyline geometry based on an element pointer.
const gz::math::Vector2d * PointByIndex(uint64_t _index) const
Get a point by its index.
sdf::ElementPtr ToElement(sdf::Errors &_errors) const
Create and return an SDF element filled with data from this polyline.
void SetHeight(const double _height)
Set the polyline's height in meters.
void ClearPoints()
Remove all points from the polyline.
sdf::ElementPtr Element() const
Get a pointer to the SDF element that was used during load.
uint64_t PointCount() const
Get the number of points.
const std::vector< gz::math::Vector2d > & Points() const
Get the polyline's points.
gz::math::Vector2d * PointByIndex(uint64_t _index)
Get a point by its index.
std::vector< Error > Errors
A vector of Error.
Definition: Types.hh:95
std::shared_ptr< Element > ElementPtr
Definition: Element.hh:55
namespace for Simulation Description Format parser
Definition: Actor.hh:35
#define SDFORMAT_VISIBLE
Use to represent "symbol visible" if supported.
Definition: system_util.hh:25