QGIS API Documentation  3.13.0-Master (13337b20cd)
Public Types | Public Member Functions | List of all members
QgsMeshRendererVectorStreamlineSettings Class Reference

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. More...
 
double seedingDensity () const
 Returns the density used for seeding start points. More...
 
SeedingStartPointsMethod seedingMethod () const
 Returns the method used for seeding start points of strealines. More...
 
void setSeedingDensity (double seedingDensity)
 Sets the density used for seeding start points. More...
 
void setSeedingMethod (const SeedingStartPointsMethod &seedingMethod)
 Sets the method used for seeding start points of strealines. More...
 
QDomElement writeXml (QDomDocument &doc) const
 Writes configuration to a new DOM element. More...
 

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 272 of file qgsmeshrenderersettings.h.

Member Enumeration Documentation

◆ 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 276 of file qgsmeshrenderersettings.h.

Member Function Documentation

◆ readXml()

void QgsMeshRendererVectorStreamlineSettings::readXml ( const QDomElement &  elem)

Reads configuration from the given DOM element.

Definition at line 495 of file qgsmeshrenderersettings.cpp.

◆ seedingDensity()

double QgsMeshRendererVectorStreamlineSettings::seedingDensity ( ) const

Returns the density used for seeding start points.

Definition at line 475 of file qgsmeshrenderersettings.cpp.

◆ seedingMethod()

QgsMeshRendererVectorStreamlineSettings::SeedingStartPointsMethod QgsMeshRendererVectorStreamlineSettings::seedingMethod ( ) const

Returns the method used for seeding start points of strealines.

Definition at line 465 of file qgsmeshrenderersettings.cpp.

◆ setSeedingDensity()

void QgsMeshRendererVectorStreamlineSettings::setSeedingDensity ( double  seedingDensity)

Sets the density used for seeding start points.

Definition at line 480 of file qgsmeshrenderersettings.cpp.

◆ setSeedingMethod()

void QgsMeshRendererVectorStreamlineSettings::setSeedingMethod ( const SeedingStartPointsMethod seedingMethod)

Sets the method used for seeding start points of strealines.

Definition at line 470 of file qgsmeshrenderersettings.cpp.

◆ writeXml()

QDomElement QgsMeshRendererVectorStreamlineSettings::writeXml ( QDomDocument &  doc) const

Writes configuration to a new DOM element.

Definition at line 485 of file qgsmeshrenderersettings.cpp.


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