Class SFCGAL::LineString

ClassList > SFCGAL > LineString

More...

• #include <LineString.h>

Inherits the following classes: SFCGAL::Geometry

Classes

Type	Name
class	Point_2_const_iterator
class	Point_3_const_iterator

Public Types

Type	Name
typedef boost::ptr_vector< Point >::const_iterator	const_iterator
typedef boost::ptr_vector< Point >::iterator	iterator

Public Functions

Type	Name
	LineString ()
	LineString (const std::vector< Point > & points)
	LineString (const Point & startPoint, const Point & endPoint)
	LineString (LineString const & other)
void	accept (GeometryVisitor & visitor) override
void	accept (ConstGeometryVisitor & visitor) override const
void	addPoint (const Point & p)
void	addPoint (Point * p)
iterator	begin ()
const_iterator	begin () const
void	clear ()
LineString *	clone () override const
void	closes ()
int	coordinateDimension () override const
int	dimension () override const
auto	dropM () override
auto	dropZ () override
iterator	end ()
const_iterator	end () const
const Point &	endPoint () const
Point &	endPoint ()
std::string	geometryType () override const
GeometryType	geometryTypeId () override const
bool	is3D () override const
bool	isClosed () const
bool	isEmpty () override const
bool	isMeasured () override const
size_t	numPoints () const
size_t	numSegments () const
LineString &	operator= (LineString other)
const Point &	pointN (size_t const & n) const
Point &	pointN (size_t const & n)
std::pair< Point_2_const_iterator, Point_2_const_iterator >	points_2 () const
Point_2_const_iterator	points_2_begin () const
Point_2_const_iterator	points_2_end () const
std::pair< Point_3_const_iterator, Point_3_const_iterator >	points_3 () const
Point_3_const_iterator	points_3_begin () const
Point_3_const_iterator	points_3_end () const
void	reserve (const size_t & n)
void	reverse ()
void	serialize (Archive & ar, const unsigned int)
const Point &	startPoint () const
Point &	startPoint ()
auto	swapXY () override
CGAL::Polygon_2< Kernel >	toPolygon_2 (bool fixOrientation=true) const
	~LineString ()

Detailed Description

A LineString in SFA

Public Types Documentation

typedef const_iterator

typedef boost::ptr_vector<Point>::const_iterator SFCGAL::LineString::const_iterator;

---

typedef iterator

typedef boost::ptr_vector<Point>::iterator SFCGAL::LineString::iterator;

---

Public Functions Documentation

function LineString [1/4]

SFCGAL::LineString::LineString () 

Empty LineString constructor

---

function LineString [2/4]

SFCGAL::LineString::LineString (
    const std::vector< Point > & points
) 

Constructor with a point vector

---

function LineString [3/4]

SFCGAL::LineString::LineString (
    const Point & startPoint,
    const Point & endPoint
) 

LineString constructor

---

function LineString [4/4]

SFCGAL::LineString::LineString (
    LineString const & other
) 

Copy constructor

---

function accept [1/2]

void SFCGAL::LineString::accept (
    GeometryVisitor & visitor
) override

---

function accept [2/2]

void SFCGAL::LineString::accept (
    ConstGeometryVisitor & visitor
) override const

---

function addPoint [1/2]

inline void SFCGAL::LineString::addPoint (
    const Point & p
) 

append a Point to the LineString

---

function addPoint [2/2]

inline void SFCGAL::LineString::addPoint (
    Point * p
) 

append a Point to the LineString and takes ownership

---

function begin [1/2]

inline iterator SFCGAL::LineString::begin () 

---

function begin [2/2]

inline const_iterator SFCGAL::LineString::begin () const

---

function clear

void SFCGAL::LineString::clear () 

remove all points from the LineString

---

function clone

LineString * SFCGAL::LineString::clone () override const

---

function closes

inline void SFCGAL::LineString::closes () 

closes the LineString

---

function coordinateDimension

int SFCGAL::LineString::coordinateDimension () override const

---

function dimension

int SFCGAL::LineString::dimension () override const

---

function dropM

auto SFCGAL::LineString::dropM () override

---

function dropZ

auto SFCGAL::LineString::dropZ () override

---

function end [1/2]

inline iterator SFCGAL::LineString::end () 

---

function end [2/2]

inline const_iterator SFCGAL::LineString::end () const

---

function endPoint [1/2]

inline const Point & SFCGAL::LineString::endPoint () const

[SFA/OGC]Returns the first point

---

function endPoint [2/2]

inline Point & SFCGAL::LineString::endPoint () 

[SFA/OGC]Returns the first point

---

function geometryType

std::string SFCGAL::LineString::geometryType () override const

---

function geometryTypeId

GeometryType SFCGAL::LineString::geometryTypeId () override const

---

function is3D

bool SFCGAL::LineString::is3D () override const

---

function isClosed

bool SFCGAL::LineString::isClosed () const

test if the LineString is closed

---

function isEmpty

bool SFCGAL::LineString::isEmpty () override const

---

function isMeasured

bool SFCGAL::LineString::isMeasured () override const

---

function numPoints

inline size_t SFCGAL::LineString::numPoints () const

[SFA/OGC]Returns the number of points

---

function numSegments

size_t SFCGAL::LineString::numSegments () const

Returns the number of segments

Warning:

not standard, returns zero if LineString contains only one point

---

function operator=

LineString & SFCGAL::LineString::operator= (
    LineString other
) 

assign operator

---

function pointN [1/2]

inline const Point & SFCGAL::LineString::pointN (
    size_t const & n
) const

[SFA/OGC]Returns the n-th point

---

function pointN [2/2]

inline Point & SFCGAL::LineString::pointN (
    size_t const & n
) 

[SFA/OGC]Returns the n-th point

---

function points_2

inline std::pair< Point_2_const_iterator , Point_2_const_iterator > SFCGAL::LineString::points_2 () const

---

function points_2_begin

inline Point_2_const_iterator SFCGAL::LineString::points_2_begin () const

---

function points_2_end

inline Point_2_const_iterator SFCGAL::LineString::points_2_end () const

---

function points_3

inline std::pair< Point_3_const_iterator , Point_3_const_iterator > SFCGAL::LineString::points_3 () const

---

function points_3_begin

inline Point_3_const_iterator SFCGAL::LineString::points_3_begin () const

---

function points_3_end

inline Point_3_const_iterator SFCGAL::LineString::points_3_end () const

---

function reserve

void SFCGAL::LineString::reserve (
    const size_t & n
) 

---

function reverse

void SFCGAL::LineString::reverse () 

reverse LineString orientation

---

function serialize

template<class Archive>
inline void SFCGAL::LineString::serialize (
    Archive & ar,
    const unsigned int
) 

Serializer

---

function startPoint [1/2]

inline const Point & SFCGAL::LineString::startPoint () const

[SFA/OGC]Returns the first point

---

function startPoint [2/2]

inline Point & SFCGAL::LineString::startPoint () 

[SFA/OGC]Returns the first point

---

function swapXY

auto SFCGAL::LineString::swapXY () override

---

function toPolygon_2

CGAL::Polygon_2< Kernel > SFCGAL::LineString::toPolygon_2 (
    bool fixOrientation=true
) const

---

function ~LineString

SFCGAL::LineString::~LineString () 

destructor

---

---

The documentation for this class was generated from the following file /builds/sfcgal/SFCGAL/src/LineString.h