Contains temporal settings and properties for the project, this may be used when animating maps or showing temporal layers.
More...
#include <qgsprojecttimesettings.h>
|
| QgsProjectTimeSettings (QObject *parent=nullptr) |
| Constructor for QgsProjectTimeSettings with the specified parent object. More...
|
|
double | framesPerSecond () const |
| Returns the project's default animation frame rate, in frames per second. More...
|
|
bool | isTemporalRangeCumulative () const |
| Returns the value of cumulative temporal range in animation settings. More...
|
|
bool | readXml (const QDomElement &element, const QgsReadWriteContext &context) |
| Reads the settings's state from a DOM element. More...
|
|
void | reset () |
| Resets the settings to a default state. More...
|
|
void | setFramesPerSecond (double rate) |
| Sets the project's default animation frame rate, in frames per second. More...
|
|
void | setIsTemporalRangeCumulative (bool state) |
| Sets the project's temporal range as cumulative in animation settings. More...
|
|
void | setTemporalRange (const QgsDateTimeRange &range) |
| Sets the project's temporal range, which indicates the earliest and latest datetime ranges associated with the project. More...
|
|
void | setTimeStep (double step) |
| Sets the project's time step (length of one animation frame), which is used as the default value when animating the project. More...
|
|
void | setTimeStepUnit (QgsUnitTypes::TemporalUnit unit) |
| Sets the project's time step (length of one animation frame) unit, which is used as the default value when animating the project. More...
|
|
QgsDateTimeRange | temporalRange () const |
| Returns the project's temporal range, which indicates the earliest and latest datetime ranges associated with the project. More...
|
|
double | timeStep () const |
| Returns the project's time step (length of one animation frame), which is used as the default value when animating the project. More...
|
|
QgsUnitTypes::TemporalUnit | timeStepUnit () const |
| Returns the project's time step (length of one animation frame) unit, which is used as the default value when animating the project. More...
|
|
QDomElement | writeXml (QDomDocument &document, const QgsReadWriteContext &context) const |
| Returns a DOM element representing the settings. More...
|
|
Contains temporal settings and properties for the project, this may be used when animating maps or showing temporal layers.
- Since
- QGIS 3.14
Definition at line 36 of file qgsprojecttimesettings.h.
◆ QgsProjectTimeSettings()
QgsProjectTimeSettings::QgsProjectTimeSettings |
( |
QObject * |
parent = nullptr | ) |
|
◆ framesPerSecond()
double QgsProjectTimeSettings::framesPerSecond |
( |
| ) |
const |
◆ isTemporalRangeCumulative()
bool QgsProjectTimeSettings::isTemporalRangeCumulative |
( |
| ) |
const |
◆ readXml()
bool QgsProjectTimeSettings::readXml |
( |
const QDomElement & |
element, |
|
|
const QgsReadWriteContext & |
context |
|
) |
| |
◆ reset()
void QgsProjectTimeSettings::reset |
( |
| ) |
|
◆ setFramesPerSecond()
void QgsProjectTimeSettings::setFramesPerSecond |
( |
double |
rate | ) |
|
◆ setIsTemporalRangeCumulative()
void QgsProjectTimeSettings::setIsTemporalRangeCumulative |
( |
bool |
state | ) |
|
◆ setTemporalRange()
void QgsProjectTimeSettings::setTemporalRange |
( |
const QgsDateTimeRange & |
range | ) |
|
Sets the project's temporal range, which indicates the earliest and latest datetime ranges associated with the project.
- Note
- This is a manual, use-set property, and does not necessarily coincide with the earliest and latest temporal ranges set for individual layers in the project.
- See also
- temporalRange()
-
temporalRangeChanged()
Definition at line 39 of file qgsprojecttimesettings.cpp.
◆ setTimeStep()
void QgsProjectTimeSettings::setTimeStep |
( |
double |
step | ) |
|
◆ setTimeStepUnit()
◆ temporalRange()
QgsDateTimeRange QgsProjectTimeSettings::temporalRange |
( |
| ) |
const |
Returns the project's temporal range, which indicates the earliest and latest datetime ranges associated with the project.
- Note
- This is a manual, use-set property, and does not necessarily coincide with the earliest and latest temporal ranges set for individual layers in the project.
- See also
- setTemporalRange()
-
temporalRangeChanged()
Definition at line 34 of file qgsprojecttimesettings.cpp.
◆ temporalRangeChanged
void QgsProjectTimeSettings::temporalRangeChanged |
( |
| ) |
|
|
signal |
◆ timeStep()
double QgsProjectTimeSettings::timeStep |
( |
| ) |
const |
◆ timeStepUnit()
◆ writeXml()
QDomElement QgsProjectTimeSettings::writeXml |
( |
QDomDocument & |
document, |
|
|
const QgsReadWriteContext & |
context |
|
) |
| const |
The documentation for this class was generated from the following files: