Geometry handling functions: DXF files. More...

Data Structures
struct	gaia_dxf_extra_attr
	wrapper for DXF Extra Attribute object More...
struct	gaia_dxf_insert
	wrapper for DXF Insert object More...
struct	gaia_dxf_text
	wrapper for DXF Text object More...
struct	gaia_dxf_point
	wrapper for DXF Point object More...
struct	gaia_dxf_circle
	wrapper for DXF Circle object More...
struct	gaia_dxf_arc
	wrapper for DXF Arc object More...
struct	gaia_dxf_hole
	wrapper for DXF Polygon interior hole object More...
struct	gaia_dxf_polyline
	wrapper for DXF Polyline object could be a Linestring or a Polygon depending on the is_closed flag More...
struct	gaia_dxf_hatch_segm
	wrapper for DXF Pattern Segment object More...
struct	gaia_dxf_boundary_path
	wrapper for DXF Boundary Path object More...
struct	gaia_dxf_hatch
	wrapper for DXF Pattern Hatch object More...
struct	gaia_dxf_block
	wrapper for DXF Block object More...
struct	gaia_dxf_layer
	wrapper for DXF Layer object More...
struct	gaia_dxf_parser
	wrapper for DXF Parser object More...
struct	gaia_dxf_write
	wrapper for DXF Write object More...
Defines
#define	GAIA_DXF_IMPORT_BY_LAYER 1
	import distinct layers
#define	GAIA_DXF_IMPORT_MIXED 2
	import layers mixed altogether by type
#define	GAIA_DXF_AUTO_2D_3D 3
	auto-selects 2D or 3D
#define	GAIA_DXF_FORCE_2D 4
	always force 2D
#define	GAIA_DXF_FORCE_3D 5
	always force 3D
#define	GAIA_DXF_RING_NONE 6
	don't apply any special Ring handling
#define	GAIA_DXF_RING_LINKED 7
	apply special "linked rings" handling
#define	GAIA_DXF_RING_UNLINKED 8
	apply special "unlinked rings" handling
#define	GAIA_DXF_V12 1000
	DXF version [Writer].
Typedefs
typedef struct gaia_dxf_extra_attr	gaiaDxfExtraAttr
	wrapper for DXF Extra Attribute object
typedef gaiaDxfExtraAttr *	gaiaDxfExtraAttrPtr
	Typedef for DXF Extra Attribute object.
typedef struct gaia_dxf_insert	gaiaDxfInsert
	wrapper for DXF Insert object
typedef gaiaDxfInsert *	gaiaDxfInsertPtr
	Typedef for DXF Insert object.
typedef struct gaia_dxf_text	gaiaDxfText
	wrapper for DXF Text object
typedef gaiaDxfText *	gaiaDxfTextPtr
	Typedef for DXF Text object.
typedef struct gaia_dxf_point	gaiaDxfPoint
	wrapper for DXF Point object
typedef gaiaDxfPoint *	gaiaDxfPointPtr
	Typedef for DXF Point object.
typedef struct gaia_dxf_circle	gaiaDxfCircle
	wrapper for DXF Circle object
typedef gaiaDxfCircle *	gaiaDxfCirclePtr
	Typedef for DXF Circle object.
typedef struct gaia_dxf_arc	gaiaDxfArc
	wrapper for DXF Arc object
typedef gaiaDxfArc *	gaiaDxfArcPtr
	Typedef for DXF Arc object.
typedef struct gaia_dxf_hole	gaiaDxfHole
	wrapper for DXF Polygon interior hole object
typedef gaiaDxfHole *	gaiaDxfHolePtr
	Typedef for DXF Point object.
typedef struct gaia_dxf_polyline	gaiaDxfPolyline
	wrapper for DXF Polyline object could be a Linestring or a Polygon depending on the is_closed flag
typedef gaiaDxfPolyline *	gaiaDxfPolylinePtr
	Typedef for DXF Polyline object.
typedef struct gaia_dxf_hatch_segm	gaiaDxfHatchSegm
	wrapper for DXF Pattern Segment object
typedef gaiaDxfHatchSegm *	gaiaDxfHatchSegmPtr
	Typedef for DXF Hatch Segment object.
typedef struct gaia_dxf_boundary_path	gaiaDxfBoundaryPath
	wrapper for DXF Boundary Path object
typedef gaiaDxfBoundaryPath *	gaiaDxfBoundaryPathPtr
	Typedef for DXF Boundary Path object.
typedef struct gaia_dxf_hatch	gaiaDxfHatch
	wrapper for DXF Pattern Hatch object
typedef gaiaDxfHatch *	gaiaDxfHatchPtr
	Typedef for DXF Hatch object.
typedef struct gaia_dxf_block	gaiaDxfBlock
	wrapper for DXF Block object
typedef gaiaDxfBlock *	gaiaDxfBlockPtr
	Typedef for DXF Block object.
typedef struct gaia_dxf_layer	gaiaDxfLayer
	wrapper for DXF Layer object
typedef gaiaDxfLayer *	gaiaDxfLayerPtr
	Typedef for DXF Layer object.
typedef struct gaia_dxf_parser	gaiaDxfParser
	wrapper for DXF Parser object
typedef gaiaDxfParser *	gaiaDxfParserPtr
	Typedef for DXF Layer object.
typedef struct gaia_dxf_write	gaiaDxfWriter
	wrapper for DXF Write object
typedef gaiaDxfWriter *	gaiaDxfWriterPtr
	Typedef for DXF Writer object.
Functions
GAIAGEO_DECLARE gaiaDxfParserPtr	gaiaCreateDxfParser (int srid, int force_dims, const char prefix, const char selected_layer, int special_rings)
	Creates a DXF Parser object.
GAIAGEO_DECLARE void	gaiaDestroyDxfParser (gaiaDxfParserPtr parser)
	Destroying a DXF Parser object.
GAIAGEO_DECLARE int	gaiaParseDxfFile (gaiaDxfParserPtr parser, const char *dxf_path)
	Parsing a DXF file.
GAIAGEO_DECLARE int	gaiaParseDxfFile_r (const void p_cache, gaiaDxfParserPtr parser, const char dxf_path)
	Parsing a DXF file.
GAIAGEO_DECLARE int	gaiaLoadFromDxfParser (sqlite3 *db_handle, gaiaDxfParserPtr parser, int mode, int append)
	Populating a DB so to permanently store all Geometries from a DXF Parser.
GAIAGEO_DECLARE int	gaiaDxfWriterInit (gaiaDxfWriterPtr dxf, FILE *out, int precision, int version)
	Initializing a DXF Writer Object.
GAIAGEO_DECLARE int	gaiaDxfWriteHeader (gaiaDxfWriterPtr dxf, double minx, double miny, double minz, double maxx, double maxy, double maxz)
	Writing the DXF Header.
GAIAGEO_DECLARE int	gaiaDxfWriteFooter (gaiaDxfWriterPtr dxf)
	Writing a DXF Entities Section Header.
GAIAGEO_DECLARE int	gaiaDxfWriteTables (gaiaDxfWriterPtr dxf)
	Writing the DXF Tables Section Header.
GAIAGEO_DECLARE int	gaiaDxfWriteLayer (gaiaDxfWriterPtr dxf, const char *layer_name)
	Writing a DXF Table/Layer definition.
GAIAGEO_DECLARE int	gaiaDxfWriteEntities (gaiaDxfWriterPtr dxf)
	Writing a DXF Entities Section Header.
GAIAGEO_DECLARE int	gaiaDxfWriteEndSection (gaiaDxfWriterPtr dxf)
	Writing a DXF Entities Section Header.
GAIAGEO_DECLARE int	gaiaDxfWritePoint (gaiaDxfWriterPtr dxf, const char *layer_name, double x, double y, double z)
	Writing a DXF Point Entity.
GAIAGEO_DECLARE int	gaiaDxfWriteText (gaiaDxfWriterPtr dxf, const char layer_name, double x, double y, double z, const char label, double text_height, double angle)
	Writing a DXF Text Entity.
GAIAGEO_DECLARE int	gaiaDxfWriteLine (gaiaDxfWriterPtr dxf, const char *layer_name, gaiaLinestringPtr line)
	Writing a DXF Polyline (opened) Entity.
GAIAGEO_DECLARE int	gaiaDxfWriteRing (gaiaDxfWriterPtr dxf, const char *layer_name, gaiaRingPtr ring)
	Writing a DXF Polyline (closed) Entity.
GAIAGEO_DECLARE int	gaiaDxfWriteGeometry (gaiaDxfWriterPtr dxf, const char layer_name, const char label, double text_height, double text_rotation, gaiaGeomCollPtr geometry)
	Writing a DXF generic Entity.
GAIAGEO_DECLARE int	gaiaExportDxf (gaiaDxfWriterPtr dxf, sqlite3 db_handle, const char sql, const char layer_col_name, const char geom_col_name, const char label_col_name, const char text_height_col_name, const char *text_rotation_col_name, gaiaGeomCollPtr geom_filter)
	Exporting a complex DXF file.

Detailed Description

Geometry handling functions: DXF files.

Typedef Documentation

typedef gaiaDxfArc* gaiaDxfArcPtr

Typedef for DXF Arc object.

See also:: gaiaDxfArc

typedef gaiaDxfBlock* gaiaDxfBlockPtr

Typedef for DXF Block object.

See also:: gaiaDxfBlock

typedef gaiaDxfBoundaryPath* gaiaDxfBoundaryPathPtr

Typedef for DXF Boundary Path object.

See also:: gaiaDxfBoundaryPath

typedef gaiaDxfCircle* gaiaDxfCirclePtr

Typedef for DXF Circle object.

See also:: gaiaDxfCircle

typedef gaiaDxfExtraAttr* gaiaDxfExtraAttrPtr

Typedef for DXF Extra Attribute object.

See also:: gaiaDxfExtraAttr

typedef gaiaDxfHatch* gaiaDxfHatchPtr

Typedef for DXF Hatch object.

See also:: gaiaDxfHatch

typedef gaiaDxfHatchSegm* gaiaDxfHatchSegmPtr

Typedef for DXF Hatch Segment object.

See also:: gaiaDxfHatch

typedef gaiaDxfHole* gaiaDxfHolePtr

Typedef for DXF Point object.

See also:: gaiaDxfHole

typedef gaiaDxfInsert* gaiaDxfInsertPtr

Typedef for DXF Insert object.

See also:: gaiaDxfText

typedef gaiaDxfLayer* gaiaDxfLayerPtr

Typedef for DXF Layer object.

See also:: gaiaDxfLayer

typedef gaiaDxfParser* gaiaDxfParserPtr

Typedef for DXF Layer object.

See also:: gaiaDxfParser

typedef gaiaDxfPoint* gaiaDxfPointPtr

Typedef for DXF Point object.

See also:: gaiaDxfPoint

typedef gaiaDxfPolyline* gaiaDxfPolylinePtr

Typedef for DXF Polyline object.

See also:: gaiaDxfPolyline

typedef gaiaDxfText* gaiaDxfTextPtr

Typedef for DXF Text object.

See also:: gaiaDxfText

Function Documentation

GAIAGEO_DECLARE gaiaDxfParserPtr gaiaCreateDxfParser	(	int	srid,
		int	force_dims,
		const char *	prefix,
		const char *	selected_layer,
		int	special_rings
	)

Creates a DXF Parser object.

Parameters:

srid	the SRID value to be used for all Geometries
force_dims	should be one of GAIA_DXF_AUTO_2D_3D, GAIA_DXF_FORCE_2D or GAIA_DXF_FORCE_3D
prefix	an optional prefix to be used for DB target tables (could be NULL)
selected_layers	if set, only the DXF Layer of corresponding name will be imported (could be NULL)
special_rings	rings handling: should be one of GAIA_DXF_RING_NONE, GAIA_DXF_RING_LINKED of GAIA_DXF_RING_UNLINKED

Returns:: the pointer to a DXF Parser object

See also:: gaiaDestroyDxfParser, gaiaParseDxfFile, gaiaLoadFromDxfParser

Note:: the DXF Parser object corresponds to dynamically allocated memory: so you are responsible to destroy this object before or later by invoking gaiaDestroyDxfParser().

GAIAGEO_DECLARE void gaiaDestroyDxfParser ( gaiaDxfParserPtr parser )

Destroying a DXF Parser object.

Parameters:

parser pointer to DXF Parser object

See also:: gaiaCreateDxfParser

Note:: the pointer to the DXF Parser object to be finalized is expected to be the one returned by a previous call to gaiaCreateDxfParser.

GAIAGEO_DECLARE int gaiaDxfWriteEndSection ( gaiaDxfWriterPtr dxf )

Writing a DXF Entities Section Header.

Parameters:

dxf	pointer to a properly initialized gaiaDxfWriter object

Returns:: 0 on failure, any other value on success

See also:: gaiaDxfWriteTables, gaiaDxfWriteEntities

GAIAGEO_DECLARE int gaiaDxfWriteEntities ( gaiaDxfWriterPtr dxf )

Writing a DXF Entities Section Header.

Parameters:

dxf	pointer to a properly initialized gaiaDxfWriter object

Returns:: 0 on failure, any other value on success

See also:: gaiaDxfWriteHeader, gaiaDxfWriteEndSection, gaiaDxfWritePoint, gaiaDxfWriteText, gaiaDxfWriteLine, gaiaDxfWriteRing, gaiaDxfWriteGeometry

GAIAGEO_DECLARE int gaiaDxfWriteFooter ( gaiaDxfWriterPtr dxf )

Writing a DXF Entities Section Header.

Parameters:

dxf	pointer to a properly initialized gaiaDxfWriter object

Returns:: 0 on failure, any other value on success

See also:: gaiaDxfWriteHeader

GAIAGEO_DECLARE int gaiaDxfWriteGeometry	(	gaiaDxfWriterPtr	dxf,
		const char *	layer_name,
		const char *	label,
		double	text_height,
		double	text_rotation,
		gaiaGeomCollPtr	geometry
	)

Writing a DXF generic Entity.

Parameters:

dxf	pointer to a properly initialized gaiaDxfWriter object
layer_name	name of the corresponding layer
line	pointer to the internal Ring to be exported into the DXF
label	text string containing the label value (could be NULL)
text_height	only for Text Labels: ingnored in any other case.
text_rotation	only for Text Labels: ingnored in any other case.

Returns:: 0 on failure, any other value on success

See also:: gaiaDxfWriteEntities, gaiaDxfWriteEndSection, gaiaDxfWritePoint, gaiaDxfWriteText, gaiaDxfWriteLine, gaiaDxfWriteRing

GAIAGEO_DECLARE int gaiaDxfWriteHeader	(	gaiaDxfWriterPtr	dxf,
		double	minx,
		double	miny,
		double	minz,
		double	maxx,
		double	maxy,
		double	maxz
	)

Writing the DXF Header.

Parameters:

dxf	pointer to a properly initialized gaiaDxfWriter object
minx	the minimum X coordinate contained within the DXF
minx	the minimum Y coordinate contained within the DXF
minx	the minimum Z coordinate contained within the DXF
minx	the maximum X coordinate contained within the DXF
minx	the maximum Y coordinate contained within the DXF
minx	the maximum Z coordinate contained within the DXF

Returns:: 0 on failure, any other value on success

See also:: gaiaDxfWriterInit, gaiaDxfWriteFooter, gaiaDxfWriteTables, gaiaDxfWriteEntities

GAIAGEO_DECLARE int gaiaDxfWriteLayer	(	gaiaDxfWriterPtr	dxf,
		const char *	layer_name
	)

Writing a DXF Table/Layer definition.

Parameters:

dxf	pointer to a properly initialized gaiaDxfWriter object
layer_name	name of the layer

Returns:: 0 on failure, any other value on success

See also:: gaiaDxfWriteTables, gaiaDxfWriteEndSection

GAIAGEO_DECLARE int gaiaDxfWriteLine	(	gaiaDxfWriterPtr	dxf,
		const char *	layer_name,
		gaiaLinestringPtr	line
	)

Writing a DXF Polyline (opened) Entity.

Parameters:

dxf	pointer to a properly initialized gaiaDxfWriter object
layer_name	name of the corresponding layer
line	pointer to the internal Linestring to be exported into the DXF

Returns:: 0 on failure, any other value on success

See also:: gaiaDxfWriteEntities, gaiaDxfWriteEndSection, gaiaDxfWritePoint, gaiaDxfWriteText, gaiaDxfWriteRing, gaiaDxfWriteGeometry

GAIAGEO_DECLARE int gaiaDxfWritePoint	(	gaiaDxfWriterPtr	dxf,
		const char *	layer_name,
		double	x,
		double	y,
		double	z
	)

Writing a DXF Point Entity.

Parameters:

dxf	pointer to a properly initialized gaiaDxfWriter object
layer_name	name of the corresponding layer
x	X coordinate value
y	Y coordinate value
z	Z coordinate value

Returns:: 0 on failure, any other value on success

See also:: gaiaDxfWriteEntities, gaiaDxfWriteEndSection, gaiaDxfWriteText, gaiaDxfWriteLine, gaiaDxfWriteRing, gaiaDxfWriteGeometry

GAIAGEO_DECLARE int gaiaDxfWriteRing	(	gaiaDxfWriterPtr	dxf,
		const char *	layer_name,
		gaiaRingPtr	ring
	)

Writing a DXF Polyline (closed) Entity.

Parameters:

dxf	pointer to a properly initialized gaiaDxfWriter object
layer_name	name of the corresponding layer
line	pointer to the internal Ring to be exported into the DXF

Returns:: 0 on failure, any other value on success

See also:: gaiaDxfWriteEntities, gaiaDxfWriteEndSection, gaiaDxfWritePoint, gaiaDxfWriteText, gaiaDxfWriteLine, gaiaDxfWriteGeometry

GAIAGEO_DECLARE int gaiaDxfWriterInit	(	gaiaDxfWriterPtr	dxf,
		FILE *	out,
		int	precision,
		int	version
	)

Initializing a DXF Writer Object.

Parameters:

writer	pointer to the gaiaDxfWriter object to be initialized
out	file handle to DXF output file
precision	number of decimal digits for any coordinate
version	currently always expected to be GAIA_DXF_V12

Returns:: 0 on failure, any other value on success

See also:: gaiaDxfWriteHeader, gaiaExportDxf

GAIAGEO_DECLARE int gaiaDxfWriteTables ( gaiaDxfWriterPtr dxf )

Writing the DXF Tables Section Header.

Parameters:

dxf	pointer to a properly initialized gaiaDxfWriter object

Returns:: 0 on failure, any other value on success

See also:: gaiaDxfWriteHeader, gaiaDxfWriteEndSection

GAIAGEO_DECLARE int gaiaDxfWriteText	(	gaiaDxfWriterPtr	dxf,
		const char *	layer_name,
		double	x,
		double	y,
		double	z,
		const char *	label,
		double	text_height,
		double	angle
	)

Writing a DXF Text Entity.

Parameters:

dxf	pointer to a properly initialized gaiaDxfWriter object
layer_name	name of the corresponding layer
x	X coordinate value
y	Y coordinate value
z	Z coordinate value
label	text string containing the label value
text_height	height of the text in map units
angle	text rotation angle

Returns:: 0 on failure, any other value on success

See also:: gaiaDxfWriteEntities, gaiaDxfWriteEndSection, gaiaDxfWritePoint, gaiaDxfWriteLine, gaiaDxfWriteRing, gaiaDxfWriteGeometry

GAIAGEO_DECLARE int gaiaExportDxf	(	gaiaDxfWriterPtr	dxf,
		sqlite3 *	db_handle,
		const char *	sql,
		const char *	layer_col_name,
		const char *	geom_col_name,
		const char *	label_col_name,
		const char *	text_height_col_name,
		const char *	text_rotation_col_name,
		gaiaGeomCollPtr	geom_filter
	)

Exporting a complex DXF file.

Parameters:

dxf	pointer to a properly initialized gaiaDxfWriter object
db_hanlde	handle to the current DB connection
sql	a text string defining the SQL query to be used for extracting all geometries/entities to be exported into the output DXF
layer_col_name	name of the SQL resultset column containing the Layer name
geom_col_name	name of the SQL resultset column containing Geometries
label_col_name	name of the SQL resultset column containing Label values (could be NULL)
text_height_col_name	name of the SQL resultset column containing Text Height values (could be NULL)
text_rotation_col_name	name of the SQL resultset column containing Text Rotation values (could be NULL)
geom_filter	an optional arbitrary Geometry to be used as a Spatial Filter (could be NULL)

Returns:: 0 on failure; the total count of exported entities on success

See also:: gaiaDxfWriterInit

GAIAGEO_DECLARE int gaiaLoadFromDxfParser	(	sqlite3 *	db_handle,
		gaiaDxfParserPtr	parser,
		int	mode,
		int	append
	)

Populating a DB so to permanently store all Geometries from a DXF Parser.

Parameters:

db_handle	handle to a valid DB connection
parser	pointer to DXF Parser object
mode	should be one of GAIA_DXF_IMPORT_BY_LAYER or GAIA_DXF_IMPORT_MIXED
append	boolean flag: if set and some required DB table already exists will attempt to append further rows into the existing table. otherwise an error will be returned.

Returns:: 0 on failure, any other value on success

See also:: gaiaCreateDxfParser, gaiaDestroyDxfParser, gaiaParseDxfFile

Note:: the pointer to the DXF Parser object is expected to be the one returned by a previous call to gaiaCreateDxfParser and previously used for a succesfull call to gaiaParseDxfFile

GAIAGEO_DECLARE int gaiaParseDxfFile	(	gaiaDxfParserPtr	parser,
		const char *	dxf_path
	)

Parsing a DXF file.

Parameters:

parser	pointer to DXF Parser object
dxf_path	pathname of the DXF external file to be parsed

Returns:: 0 on failure, any other value on success

See also:: gaiaParseDxfFile_r, gaiaCreateDxfParser, gaiaDestroyDxfParser, gaiaLoadFromDxfParser

Note:: the pointer to the DXF Parser object is expected to be the one returned by a previous call to gaiaCreateDxfParser. A DXF Parser object can be used only a single time to parse a DXF file.
not reentrant and thread unsafe.

GAIAGEO_DECLARE int gaiaParseDxfFile_r	(	const void *	p_cache,
		gaiaDxfParserPtr	parser,
		const char *	dxf_path
	)

Parsing a DXF file.

Parameters:

p_cache	a memory pointer returned by spatialite_alloc_connection()
parser	pointer to DXF Parser object
dxf_path	pathname of the DXF external file to be parsed

Returns:: 0 on failure, any other value on success

See also:: gaiaParseDxfFile, gaiaCreateDxfParser, gaiaDestroyDxfParser, gaiaLoadFromDxfParser

Note:: the pointer to the DXF Parser object is expected to be the one returned by a previous call to gaiaCreateDxfParser. A DXF Parser object can be used only a single time to parse a DXF file.
reentrant and thread-safe.

src/headers/spatialite/gg_dxf.h File Reference

Data Structures

Defines

Typedefs

Functions

Detailed Description

Typedef Documentation

Function Documentation