SFCGAL: Public C API

SFCGAL

Typedefs
typedef void	sfcgal_geometry_t
	Minimal C API for SFCGAL. More...

typedef void	sfcgal_prepared_geometry_t
	Opaque type that represents the C++ type SFCGAL::PreparedGeometry. More...

typedef int(*	sfcgal_error_handler_t) (const char *,...)
	Warning and error handlers. More...

Enumerations
enum	sfcgal_geometry_type_t { SFCGAL_TYPE_POINT = 1 , SFCGAL_TYPE_LINESTRING = 2 , SFCGAL_TYPE_POLYGON = 3 , SFCGAL_TYPE_MULTIPOINT = 4 , SFCGAL_TYPE_MULTILINESTRING = 5 , SFCGAL_TYPE_MULTIPOLYGON = 6 , SFCGAL_TYPE_GEOMETRYCOLLECTION = 7 , SFCGAL_TYPE_POLYHEDRALSURFACE = 15 , SFCGAL_TYPE_TRIANGULATEDSURFACE = 16 , SFCGAL_TYPE_TRIANGLE = 100 , SFCGAL_TYPE_SOLID = 101 , SFCGAL_TYPE_MULTISOLID = 102 }
	Geometric types. More...

Functions
SFCGAL_API void	sfcgal_set_geometry_validation (int enabled)
	Set the geometry validation mode. More...

SFCGAL_API sfcgal_geometry_type_t	sfcgal_geometry_type_id (const sfcgal_geometry_t *)
	Returns the type of a given geometry. More...

SFCGAL_API int	sfcgal_geometry_is_valid (const sfcgal_geometry_t *)
	Tests if the given geometry is valid or not. More...

SFCGAL_API int	sfcgal_geometry_is_valid_detail (const sfcgal_geometry_t geom, char invalidity_reason, sfcgal_geometry_t *invalidity_location)
	Tests if the given geometry is valid or not And return details in case of invalidity. More...

SFCGAL_API int	sfcgal_geometry_is_3d (const sfcgal_geometry_t *)
	Tests if the given geometry is 3D or not. More...

SFCGAL_API int	sfcgal_geometry_is_measured (const sfcgal_geometry_t *)
	Tests if the given geometry is measured (has an m) or not. More...

SFCGAL_API int	sfcgal_geometry_is_empty (const sfcgal_geometry_t *)
	Tests if the given geometry is empty or not. More...

SFCGAL_API sfcgal_geometry_t *	sfcgal_geometry_clone (const sfcgal_geometry_t *)
	Returns a deep clone of the given geometry. More...

SFCGAL_API void	sfcgal_geometry_delete (sfcgal_geometry_t *)
	Deletes a given geometry. More...

SFCGAL_API void	sfcgal_geometry_as_text (const sfcgal_geometry_t , char buffer, size_t len)
	Returns a WKT representation of the given geometry using CGAL exact integer fractions as coordinate values. More...

SFCGAL_API void	sfcgal_geometry_as_text_decim (const sfcgal_geometry_t , int numDecimals, char buffer, size_t len)
	Returns a WKT representation of the given geometry using floating point coordinate values. More...

SFCGAL_API sfcgal_geometry_t *	sfcgal_point_create ()
	Creates an empty point. More...

SFCGAL_API sfcgal_geometry_t *	sfcgal_point_create_from_xy (double x, double y)
	Creates a point from two X and Y coordinates. More...

SFCGAL_API sfcgal_geometry_t *	sfcgal_point_create_from_xyz (double x, double y, double z)
	Creates a point from three X, Y and Z coordinates. More...

SFCGAL_API sfcgal_geometry_t *	sfcgal_point_create_from_xym (double x, double y, double m)
	Creates a point from three X, Y and M coordinates. More...

SFCGAL_API sfcgal_geometry_t *	sfcgal_point_create_from_xyzm (double x, double y, double z, double m)
	Creates a point from four X, Y, Z and M coordinates. More...

SFCGAL_API double	sfcgal_point_x (const sfcgal_geometry_t *)
	Returns the X coordinate of the given Point. More...

SFCGAL_API double	sfcgal_point_y (const sfcgal_geometry_t *)
	Returns the Y coordinate of the given Point. More...

SFCGAL_API double	sfcgal_point_z (const sfcgal_geometry_t *)
	Returns the Z coordinate of the given Point. More...

SFCGAL_API double	sfcgal_point_m (const sfcgal_geometry_t *)
	Returns the M coordinate of the given Point. More...

SFCGAL_API sfcgal_geometry_t *	sfcgal_linestring_create ()
	Creates an empty LineString. More...

SFCGAL_API size_t	sfcgal_linestring_num_points (const sfcgal_geometry_t *linestring)
	Returns the number of points of the given LineString. More...

SFCGAL_API const sfcgal_geometry_t *	sfcgal_linestring_point_n (const sfcgal_geometry_t *linestring, size_t i)
	Returns the ith point of a given LineString. More...

SFCGAL_API void	sfcgal_linestring_add_point (sfcgal_geometry_t linestring, sfcgal_geometry_t point)
	Adds a point to a LineString. More...

SFCGAL_API sfcgal_geometry_t *	sfcgal_triangle_create ()
	Creates an empty Triangle. More...

SFCGAL_API sfcgal_geometry_t *	sfcgal_triangle_create_from_points (const sfcgal_geometry_t pta, const sfcgal_geometry_t ptb, const sfcgal_geometry_t *ptc)
	Creates a Triangle from three given Point. More...

SFCGAL_API const sfcgal_geometry_t *	sfcgal_triangle_vertex (const sfcgal_geometry_t *triangle, int i)
	Returns one the Triangle's vertex as a Point. More...

SFCGAL_API void	sfcgal_triangle_set_vertex (sfcgal_geometry_t triangle, int i, const sfcgal_geometry_t vertex)
	Sets one vertex of a Triangle. More...

SFCGAL_API void	sfcgal_triangle_set_vertex_from_xy (sfcgal_geometry_t *triangle, int i, double x, double y)
	Sets one vertex of a Triangle from two coordinates. More...

SFCGAL_API void	sfcgal_triangle_set_vertex_from_xyz (sfcgal_geometry_t *triangle, int i, double x, double y, double z)
	Sets one vertex of a Triangle from three coordinates. More...

SFCGAL_API sfcgal_geometry_t *	sfcgal_polygon_create ()
	Creates an empty Polygon. More...

SFCGAL_API sfcgal_geometry_t *	sfcgal_polygon_create_from_exterior_ring (sfcgal_geometry_t *ring)
	Creates an empty Polygon from an extrior ring. More...

SFCGAL_API const sfcgal_geometry_t *	sfcgal_polygon_exterior_ring (const sfcgal_geometry_t *polygon)
	Returns the exterior ring of a given Polygon. More...

SFCGAL_API size_t	sfcgal_polygon_num_interior_rings (const sfcgal_geometry_t *polygon)
	Returns the number of interior rings of a given Polygon. More...

SFCGAL_API const sfcgal_geometry_t *	sfcgal_polygon_interior_ring_n (const sfcgal_geometry_t *polygon, size_t i)
	Returns the ith interior ring of a given Polygon. More...

SFCGAL_API void	sfcgal_polygon_add_interior_ring (sfcgal_geometry_t polygon, sfcgal_geometry_t ring)
	Adds an interior ring to a given Polygon. More...

SFCGAL_API sfcgal_geometry_t *	sfcgal_geometry_collection_create ()
	Creates an empty GeometryCollection. More...

SFCGAL_API size_t	sfcgal_geometry_collection_num_geometries (const sfcgal_geometry_t *collection)
	Returns the number of geometries of a given GeometryCollection. More...

SFCGAL_API const sfcgal_geometry_t *	sfcgal_geometry_collection_geometry_n (const sfcgal_geometry_t *collection, size_t i)
	Returns the ith geometry of a GeometryCollection. More...

SFCGAL_API void	sfcgal_geometry_collection_add_geometry (sfcgal_geometry_t collection, sfcgal_geometry_t geometry)
	Adds a Geometry to a given GeometryCollection. More...

SFCGAL_API sfcgal_geometry_t *	sfcgal_multi_point_create ()
	Creates an empty MultiPoint. More...

SFCGAL_API sfcgal_geometry_t *	sfcgal_multi_linestring_create ()
	Creates an empty MultiLineString. More...

SFCGAL_API sfcgal_geometry_t *	sfcgal_multi_polygon_create ()
	Creates an empty MultiPolygon. More...

SFCGAL_API sfcgal_geometry_t *	sfcgal_polyhedral_surface_create ()
	Creates an empty PolyhedralSurface. More...

SFCGAL_API size_t	sfcgal_polyhedral_surface_num_polygons (const sfcgal_geometry_t *polyhedral)
	Returns the number of polygons of a given PolyhedralSurface. More...

SFCGAL_API const sfcgal_geometry_t *	sfcgal_polyhedral_surface_polygon_n (const sfcgal_geometry_t *polyhedral, size_t i)
	Returns the ith polygon of a given PolyhedralSurface. More...

SFCGAL_API void	sfcgal_polyhedral_surface_add_polygon (sfcgal_geometry_t polyhedral, sfcgal_geometry_t polygon)
	Adds a Polygon to a given PolyhedralSurface. More...

SFCGAL_API sfcgal_geometry_t *	sfcgal_triangulated_surface_create ()
	Creates an empty TriangulatedSurface. More...

SFCGAL_API size_t	sfcgal_triangulated_surface_num_triangles (const sfcgal_geometry_t *tin)
	Returns the number of triangles of a given TriangulatedSurface. More...

SFCGAL_API const sfcgal_geometry_t *	sfcgal_triangulated_surface_triangle_n (const sfcgal_geometry_t *tin, size_t i)
	Returns the ith Triangle of a given TriangulatedSurface. More...

SFCGAL_API void	sfcgal_triangulated_surface_add_triangle (sfcgal_geometry_t tin, sfcgal_geometry_t triangle)
	Adds a Triangle to a given TriangulatedSurface. More...

SFCGAL_API sfcgal_geometry_t *	sfcgal_solid_create ()
	Creates an empty Solid. More...

SFCGAL_API sfcgal_geometry_t *	sfcgal_solid_create_from_exterior_shell (sfcgal_geometry_t *shell)
	Creates a Solid from an exterior shell. More...

SFCGAL_API size_t	sfcgal_solid_num_shells (const sfcgal_geometry_t *solid)
	Returns the number of shells of a given Solid. More...

SFCGAL_API const sfcgal_geometry_t *	sfcgal_solid_shell_n (const sfcgal_geometry_t *solid, size_t i)
	Returns the ith shell of a given Solid. More...

SFCGAL_API void	sfcgal_solid_add_interior_shell (sfcgal_geometry_t solid, sfcgal_geometry_t shell)
	Adds a shell to a given Solid. More...

SFCGAL_API sfcgal_prepared_geometry_t *	sfcgal_prepared_geometry_create ()
	Creates an empty PreparedGeometry. More...

SFCGAL_API sfcgal_prepared_geometry_t *	sfcgal_prepared_geometry_create_from_geometry (sfcgal_geometry_t *geometry, srid_t srid)
	Creates a PreparedGeometry from a Geometry and an SRID. More...

SFCGAL_API void	sfcgal_prepared_geometry_delete (sfcgal_prepared_geometry_t *prepared)
	Deletes a given PreparedGeometry. More...

SFCGAL_API const sfcgal_geometry_t *	sfcgal_prepared_geometry_geometry (const sfcgal_prepared_geometry_t *prepared)
	Returns the Geometry associated with a given PreparedGeometry. More...

SFCGAL_API void	sfcgal_prepared_geometry_set_geometry (sfcgal_prepared_geometry_t prepared, sfcgal_geometry_t geometry)
	Sets the Geometry associated with the given PreparedGeometry. More...

SFCGAL_API srid_t	sfcgal_prepared_geometry_srid (const sfcgal_prepared_geometry_t *prepared)
	Returns SRID associated with a given PreparedGeometry. More...

SFCGAL_API void	sfcgal_prepared_geometry_set_srid (sfcgal_prepared_geometry_t *prepared, srid_t)
	Sets SRID associated with a given PreparedGeometry. More...

SFCGAL_API void	sfcgal_prepared_geometry_as_ewkt (const sfcgal_prepared_geometry_t prepared, int num_decimals, char buffer, size_t len)
	Returns an EWKT representation of the given PreparedGeometry. More...

SFCGAL_API int	sfcgal_geometry_intersects (const sfcgal_geometry_t geom1, const sfcgal_geometry_t geom2)
	Tests the intersection of geom1 and geom2. More...

SFCGAL_API int	sfcgal_geometry_intersects_3d (const sfcgal_geometry_t geom1, const sfcgal_geometry_t geom2)
	Tests the 3D intersection of geom1 and geom2. More...

SFCGAL_API sfcgal_geometry_t *	sfcgal_geometry_intersection (const sfcgal_geometry_t geom1, const sfcgal_geometry_t geom2)
	Returns the intersection of geom1 and geom2. More...

SFCGAL_API sfcgal_geometry_t *	sfcgal_geometry_intersection_3d (const sfcgal_geometry_t geom1, const sfcgal_geometry_t geom2)
	Returns the 3D intersection of geom1 and geom2. More...

SFCGAL_API sfcgal_geometry_t *	sfcgal_geometry_difference (const sfcgal_geometry_t geom1, const sfcgal_geometry_t geom2)
	Returns the difference of geom1 and geom2. More...

SFCGAL_API sfcgal_geometry_t *	sfcgal_geometry_difference_3d (const sfcgal_geometry_t geom1, const sfcgal_geometry_t geom2)
	Returns the 3D difference of geom1 and geom2. More...

SFCGAL_API sfcgal_geometry_t *	sfcgal_geometry_union (const sfcgal_geometry_t geom1, const sfcgal_geometry_t geom2)
	Returns the union of geom1 and geom2. More...

SFCGAL_API sfcgal_geometry_t *	sfcgal_geometry_union_3d (const sfcgal_geometry_t geom1, const sfcgal_geometry_t geom2)
	Returns the 3D union of geom1 and geom2. More...

SFCGAL_API sfcgal_geometry_t *	sfcgal_geometry_convexhull (const sfcgal_geometry_t *geom)
	Returns the convex hull of geom. More...

SFCGAL_API sfcgal_geometry_t *	sfcgal_geometry_convexhull_3d (const sfcgal_geometry_t *geom)
	Returns the 3D convex hull of geom. More...

SFCGAL_API double	sfcgal_geometry_volume (const sfcgal_geometry_t *geom)
	Returns the volume of geom (must be a volume) More...

SFCGAL_API double	sfcgal_geometry_area (const sfcgal_geometry_t *geom)
	Returns the area of geom. More...

SFCGAL_API double	sfcgal_geometry_area_3d (const sfcgal_geometry_t *geom)
	Returns the 3D area of geom. More...

SFCGAL_API int	sfcgal_geometry_is_planar (const sfcgal_geometry_t *geom)
	Tests if the given Geometry is planar. More...

SFCGAL_API int	sfcgal_geometry_orientation (const sfcgal_geometry_t *geom)
	Returns the orientation of the given Polygon -1 for a counter clockwise orientation 1 for a clockwise orientation 0 for an invalid or undetermined orientation. More...

SFCGAL_API sfcgal_geometry_t *	sfcgal_geometry_tesselate (const sfcgal_geometry_t *geom)
	Returns a tesselation of the given Geometry. More...

SFCGAL_API sfcgal_geometry_t *	sfcgal_geometry_triangulate_2dz (const sfcgal_geometry_t *geom)
	Returns a triangulation of the given Geometry. More...

SFCGAL_API sfcgal_geometry_t *	sfcgal_geometry_extrude (const sfcgal_geometry_t *geom, double ex, double ey, double ez)
	Returns an extrusion of the given Geometry. More...

SFCGAL_API sfcgal_geometry_t *	sfcgal_geometry_force_lhr (const sfcgal_geometry_t *geom)
	Force a Left Handed Rule on the given Geometry. More...

SFCGAL_API sfcgal_geometry_t *	sfcgal_geometry_force_rhr (const sfcgal_geometry_t *geom)
	Force a Right Handed Rule on the given Geometry. More...

SFCGAL_API double	sfcgal_geometry_distance (const sfcgal_geometry_t geom1, const sfcgal_geometry_t geom2)
	Computes the distance of the two given Geometry objects. More...

SFCGAL_API double	sfcgal_geometry_distance_3d (const sfcgal_geometry_t geom1, const sfcgal_geometry_t geom2)
	Computes the 3D distance of the two given Geometry objects. More...

SFCGAL_API sfcgal_geometry_t *	sfcgal_geometry_round (const sfcgal_geometry_t *geom, int r)
	Round coordinates of the given Geometry. More...

SFCGAL_API sfcgal_geometry_t *	sfcgal_geometry_minkowski_sum (const sfcgal_geometry_t geom1, const sfcgal_geometry_t geom2)
	Returns the minkowski sum geom1 + geom2. More...

SFCGAL_API sfcgal_geometry_t *	sfcgal_geometry_offset_polygon (const sfcgal_geometry_t *geom, double radius)
	Returns the offset polygon of the given Geometry. More...

SFCGAL_API sfcgal_geometry_t *	sfcgal_geometry_straight_skeleton (const sfcgal_geometry_t *geom)
	Returns the straight skeleton of the given Geometry. More...

SFCGAL_API sfcgal_geometry_t *	sfcgal_geometry_straight_skeleton_distance_in_m (const sfcgal_geometry_t *geom)
	Returns the straight skeleton of the given Geometry with the distance to the border as M coordinate. More...

SFCGAL_API sfcgal_geometry_t *	sfcgal_geometry_approximate_medial_axis (const sfcgal_geometry_t *geom)
	Returns the approximate medial axis for the given Polygon Approximate medial axis is based on straight skeleton. More...

SFCGAL_API int	sfcgal_geometry_covers (const sfcgal_geometry_t geom1, const sfcgal_geometry_t geom2)
	Tests the coverage of geom1 and geom2. More...

SFCGAL_API int	sfcgal_geometry_covers_3d (const sfcgal_geometry_t geom1, const sfcgal_geometry_t geom2)
	Tests the 3D coverage of geom1 and geom2. More...

SFCGAL_API sfcgal_geometry_t *	sfcgal_geometry_line_sub_string (const sfcgal_geometry_t *geom, double start, double end)
	Returns the substring of the given LineString between fractional distances. More...

SFCGAL_API sfcgal_geometry_t *	sfcgal_geometry_alpha_shapes (const sfcgal_geometry_t *geom, double alpha, bool allow_holes)
	Returns the alpha shapes of geom. More...

SFCGAL_API sfcgal_geometry_t *	sfcgal_geometry_optimal_alpha_shapes (const sfcgal_geometry_t *geom, bool allow_holes, size_t nb_components)
	Returns the optimal alpha shapes of geom. More...

SFCGAL_API void	sfcgal_set_error_handlers (sfcgal_error_handler_t warning_handler, sfcgal_error_handler_t error_handler)
	Sets the error handlers. More...

SFCGAL_API void	sfcgal_set_alloc_handlers (sfcgal_alloc_handler_t malloc_handler, sfcgal_free_handler_t free_handler)
	Sets the error handlers. More...

SFCGAL_API void	sfcgal_init ()
	This function must be called before all the other one. More...

SFCGAL_API const char *	sfcgal_version ()
	Get version. More...

SFCGAL_API const char *	sfcgal_full_version ()
	Get full version (including CGAL and Boost versions) More...

Detailed Description

Typedef Documentation

◆ sfcgal_error_handler_t

typedef int(* sfcgal_error_handler_t) (const char *,...)

Warning and error handlers.

◆ sfcgal_geometry_t

typedef void sfcgal_geometry_t

Minimal C API for SFCGAL.

sfcgal_geometry_t is an opaque pointer type that is used to represent a pointer to SFCGAL::Geometry

◆ sfcgal_prepared_geometry_t

typedef void sfcgal_prepared_geometry_t

Opaque type that represents the C++ type SFCGAL::PreparedGeometry.

Enumeration Type Documentation

◆ sfcgal_geometry_type_t

enum sfcgal_geometry_type_t

Geometric types.

Enumerator
SFCGAL_TYPE_POINT
SFCGAL_TYPE_LINESTRING
SFCGAL_TYPE_POLYGON
SFCGAL_TYPE_MULTIPOINT
SFCGAL_TYPE_MULTILINESTRING
SFCGAL_TYPE_MULTIPOLYGON
SFCGAL_TYPE_GEOMETRYCOLLECTION
SFCGAL_TYPE_POLYHEDRALSURFACE
SFCGAL_TYPE_TRIANGULATEDSURFACE
SFCGAL_TYPE_TRIANGLE
SFCGAL_TYPE_SOLID
SFCGAL_TYPE_MULTISOLID

Function Documentation

◆ sfcgal_full_version()

SFCGAL_API const char * sfcgal_full_version ( )

Get full version (including CGAL and Boost versions)

◆ sfcgal_geometry_alpha_shapes()

SFCGAL_API sfcgal_geometry_t * sfcgal_geometry_alpha_shapes	(	const sfcgal_geometry_t *	geom,
		double	alpha,
		bool	allow_holes
	)

Returns the alpha shapes of geom.

Precondition: isValid(geom) == true; alpha >= 0

Postcondition: isValid(return) == true

◆ sfcgal_geometry_approximate_medial_axis()

SFCGAL_API sfcgal_geometry_t * sfcgal_geometry_approximate_medial_axis ( const sfcgal_geometry_t * geom )

Returns the approximate medial axis for the given Polygon Approximate medial axis is based on straight skeleton.

Precondition: isValid(geom) == true

◆ sfcgal_geometry_area()

SFCGAL_API double sfcgal_geometry_area ( const sfcgal_geometry_t * geom )

Returns the area of geom.

Precondition: isValid(geom) == true

◆ sfcgal_geometry_area_3d()

SFCGAL_API double sfcgal_geometry_area_3d ( const sfcgal_geometry_t * geom )

Returns the 3D area of geom.

Precondition: isValid(geom) == true

◆ sfcgal_geometry_as_text()

SFCGAL_API void sfcgal_geometry_as_text	(	const sfcgal_geometry_t *	pgeom,
		char **	buffer,
		size_t *	len
	)

Returns a WKT representation of the given geometry using CGAL exact integer fractions as coordinate values.

Postcondition: buffer is returned allocated and must be freed by the caller

◆ sfcgal_geometry_as_text_decim()

SFCGAL_API void sfcgal_geometry_as_text_decim	(	const sfcgal_geometry_t *	pgeom,
		int	numDecimals,
		char **	buffer,
		size_t *	len
	)

Returns a WKT representation of the given geometry using floating point coordinate values.

Floating point precision can be set via the numDecimals parameter. Setting numDecimals to -1 yields the same result as sfcgal_geometry_as_text.

Postcondition: buffer is returned allocated and must be freed by the caller

◆ sfcgal_geometry_clone()

SFCGAL_API sfcgal_geometry_t * sfcgal_geometry_clone ( const sfcgal_geometry_t * geom )

Returns a deep clone of the given geometry.

Postcondition: returns a pointer to an allocated geometry that must be deallocated by sfcgal_geometry_delete

◆ sfcgal_geometry_collection_add_geometry()

SFCGAL_API void sfcgal_geometry_collection_add_geometry	(	sfcgal_geometry_t *	collection,
		sfcgal_geometry_t *	geometry
	)

Adds a Geometry to a given GeometryCollection.

Precondition: collection must be a GeometryCollection

Postcondition: the ownership of the given geometry is taken. The caller is not responsible anymore of its deallocation

◆ sfcgal_geometry_collection_create()

SFCGAL_API sfcgal_geometry_t * sfcgal_geometry_collection_create ( ) -> sfcgal_geometry_t *

Creates an empty GeometryCollection.

◆ sfcgal_geometry_collection_geometry_n()

SFCGAL_API const sfcgal_geometry_t * sfcgal_geometry_collection_geometry_n	(	const sfcgal_geometry_t *	collection,
		size_t	i
	)

Returns the ith geometry of a GeometryCollection.

Precondition: collection is a GeometryCollection; i >= 0 and i < sfcgal_geometry_collection_num_geometries

Postcondition: the returned Geometry is not writable and must not be deallocated by the caller

◆ sfcgal_geometry_collection_num_geometries()

SFCGAL_API size_t sfcgal_geometry_collection_num_geometries ( const sfcgal_geometry_t * collection )

Returns the number of geometries of a given GeometryCollection.

Precondition: collection is a GeometryCollection

◆ sfcgal_geometry_convexhull()

SFCGAL_API sfcgal_geometry_t * sfcgal_geometry_convexhull ( const sfcgal_geometry_t * geom )

Returns the convex hull of geom.

Precondition: isValid(geom) == true

Postcondition: isValid(return) == true

◆ sfcgal_geometry_convexhull_3d()

SFCGAL_API sfcgal_geometry_t * sfcgal_geometry_convexhull_3d ( const sfcgal_geometry_t * geom )

Returns the 3D convex hull of geom.

Precondition: isValid(geom) == true

Postcondition: isValid(return) == true

◆ sfcgal_geometry_covers()

SFCGAL_API int sfcgal_geometry_covers	(	const sfcgal_geometry_t *	geom1,
		const sfcgal_geometry_t *	geom2
	)

Tests the coverage of geom1 and geom2.

Precondition: isValid(geom1) == true; isValid(geom2) == true

◆ sfcgal_geometry_covers_3d()

SFCGAL_API int sfcgal_geometry_covers_3d	(	const sfcgal_geometry_t *	geom1,
		const sfcgal_geometry_t *	geom2
	)

Tests the 3D coverage of geom1 and geom2.

Precondition: isValid(geom1) == true; isValid(geom2) == true

◆ sfcgal_geometry_delete()

SFCGAL_API void sfcgal_geometry_delete ( sfcgal_geometry_t * geom )

Deletes a given geometry.

Precondition: the given pointer must have been previously allocated by a creation function

◆ sfcgal_geometry_difference()

SFCGAL_API sfcgal_geometry_t * sfcgal_geometry_difference	(	const sfcgal_geometry_t *	geom1,
		const sfcgal_geometry_t *	geom2
	)

Returns the difference of geom1 and geom2.

Precondition: isValid(geom1) == true; isValid(geom2) == true

Postcondition: isValid(return) == true

◆ sfcgal_geometry_difference_3d()

SFCGAL_API sfcgal_geometry_t * sfcgal_geometry_difference_3d	(	const sfcgal_geometry_t *	geom1,
		const sfcgal_geometry_t *	geom2
	)

Returns the 3D difference of geom1 and geom2.

Precondition: isValid(geom1) == true; isValid(geom2) == true

Postcondition: isValid(return) == true

◆ sfcgal_geometry_distance()

SFCGAL_API double sfcgal_geometry_distance	(	const sfcgal_geometry_t *	geom1,
		const sfcgal_geometry_t *	geom2
	)

Computes the distance of the two given Geometry objects.

Precondition: isValid(geom1) == true; isValid(geom2) == true

◆ sfcgal_geometry_distance_3d()

SFCGAL_API double sfcgal_geometry_distance_3d	(	const sfcgal_geometry_t *	geom1,
		const sfcgal_geometry_t *	geom2
	)

Computes the 3D distance of the two given Geometry objects.

Precondition: isValid(geom1) == true; isValid(geom2) == true

◆ sfcgal_geometry_extrude()

SFCGAL_API sfcgal_geometry_t * sfcgal_geometry_extrude	(	const sfcgal_geometry_t *	geom,
		double	ex,
		double	ey,
		double	ez
	)

Returns an extrusion of the given Geometry.

Precondition: isValid(geom) == true

Postcondition: isValid(return) == true

◆ sfcgal_geometry_force_lhr()

SFCGAL_API sfcgal_geometry_t * sfcgal_geometry_force_lhr ( const sfcgal_geometry_t * geom )

Force a Left Handed Rule on the given Geometry.

Precondition: isValid(geom) == true

Postcondition: isValid(return) == true

◆ sfcgal_geometry_force_rhr()

SFCGAL_API sfcgal_geometry_t * sfcgal_geometry_force_rhr ( const sfcgal_geometry_t * geom )

Force a Right Handed Rule on the given Geometry.

Precondition: isValid(geom) == true

Postcondition: isValid(return) == true

◆ sfcgal_geometry_intersection()

SFCGAL_API sfcgal_geometry_t * sfcgal_geometry_intersection	(	const sfcgal_geometry_t *	geom1,
		const sfcgal_geometry_t *	geom2
	)

Returns the intersection of geom1 and geom2.

Precondition: isValid(geom1) == true; isValid(geom2) == true

Postcondition: isValid(return) == true

◆ sfcgal_geometry_intersection_3d()

SFCGAL_API sfcgal_geometry_t * sfcgal_geometry_intersection_3d	(	const sfcgal_geometry_t *	geom1,
		const sfcgal_geometry_t *	geom2
	)

Returns the 3D intersection of geom1 and geom2.

Precondition: isValid(geom1) == true; isValid(geom2) == true

Postcondition: isValid(return) == true

◆ sfcgal_geometry_intersects()

SFCGAL_API int sfcgal_geometry_intersects	(	const sfcgal_geometry_t *	geom1,
		const sfcgal_geometry_t *	geom2
	)

Tests the intersection of geom1 and geom2.

Precondition: isValid(geom1) == true; isValid(geom2) == true

◆ sfcgal_geometry_intersects_3d()

SFCGAL_API int sfcgal_geometry_intersects_3d	(	const sfcgal_geometry_t *	geom1,
		const sfcgal_geometry_t *	geom2
	)

Tests the 3D intersection of geom1 and geom2.

Precondition: isValid(geom1) == true; isValid(geom2) == true

◆ sfcgal_geometry_is_3d()

SFCGAL_API int sfcgal_geometry_is_3d ( const sfcgal_geometry_t * geom )

Tests if the given geometry is 3D or not.

◆ sfcgal_geometry_is_empty()

SFCGAL_API int sfcgal_geometry_is_empty ( const sfcgal_geometry_t * geom )

Tests if the given geometry is empty or not.

◆ sfcgal_geometry_is_measured()

SFCGAL_API int sfcgal_geometry_is_measured ( const sfcgal_geometry_t * geom )

Tests if the given geometry is measured (has an m) or not.

◆ sfcgal_geometry_is_planar()

SFCGAL_API int sfcgal_geometry_is_planar ( const sfcgal_geometry_t * geom )

Tests if the given Geometry is planar.

Precondition: isValid(geom) == true

◆ sfcgal_geometry_is_valid()

SFCGAL_API int sfcgal_geometry_is_valid ( const sfcgal_geometry_t * geom )

Tests if the given geometry is valid or not.

◆ sfcgal_geometry_is_valid_detail()

SFCGAL_API int sfcgal_geometry_is_valid_detail	(	const sfcgal_geometry_t *	geom,
		char **	invalidity_reason,
		sfcgal_geometry_t **	invalidity_location
	)

Tests if the given geometry is valid or not And return details in case of invalidity.

Parameters

geom	the input geometry
invalidity_reason	input/output parameter. If non null, a null-terminated string could be allocated and contain reason of the invalidity
invalidity_location	input/output parameter. If non null, a geometry could be allocated and contain the location of the invalidity

◆ sfcgal_geometry_line_sub_string()

SFCGAL_API sfcgal_geometry_t * sfcgal_geometry_line_sub_string	(	const sfcgal_geometry_t *	geom,
		double	start,
		double	end
	)

Returns the substring of the given LineString between fractional distances.

Precondition: isValid(geom) == true; geom is a Linestring; -1 <= start <= 1; -1 <= end <= 1

Postcondition: isValid(return) == true

◆ sfcgal_geometry_minkowski_sum()

SFCGAL_API sfcgal_geometry_t * sfcgal_geometry_minkowski_sum	(	const sfcgal_geometry_t *	geom1,
		const sfcgal_geometry_t *	geom2
	)

Returns the minkowski sum geom1 + geom2.

Precondition: isValid(geom1) == true; isValid(geom2) == true

Postcondition: isValid(return) == true

◆ sfcgal_geometry_offset_polygon()

SFCGAL_API sfcgal_geometry_t * sfcgal_geometry_offset_polygon	(	const sfcgal_geometry_t *	geom,
		double	radius
	)

Returns the offset polygon of the given Geometry.

Precondition: isValid(geom) == true

Postcondition: isValid(return) == true

◆ sfcgal_geometry_optimal_alpha_shapes()

SFCGAL_API sfcgal_geometry_t * sfcgal_geometry_optimal_alpha_shapes	(	const sfcgal_geometry_t *	geom,
		bool	allow_holes,
		size_t	nb_components
	)

Returns the optimal alpha shapes of geom.

Precondition: isValid(geom) == true; alpha >= 0; nb_components >= 0

Postcondition: isValid(return) == true

◆ sfcgal_geometry_orientation()

SFCGAL_API int sfcgal_geometry_orientation ( const sfcgal_geometry_t * ga ) -> int

Returns the orientation of the given Polygon -1 for a counter clockwise orientation 1 for a clockwise orientation 0 for an invalid or undetermined orientation.

Precondition: geom is a Polygon; isValid(geom) == true

Returns the orientation of the given Polygon -1 for a counter clockwise orientation 1 for a clockwise orientation 0 for an invalid or undetermined orientation.

Returns: -1 for a counter clock wise orientation, 1 for a clock wise orientation, 0 for invalid or undetermined orientation

◆ sfcgal_geometry_round()

SFCGAL_API sfcgal_geometry_t * sfcgal_geometry_round	(	const sfcgal_geometry_t *	geom,
		int	r
	)

Round coordinates of the given Geometry.

Precondition: isValid(geom) == true

Postcondition: isValid(return) == true

◆ sfcgal_geometry_straight_skeleton()

SFCGAL_API sfcgal_geometry_t * sfcgal_geometry_straight_skeleton ( const sfcgal_geometry_t * geom )

Returns the straight skeleton of the given Geometry.

Precondition: isValid(geom) == true

Postcondition: isValid(return) == true

◆ sfcgal_geometry_straight_skeleton_distance_in_m()

SFCGAL_API sfcgal_geometry_t * sfcgal_geometry_straight_skeleton_distance_in_m ( const sfcgal_geometry_t * geom )

Returns the straight skeleton of the given Geometry with the distance to the border as M coordinate.

Precondition: isValid(geom) == true

Postcondition: isValid(return) == true

◆ sfcgal_geometry_tesselate()

SFCGAL_API sfcgal_geometry_t * sfcgal_geometry_tesselate ( const sfcgal_geometry_t * geom )

Returns a tesselation of the given Geometry.

Precondition: isValid(geom) == true

Postcondition: isValid(return) == true

◆ sfcgal_geometry_triangulate_2dz()

SFCGAL_API sfcgal_geometry_t * sfcgal_geometry_triangulate_2dz ( const sfcgal_geometry_t * geom )

Returns a triangulation of the given Geometry.

Precondition: isValid(geom) == true

Postcondition: isValid(return) == true

◆ sfcgal_geometry_type_id()

SFCGAL_API sfcgal_geometry_type_t sfcgal_geometry_type_id ( const sfcgal_geometry_t * geom )

Returns the type of a given geometry.

◆ sfcgal_geometry_union()

SFCGAL_API sfcgal_geometry_t * sfcgal_geometry_union	(	const sfcgal_geometry_t *	geom1,
		const sfcgal_geometry_t *	geom2
	)

Returns the union of geom1 and geom2.

Precondition: isValid(geom1) == true; isValid(geom2) == true

Postcondition: isValid(return) == true

◆ sfcgal_geometry_union_3d()

SFCGAL_API sfcgal_geometry_t * sfcgal_geometry_union_3d	(	const sfcgal_geometry_t *	geom1,
		const sfcgal_geometry_t *	geom2
	)

Returns the 3D union of geom1 and geom2.

Precondition: isValid(geom1) == true; isValid(geom2) == true

Postcondition: isValid(return) == true

◆ sfcgal_geometry_volume()

SFCGAL_API double sfcgal_geometry_volume ( const sfcgal_geometry_t * geom )

Returns the volume of geom (must be a volume)

Precondition: isValid(geom) == true

◆ sfcgal_init()

SFCGAL_API void sfcgal_init ( )

This function must be called before all the other one.

◆ sfcgal_linestring_add_point()

SFCGAL_API void sfcgal_linestring_add_point	(	sfcgal_geometry_t *	linestring,
		sfcgal_geometry_t *	point
	)

Adds a point to a LineString.

Parameters

linestring	is the LineString where the Point has to be added to
point	is the Point to add to the given LineString

Precondition: i >= and i < sfcgal_linestring_num_points

Postcondition: the ownership of Point is taken by the function

◆ sfcgal_linestring_create()

SFCGAL_API sfcgal_geometry_t * sfcgal_linestring_create ( ) -> sfcgal_geometry_t *

Creates an empty LineString.

◆ sfcgal_linestring_num_points()

SFCGAL_API size_t sfcgal_linestring_num_points ( const sfcgal_geometry_t * linestring )

Returns the number of points of the given LineString.

Precondition: linestring must be a LineString

◆ sfcgal_linestring_point_n()

SFCGAL_API const sfcgal_geometry_t * sfcgal_linestring_point_n	(	const sfcgal_geometry_t *	linestring,
		size_t	i
	)

Returns the ith point of a given LineString.

Parameters

i	is the point index in the LineString

Precondition: linestring must be a LineString; i >= and i < sfcgal_linestring_num_points

Postcondition: the returned Point is not writable and must not be deallocated by the caller

◆ sfcgal_multi_linestring_create()

SFCGAL_API sfcgal_geometry_t * sfcgal_multi_linestring_create ( )

Creates an empty MultiLineString.

◆ sfcgal_multi_point_create()

SFCGAL_API sfcgal_geometry_t * sfcgal_multi_point_create ( ) -> sfcgal_geometry_t *

Creates an empty MultiPoint.

◆ sfcgal_multi_polygon_create()

SFCGAL_API sfcgal_geometry_t * sfcgal_multi_polygon_create ( )

Creates an empty MultiPolygon.

◆ sfcgal_point_create()

SFCGAL_API sfcgal_geometry_t * sfcgal_point_create ( ) -> sfcgal_geometry_t *

Creates an empty point.

◆ sfcgal_point_create_from_xy()

SFCGAL_API sfcgal_geometry_t * sfcgal_point_create_from_xy	(	double	x,
		double	y
	)

Creates a point from two X and Y coordinates.

◆ sfcgal_point_create_from_xym()

SFCGAL_API sfcgal_geometry_t * sfcgal_point_create_from_xym	(	double	x,
		double	y,
		double	m
	)

Creates a point from three X, Y and M coordinates.

◆ sfcgal_point_create_from_xyz()

SFCGAL_API sfcgal_geometry_t * sfcgal_point_create_from_xyz	(	double	x,
		double	y,
		double	z
	)

Creates a point from three X, Y and Z coordinates.

◆ sfcgal_point_create_from_xyzm()

SFCGAL_API sfcgal_geometry_t * sfcgal_point_create_from_xyzm	(	double	x,
		double	y,
		double	z,
		double	m
	)

Creates a point from four X, Y, Z and M coordinates.

◆ sfcgal_point_m()

SFCGAL_API double sfcgal_point_m ( const sfcgal_geometry_t * geom )

Returns the M coordinate of the given Point.

Precondition: the given geometry must be a Point; the given point must not be empty

Postcondition: the M coordinate can value NaN if the given point has no m

◆ sfcgal_point_x()

SFCGAL_API double sfcgal_point_x ( const sfcgal_geometry_t * geom )

Returns the X coordinate of the given Point.

Precondition: the given geometry must be a Point; the given point must not be empty

◆ sfcgal_point_y()

SFCGAL_API double sfcgal_point_y ( const sfcgal_geometry_t * geom )

Returns the Y coordinate of the given Point.

Precondition: the given geometry must be a Point; the given point must not be empty

◆ sfcgal_point_z()

SFCGAL_API double sfcgal_point_z ( const sfcgal_geometry_t * geom )

Returns the Z coordinate of the given Point.

Precondition: the given geometry must be a Point; the given point must not be empty

Postcondition: the Z coordinate can value NaN if the given point is 2D only

◆ sfcgal_polygon_add_interior_ring()

SFCGAL_API void sfcgal_polygon_add_interior_ring	(	sfcgal_geometry_t *	polygon,
		sfcgal_geometry_t *	ring
	)

Adds an interior ring to a given Polygon.

Precondition: polygon must be a Polygon; ring must be a LineString

◆ sfcgal_polygon_create()

SFCGAL_API sfcgal_geometry_t * sfcgal_polygon_create ( ) -> sfcgal_geometry_t *

Creates an empty Polygon.

◆ sfcgal_polygon_create_from_exterior_ring()

SFCGAL_API sfcgal_geometry_t * sfcgal_polygon_create_from_exterior_ring ( sfcgal_geometry_t * ring )

Creates an empty Polygon from an extrior ring.

Precondition: ring must be a LineString

Postcondition: the ownership of the given ring is taken. The caller is not responsible anymore of its deallocation

◆ sfcgal_polygon_exterior_ring()

SFCGAL_API const sfcgal_geometry_t * sfcgal_polygon_exterior_ring ( const sfcgal_geometry_t * polygon )

Returns the exterior ring of a given Polygon.

Precondition: polygon must be a Polygon; polygon must not be empty

Postcondition: the returned ring is a LineString, is not writable and must not be deallocated by the caller

◆ sfcgal_polygon_interior_ring_n()

SFCGAL_API const sfcgal_geometry_t * sfcgal_polygon_interior_ring_n	(	const sfcgal_geometry_t *	polygon,
		size_t	i
	)

Returns the ith interior ring of a given Polygon.

Precondition: polygon must be a Polygon; i >= 0 and i < sfcgal_polygon_num_interior_rings

Postcondition: the returned ring is a LineString, is not writable and must not be deallocated by the caller

◆ sfcgal_polygon_num_interior_rings()

SFCGAL_API size_t sfcgal_polygon_num_interior_rings ( const sfcgal_geometry_t * polygon )

Returns the number of interior rings of a given Polygon.

Precondition: polygon must be a Polygon

◆ sfcgal_polyhedral_surface_add_polygon()

SFCGAL_API void sfcgal_polyhedral_surface_add_polygon	(	sfcgal_geometry_t *	polyhedral,
		sfcgal_geometry_t *	polygon
	)

Adds a Polygon to a given PolyhedralSurface.

Precondition: polyhedral must be a PolyhedralSurface; polygon must be a Polygon

Postcondition: the ownership of the Polygon is taken. The caller is not responsible anymore of its deallocation

◆ sfcgal_polyhedral_surface_create()

SFCGAL_API sfcgal_geometry_t * sfcgal_polyhedral_surface_create ( ) -> sfcgal_geometry_t *

Creates an empty PolyhedralSurface.

◆ sfcgal_polyhedral_surface_num_polygons()

SFCGAL_API size_t sfcgal_polyhedral_surface_num_polygons ( const sfcgal_geometry_t * polyhedral )

Returns the number of polygons of a given PolyhedralSurface.

Precondition: polyhedral must be a PolyhedralSurface

◆ sfcgal_polyhedral_surface_polygon_n()

SFCGAL_API const sfcgal_geometry_t * sfcgal_polyhedral_surface_polygon_n	(	const sfcgal_geometry_t *	polyhedral,
		size_t	i
	)

Returns the ith polygon of a given PolyhedralSurface.

Precondition: polyhedral must be a PolyhedralSurface; i >= 0 and i < sfcgal_polyhedral_surface_num_polygons(polyhedral)

Postcondition: the returned Polygon is not writable and must not be deallocated by the caller

◆ sfcgal_prepared_geometry_as_ewkt()

SFCGAL_API void sfcgal_prepared_geometry_as_ewkt	(	const sfcgal_prepared_geometry_t *	prepared,
		int	num_decimals,
		char **	buffer,
		size_t *	len
	)

Returns an EWKT representation of the given PreparedGeometry.

Parameters

num_decimals number of decimals. -2 for a variable number of decimals. -1 for an exact representation

Postcondition: buffer is returned allocated and must be freed by the caller

◆ sfcgal_prepared_geometry_create()

SFCGAL_API sfcgal_prepared_geometry_t * sfcgal_prepared_geometry_create ( )

Creates an empty PreparedGeometry.

◆ sfcgal_prepared_geometry_create_from_geometry()

SFCGAL_API sfcgal_prepared_geometry_t * sfcgal_prepared_geometry_create_from_geometry	(	sfcgal_geometry_t *	geometry,
		srid_t	srid
	)

Creates a PreparedGeometry from a Geometry and an SRID.

◆ sfcgal_prepared_geometry_delete()

SFCGAL_API void sfcgal_prepared_geometry_delete ( sfcgal_prepared_geometry_t * prepared )

Deletes a given PreparedGeometry.

Precondition: prepared must be a PreparedGeometry

Postcondition: the underlying Geometry linked to the given PreparedGeometry is also deleted

◆ sfcgal_prepared_geometry_geometry()

SFCGAL_API const sfcgal_geometry_t * sfcgal_prepared_geometry_geometry ( const sfcgal_prepared_geometry_t * prepared )

Returns the Geometry associated with a given PreparedGeometry.

Precondition: prepared must be a PreparedGeometry

Postcondition: the returned Geometry is not writable and must not be deallocated by the caller

◆ sfcgal_prepared_geometry_set_geometry()

SFCGAL_API void sfcgal_prepared_geometry_set_geometry	(	sfcgal_prepared_geometry_t *	prepared,
		sfcgal_geometry_t *	geometry
	)

Sets the Geometry associated with the given PreparedGeometry.

Precondition: prepared must be a PreparedGeometry

Postcondition: the ownership of the given geometry is taken. The caller is not responsible anymore of its deallocation

◆ sfcgal_prepared_geometry_set_srid()

SFCGAL_API void sfcgal_prepared_geometry_set_srid	(	sfcgal_prepared_geometry_t *	prepared,
		srid_t	srid
	)

Sets SRID associated with a given PreparedGeometry.

Precondition: prepared must be a PreparedGeometry

◆ sfcgal_prepared_geometry_srid()

SFCGAL_API srid_t sfcgal_prepared_geometry_srid ( const sfcgal_prepared_geometry_t * prepared )

Returns SRID associated with a given PreparedGeometry.

Precondition: prepared must be a PreparedGeometry

◆ sfcgal_set_alloc_handlers()

SFCGAL_API void sfcgal_set_alloc_handlers	(	sfcgal_alloc_handler_t	malloc_handler,
		sfcgal_free_handler_t	free_handler
	)

Sets the error handlers.

These callbacks are called on warning or error

Parameters

malloc_handler	is the function to call for memory allocation. The default behaviour is to call malloc()
free_handler	is the function to call for memory deallocation. The default behaviour is to call free()

◆ sfcgal_set_error_handlers()

SFCGAL_API void sfcgal_set_error_handlers	(	sfcgal_error_handler_t	warning_handler,
		sfcgal_error_handler_t	error_handler
	)

Sets the error handlers.

These callbacks are called on warning or error

Parameters

warning_handler	is the printf-styled callback function that will be called when a function raises a warning. The default behaviour is to call printf.
error_handler	is the printf-style callback function that will be called when a function generates an error. The default behaviour is to call printf.

◆ sfcgal_set_geometry_validation()

SFCGAL_API void sfcgal_set_geometry_validation ( int enabled )

Set the geometry validation mode.

Note: obsolete

◆ sfcgal_solid_add_interior_shell()

SFCGAL_API void sfcgal_solid_add_interior_shell	(	sfcgal_geometry_t *	solid,
		sfcgal_geometry_t *	shell
	)

Adds a shell to a given Solid.

Precondition: solid must be a Solid; shell must be a PolyhedralSurface

Postcondition: the ownership of the shell is taken. The caller is not responsible anymore of its deallocation

◆ sfcgal_solid_create()

SFCGAL_API sfcgal_geometry_t * sfcgal_solid_create ( ) -> sfcgal_geometry_t *

Creates an empty Solid.

◆ sfcgal_solid_create_from_exterior_shell()

SFCGAL_API sfcgal_geometry_t * sfcgal_solid_create_from_exterior_shell ( sfcgal_geometry_t * shell )

Creates a Solid from an exterior shell.

Precondition: ring must be a PolyhedralSurface

Postcondition: the ownership of the given shell is taken. The caller is not responsible anymore of its deallocation

◆ sfcgal_solid_num_shells()

SFCGAL_API size_t sfcgal_solid_num_shells ( const sfcgal_geometry_t * solid )

Returns the number of shells of a given Solid.

Precondition: solid must be a Solid

◆ sfcgal_solid_shell_n()

SFCGAL_API const sfcgal_geometry_t * sfcgal_solid_shell_n	(	const sfcgal_geometry_t *	solid,
		size_t	i
	)

Returns the ith shell of a given Solid.

Precondition: solid must be a Solid; i >= 0 and i < sfcgal_solid_num_shells( tin )

Postcondition: the returned PolyhedralSurface is not writable and must not be deallocated by the caller

◆ sfcgal_triangle_create()

SFCGAL_API sfcgal_geometry_t * sfcgal_triangle_create ( ) -> sfcgal_geometry_t *

Creates an empty Triangle.

◆ sfcgal_triangle_create_from_points()

SFCGAL_API sfcgal_geometry_t * sfcgal_triangle_create_from_points	(	const sfcgal_geometry_t *	pta,
		const sfcgal_geometry_t *	ptb,
		const sfcgal_geometry_t *	ptc
	)

Creates a Triangle from three given Point.

Precondition: pta must be a Triangle; ptb must be a Triangle; ptc must be a Triangle

Postcondition: the ownership of the three points are not taken. The caller is still responsible of their deallocation

◆ sfcgal_triangle_set_vertex()

SFCGAL_API void sfcgal_triangle_set_vertex	(	sfcgal_geometry_t *	triangle,
		int	i,
		const sfcgal_geometry_t *	vertex
	)

Sets one vertex of a Triangle.

Precondition: triangle must be a Triangle; vertex must be a Point

Postcondition: returns a pointer to one of the vertices as a Point. This pointer is not writable and must not be deallocated by the caller

◆ sfcgal_triangle_set_vertex_from_xy()

SFCGAL_API void sfcgal_triangle_set_vertex_from_xy	(	sfcgal_geometry_t *	triangle,
		int	i,
		double	x,
		double	y
	)

Sets one vertex of a Triangle from two coordinates.

Precondition: triangle must be a Triangle; i >= 0 and i < 3

◆ sfcgal_triangle_set_vertex_from_xyz()

SFCGAL_API void sfcgal_triangle_set_vertex_from_xyz	(	sfcgal_geometry_t *	triangle,
		int	i,
		double	x,
		double	y,
		double	z
	)

Sets one vertex of a Triangle from three coordinates.

Precondition: triangle must be a Triangle; i >= 0 and i < 3

◆ sfcgal_triangle_vertex()

SFCGAL_API const sfcgal_geometry_t * sfcgal_triangle_vertex	(	const sfcgal_geometry_t *	triangle,
		int	i
	)

Returns one the Triangle's vertex as a Point.

Precondition: triangle must be a Triangle; i >= 0 and i < 3

Postcondition: returns a pointer to one of the vertices as a Point. This pointer is not writable and must not be deallocated by the caller

◆ sfcgal_triangulated_surface_add_triangle()

SFCGAL_API void sfcgal_triangulated_surface_add_triangle	(	sfcgal_geometry_t *	tin,
		sfcgal_geometry_t *	triangle
	)

Adds a Triangle to a given TriangulatedSurface.

Precondition: tin must be a TriangulatedSurface; triangle must be a Triangle

Postcondition: the ownership of the Triangle is taken. The caller is not responsible anymore of its deallocation

◆ sfcgal_triangulated_surface_create()

SFCGAL_API sfcgal_geometry_t * sfcgal_triangulated_surface_create ( ) -> sfcgal_geometry_t *

Creates an empty TriangulatedSurface.

◆ sfcgal_triangulated_surface_num_triangles()

SFCGAL_API size_t sfcgal_triangulated_surface_num_triangles ( const sfcgal_geometry_t * tin )

Returns the number of triangles of a given TriangulatedSurface.

Precondition: tin must be a TriangulatedSurface

◆ sfcgal_triangulated_surface_triangle_n()

SFCGAL_API const sfcgal_geometry_t * sfcgal_triangulated_surface_triangle_n	(	const sfcgal_geometry_t *	tin,
		size_t	i
	)

Returns the ith Triangle of a given TriangulatedSurface.

Precondition: tin must be a TriangulatedSurface; i >= 0 and i < sfcgal_triangulated_surface_num_triangles( tin )

Postcondition: the returned Triangle is not writable and must not be deallocated by the caller

◆ sfcgal_version()

SFCGAL_API const char * sfcgal_version ( )

Get version.

Typedefs

Enumerations

Functions

Detailed Description

Typedef Documentation

◆ sfcgal_error_handler_t

◆ sfcgal_geometry_t

◆ sfcgal_prepared_geometry_t

Enumeration Type Documentation

◆ sfcgal_geometry_type_t

Function Documentation

◆ sfcgal_full_version()

◆ sfcgal_geometry_alpha_shapes()

◆ sfcgal_geometry_approximate_medial_axis()

◆ sfcgal_geometry_area()

◆ sfcgal_geometry_area_3d()

◆ sfcgal_geometry_as_text()

◆ sfcgal_geometry_as_text_decim()

◆ sfcgal_geometry_clone()

◆ sfcgal_geometry_collection_add_geometry()

◆ sfcgal_geometry_collection_create()

◆ sfcgal_geometry_collection_geometry_n()

◆ sfcgal_geometry_collection_num_geometries()

◆ sfcgal_geometry_convexhull()

◆ sfcgal_geometry_convexhull_3d()

◆ sfcgal_geometry_covers()

◆ sfcgal_geometry_covers_3d()

◆ sfcgal_geometry_delete()

◆ sfcgal_geometry_difference()

◆ sfcgal_geometry_difference_3d()

◆ sfcgal_geometry_distance()

◆ sfcgal_geometry_distance_3d()

◆ sfcgal_geometry_extrude()

◆ sfcgal_geometry_force_lhr()

◆ sfcgal_geometry_force_rhr()

◆ sfcgal_geometry_intersection()

◆ sfcgal_geometry_intersection_3d()

◆ sfcgal_geometry_intersects()

◆ sfcgal_geometry_intersects_3d()

◆ sfcgal_geometry_is_3d()

◆ sfcgal_geometry_is_empty()

◆ sfcgal_geometry_is_measured()

◆ sfcgal_geometry_is_planar()

◆ sfcgal_geometry_is_valid()

◆ sfcgal_geometry_is_valid_detail()

◆ sfcgal_geometry_line_sub_string()

◆ sfcgal_geometry_minkowski_sum()

◆ sfcgal_geometry_offset_polygon()

◆ sfcgal_geometry_optimal_alpha_shapes()

◆ sfcgal_geometry_orientation()

◆ sfcgal_geometry_round()

◆ sfcgal_geometry_straight_skeleton()

◆ sfcgal_geometry_straight_skeleton_distance_in_m()

◆ sfcgal_geometry_tesselate()

◆ sfcgal_geometry_triangulate_2dz()

◆ sfcgal_geometry_type_id()

◆ sfcgal_geometry_union()

◆ sfcgal_geometry_union_3d()

◆ sfcgal_geometry_volume()

◆ sfcgal_init()

◆ sfcgal_linestring_add_point()

◆ sfcgal_linestring_create()

◆ sfcgal_linestring_num_points()

◆ sfcgal_linestring_point_n()

◆ sfcgal_multi_linestring_create()

◆ sfcgal_multi_point_create()

◆ sfcgal_multi_polygon_create()

◆ sfcgal_point_create()

◆ sfcgal_point_create_from_xy()

◆ sfcgal_point_create_from_xym()

◆ sfcgal_point_create_from_xyz()

◆ sfcgal_point_create_from_xyzm()

◆ sfcgal_point_m()

◆ sfcgal_point_x()

◆ sfcgal_point_y()

◆ sfcgal_point_z()

◆ sfcgal_polygon_add_interior_ring()

◆ sfcgal_polygon_create()

◆ sfcgal_polygon_create_from_exterior_ring()

◆ sfcgal_polygon_exterior_ring()