QGIS API Documentation  3.11.0-Master (68611307d7)
Public Member Functions | List of all members
QgsMeshRendererVectorTracesSettings Class Reference

Represents a trace renderer settings for vector datasets displayed by particle traces. More...

#include <qgsmeshrenderersettings.h>

Public Member Functions

double maximumTailLength () const
 Returns the maximum tail length. More...
 
QgsUnitTypes::RenderUnit maximumTailLengthUnit () const
 Returns the maximum tail length unit. More...
 
int particlesCount () const
 Returns particles count. More...
 
void readXml (const QDomElement &elem)
 Reads configuration from the given DOM element. More...
 
void setMaximumTailLength (double maximumTailLength)
 Sets the maximums tail length. More...
 
void setMaximumTailLengthUnit (const QgsUnitTypes::RenderUnit &maximumTailLengthUnit)
 Sets the maximum tail length unit. More...
 
void setParticlesCount (int value)
 Sets particles count. More...
 
QDomElement writeXml (QDomDocument &doc) const
 Writes configuration to a new DOM element. More...
 

Detailed Description

Represents a trace renderer settings for vector datasets displayed by particle traces.

Note
The API is considered EXPERIMENTAL and can be changed without a notice
Since
QGIS 3.12

Definition at line 318 of file qgsmeshrenderersettings.h.

Member Function Documentation

◆ maximumTailLength()

double QgsMeshRendererVectorTracesSettings::maximumTailLength ( ) const

Returns the maximum tail length.

Definition at line 619 of file qgsmeshrenderersettings.cpp.

◆ maximumTailLengthUnit()

QgsUnitTypes::RenderUnit QgsMeshRendererVectorTracesSettings::maximumTailLengthUnit ( ) const

Returns the maximum tail length unit.

Definition at line 609 of file qgsmeshrenderersettings.cpp.

◆ particlesCount()

int QgsMeshRendererVectorTracesSettings::particlesCount ( ) const

Returns particles count.

Definition at line 629 of file qgsmeshrenderersettings.cpp.

◆ readXml()

void QgsMeshRendererVectorTracesSettings::readXml ( const QDomElement &  elem)

Reads configuration from the given DOM element.

Definition at line 591 of file qgsmeshrenderersettings.cpp.

◆ setMaximumTailLength()

void QgsMeshRendererVectorTracesSettings::setMaximumTailLength ( double  maximumTailLength)

Sets the maximums tail length.

Definition at line 624 of file qgsmeshrenderersettings.cpp.

◆ setMaximumTailLengthUnit()

void QgsMeshRendererVectorTracesSettings::setMaximumTailLengthUnit ( const QgsUnitTypes::RenderUnit maximumTailLengthUnit)

Sets the maximum tail length unit.

Definition at line 614 of file qgsmeshrenderersettings.cpp.

◆ setParticlesCount()

void QgsMeshRendererVectorTracesSettings::setParticlesCount ( int  value)

Sets particles count.

Definition at line 634 of file qgsmeshrenderersettings.cpp.

◆ writeXml()

QDomElement QgsMeshRendererVectorTracesSettings::writeXml ( QDomDocument &  doc) const

Writes configuration to a new DOM element.

Definition at line 599 of file qgsmeshrenderersettings.cpp.


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