#include <qgsdxfexport.h>

Classes
struct	DxfLayer
	Layers and optional attribute index to split into multiple layers using attribute value as layer name. More...

Public Types
enum	Flag { FlagNoMText = 1 << 1 }
	Export flags. More...

enum	SymbologyExport { NoSymbology = 0, FeatureSymbology, SymbolLayerSymbology }

Public Member Functions
	QgsDxfExport ()=default
	Constructor for QgsDxfExport. More...

	QgsDxfExport (const QgsDxfExport &dxfExport)

void	addLayers (const QList< QgsDxfExport::DxfLayer > &layers)
	Add layers to export. More...

void	clipValueToMapUnitScale (double &value, const QgsMapUnitScale &scale, double pixelToMMFactor) const
	Clips value to scale minimum/maximum. More...

QgsCoordinateReferenceSystem	destinationCrs () const
	Returns the destination CRS, or an invalid CRS if no reprojection will be done. More...

void	drawLabel (const QString &layerId, QgsRenderContext &context, pal::LabelPosition *label, const QgsPalLayerSettings &settings)
	Output the label. More...

QgsRectangle	extent () const
	Gets extent of area to export. More...

QgsDxfExport::Flags	flags () const
	Returns the export flags. More...

bool	force2d ()
	Retrieve whether the output should be forced to 2d. More...

QString	layerName (const QString &id, const QgsFeature &f) const
	Gets layer name for feature. More...

QString	layerName (QgsVectorLayer *vl) const
	Gets name for layer respecting the use layer title as layer name mode. More...

bool	layerTitleAsName ()
	Retrieve whether layer title (where set) instead of name shall be use. More...

QgsUnitTypes::DistanceUnit	mapUnits () const
	Retrieve map units. More...

QgsDxfExport &	operator= (const QgsDxfExport &dxfExport)

void	registerDxfLayer (const QString &layerId, QgsFeatureId fid, const QString &layer)
	Register name of layer for feature. More...

void	setDestinationCrs (const QgsCoordinateReferenceSystem &crs)
	Set destination CRS. More...

void	setExtent (const QgsRectangle &r)
	Set extent of area to export. More...

void	setFlags (QgsDxfExport::Flags flags)
	Sets the export flags. More...

void	setForce2d (bool force2d)
	Force 2d output (eg. More...

void	setLayerTitleAsName (bool layerTitleAsName)
	Enable use of title (where set) instead of layer name, when attribute index of corresponding layer index is -1. More...

void	setMapSettings (const QgsMapSettings &settings)
	Set map settings and assign layer name attributes. More...

void	setSymbologyExport (QgsDxfExport::SymbologyExport e)
	Set symbology export mode. More...

void	setSymbologyScale (double scale)
	Set reference scale for output. More...

QgsDxfExport::SymbologyExport	symbologyExport () const
	Gets symbology export mode. More...

double	symbologyScale () const
	Returns the reference scale for output. More...

void	writeCircle (const QString &layer, const QColor &color, const QgsPoint &pt, double radius, const QString &lineStyleName, double width)
	Write circle (as polyline) More...

void	writeDouble (double d)
	Write a floating point value. More...

void	writeFilledCircle (const QString &layer, const QColor &color, const QgsPoint &pt, double radius)
	Write filled circle (as hatch) More...

void	writeGroup (int code, int i)
	Write a tuple of group code and integer value. More...

void	writeGroup (int code, double d)
	Write a group code with a floating point value. More...

void	writeGroup (int code, const QString &s)
	Write a group code with a string value. More...

void	writeGroup (int code, const QgsPoint &p)
	Write a group code with a point. More...

void	writeGroup (const QColor &color, int exactMatch=62, int rgbCode=420, int transparencyCode=440)
	Write a group code with color value. More...

void	writeGroupCode (int code)
	Write a group code. More...

int	writeHandle (int code=5, int handle=0)
	Write a tuple of group code and a handle. More...

void	writeInt (int i)
	Write an integer value. More...

void	writeLine (const QgsPoint &pt1, const QgsPoint &pt2, const QString &layer, const QString &lineStyleName, const QColor &color, double width=-1)
	Write line (as a polyline) More...

void	writeMText (const QString &layer, const QString &text, const QgsPoint &pt, double width, double angle, const QColor &color)
	Write mtext (MTEXT) More...

void	writePoint (const QString &layer, const QColor &color, const QgsPoint &pt)
	Write point. More...

void	writePolygon (const QgsRingSequence &polygon, const QString &layer, const QString &hatchPattern, const QColor &color)
	Draw dxf filled polygon (HATCH) More...

void	writePolygon (const QgsCurvePolygon &polygon, const QString &layer, const QString &hatchPattern, const QColor &color)
	Draw dxf curved filled polygon (HATCH) More...

void	writePolyline (const QgsPointSequence &line, const QString &layer, const QString &lineStyleName, const QColor &color, double width=-1)
	Draw dxf primitives (LWPOLYLINE) More...

void	writePolyline (const QgsCurve &curve, const QString &layer, const QString &lineStyleName, const QColor &color, double width=-1)
	Draw dxf primitives (LWPOLYLINE) More...

void	writeString (const QString &s)
	Write a string value. More...

void	writeText (const QString &layer, const QString &text, const QgsPoint &pt, double size, double angle, const QColor &color)
	Write text (TEXT) More...

int	writeToFile (QIODevice *d, const QString &codec)
	Export to a dxf file in the given encoding. More...

Static Public Member Functions
static int	closestColorMatch (QRgb color)
	Gets DXF palette index of nearest entry for given color. More...

static QString	dxfEncoding (const QString &name)
	Returns DXF encoding for Qt encoding. More...

static QString	dxfLayerName (const QString &name)
	Returns cleaned layer name for use in DXF. More...

static QStringList	encodings ()
	Returns list of available DXF encodings. More...

static double	mapUnitScaleFactor (double scale, QgsUnitTypes::RenderUnit symbolUnits, QgsUnitTypes::DistanceUnit mapUnits, double mapUnitsPerPixel=1.0)
	Returns scale factor for conversion to map units. More...

Detailed Description

Definition at line 55 of file qgsdxfexport.h.

Member Enumeration Documentation

◆ Flag

enum QgsDxfExport::Flag

Export flags.

Enumerator
FlagNoMText	Export text as TEXT elements. If not set, text will be exported as MTEXT elements.

Definition at line 92 of file qgsdxfexport.h.

◆ SymbologyExport

enum QgsDxfExport::SymbologyExport

Enumerator
NoSymbology	Export only data.
FeatureSymbology	Keeps the number of features and export symbology per feature (using the first symbol level)
SymbolLayerSymbology	Exports one feature per symbol layer (considering symbol levels)

Definition at line 84 of file qgsdxfexport.h.

Constructor & Destructor Documentation

◆ QgsDxfExport() [1/2]

QgsDxfExport::QgsDxfExport ( )

default

Constructor for QgsDxfExport.

◆ QgsDxfExport() [2/2]

QgsDxfExport::QgsDxfExport ( const QgsDxfExport & dxfExport )

Definition at line 372 of file qgsdxfexport.cpp.

Member Function Documentation

◆ addLayers()

void QgsDxfExport::addLayers ( const QList< QgsDxfExport::DxfLayer > & layers )

Add layers to export.

Parameters

layers list of layers and corresponding attribute indexes that determine the layer name (-1 for original layer name or title)

See also: setLayerTitleAsName

Definition at line 409 of file qgsdxfexport.cpp.

◆ clipValueToMapUnitScale()

void QgsDxfExport::clipValueToMapUnitScale	(	double &	value,
		const QgsMapUnitScale &	scale,
		double	pixelToMMFactor
	)		const

Clips value to scale minimum/maximum.

Parameters

value	the value to clip
scale	the scale dependent minimum/maximum values
pixelToMMFactor	pixels per mm

Definition at line 4238 of file qgsdxfexport.cpp.

◆ closestColorMatch()

int QgsDxfExport::closestColorMatch ( QRgb color )

static

Gets DXF palette index of nearest entry for given color.

Parameters

color

Definition at line 4169 of file qgsdxfexport.cpp.

◆ destinationCrs()

QgsCoordinateReferenceSystem QgsDxfExport::destinationCrs ( ) const

Returns the destination CRS, or an invalid CRS if no reprojection will be done.

See also: setDestinationCrs()

Since: QGIS 3.0

Definition at line 4788 of file qgsdxfexport.cpp.

◆ drawLabel()

void QgsDxfExport::drawLabel	(	const QString &	layerId,
		QgsRenderContext &	context,
		pal::LabelPosition *	label,
		const QgsPalLayerSettings &	settings
	)

Output the label.

Parameters

layerId	id of the layer
context	render context
label	position of label
settings	label settings

Note: not available in Python bindings

Definition at line 4627 of file qgsdxfexport.cpp.

◆ dxfEncoding()

QString QgsDxfExport::dxfEncoding ( const QString & name )

static

Returns DXF encoding for Qt encoding.

Definition at line 4584 of file qgsdxfexport.cpp.

◆ dxfLayerName()

QString QgsDxfExport::dxfLayerName ( const QString & name )

static

Returns cleaned layer name for use in DXF.

Definition at line 4525 of file qgsdxfexport.cpp.

◆ encodings()

QStringList QgsDxfExport::encodings ( )

static

Returns list of available DXF encodings.

Definition at line 4605 of file qgsdxfexport.cpp.

◆ extent()

QgsRectangle QgsDxfExport::extent ( ) const

inline

Gets extent of area to export.

Returns: area to export

See also: setExtent

Definition at line 200 of file qgsdxfexport.h.

◆ flags()

QgsDxfExport::Flags QgsDxfExport::flags ( ) const

Returns the export flags.

See also: setFlags()

Since: QGIS 3.0

Definition at line 404 of file qgsdxfexport.cpp.

◆ force2d()

bool QgsDxfExport::force2d ( )

inline

Retrieve whether the output should be forced to 2d.

Returns: flag

See also: setForce2d

Definition at line 229 of file qgsdxfexport.h.

◆ layerName() [1/2]

QString QgsDxfExport::layerName	(	const QString &	id,
		const QgsFeature &	f
	)		const

Gets layer name for feature.

Parameters

id	layer id of layer
f	feature of layer

Returns: layer name for feature

Definition at line 4568 of file qgsdxfexport.cpp.

◆ layerName() [2/2]

QString QgsDxfExport::layerName ( QgsVectorLayer * vl ) const

Gets name for layer respecting the use layer title as layer name mode.

Parameters

vl	the vector layer

Returns: name of layer

See also: setLayerTitleAsName

Definition at line 4621 of file qgsdxfexport.cpp.

◆ layerTitleAsName()

bool QgsDxfExport::layerTitleAsName ( )

inline

Retrieve whether layer title (where set) instead of name shall be use.

Returns: flag

See also: setLayerTitleAsName

Definition at line 215 of file qgsdxfexport.h.

◆ mapUnits()

QgsUnitTypes::DistanceUnit QgsDxfExport::mapUnits ( ) const

Retrieve map units.

Returns: unit

Definition at line 565 of file qgsdxfexport.cpp.

◆ mapUnitScaleFactor()

double QgsDxfExport::mapUnitScaleFactor	(	double	scale,
		QgsUnitTypes::RenderUnit	symbolUnits,
		QgsUnitTypes::DistanceUnit	mapUnits,
		double	mapUnitsPerPixel = `1.0`
	)

static

Returns scale factor for conversion to map units.

Parameters

scale	the map scale denominator
symbolUnits	the symbol output units
mapUnits	the map units
mapUnitsPerPixel	Map units per pixel

Definition at line 4221 of file qgsdxfexport.cpp.

◆ operator=()

QgsDxfExport & QgsDxfExport::operator= ( const QgsDxfExport & dxfExport )

Definition at line 377 of file qgsdxfexport.cpp.

◆ registerDxfLayer()

void QgsDxfExport::registerDxfLayer	(	const QString &	layerId,
		QgsFeatureId	fid,
		const QString &	layer
	)

Register name of layer for feature.

Parameters

layerId	id of layer
fid	id of feature
layer	dxf layer of feature

Definition at line 4774 of file qgsdxfexport.cpp.

◆ setDestinationCrs()

void QgsDxfExport::setDestinationCrs ( const QgsCoordinateReferenceSystem & crs )

Set destination CRS.

See also: destinationCrs()

Since: QGIS 3.0

Definition at line 4782 of file qgsdxfexport.cpp.

◆ setExtent()

void QgsDxfExport::setExtent ( const QgsRectangle & r )

inline

Set extent of area to export.

Parameters

r	area to export

Definition at line 193 of file qgsdxfexport.h.

◆ setFlags()

void QgsDxfExport::setFlags ( QgsDxfExport::Flags flags )

Sets the export flags.

See also: flags()

Since: QGIS 3.0

Definition at line 399 of file qgsdxfexport.cpp.

◆ setForce2d()

void QgsDxfExport::setForce2d ( bool force2d )

inline

Force 2d output (eg.

to support linewidth in polylines)

Parameters

force2d flag

See also: force2d

Definition at line 222 of file qgsdxfexport.h.

◆ setLayerTitleAsName()

void QgsDxfExport::setLayerTitleAsName ( bool layerTitleAsName )

inline

Enable use of title (where set) instead of layer name, when attribute index of corresponding layer index is -1.

Parameters

layerTitleAsName flag

See also: addLayers

Definition at line 208 of file qgsdxfexport.h.

◆ setMapSettings()

void QgsDxfExport::setMapSettings ( const QgsMapSettings & settings )

Set map settings and assign layer name attributes.

Parameters

settings map settings to apply

Definition at line 394 of file qgsdxfexport.cpp.

◆ setSymbologyExport()

void QgsDxfExport::setSymbologyExport ( QgsDxfExport::SymbologyExport e )

inline

Set symbology export mode.

Parameters

e the mode

Definition at line 180 of file qgsdxfexport.h.

◆ setSymbologyScale()

void QgsDxfExport::setSymbologyScale ( double scale )

inline

Set reference scale for output.

The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map.

See also: symbologyScale()

Since: QGIS 3.0

Definition at line 146 of file qgsdxfexport.h.

◆ symbologyExport()

QgsDxfExport::SymbologyExport QgsDxfExport::symbologyExport ( ) const

inline

Gets symbology export mode.

Returns: mode

See also: setSymbologyExport

Definition at line 187 of file qgsdxfexport.h.

◆ symbologyScale()

double QgsDxfExport::symbologyScale ( ) const

inline

Returns the reference scale for output.

The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map.

See also: setSymbologyScale()

Since: QGIS 3.0

Definition at line 154 of file qgsdxfexport.h.

◆ writeCircle()

void QgsDxfExport::writeCircle	(	const QString &	layer,
		const QColor &	color,
		const QgsPoint &	pt,
		double	radius,
		const QString &	lineStyleName,
		double	width
	)

Write circle (as polyline)

Note: available in Python bindings as writeCircleV2

Since: QGIS 2.15

Definition at line 3850 of file qgsdxfexport.cpp.

◆ writeDouble()

void QgsDxfExport::writeDouble ( double d )

Write a floating point value.

Parameters

d	floating point value

Definition at line 491 of file qgsdxfexport.cpp.

◆ writeFilledCircle()

void QgsDxfExport::writeFilledCircle	(	const QString &	layer,
		const QColor &	color,
		const QgsPoint &	pt,
		double	radius
	)

Write filled circle (as hatch)

Note: available in Python bindings as writePointV2

Since: QGIS 2.15

Definition at line 3813 of file qgsdxfexport.cpp.

◆ writeGroup() [1/5]

void QgsDxfExport::writeGroup	(	int	code,
		int	i
	)

Write a tuple of group code and integer value.

Parameters

code	group code
i	integer value

Note: available in Python bindings as writeGroupInt

Definition at line 426 of file qgsdxfexport.cpp.

◆ writeGroup() [2/5]

void QgsDxfExport::writeGroup	(	int	code,
		double	d
	)

Write a group code with a floating point value.

Parameters

code	group code
d	floating point value

Note: available in Python bindings as writeGroupDouble

Definition at line 432 of file qgsdxfexport.cpp.

◆ writeGroup() [3/5]

void QgsDxfExport::writeGroup	(	int	code,
		const QString &	s
	)

Write a group code with a string value.

Parameters

code	group code
s	string value

Definition at line 438 of file qgsdxfexport.cpp.

◆ writeGroup() [4/5]

void QgsDxfExport::writeGroup	(	int	code,
		const QgsPoint &	p
	)

Write a group code with a point.

Parameters

code	group code
p	point value

Note: available in Python bindings as writeGroupPointV2

Since: QGIS 2.15

Definition at line 444 of file qgsdxfexport.cpp.

◆ writeGroup() [5/5]

void QgsDxfExport::writeGroup	(	const QColor &	color,
		int	exactMatch = `62`,
		int	rgbCode = `420`,
		int	transparencyCode = `440`
	)

Write a group code with color value.

Parameters

color	color
exactMatch	group code to use if the color has an exact match in the dxf palette
rgbCode	group code to use if the color doesn't have an exact match or has a transparency component
transparencyCode	group code to use for transparency component

Note: available in Python bindings as writeGroupPoint

Definition at line 452 of file qgsdxfexport.cpp.

◆ writeGroupCode()

void QgsDxfExport::writeGroupCode ( int code )

Write a group code.

Parameters

code	group code value

Definition at line 481 of file qgsdxfexport.cpp.

◆ writeHandle()

int QgsDxfExport::writeHandle	(	int	code = `5`,
		int	handle = `0`
	)

Write a tuple of group code and a handle.

Parameters

code	group code to use
handle	handle to use (0 generates a new handle)

Returns: the used handle

Definition at line 614 of file qgsdxfexport.cpp.

◆ writeInt()

void QgsDxfExport::writeInt ( int i )

Write an integer value.

Parameters

i	integer value

Definition at line 486 of file qgsdxfexport.cpp.

◆ writeLine()

void QgsDxfExport::writeLine	(	const QgsPoint &	pt1,
		const QgsPoint &	pt2,
		const QString &	layer,
		const QString &	lineStyleName,
		const QColor &	color,
		double	width = `-1`
	)

Write line (as a polyline)

Since: QGIS 2.15

Definition at line 3797 of file qgsdxfexport.cpp.

◆ writeMText()

void QgsDxfExport::writeMText	(	const QString &	layer,
		const QString &	text,
		const QgsPoint &	pt,
		double	width,
		double	angle,
		const QColor &	color
	)

Write mtext (MTEXT)

Note: available in Python bindings as writeMTextV2

Since: QGIS 2.15

Definition at line 3888 of file qgsdxfexport.cpp.

◆ writePoint()

void QgsDxfExport::writePoint	(	const QString &	layer,
		const QColor &	color,
		const QgsPoint &	pt
	)

Write point.

Note: available in Python bindings as writePointV2

Since: QGIS 2.15

Definition at line 3802 of file qgsdxfexport.cpp.

◆ writePolygon() [1/2]

void QgsDxfExport::writePolygon	(	const QgsRingSequence &	polygon,
		const QString &	layer,
		const QString &	hatchPattern,
		const QColor &	color
	)

Draw dxf filled polygon (HATCH)

Parameters

polygon	polygon
layer	layer name to use
hatchPattern	hatchPattern to use
color	color to use

Note: not available in Python bindings

Since: QGIS 2.15

Definition at line 3697 of file qgsdxfexport.cpp.

◆ writePolygon() [2/2]

void QgsDxfExport::writePolygon	(	const QgsCurvePolygon &	polygon,
		const QString &	layer,
		const QString &	hatchPattern,
		const QColor &	color
	)

Draw dxf curved filled polygon (HATCH)

Parameters

polygon	polygon (including curves)
layer	layer name to use
hatchPattern	hatchPattern to use
color	color to use

Note: not available in Python bindings

Since: QGIS 3.8

Definition at line 3736 of file qgsdxfexport.cpp.

◆ writePolyline() [1/2]

void QgsDxfExport::writePolyline	(	const QgsPointSequence &	line,
		const QString &	layer,
		const QString &	lineStyleName,
		const QColor &	color,
		double	width = `-1`
	)

Draw dxf primitives (LWPOLYLINE)

Parameters

line	polyline
layer	layer name to use
lineStyleName	line type to use
color	color to use
width	line width to use

Note: not available in Python bindings

Since: QGIS 2.15

Definition at line 3481 of file qgsdxfexport.cpp.

◆ writePolyline() [2/2]

void QgsDxfExport::writePolyline	(	const QgsCurve &	curve,
		const QString &	layer,
		const QString &	lineStyleName,
		const QColor &	color,
		double	width = `-1`
	)

Draw dxf primitives (LWPOLYLINE)

Parameters

curve	polyline (including curved)
layer	layer name to use
lineStyleName	line type to use
color	color to use
width	line width to use

Note: not available in Python bindings

Since: QGIS 3.8

Definition at line 3619 of file qgsdxfexport.cpp.

◆ writeString()

void QgsDxfExport::writeString ( const QString & s )

Write a string value.

Parameters

s	string value

Definition at line 499 of file qgsdxfexport.cpp.

◆ writeText()

void QgsDxfExport::writeText	(	const QString &	layer,
		const QString &	text,
		const QgsPoint &	pt,
		double	size,
		double	angle,
		const QColor &	color
	)

Write text (TEXT)

Note: available in Python bindings as writeTextV2

Since: QGIS 2.15

Definition at line 3872 of file qgsdxfexport.cpp.

◆ writeToFile()

int QgsDxfExport::writeToFile	(	QIODevice *	d,
		const QString &	codec
	)

Export to a dxf file in the given encoding.

Parameters

d	device
codec	encoding

Returns: 0 on success, 1 on invalid device, 2 when devices is not writable

Definition at line 504 of file qgsdxfexport.cpp.

The documentation for this class was generated from the following files:

/build/qgis-3.10.0+15buster/src/core/dxf/qgsdxfexport.h
/build/qgis-3.10.0+15buster/src/core/dxf/qgsdxfexport.cpp

Classes

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ Flag

◆ SymbologyExport

Constructor & Destructor Documentation

◆ QgsDxfExport() [1/2]

◆ QgsDxfExport() [2/2]

Member Function Documentation

◆ addLayers()

◆ clipValueToMapUnitScale()

◆ closestColorMatch()

◆ destinationCrs()

◆ drawLabel()

◆ dxfEncoding()

◆ dxfLayerName()

◆ encodings()

◆ extent()

◆ flags()

◆ force2d()

◆ layerName() [1/2]

◆ layerName() [2/2]

◆ layerTitleAsName()

◆ mapUnits()

◆ mapUnitScaleFactor()

◆ operator=()

◆ registerDxfLayer()

◆ setDestinationCrs()

◆ setExtent()

◆ setFlags()

◆ setForce2d()

◆ setLayerTitleAsName()

◆ setMapSettings()

◆ setSymbologyExport()

◆ setSymbologyScale()

◆ symbologyExport()

◆ symbologyScale()

◆ writeCircle()

◆ writeDouble()

◆ writeFilledCircle()

◆ writeGroup() [1/5]

◆ writeGroup() [2/5]

◆ writeGroup() [3/5]

◆ writeGroup() [4/5]

◆ writeGroup() [5/5]

◆ writeGroupCode()

◆ writeHandle()

◆ writeInt()

◆ writeLine()

◆ writeMText()

◆ writePoint()

◆ writePolygon() [1/2]

◆ writePolygon() [2/2]

◆ writePolyline() [1/2]

◆ writePolyline() [2/2]

◆ writeString()

◆ writeText()

◆ writeToFile()