QGIS API Documentation 3.29.0-Master (ade4f0cf0f)
Public Member Functions | List of all members
QgsSymbolAnimationSettings Class Reference

Contains settings relating to symbol animation. More...

#include <qgssymbol.h>

Public Member Functions

double frameRate () const
 Returns the symbol animation frame rate (in frames per second). More...
 
bool isAnimated () const
 Returns true if the symbol is animated. More...
 
void setFrameRate (double rate)
 Sets the symbol animation frame rate (in frames per second). More...
 
void setIsAnimated (bool animated)
 Sets whether the symbol is animated. More...
 

Detailed Description

Contains settings relating to symbol animation.

Since
QGIS 3.26

Definition at line 39 of file qgssymbol.h.

Member Function Documentation

◆ frameRate()

double QgsSymbolAnimationSettings::frameRate ( ) const
inline

Returns the symbol animation frame rate (in frames per second).

See also
setFrameRate()

Definition at line 77 of file qgssymbol.h.

◆ isAnimated()

bool QgsSymbolAnimationSettings::isAnimated ( ) const
inline

Returns true if the symbol is animated.

This is a user-facing setting for symbols, which allows users to define whether a symbol is animated, and allows for creation of animated symbols via data defined properties.

See also
setIsAnimated()

Definition at line 63 of file qgssymbol.h.

◆ setFrameRate()

void QgsSymbolAnimationSettings::setFrameRate ( double  rate)
inline

Sets the symbol animation frame rate (in frames per second).

See also
frameRate()

Definition at line 70 of file qgssymbol.h.

◆ setIsAnimated()

void QgsSymbolAnimationSettings::setIsAnimated ( bool  animated)
inline

Sets whether the symbol is animated.

This is a user-facing setting for symbols, which allows users to define whether a symbol is animated, and allows for creation of animated symbols via data defined properties.

See also
isAnimated()

Definition at line 52 of file qgssymbol.h.


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