A mutable clockwise oriented, open (ie start point != end point) polygon in 3d. More...

#include <Polygon.h>

Inheritance diagram for lanelet::Polygon3d:

[legend]

Public Types
using	ConstType = ConstPolygon3d

using	MutableType = Polygon3d

using	ThreeDType = Polygon3d

using	TwoDType = Polygon2d

Public Types inherited from lanelet::LineStringImpl< ConstPolygon3d >
using	iterator = internal::SelectLsIteratorT< PointType >

using	PointType = typename Base::MutablePointType

using	SegmentType = typename Base::SegmentType

Public Types inherited from lanelet::Primitive< ConstPolygon3d >
using	DataType = typename ConstPolygon3d ::DataType

Public Types inherited from lanelet::ConstPolygon3d
using	Category = traits::PolygonTag

using	ConstType = ConstPolygon3d

using	HybridType = ConstHybridPolygon3d

using	MutableType = Polygon3d

using	ThreeDType = ConstPolygon3d

using	TwoDType = ConstPolygon2d

Public Types inherited from lanelet::ConstLineStringImpl< Point3d >
using	BasicIterator = internal::TransformIterator< const_iterator, const BasicPointType >

using	BasicLineString = internal::SelectBasicLineStringT< BasicPointType >

using	BasicPointType = traits::BasicPointT< Point3d >

using	Category = traits::LineStringTag

using	const_iterator = internal::SelectLsIteratorT< const ConstPointType >

using	ConstPointType = traits::ConstPointT< Point3d >

using	ConstSegmentType = traits::ConstPrimitiveType< SegmentType >

using	difference_type = typename iterator::difference_type

using	iterator = const_iterator

using	MutablePointType = traits::MutablePointT< Point3d >
	linestring will return this point type More...

using	PointType = ConstPointType

using	SegmentType = Segment< Point3d >

using	size_type = size_t

using	value_type = ConstPointType

Public Types inherited from lanelet::ConstPrimitive< LineStringData >
using	DataType = LineStringData

Public Member Functions
BasicPolygon3d	basicPolygon () const
	create a simple 3d polygon from this (just a vector) More...

	LineStringImpl ()=default

	LineStringImpl (const LineStringImpl &rhs)=default

template<typename OtherT >
	LineStringImpl (const LineStringImpl< OtherT > &other)
	Construct from other (mutable!) LineStrings. More...

	LineStringImpl (const std::shared_ptr< const LineStringData > &, bool inverted)=delete

	LineStringImpl (const std::shared_ptr< LineStringData > &data, bool inverted)
	Construct from linestring data. More...

	LineStringImpl (LineStringImpl &&rhs) noexcept=default

	operator BasicPolygon3d () const
	implicit conversion to a basic polygon More...

	operator LineString3d () const

	Polygon3d ()=default

	Polygon3d (const LineString3d &other)
	Conversion from LineString3d. Does not ensure validity of the polygon! More...

Public Member Functions inherited from lanelet::LineStringImpl< ConstPolygon3d >
PointType &	back ()
	get a reference to the last element if it exists More...

iterator	begin ()
	mutable iterator for the elements of this vector. More...

void	clear ()

iterator	end ()
	mutable iterator to the end of the elements of this vector. More...

iterator	erase (iterator position)
	Removes point, returns iterator to the next point. More...

PointType &	front ()
	get a refernce to the first element (make sure it exists) More...

iterator	insert (iterator position, const PointType &point)
	Inserts an element at a specific position. More...

iterator	insert (iterator position, InIter start, InIter end)
	Inserts an range of elements at a specific position. More...

	LineStringImpl ()=default

	LineStringImpl (const LineStringImpl< OtherT > &other)
	Construct from other (mutable!) LineStrings. More...

	LineStringImpl (const std::shared_ptr< const LineStringData > &, bool inverted)=delete

	LineStringImpl (const std::shared_ptr< LineStringData > &data, bool inverted)
	Construct from linestring data. More...

LineStringImpl &	operator= (std::vector< Point3d > &&rhs)
	Move assign from a normal vector. Id and attributes stay unchanged. More...

LineStringImpl &	operator= (std::vector< PointType > rhs)
	Copy assign from a normal vector. The Id of this object is unchanged. More...

PointType &	operator[] (size_t idx)
	access element at specific position More...

void	pop_back ()
	removes element from the end More...

void	push_back (const PointType &point)
	inserts a new element at the end More...

void	reserve (size_t num)
	request a change in capacity More...

void	resize (size_t num)

SegmentType	segment (size_t idx) noexcept
	returns the n-th segment. If n equals size() -1, the segment from back() to front() is returned. More...

Public Member Functions inherited from lanelet::Primitive< ConstPolygon3d >
AttributeMap &	attributes () noexcept
	get the attributes in a mutable way More...

	Primitive ()=default

	Primitive (const Primitive< OtherT > &rhs)
	Construct from another primitive. Only works if both share the same. More...

	Primitive (const std::shared_ptr< const DataType > &)=delete

	Primitive (const std::shared_ptr< DataType > &data)
	Construct a new primitive from shared_ptr to its data. More...

void	setAttribute (AttributeName name, const Attribute &attribute)
	set or overwrite an attribute (enum version) More...

void	setAttribute (const std::string &name, const Attribute &attribute)
	set or overwrite an attribute More...

void	setId (Id id) noexcept
	set a new id for this primitive More...

Public Member Functions inherited from lanelet::ConstPolygon3d
BasicPolygon3d	basicPolygon () const
	create a simple 3d polygon from this (just a vector) More...

	ConstLineStringImpl (const ConstLineStringImpl &rhs)=default

template<typename OtherT >
	ConstLineStringImpl (const ConstLineStringImpl< OtherT > &other)
	construct from other ConstLineStrings More...

	ConstLineStringImpl (const std::shared_ptr< const LineStringData > &data, bool inverted=false)
	Constructs a linestring from the data object of another linestring. More...

	ConstLineStringImpl (ConstLineStringImpl &&rhs) noexcept=default

	ConstLineStringImpl (Id id=InvalId, Points3d points=Points3d(), const AttributeMap &attributes=AttributeMap())
	Constructs a LineString or similar from an Id and a list of points. More...

	ConstPolygon3d ()=default

	ConstPolygon3d (const ConstLineString3d &other)

size_t	numSegments () const noexcept
	Returns the number of (geometrically valid) segments. More...

	operator BasicPolygon3d () const
	implicit conversion to a basic polygon More...

	operator ConstLineString3d () const

Public Member Functions inherited from lanelet::ConstLineStringImpl< Point3d >
const ConstPointType &	back () const noexcept
	returns the last point (if it exist) More...

BasicIterator	basicBegin () const noexcept
	returns a normal iterator to the internal point type at begin More...

BasicIterator	basicEnd () const noexcept
	returns a normal iterator for the internal point type at end More...

BasicLineString	basicLineString () const noexcept
	Create a basic linestring (ie a vector of Eigen Points) More...

const_iterator	begin () const noexcept
	Returns an iterator to the start of the points. More...

	ConstLineStringImpl (const ConstLineStringImpl< OtherT > &other)
	construct from other ConstLineStrings More...

	ConstLineStringImpl (const std::shared_ptr< const LineStringData > &data, bool inverted=false)
	Constructs a linestring from the data object of another linestring. More...

	ConstLineStringImpl (Id id=InvalId, Points3d points=Points3d(), const AttributeMap &attributes=AttributeMap())
	Constructs a LineString or similar from an Id and a list of points. More...

bool	empty () const noexcept
	return if there are any points in this object More...

const_iterator	end () const noexcept
	Returns an iterator to end of the points. More...

const ConstPointType &	front () const noexcept
	returns the first point (if it exist) More...

bool	inverted () const noexcept
	Returns whether this is an inverted linestring. More...

size_t	numSegments () const noexcept
	Returns the number of (geometrically valid) segments. More...

const ConstPointType &	operator[] (size_t idx) const noexcept
	returns the point at this position More...

ConstSegmentType	segment (size_t idx) const noexcept
	returns the n-th segment. If n equals size() -1, the segment from back() to front() is returned. More...

size_t	size () const noexcept
	Return the number of points in this linestring. More...

Public Member Functions inherited from lanelet::ConstPrimitive< LineStringData >
const Attribute &	attribute (AttributeName name) const
	retrieve an attribute (enum version) More...

const Attribute &	attribute (const std::string &name) const
	retrieve an attribute More...

T	attributeOr (AttributeName name, T defaultVal) const
	retrieve an attribute (enum version) More...

T	attributeOr (const std::string &name, T defaultVal) const noexcept
	retrieve an attribute (string version) More...

const AttributeMap &	attributes () const
	get the attributes of this primitive More...

const std::shared_ptr< const LineStringData > &	constData () const
	get the internal data of this primitive More...

	ConstPrimitive (const std::shared_ptr< const LineStringData > &data)
	Construct from a pointer to the data. More...

bool	hasAttribute (AttributeName name) const noexcept
	check for an attribute (enum version) More...

bool	hasAttribute (const std::string &name) const noexcept
	check whether this primitive has a specific attribute More...

Id	id () const noexcept
	get the unique id of this primitive More...

bool	operator!= (const ConstPrimitive &rhs) const

bool	operator== (const ConstPrimitive &rhs) const

Friends
class	Polygon2d

Additional Inherited Members
Static Public Attributes inherited from lanelet::Primitive< ConstPolygon3d >
static constexpr bool	IsConst

Static Public Attributes inherited from lanelet::ConstLineStringImpl< Point3d >
static constexpr traits::Dimensions	Dimension

Static Public Attributes inherited from lanelet::ConstPrimitive< LineStringData >
static constexpr bool	IsConst

Protected Types inherited from lanelet::LineStringImpl< ConstPolygon3d >
using	Base = Primitive< ConstPolygon3d >

Protected Member Functions inherited from lanelet::LineStringImpl< ConstPolygon3d >
	LineStringImpl (const LineStringImpl &rhs)=default

	LineStringImpl (LineStringImpl &&rhs) noexcept=default

LineStringImpl &	operator= (const LineStringImpl &rhs)=default

LineStringImpl &	operator= (LineStringImpl &&rhs) noexcept=default

Points3d &	points ()

	~LineStringImpl () noexcept=default

Protected Member Functions inherited from lanelet::Primitive< ConstPolygon3d >
std::shared_ptr< DataType >	data () const

Primitive &	operator= (const Primitive &rhs) noexcept

Primitive &	operator= (Primitive &&rhs) noexcept

	Primitive (const Primitive &rhs) noexcept

	Primitive (Primitive &&rhs) noexcept

	~Primitive () noexcept=default

Protected Member Functions inherited from lanelet::ConstLineStringImpl< Point3d >
	ConstLineStringImpl (const ConstLineStringImpl &rhs)=default

	ConstLineStringImpl (ConstLineStringImpl &&rhs) noexcept=default

ConstLineStringImpl &	operator= (const ConstLineStringImpl &rhs)=default

ConstLineStringImpl &	operator= (ConstLineStringImpl &&rhs) noexcept=default

	~ConstLineStringImpl () noexcept=default

Protected Member Functions inherited from lanelet::ConstPrimitive< LineStringData >
	ConstPrimitive (const ConstPrimitive &rhs)=default

	ConstPrimitive (ConstPrimitive &&rhs) noexcept=default

ConstPrimitive &	operator= (const ConstPrimitive &rhs)=default

ConstPrimitive &	operator= (ConstPrimitive &&rhs) noexcept=default

	~ConstPrimitive () noexcept=default

Detailed Description

A mutable clockwise oriented, open (ie start point != end point) polygon in 3d.

Definition at line 157 of file primitives/Polygon.h.

Member Typedef Documentation

◆ ConstType

using lanelet::Polygon3d::ConstType = ConstPolygon3d

Definition at line 160 of file primitives/Polygon.h.

◆ MutableType

using lanelet::Polygon3d::MutableType = Polygon3d

Definition at line 161 of file primitives/Polygon.h.

◆ ThreeDType

using lanelet::Polygon3d::ThreeDType = Polygon3d

Definition at line 163 of file primitives/Polygon.h.

◆ TwoDType

using lanelet::Polygon3d::TwoDType = Polygon2d

Definition at line 162 of file primitives/Polygon.h.

Constructor & Destructor Documentation

◆ Polygon3d() [1/2]

lanelet::Polygon3d::Polygon3d ( )

default

◆ Polygon3d() [2/2]

lanelet::Polygon3d::Polygon3d ( const LineString3d & other )

inlineexplicit

Conversion from LineString3d. Does not ensure validity of the polygon!

Definition at line 168 of file primitives/Polygon.h.

Member Function Documentation

◆ basicPolygon()

BasicPolygon3d lanelet::Polygon3d::basicPolygon ( ) const

inline

create a simple 3d polygon from this (just a vector)

Definition at line 174 of file primitives/Polygon.h.

◆ LineStringImpl() [1/6]

lanelet::LineStringImpl< ConstLineStringT >::LineStringImpl

default

◆ LineStringImpl() [2/6]

lanelet::LineStringImpl< ConstLineStringT >::LineStringImpl

default

◆ LineStringImpl() [3/6]

template<typename OtherT >

lanelet::LineStringImpl< ConstLineStringT >::LineStringImpl ( typename OtherT )

inlineexplicit

Construct from other (mutable!) LineStrings.

Definition at line 380 of file primitives/LineString.h.

◆ LineStringImpl() [4/6]

lanelet::LineStringImpl< ConstLineStringT >::LineStringImpl

explicitdelete

◆ LineStringImpl() [5/6]

lanelet::LineStringImpl< ConstLineStringT >::LineStringImpl

inlineexplicit

Construct from linestring data.

Definition at line 385 of file primitives/LineString.h.

◆ LineStringImpl() [6/6]

lanelet::LineStringImpl< ConstLineStringT >::LineStringImpl

defaultnoexcept

◆ operator BasicPolygon3d()

lanelet::Polygon3d::operator BasicPolygon3d ( ) const

inline

implicit conversion to a basic polygon

Definition at line 177 of file primitives/Polygon.h.

◆ operator LineString3d()

lanelet::Polygon3d::operator LineString3d ( ) const

inlineexplicit

Definition at line 169 of file primitives/Polygon.h.

Friends And Related Function Documentation

◆ Polygon2d

friend class Polygon2d

friend

Definition at line 171 of file primitives/Polygon.h.

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

primitives/Polygon.h

Public Types

Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ ConstType

◆ MutableType

◆ ThreeDType

◆ TwoDType

Constructor & Destructor Documentation

◆ Polygon3d() [1/2]

◆ Polygon3d() [2/2]

Member Function Documentation

◆ basicPolygon()

◆ LineStringImpl() [1/6]

◆ LineStringImpl() [2/6]

◆ LineStringImpl() [3/6]

◆ LineStringImpl() [4/6]

◆ LineStringImpl() [5/6]

◆ LineStringImpl() [6/6]

◆ operator BasicPolygon3d()

◆ operator LineString3d()

Friends And Related Function Documentation

◆ Polygon2d