Namespace SFCGAL

Namespace List > SFCGAL

More...

Namespaces

Type	Name
namespace	algorithm
namespace	detail
namespace	generator
namespace	graph
namespace	io
namespace	tools
namespace	transform
namespace	triangulate

Classes

Type	Name
class	ConstGeometryVisitor
class	Coordinate Represents the Coordinate of aPoint (wraps either an empty structure, or a Kernel::Point_2, or a Kernel::Point_3)
class	CoordinateDimensionVisitor
class	Cylinder Represents a cylinder in 3D space.
class	Envelope
class	Exception
class	Geometry OGC/SFA based Geometry abstract class.
class	GeometryCollection
class	GeometryInvalidityException
class	GeometryVisitor
class	GetXVisitor
class	GetYVisitor
class	GetZVisitor
class	InappropriateGeometryException
class	LineString
class	Logger
class	MultiLineString
class	MultiPoint
class	MultiPolygon
class	MultiSolid
class	NonFiniteValueException
class	NotImplementedException
struct	Plane_from_facet <typename Polyhedron>
class	Point
class	Polygon
class	PolyhedralSurface
class	PreparedGeometry
class	RoundVisitor
class	Solid
class	Sphere Represents a sphere in 3D space.
class	Sphere_builder <class HDS> Helper class for building the sphere polyhedron.
class	Surface
struct	TestGeometry
class	ToPoint2Visitor
class	ToPoint3Visitor
class	Transform
class	Triangle
class	Triangulated2Polyhedron <class HDS>
class	TriangulatedSurface
struct	Validity the class, convertible to bool, that stores the reason why a geom is invalid
class	WktParseException
struct	do_toPoint_d <D> Private structures used to implement partial function specialization.
struct	do_toPoint_d< 3 > <>

Public Types

Type	Name
enum	CoordinateType coordinate types (XY, XYZ, XYM, etc.)
enum	GeometryType
typedef CGAL::Exact_predicates_exact_constructions_kernel	Kernel
typedef CGAL::Point_2< Kernel >	Point_2
typedef Kernel::Point_3	Point_3
typedef CGAL::Polyhedron_3< Kernel >	Polyhedron_3
typedef CGAL::Gmpq	QT
typedef CGAL::Segment_2< Kernel >	Segment_2
typedef CGAL::Triangle_2< Kernel >	Triangle_2
typedef uint32_t	srid_t

Public Attributes

Type	Name
const char	_sfcgal_full_version = = SFCGAL_FULL_VERSION
const char	_sfcgal_version = = SFCGAL_VERSION
const uint32_t	wkbM = = 0x40000000
const uint32_t	wkbSRID = = 0x20000000
const uint32_t	wkbZ = = 0x80000000

Public Functions

Type	Name
auto	Full_Version ()
double	NaN ()
void	SFCGAL_ASSERT_GEOMETRY_VALIDITY (const Geometry & g)
void	SFCGAL_ASSERT_GEOMETRY_VALIDITY_ (const Geometry & g, const std::string & ctxt)
void	SFCGAL_ASSERT_GEOMETRY_VALIDITY_2D (const Geometry & g)
void	SFCGAL_ASSERT_GEOMETRY_VALIDITY_3D (const Geometry & g)
void	SFCGAL_ASSERT_GEOMETRY_VALIDITY_ON_PLANE (const Geometry & g)
template SFCGAL_API std::unique_ptr< CGAL::Polyhedron_3< Kernel > >	toPolyhedron_3< Kernel, CGAL::Polyhedron_3< Kernel > > () const
template SFCGAL_API std::unique_ptr< detail::MarkedPolyhedron >	toPolyhedron_3< Kernel, detail::MarkedPolyhedron > () const
auto	Version ()
auto	almostEqual (const double a, const double b, const double epsilon)
auto	almostEqual (const Kernel::FT & a, const Kernel::FT & b, const Kernel::FT & epsilon)
auto	ceil (const CGAL::Gmpq & v) ceil a rational to an integer
const std::vector< TestGeometry >	createTestGeometries ()
auto	floor (const CGAL::Gmpq & v) floor a rational to an integer
auto	logger ()
Kernel::Vector_3	normalizeVector (const Kernel::Vector_3 & vec) Normalizes a vector.
auto	operator<< (std::ostream & ostr, const Envelope & env)
auto	operator<< (std::ostream & ostr, const Geometry & g)
auto	operator== (const Envelope & a, const Envelope & b)
auto	operator== (const Geometry & ga, const Geometry & gb)
auto	round (const CGAL::Gmpq & v) round a rational to an integer
double	round (const double & v) round a double to the nearest integer

Detailed Description

http://www.gnu.org/licenses/.

Public Types Documentation

enum CoordinateType

coordinate types (XY, XYZ, XYM, etc.)

enum SFCGAL::CoordinateType {
    COORDINATE_XY = 0,
    COORDINATE_XYZ = 1000,
    COORDINATE_XYM = 2000,
    COORDINATE_XYZM = 3000
};

See also: SFA 2.8.3 LineStringZ = 1003 ( coordinateType + geometryType)

---

enum GeometryType

enum SFCGAL::GeometryType {
    TYPE_POINT = 1,
    TYPE_LINESTRING = 2,
    TYPE_POLYGON = 3,
    TYPE_MULTIPOINT = 4,
    TYPE_MULTILINESTRING = 5,
    TYPE_MULTIPOLYGON = 6,
    TYPE_GEOMETRYCOLLECTION = 7,
    TYPE_POLYHEDRALSURFACE = 15,
    TYPE_TRIANGULATEDSURFACE = 16,
    TYPE_TRIANGLE = 17,
    TYPE_SOLID = 101,
    TYPE_MULTISOLID = 102
};

[OGC/SFA]8.2.3 "A common list of codes for geometric types"

Todo

solid and triangles as non OGC/SFA geometric types?

Warning:

codes for abstract classes and unimplemented classes are hidden

Warning:

code values have are important for WKB

---

typedef Kernel

using SFCGAL::Kernel = typedef CGAL::Exact_predicates_exact_constructions_kernel;

default Kernel

---

typedef Point_2

using SFCGAL::Point_2 = typedef CGAL::Point_2<Kernel>;

---

typedef Point_3

using SFCGAL::Point_3 = typedef Kernel::Point_3;

---

typedef Polyhedron_3

using SFCGAL::Polyhedron_3 = typedef CGAL::Polyhedron_3<Kernel>;

---

typedef QT

typedef CGAL::Gmpq SFCGAL::QT;

Quotient type

---

typedef Segment_2

using SFCGAL::Segment_2 = typedef CGAL::Segment_2<Kernel>;

---

typedef Triangle_2

using SFCGAL::Triangle_2 = typedef CGAL::Triangle_2<Kernel>;

---

typedef srid_t

typedef uint32_t SFCGAL::srid_t;

---

Public Attributes Documentation

variable _sfcgal_full_version

const char SFCGAL::_sfcgal_full_version[];

---

variable _sfcgal_version

const char SFCGAL::_sfcgal_version[];

---

variable wkbM

const uint32_t SFCGAL::wkbM;

---

variable wkbSRID

const uint32_t SFCGAL::wkbSRID;

---

variable wkbZ

const uint32_t SFCGAL::wkbZ;

---

Public Functions Documentation

function Full_Version

auto SFCGAL::Full_Version () 

---

function NaN

inline double SFCGAL::NaN () 

shortcut to get NaN for double

---

function SFCGAL_ASSERT_GEOMETRY_VALIDITY

void SFCGAL::SFCGAL_ASSERT_GEOMETRY_VALIDITY (
    const Geometry & g
) 

Functions used to assert for geometry validity

Note:

exception message is apparently limited in length, thus print the reason for invalidity before its text representation (that can be very long)

---

function SFCGAL_ASSERT_GEOMETRY_VALIDITY_

void SFCGAL::SFCGAL_ASSERT_GEOMETRY_VALIDITY_ (
    const Geometry & g,
    const std::string & ctxt
) 

---

function SFCGAL_ASSERT_GEOMETRY_VALIDITY_2D

void SFCGAL::SFCGAL_ASSERT_GEOMETRY_VALIDITY_2D (
    const Geometry & g
) 

---

function SFCGAL_ASSERT_GEOMETRY_VALIDITY_3D

void SFCGAL::SFCGAL_ASSERT_GEOMETRY_VALIDITY_3D (
    const Geometry & g
) 

---

function SFCGAL_ASSERT_GEOMETRY_VALIDITY_ON_PLANE

void SFCGAL::SFCGAL_ASSERT_GEOMETRY_VALIDITY_ON_PLANE (
    const Geometry & g
) 

---

function toPolyhedron_3< Kernel, CGAL::Polyhedron_3< Kernel > >

template SFCGAL_API std::unique_ptr< CGAL::Polyhedron_3< Kernel > > SFCGAL::toPolyhedron_3< Kernel, CGAL::Polyhedron_3< Kernel > > () const

---

function toPolyhedron_3< Kernel, detail::MarkedPolyhedron >

template SFCGAL_API std::unique_ptr< detail::MarkedPolyhedron > SFCGAL::toPolyhedron_3< Kernel, detail::MarkedPolyhedron > () const

---

function Version

auto SFCGAL::Version () 

---

function almostEqual

inline auto SFCGAL::almostEqual (
    const double a,
    const double b,
    const double epsilon
) 

---

function almostEqual

inline auto SFCGAL::almostEqual (
    const Kernel::FT & a,
    const Kernel::FT & b,
    const Kernel::FT & epsilon
) 

---

function ceil

auto SFCGAL::ceil (
    const CGAL::Gmpq & v
) 

---

function createTestGeometries

inline const std::vector< TestGeometry > SFCGAL::createTestGeometries () 

---

function floor

auto SFCGAL::floor (
    const CGAL::Gmpq & v
) 

---

function logger

auto SFCGAL::logger () 

get the logger

---

function normalizeVector

Normalizes a vector.

inline Kernel::Vector_3 SFCGAL::normalizeVector (
    const Kernel::Vector_3 & vec
) 

Parameters:

• v The vector to normalize

Returns:

The normalized vector

---

function operator<<

auto SFCGAL::operator<< (
    std::ostream & ostr,
    const Envelope & env
) 

Ostream operator for Envelope;

---

function operator<<

auto SFCGAL::operator<< (
    std::ostream & ostr,
    const Geometry & g
) 

Ostream operator for Geometry;

---

function operator==

auto SFCGAL::operator== (
    const Envelope & a,
    const Envelope & b
) 

Global comparison operator on Envelope

---

function operator==

auto SFCGAL::operator== (
    const Geometry & ga,
    const Geometry & gb
) 

Function used to compare geometries FIXME Since we do not have (yet) a real "equals" operator, we only compare points coordinates

Equality operator

Todo

only compare coordinate points

Precondition:

the two geometries must be valid

---

function round

auto SFCGAL::round (
    const CGAL::Gmpq & v
) 

---

function round

inline double SFCGAL::round (
    const double & v
) 

---

---

The documentation for this class was generated from the following file /builds/sfcgal/SFCGAL/src/algorithm/alphaShapes.cpp