sdf::v12::Polyline Class Reference

Polyline represents a 2D path. Multiple polylines can be combined. More...

#include <Polyline.hh>

Public Member Functions
	Polyline ()
	Constructor. More...
bool	AddPoint (const ignition::math::Vector2d &_point)
	Add a point to the polyline. More...
void	ClearPoints ()
	Remove all points from the polyline. More...
sdf::ElementPtr	Element () const
	Get a pointer to the SDF element that was used during load. More...
double	Height () const
	Get the polyline's height in meters. More...
Errors	Load (ElementPtr _sdf)
	Load the polyline geometry based on an element pointer. More...
ignition::math::Vector2d *	PointByIndex (uint64_t _index)
	Get a point by its index. More...
const ignition::math::Vector2d *	PointByIndex (uint64_t _index) const
	Get a point by its index. More...
uint64_t	PointCount () const
	Get the number of points. More...
const std::vector< ignition::math::Vector2d > &	Points () const
	Get the polyline's points. More...
void	SetHeight (const double _height)
	Set the polyline's height in meters. More...
sdf::ElementPtr	ToElement () const
	Create and return an SDF element filled with data from this polyline. More...

Detailed Description

Polyline represents a 2D path. Multiple polylines can be combined.

Constructor & Destructor Documentation

Polyline()

sdf::v12::Polyline::Polyline

(

)

Constructor.

Member Function Documentation

AddPoint()

bool sdf::v12::Polyline::AddPoint

(

const ignition::math::Vector2d &

_point

)

Add a point to the polyline.

Parameters

[in]

_point

2D point to add.

Returns

True for success.

ClearPoints()

void sdf::v12::Polyline::ClearPoints

(

)

Remove all points from the polyline.

Element()

sdf::ElementPtr sdf::v12::Polyline::Element

(

)

const

Get a pointer to the SDF element that was used during load.

Returns

SDF element pointer. The value will be nullptr if Load has not been called.

Height()

double sdf::v12::Polyline::Height

(

)

const

Get the polyline's height in meters.

Returns

The height of the polyline in meters.

Load()

Errors sdf::v12::Polyline::Load

(

ElementPtr

_sdf

)

Load the polyline geometry based on an element pointer.

This is not the usual entry point. Typical usage of the SDF DOM is through the Root object.

Parameters

[in]

_sdf

The SDF Element pointer

Returns

Errors, which is a vector of Error objects. Each Error includes an error code and message. An empty vector indicates no error.

PointByIndex() [1/2]

ignition::math::Vector2d* sdf::v12::Polyline::PointByIndex

(

uint64_t

_index

)

Get a point by its index.

Returns

Mutable pointer to the point.

PointByIndex() [2/2]

const ignition::math::Vector2d* sdf::v12::Polyline::PointByIndex

(

uint64_t

_index

)

const

Get a point by its index.

Returns

Constant pointer to the point.

PointCount()

uint64_t sdf::v12::Polyline::PointCount

(

)

const

Get the number of points.

Returns

Number of points.

Points()

const std::vector<ignition::math::Vector2d>& sdf::v12::Polyline::Points

(

)

const

Get the polyline's points.

Each point has 2D coordinates in meters.

Returns

The polyline's points.

SetHeight()

void sdf::v12::Polyline::SetHeight

(

const double

_height

)

Set the polyline's height in meters.

Parameters

[in]

_height

The height of the polyline in meters.

ToElement()

sdf::ElementPtr sdf::v12::Polyline::ToElement

(

)

const

Create and return an SDF element filled with data from this polyline.

Note that parameter passing functionality is not captured with this function.

Returns

SDF element pointer with updated polyline values.

---

The documentation for this class was generated from the following file:

• Polyline.hh