QGIS API Documentation: QgsMeshRendererMeshSettings Class Reference

QGIS API Documentation 3.38.0-Grenoble (exported)

Loading...

Searching...

No Matches

Represents a mesh renderer settings for mesh object. More...

#include <qgsmeshrenderersettings.h>

Public Member Functions
QColor	color () const
	Returns color used for rendering.

bool	isEnabled () const
	Returns whether mesh structure rendering is enabled.

double	lineWidth () const
	Returns line width used for rendering (in millimeters)

Qgis::RenderUnit	lineWidthUnit () const
	Returns units of the width of the mesh frame.

void	readXml (const QDomElement &elem)
	Reads configuration from the given DOM element.

void	setColor (const QColor &color)
	Sets color used for rendering of the mesh.

void	setEnabled (bool enabled)
	Sets whether mesh structure rendering is enabled.

void	setLineWidth (double lineWidth)
	Sets line width used for rendering (in millimeters)

void	setLineWidthUnit (Qgis::RenderUnit lineWidthUnit)
	Sets units of the width of the mesh frame.

QDomElement	writeXml (QDomDocument &doc) const
	Writes configuration to a new DOM element.

Detailed Description

Represents a mesh renderer settings for mesh object.

Note: The API is considered EXPERIMENTAL and can be changed without a notice

Since: QGIS 3.2

Definition at line 40 of file qgsmeshrenderersettings.h.

Member Function Documentation

◆ color()

QColor QgsMeshRendererMeshSettings::color ( ) const

Returns color used for rendering.

Definition at line 42 of file qgsmeshrenderersettings.cpp.

◆ isEnabled()

bool QgsMeshRendererMeshSettings::isEnabled ( ) const

Returns whether mesh structure rendering is enabled.

Definition at line 22 of file qgsmeshrenderersettings.cpp.

◆ lineWidth()

double QgsMeshRendererMeshSettings::lineWidth ( ) const

Returns line width used for rendering (in millimeters)

Definition at line 32 of file qgsmeshrenderersettings.cpp.

◆ lineWidthUnit()

Qgis::RenderUnit QgsMeshRendererMeshSettings::lineWidthUnit ( ) const

Returns units of the width of the mesh frame.

Since: QGIS 3.14

Definition at line 52 of file qgsmeshrenderersettings.cpp.

◆ readXml()

void QgsMeshRendererMeshSettings::readXml ( const QDomElement & elem )

Reads configuration from the given DOM element.

Definition at line 72 of file qgsmeshrenderersettings.cpp.

◆ setColor()

void QgsMeshRendererMeshSettings::setColor ( const QColor & color )

Sets color used for rendering of the mesh.

Definition at line 47 of file qgsmeshrenderersettings.cpp.

◆ setEnabled()

void QgsMeshRendererMeshSettings::setEnabled ( bool enabled )

Sets whether mesh structure rendering is enabled.

Definition at line 27 of file qgsmeshrenderersettings.cpp.

◆ setLineWidth()

void QgsMeshRendererMeshSettings::setLineWidth ( double lineWidth )

Sets line width used for rendering (in millimeters)

Definition at line 37 of file qgsmeshrenderersettings.cpp.

◆ setLineWidthUnit()

void QgsMeshRendererMeshSettings::setLineWidthUnit ( Qgis::RenderUnit lineWidthUnit )

Sets units of the width of the mesh frame.

Since: QGIS 3.14

Definition at line 57 of file qgsmeshrenderersettings.cpp.

◆ writeXml()

QDomElement QgsMeshRendererMeshSettings::writeXml ( QDomDocument & doc ) const

Writes configuration to a new DOM element.

Definition at line 62 of file qgsmeshrenderersettings.cpp.

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

/home/fischer/src/qgis-3.38/src/core/mesh/qgsmeshrenderersettings.h
/home/fischer/src/qgis-3.38/src/core/mesh/qgsmeshrenderersettings.cpp