Class SFCGAL::LineString
ClassList > SFCGAL > LineString
#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) |
|
| virtual void | accept (GeometryVisitor & visitor) [visitor]dispatch visitor |
| virtual void | accept (ConstGeometryVisitor & visitor) const [visitor]dispatch visitor |
| void | addPoint (const Point & p) |
| void | addPoint (Point * p) |
| iterator | begin () |
| const_iterator | begin () const |
| void | clear () |
| virtual LineString * | clone () const Get a deep copy of the geometry. |
| void | closes () |
| virtual int | coordinateDimension () const |
| virtual int | dimension () const |
| iterator | end () |
| const_iterator | end () const |
| const Point & | endPoint () const |
| Point & | endPoint () |
| virtual std::string | geometryType () const [OGC/SFA]returns the geometry type |
| virtual GeometryType | geometryTypeId () const Returns a code corresponding to the type. |
| virtual bool | is3D () const |
| bool | isClosed () const |
| virtual bool | isEmpty () const |
| virtual bool | isMeasured () 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 () |
| CGAL::Polygon_2< Kernel > | toPolygon_2 (bool fixOrientation=true) const |
| ~LineString () |
Public Functions inherited from SFCGAL::Geometry
See SFCGAL::Geometry
| Type | Name |
|---|---|
| Geometry () Default constructor. |
|
| Geometry (const Geometry &) = default Copy constructor. |
|
| virtual void | accept (GeometryVisitor & visitor) = 0 [visitor]dispatch visitor |
| virtual void | accept (ConstGeometryVisitor & visitor) const = 0 [visitor]dispatch visitor |
| auto | almostEqual (const Geometry & other, const double tolerance) const |
| const Derived & | as () const Downcast to a "Derived" class. |
| Derived & | as () Downcast to a "Derived" class. |
| std::string | asText (const int & numDecimals=-1) const |
| std::string | asWkb (boost::endian::order wkbOrder=boost::endian::order::native, bool asHex=false) const |
| virtual std::unique_ptr< Geometry > | boundary () const [OGC/SFA]Returns the boundary of the geometry |
| virtual Geometry * | clone () const = 0 Get a deep copy of the geometry. |
| virtual int | coordinateDimension () const = 0 |
| virtual int | dimension () const = 0 |
| double | distance (const Geometry & other) const Computes the distance to an other geometry. |
| double | distance3D (const Geometry & other) const Computes the 3D distance to an other geometry. |
| Envelope | envelope () const |
| void | forceValidityFlag (bool validity) |
| virtual const Geometry & | geometryN (size_t const & n) const [OGC/SFA]Returns the n-th geometry |
| virtual Geometry & | geometryN (size_t const & n) [OGC/SFA]Returns the n-th geometry |
| virtual std::string | geometryType () const = 0 [OGC/SFA]returns the geometry type |
| virtual GeometryType | geometryTypeId () const = 0 Returns a code corresponding to the type. |
| bool | hasValidityFlag () const |
| bool | is () const Tests if geometry is of "Derived" type given as template parameter. |
| virtual bool | is3D () const = 0 |
| virtual bool | isEmpty () const = 0 |
| virtual bool | isMeasured () const = 0 |
| virtual size_t | numGeometries () const [OGC/SFA]Gets the number of geometries in a collection of geometries |
| Geometry & | operator= (const Geometry & other) = default Copy assignemnt operator. |
| void | round (const long & scale=1) round the geometry with a corresponding scale factor |
| void | serialize (Archive &, const unsigned int) |
| virtual | ~Geometry () = default Destructor. |
Protected Attributes inherited from SFCGAL::Geometry
See SFCGAL::Geometry
| Type | Name |
|---|---|
| bool | validityFlag_ = = false |
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]
virtual void SFCGAL::LineString::accept (
GeometryVisitor & visitor
)
Implements SFCGAL::Geometry::accept
function accept [2/2]
virtual void SFCGAL::LineString::accept (
ConstGeometryVisitor & visitor
) const
Implements SFCGAL::Geometry::accept
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
virtual LineString * SFCGAL::LineString::clone () const
Implements SFCGAL::Geometry::clone
function closes
inline void SFCGAL::LineString::closes ()
closes the LineString
function coordinateDimension
virtual int SFCGAL::LineString::coordinateDimension () const
[OGC/SFA]returns the dimension of the coordinates
Precondition:
suppose no mix of 2D/3D coordinates
Implements SFCGAL::Geometry::coordinateDimension
function dimension
virtual int SFCGAL::LineString::dimension () const
[OGC/SFA]Dimension of the Geometry ( 0 : punctual, 1 : curve, ...)
Warning:
empty geometries provide the dimension corresponding to the object
Implements SFCGAL::Geometry::dimension
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
[OGC/SFA]returns the geometry type
virtual std::string SFCGAL::LineString::geometryType () const
Warning:
use CamelCase (LineString, not LINESTRING)
Implements SFCGAL::Geometry::geometryType
function geometryTypeId
Returns a code corresponding to the type.
virtual GeometryType SFCGAL::LineString::geometryTypeId () const
Warning:
not standard
Implements SFCGAL::Geometry::geometryTypeId
function is3D
virtual bool SFCGAL::LineString::is3D () const
[OGC/SFA]test if geometry is 3d
Precondition:
suppose no mix of 2D/3D coordinates
Implements SFCGAL::Geometry::is3D
function isClosed
bool SFCGAL::LineString::isClosed () const
test if the LineString is closed
function isEmpty
virtual bool SFCGAL::LineString::isEmpty () const
[OGC/SFA]test if geometry is empty
Implements SFCGAL::Geometry::isEmpty
function isMeasured
virtual bool SFCGAL::LineString::isMeasured () const
[OGC/SFA]test if geometry is measured (has an m)
Precondition:
suppose no mix of M/!M points
Implements SFCGAL::Geometry::isMeasured
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 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