Class SFCGAL::Point

ClassList > SFCGAL > Point

More...

• #include <Point.h>

Inherits the following classes: SFCGAL::Geometry

Public Functions

Type	Name
	Point ()
	Point (const Coordinate & coordinate)
	Point (const Kernel::FT & x, const Kernel::FT & y)
	Point (const Kernel::FT & x, const Kernel::FT & y, const Kernel::FT & z, const double & m=NaN())
	Point (const double & x, const double & y)
	Point (const double & x, const double & y, const double & z)
	Point (const double & x, const double & y, const double & z, const double & m)
	Point (const double & x, const double & y, const double & z, const double & m, CoordinateType dim)
	Point (const Kernel::FT & x, const Kernel::FT & y, const Kernel::FT & z, const double & m, CoordinateType dim)
	Point (const Kernel::Point_2 & other)
	Point (const Kernel::Point_3 & other)
	Point (const Point & other)
void	accept (GeometryVisitor & visitor) override
void	accept (ConstGeometryVisitor & visitor) override const
bool	almostEqual (const Point & other, const double tolerance) const
Point *	clone () override const
Coordinate &	coordinate ()
const Coordinate &	coordinate () const
int	coordinateDimension () override const
int	dimension () override const
auto	dropM () override
auto	dropZ () override
std::string	geometryType () override const
GeometryType	geometryTypeId () override const
bool	is3D () override const
bool	isEmpty () override const
bool	isMeasured () override const
double	m () const
bool	operator!= (const Point & other) const
bool	operator< (const Point & other) const
Point &	operator= (const Point & other)
bool	operator== (const Point & other) const
void	serialize (Archive & ar, const unsigned int)
void	setM (const double & m)
auto	swapXY () override
Kernel::Point_2	toPoint_2 () const
Kernel::Point_3	toPoint_3 () const
detail::TypeForDimension< D >::Point	toPoint_d () const Converts to CGAL::Point_2 or CGAL::Point_3.
Kernel::Vector_2	toVector_2 () const
Kernel::Vector_3	toVector_3 () const
Kernel::RT	x () const
Kernel::RT	y () const
Kernel::RT	z () const
	~Point ()

Detailed Description

A point in SFA. The x(),y(),z() interface is based on CGAL kernel requirements, taken from examples/Kernel_23/MyPointC2.h

Todo

strong typing on coordinate dimension?

Public Functions Documentation

function Point [1/12]

SFCGAL::Point::Point () 

Empty point constructor

---

function Point [2/12]

SFCGAL::Point::Point (
    const Coordinate & coordinate
) 

Constructor with Coordinate

---

function Point [3/12]

SFCGAL::Point::Point (
    const Kernel::FT & x,
    const Kernel::FT & y
) 

XY Constructor with exact coordinates

---

function Point [4/12]

SFCGAL::Point::Point (
    const Kernel::FT & x,
    const Kernel::FT & y,
    const Kernel::FT & z,
    const double & m=NaN ()
) 

XY Constructor with exact coordinates

---

function Point [5/12]

SFCGAL::Point::Point (
    const double & x,
    const double & y
) 

XY constructor

---

function Point [6/12]

SFCGAL::Point::Point (
    const double & x,
    const double & y,
    const double & z
) 

XYZ constructor

---

function Point [7/12]

SFCGAL::Point::Point (
    const double & x,
    const double & y,
    const double & z,
    const double & m
) 

XYZM constructor

---

function Point [8/12]

SFCGAL::Point::Point (
    const double & x,
    const double & y,
    const double & z,
    const double & m,
    CoordinateType dim
) 

Generic XYZM constructor determined by CoordinateType

---

function Point [9/12]

SFCGAL::Point::Point (
    const Kernel::FT & x,
    const Kernel::FT & y,
    const Kernel::FT & z,
    const double & m,
    CoordinateType dim
) 

Generic XYZM constructor determined by CoordinateType

---

function Point [10/12]

SFCGAL::Point::Point (
    const Kernel::Point_2 & other
) 

Constructor from CGAL::Point_2<K>

---

function Point [11/12]

SFCGAL::Point::Point (
    const Kernel::Point_3 & other
) 

Constructor from CGAL::Point_3<K>

---

function Point [12/12]

SFCGAL::Point::Point (
    const Point & other
) 

copy constructor

---

function accept [1/2]

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

---

function accept [2/2]

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

---

function almostEqual

bool SFCGAL::Point::almostEqual (
    const Point & other,
    const double tolerance
) const

absolute comparison with an other point

---

function clone

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

---

function coordinate [1/2]

inline Coordinate & SFCGAL::Point::coordinate () 

---

function coordinate [2/2]

inline const Coordinate & SFCGAL::Point::coordinate () const

---

function coordinateDimension

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

---

function dimension

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

---

function dropM

auto SFCGAL::Point::dropM () override

---

function dropZ

auto SFCGAL::Point::dropZ () override

---

function geometryType

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

---

function geometryTypeId

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

---

function is3D

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

---

function isEmpty

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

---

function isMeasured

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

---

function m

inline double SFCGAL::Point::m () const

Returns the m value (NaN is not defined)

---

function operator!=

bool SFCGAL::Point::operator!= (
    const Point & other
) const

compare with an other point

---

function operator<

bool SFCGAL::Point::operator< (
    const Point & other
) const

compare two points

---

function operator=

Point & SFCGAL::Point::operator= (
    const Point & other
) 

assign operator

---

function operator==

bool SFCGAL::Point::operator== (
    const Point & other
) const

compare with an other point

---

function serialize

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

Serializer

---

function setM

inline void SFCGAL::Point::setM (
    const double & m
) 

Sets the m value

---

function swapXY

auto SFCGAL::Point::swapXY () override

---

function toPoint_2

inline Kernel::Point_2 SFCGAL::Point::toPoint_2 () const

See also: Coordinate::toPoint_2()

---

function toPoint_3

inline Kernel::Point_3 SFCGAL::Point::toPoint_3 () const

See also: Coordinate::toPoint_3()

---

function toPoint_d [1/2]

Converts to CGAL::Point_2 or CGAL::Point_3.

template<int D>
detail::TypeForDimension < D > ::Point SFCGAL::Point::toPoint_d () const

---

function toVector_2

inline Kernel::Vector_2 SFCGAL::Point::toVector_2 () const

See also: Coordinate::toVector_2()

---

function toVector_3

inline Kernel::Vector_3 SFCGAL::Point::toVector_3 () const

See also: Coordinate::toVector_3()

---

function x

inline Kernel::RT SFCGAL::Point::x () const

Returns the x value as a double throw for empty Point

---

function y

inline Kernel::RT SFCGAL::Point::y () const

Returns the y value as a double throw for empty Point

---

function z

inline Kernel::RT SFCGAL::Point::z () const

Returns the z value (zero for 2D) throw for empty Point

---

function ~Point

SFCGAL::Point::~Point () 

destructor

---

---

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