Skip to content

Namespace SFCGAL#

Namespace List > SFCGAL

Default SFCGAL namespace.

Namespaces#

Type Name
namespace algorithm
Main algorithm namespace.
namespace detail
Implementation details namespace.
namespace generator
Generator namespace.
namespace graph
graph namespace
namespace io
Main Input/output namespace.
namespace tools
namespace transform
transform namespace
namespace triangulate
Triangulate dedicated namespace.

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 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 Segment
Represents a line segment in space.
struct Simplicity
the class, convertible to bool, that stores the reason why a geom is not simple
class Solid
class Sphere
Represents a sphere in 3D space.
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

Public Types#

Type Name
typedef CGAL::Exact_predicates_exact_constructions_kernel Kernel
typedef Kernel::FT squared_distance_t

Public Attributes#

Type Name
constexpr double EPSILON = 1e-8

Public Functions#

Type Name
auto Full_Version ()
double NaN ()
void SFCGAL_API SFCGAL_ASSERT_GEOMETRY_SIMPLICITY (const Geometry & g)
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

Public Static Functions#

Type Name
auto validatePointDimensions (const Point & point1, const Point & point2, const char * point1Name, const char * point2Name)

Public Types Documentation#

typedef Kernel#

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

default Kernel

typedef squared_distance_t#

using SFCGAL::squared_distance_t = typedef Kernel::FT;

Public Attributes Documentation#

variable EPSILON#

constexpr double SFCGAL::EPSILON;

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_SIMPLICITY#

void SFCGAL_API SFCGAL::SFCGAL_ASSERT_GEOMETRY_SIMPLICITY (
    const Geometry & g
)

Functions used to assert for geometry simplicity

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#

ceil a rational to an integer 

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

function createTestGeometries#

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

function floor#

floor a rational to an integer 

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#

round a rational to an integer 

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

function round#

round a double to the nearest integer 

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

Public Static Functions Documentation#

function validatePointDimensions#

static auto SFCGAL::validatePointDimensions (
    const Point & point1,
    const Point & point2,
    const char * point1Name,
    const char * point2Name
)

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