SFCGAL  1.3.0
Namespaces | Classes | Typedefs | Enumerations | Functions | Variables
SFCGAL Namespace Reference

SFCGAL. More...

Namespaces

 algorithm
 
 detail
 
 generator
 
 graph
 
 io
 
 tools
 
 transform
 
 triangulate
 

Classes

class  ConstGeometryVisitor
 Visitor for const geometries. More...
 
class  Coordinate
 Represents the Coordinate of a Point (wraps either an empty structure, or a Kernel::Point_2, or a Kernel::Point_3) More...
 
class  CoordinateDimensionVisitor
 
struct  do_toPoint_d
 Private structures used to implement partial function specialization. More...
 
struct  do_toPoint_d< 3 >
 
class  Envelope
 Represents a bounding box. More...
 
class  Exception
 Base SFCGAL Exception. More...
 
class  Geometry
 OGC/SFA based Geometry abstract class. More...
 
class  GeometryCollection
 A GeometryCollection in SFA. More...
 
class  GeometryInvalidityException
 SFCGAL Exception thrown when invalid geometries are found before entering an algo. More...
 
class  GeometryVisitor
 GeometryVisitor. More...
 
class  GetXVisitor
 
class  GetYVisitor
 
class  GetZVisitor
 
class  InappropriateGeometryException
 SFCGAL Exception thrown when geometry is inapropriate for a function. More...
 
class  LineString
 A LineString in SFA. More...
 
class  Logger
 [Singleton]Logger class More...
 
class  MultiLineString
 A MultiLineString in SFA. More...
 
class  MultiPoint
 A MultiPoint in SFA. More...
 
class  MultiPolygon
 A MultiPolygon in SFA. More...
 
class  MultiSolid
 A MultiSolid. More...
 
class  NonFiniteValueException
 SFCGAL Exception thrown when non finite value is found. More...
 
class  NotImplementedException
 SFCGAL Exception thrown when a function is not implemented. More...
 
struct  Plane_from_facet
 
class  Point
 A point in SFA. More...
 
class  Polygon
 A Polygon in SFA with holes. More...
 
class  PolyhedralSurface
 A PolyhedralSurface in SFA modeled as a Polygon soup. More...
 
class  PreparedGeometry
 A PreparedGeometry is a shell around a SFCGAL::Geometry. More...
 
class  RoundVisitor
 
class  Solid
 A Solid modeled with an exteriorShell and interiorShells materialized by PolyhedralSurface. More...
 
class  Surface
 Abstract Surface class. More...
 
struct  TestGeometry
 
class  ToPoint2Visitor
 
class  ToPoint3Visitor
 
class  Transform
 Represents a coordinate transform. More...
 
class  Triangle
 [OGC/SFA]Triangle More...
 
class  Triangulated2Polyhedron
 
class  TriangulatedSurface
 A TriangulatedSurface in SFA modeled as a Triangle soup. More...
 
struct  Validity
 the class, convertible to bool, that stores the reason why a geom is invalid More...
 
class  WktParseException
 SFCGAL Exception thrown when parsing WKT. More...
 

Typedefs

typedef CGAL::Point_2< KernelPoint_2
 
typedef CGAL::Segment_2< KernelSegment_2
 
typedef CGAL::Triangle_2< KernelTriangle_2
 
typedef CGAL::Exact_predicates_exact_constructions_kernel Kernel
 default Kernel More...
 
typedef CGAL::Gmpq QT
 Quotient type. More...
 
typedef uint32_t srid_t
 

Enumerations

enum  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 = 100, TYPE_SOLID = 101, TYPE_MULTISOLID = 102
}
 [OGC/SFA]8.2.3 "A common list of codes for geometric types" More...
 
enum  CoordinateType { COORDINATE_XY = 0, COORDINATE_XYZ = 1000, COORDINATE_XYM = 2000, COORDINATE_XYZM = 3000 }
 coordinate types (XY, XYZ, XYM, etc.) More...
 

Functions

SFCGAL_API const char * Version ()
 
void SFCGAL_ASSERT_GEOMETRY_VALIDITY_ (const Geometry &g, const std::string &ctxt)
 
void SFCGAL_ASSERT_GEOMETRY_VALIDITY (const Geometry &g)
 Functions used to assert for geometry validity. More...
 
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 &)
 
const std::vector< TestGeometrycreateTestGeometries ()
 
Loggerlogger ()
 get the logger More...
 
bool operator== (const Envelope &, const Envelope &)
 Global comparison operator on Envelope. More...
 
bool 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. More...
 
std::ostream & operator<< (std::ostream &, const Envelope &)
 Ostream operator for Envelope;. More...
 
std::ostream & operator<< (std::ostream &, const Geometry &)
 Ostream operator for Geometry;. More...
 
CGAL::Gmpz floor (const CGAL::Gmpq &v)
 floor a rational to an integer More...
 
CGAL::Gmpz ceil (const CGAL::Gmpq &v)
 ceil a rational to an integer More...
 
CGAL::Gmpz round (const CGAL::Gmpq &v)
 round a rational to an integer More...
 
double NaN ()
 shortcut to get NaN for double More...
 
bool isNaN (const double &value)
 shortcut to test NaN for double More...
 
double round (const double &v)
 round a double to the nearest integer More...
 
template SFCGAL_API std::auto_ptr< detail::MarkedPolyhedronTriangulatedSurface::toPolyhedron_3< Kernel, detail::MarkedPolyhedron > () const
 

Variables

const char _sfcgal_version [] = SFCGAL_VERSION
 

Detailed Description

SFCGAL.

Copyright (C) 2012-2013 Oslandia infos.nosp@m.@osl.nosp@m.andia.nosp@m..com Copyright (C) 2012-2013 IGN (http://www.ign.fr)

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Library General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public License for more details.

You should have received a copy of the GNU Library General Public License along with this library; if not, see http://www.gnu.org/licenses/.

Typedef Documentation

typedef CGAL::Exact_predicates_exact_constructions_kernel SFCGAL::Kernel

default Kernel

typedef CGAL::Point_2<Kernel> SFCGAL::Point_2
typedef CGAL::Gmpq SFCGAL::QT

Quotient type.

typedef CGAL::Segment_2<Kernel> SFCGAL::Segment_2
typedef uint32_t SFCGAL::srid_t
typedef CGAL::Triangle_2<Kernel> SFCGAL::Triangle_2

Function Documentation

SFCGAL_API CGAL::Gmpz SFCGAL::ceil ( const CGAL::Gmpq &  v)

ceil a rational to an integer

const std::vector< TestGeometry > SFCGAL::createTestGeometries ( )
inline
SFCGAL_API CGAL::Gmpz SFCGAL::floor ( const CGAL::Gmpq &  v)

floor a rational to an integer

bool SFCGAL::isNaN ( const double &  value)
inline

shortcut to test NaN for double

SFCGAL_API Logger & SFCGAL::logger ( )

get the logger

double SFCGAL::NaN ( )
inline

shortcut to get NaN for double

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

Ostream operator for Envelope;.

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

Ostream operator for Geometry;.

SFCGAL_API bool SFCGAL::operator== ( const Geometry ,
const Geometry  
)

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
SFCGAL_API bool SFCGAL::operator== ( const Envelope a,
const Envelope b 
)

Global comparison operator on Envelope.

SFCGAL_API CGAL::Gmpz SFCGAL::round ( const CGAL::Gmpq &  v)

round a rational to an integer

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

round a double to the nearest integer

void SFCGAL_API 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)
void SFCGAL::SFCGAL_ASSERT_GEOMETRY_VALIDITY_ ( const Geometry g,
const std::string &  ctxt 
)
void SFCGAL_API SFCGAL::SFCGAL_ASSERT_GEOMETRY_VALIDITY_2D ( const Geometry g)
void SFCGAL_API SFCGAL::SFCGAL_ASSERT_GEOMETRY_VALIDITY_3D ( const Geometry g)
void SFCGAL_API SFCGAL::SFCGAL_ASSERT_GEOMETRY_VALIDITY_ON_PLANE ( const Geometry )
const char * SFCGAL::Version ( )

Variable Documentation

const char SFCGAL::_sfcgal_version[] = SFCGAL_VERSION