Represents a streamline renderer settings for vector datasets displayed by streamlines. More...

#include <qgsmeshrenderersettings.h>

Public Types
enum	SeedingStartPointsMethod { MeshGridded = 0 , Random }
	Method used to define start points that are used to draw streamlines. More...

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

double	seedingDensity () const
	Returns the density used for seeding start points.

SeedingStartPointsMethod	seedingMethod () const
	Returns the method used for seeding start points of strealines.

void	setSeedingDensity (double seedingDensity)
	Sets the density used for seeding start points.

void	setSeedingMethod (const SeedingStartPointsMethod &seedingMethod)
	Sets the method used for seeding start points of strealines.

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

Detailed Description

Represents a streamline renderer settings for vector datasets displayed by streamlines.

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

Since: QGIS 3.12

Definition at line 323 of file qgsmeshrenderersettings.h.

Member Enumeration Documentation

◆ SeedingStartPointsMethod

enum QgsMeshRendererVectorStreamlineSettings::SeedingStartPointsMethod

Method used to define start points that are used to draw streamlines.

Enumerator
MeshGridded	Seeds start points on the vertices mesh or user regular grid.
Random	Seeds start points randomly on the mesh.

Definition at line 327 of file qgsmeshrenderersettings.h.

Member Function Documentation

◆ readXml()

void QgsMeshRendererVectorStreamlineSettings::readXml ( const QDomElement & elem )

Reads configuration from the given DOM element.

Definition at line 557 of file qgsmeshrenderersettings.cpp.

◆ seedingDensity()

double QgsMeshRendererVectorStreamlineSettings::seedingDensity ( ) const

Returns the density used for seeding start points.

Definition at line 537 of file qgsmeshrenderersettings.cpp.

◆ seedingMethod()

QgsMeshRendererVectorStreamlineSettings::SeedingStartPointsMethod QgsMeshRendererVectorStreamlineSettings::seedingMethod ( ) const

Returns the method used for seeding start points of strealines.

Definition at line 527 of file qgsmeshrenderersettings.cpp.

◆ setSeedingDensity()

void QgsMeshRendererVectorStreamlineSettings::setSeedingDensity ( double seedingDensity )

Sets the density used for seeding start points.

Definition at line 542 of file qgsmeshrenderersettings.cpp.

◆ setSeedingMethod()

void QgsMeshRendererVectorStreamlineSettings::setSeedingMethod ( const SeedingStartPointsMethod & seedingMethod )

Sets the method used for seeding start points of strealines.

Definition at line 532 of file qgsmeshrenderersettings.cpp.

◆ writeXml()

QDomElement QgsMeshRendererVectorStreamlineSettings::writeXml ( QDomDocument & doc ) const

Writes configuration to a new DOM element.

Definition at line 547 of file qgsmeshrenderersettings.cpp.

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

/build/qgis-3.41.0+git20241214+cea29feecf2+99sid/src/core/mesh/qgsmeshrenderersettings.h
/build/qgis-3.41.0+git20241214+cea29feecf2+99sid/src/core/mesh/qgsmeshrenderersettings.cpp

Public Types

Public Member Functions