Public Types | Public Member Functions | List of all members
lanelet::CompoundPolygon2d Class Reference

Combines multiple linestrings to one polygon in 2d. More...

#include <CompoundPolygon.h>

Inheritance diagram for lanelet::CompoundPolygon2d:
Inheritance graph
[legend]

Public Types

using Category = traits::PolygonTag
 
using ConstType = CompoundPolygon2d
 
using HybridType = CompoundHybridPolygon2d
 
using MutableType = void
 
using ThreeDType = CompoundPolygon3d
 
using TwoDType = CompoundPolygon2d
 
- Public Types inherited from lanelet::CompoundLineStringImpl< ConstPoint2d >
using BasicIterator = internal::TransformIterator< RFIter, const BasicPointType >
 
using BasicLineString = internal::SelectBasicLineStringT< BasicPointType >
 
using BasicPointType = traits::BasicPointT< ConstPoint2d >
 
using Category = traits::LineStringTag
 
using const_iterator = internal::SelectCompoundLsIteratorT< ConstPointType >
 
using ConstPointType = traits::ConstPointT< ConstPoint2d >
 
using DataType = CompoundLineStringData
 
using iterator = const_iterator
 
using PointType = ConstPoint2d
 
using SegmentType = Segment< ConstPointType >
 

Public Member Functions

BasicLineString basicLineString ()=delete
 
BasicPolygon2d basicPolygon () const
 
 CompoundLineStringImpl (CompoundLineStringDataConstPtr data, bool inverted)
 Internal construction from data pointer. More...
 
 CompoundLineStringImpl (CompoundLineStringImpl &&rhs) noexcept=default
 
 CompoundLineStringImpl (const CompoundLineStringImpl &rhs)=default
 
template<typename OtherT >
 CompoundLineStringImpl (const CompoundLineStringImpl< OtherT > &other)
 construct from other CompoundLineString More...
 
 CompoundLineStringImpl (const ConstLineStrings3d &ls=ConstLineStrings3d())
 Construct from a vector of ConstLineString3d. More...
 
template<typename OtherT , typename = IfLS<OtherT, void>>
 CompoundLineStringImpl (const std::vector< OtherT > &lss)
 Construct from a vector of LineStrings or CompoundLineStrings. More...
 
 CompoundPolygon2d ()=default
 
 CompoundPolygon2d (const CompoundLineString2d &other)
 
 CompoundPolygon2d (const CompoundLineStrings2d &other)
 
 CompoundPolygon2d (const CompoundPolygons2d &other)
 
size_t numSegments () const noexcept
 Returns the number of (geometrically valid) segments. More...
 
 operator CompoundLineString2d () const
 
- Public Member Functions inherited from lanelet::CompoundLineStringImpl< ConstPoint2d >
const PointTypeback () const noexcept
 returns the last point of the last linestring More...
 
BasicIterator basicBegin () const
 returns a normal iterator to the internal point type at begin More...
 
BasicIterator basicEnd () const
 returns a normal iterator for the internal point type at end More...
 
BasicLineString basicLineString () const
 create a basic linestring from this linestring More...
 
const_iterator begin () const noexcept
 returns an iterator to the start of the points More...
 
 CompoundLineStringImpl (CompoundLineStringDataConstPtr data, bool inverted)
 Internal construction from data pointer. More...
 
 CompoundLineStringImpl (CompoundLineStringImpl &&rhs) noexcept=default
 
 CompoundLineStringImpl (const CompoundLineStringImpl &rhs)=default
 
 CompoundLineStringImpl (const CompoundLineStringImpl< OtherT > &other)
 construct from other CompoundLineString More...
 
 CompoundLineStringImpl (const ConstLineStrings3d &ls=ConstLineStrings3d())
 Construct from a vector of ConstLineString3d. More...
 
 CompoundLineStringImpl (const std::vector< OtherT > &lss)
 Construct from a vector of LineStrings or CompoundLineStrings. More...
 
std::shared_ptr< const CompoundLineStringDataconstData () const noexcept
 returns the internal data on the linestrings managed by this object More...
 
bool empty () const noexcept
 return whether this contains any points More...
 
const_iterator end () const noexcept
 returns an iterator to end of the points More...
 
const PointTypefront () const noexcept
 returns the first point of the first linestring More...
 
Ids ids () const
 returns the ids of all linestrings in order More...
 
bool inverted () const noexcept
 returns whether this is an inverted CompoundLineString More...
 
ConstLineStrings3d lineStrings () const
 
size_t numSegments () const noexcept
 Returns the number of (geometrically valid) segments. More...
 
CompoundLineStringImploperator= (CompoundLineStringImpl &&rhs) noexcept=default
 
CompoundLineStringImploperator= (const CompoundLineStringImpl &rhs)=default
 
const PointTypeoperator[] (size_t idx) const
 returns the point at this position More...
 
SegmentType 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 total number of unique points More...
 
 ~CompoundLineStringImpl () noexcept=default
 

Additional Inherited Members

- Static Public Attributes inherited from lanelet::CompoundLineStringImpl< ConstPoint2d >
static constexpr traits::Dimensions Dimension
 

Detailed Description

Combines multiple linestrings to one polygon in 2d.

Definition at line 11 of file CompoundPolygon.h.

Member Typedef Documentation

◆ Category

Definition at line 18 of file CompoundPolygon.h.

◆ ConstType

Definition at line 15 of file CompoundPolygon.h.

◆ HybridType

Definition at line 16 of file CompoundPolygon.h.

◆ MutableType

Definition at line 17 of file CompoundPolygon.h.

◆ ThreeDType

Definition at line 14 of file CompoundPolygon.h.

◆ TwoDType

Definition at line 13 of file CompoundPolygon.h.

Constructor & Destructor Documentation

◆ CompoundPolygon2d() [1/4]

lanelet::CompoundPolygon2d::CompoundPolygon2d ( const CompoundPolygons2d other)
inlineexplicit

Definition at line 21 of file CompoundPolygon.h.

◆ CompoundPolygon2d() [2/4]

lanelet::CompoundPolygon2d::CompoundPolygon2d ( const CompoundLineStrings2d other)
inlineexplicit

Definition at line 23 of file CompoundPolygon.h.

◆ CompoundPolygon2d() [3/4]

lanelet::CompoundPolygon2d::CompoundPolygon2d ( )
default

◆ CompoundPolygon2d() [4/4]

lanelet::CompoundPolygon2d::CompoundPolygon2d ( const CompoundLineString2d other)
inlineexplicit

Definition at line 27 of file CompoundPolygon.h.

Member Function Documentation

◆ basicLineString()

BasicLineString lanelet::CompoundPolygon2d::basicLineString ( )
delete

◆ basicPolygon()

BasicPolygon2d lanelet::CompoundPolygon2d::basicPolygon ( ) const
inline

Definition at line 33 of file CompoundPolygon.h.

◆ CompoundLineStringImpl() [1/6]

Internal construction from data pointer.

Definition at line 101 of file CompoundLineString.h.

◆ CompoundLineStringImpl() [2/6]

◆ CompoundLineStringImpl() [3/6]

◆ CompoundLineStringImpl() [4/6]

template<typename OtherT >
lanelet::CompoundLineStringImpl< PointT >::CompoundLineStringImpl ( typename OtherT  )
inlineexplicit

construct from other CompoundLineString

Definition at line 106 of file CompoundLineString.h.

◆ CompoundLineStringImpl() [5/6]

Construct from a vector of ConstLineString3d.

Parameters
lsobjects to construct from. The order will also be the order of the linestrings.

Definition at line 91 of file CompoundLineString.h.

◆ CompoundLineStringImpl() [6/6]

template<typename OtherT , typename = IfLS<OtherT, void>>
lanelet::CompoundLineStringImpl< PointT >::CompoundLineStringImpl ( typename OtherT  ,
typename  = IfLS<OtherT, void> 
)
inlineexplicit

Construct from a vector of LineStrings or CompoundLineStrings.

Definition at line 96 of file CompoundLineString.h.

◆ numSegments()

size_t lanelet::CompoundPolygon2d::numSegments ( ) const
inlinenoexcept

Returns the number of (geometrically valid) segments.

Definition at line 30 of file CompoundPolygon.h.

◆ operator CompoundLineString2d()

lanelet::CompoundPolygon2d::operator CompoundLineString2d ( ) const
inlineexplicit

Definition at line 28 of file CompoundPolygon.h.


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


lanelet2_core
Author(s): Fabian Poggenhans
autogenerated on Thu Mar 6 2025 03:25:52