Base class for storage of map layer temporal properties. More...
#include <qgsmaplayertemporalproperties.h>
Public Member Functions | |
| QgsMapLayerTemporalProperties (QObject *parent, bool enabled=false) | |
| Constructor for QgsMapLayerTemporalProperties, with the specified parent object. More... | |
| virtual QList< QgsDateTimeRange > | allTemporalRanges (QgsMapLayer *layer) const |
| Attempts to calculate the overall list of all temporal extents which are contained in the specified layer, using the settings defined by the temporal properties object. More... | |
| virtual QgsDateTimeRange | calculateTemporalExtent (QgsMapLayer *layer) const |
| Attempts to calculate the overall temporal extent for the specified layer, using the settings defined by the temporal properties object. More... | |
| virtual bool | isVisibleInTemporalRange (const QgsDateTimeRange &range) const |
Returns true if the layer should be visible and rendered for the specified time range. More... | |
| virtual bool | readXml (const QDomElement &element, const QgsReadWriteContext &context)=0 |
| Reads temporal properties from a DOM element previously written by writeXml(). More... | |
| virtual void | setDefaultsFromDataProviderTemporalCapabilities (const QgsDataProviderTemporalCapabilities *capabilities)=0 |
| Sets the layers temporal settings to appropriate defaults based on a provider's temporal capabilities. More... | |
| virtual QDomElement | writeXml (QDomElement &element, QDomDocument &doc, const QgsReadWriteContext &context)=0 |
| Writes the properties to a DOM element, to be used later with readXml(). More... | |
 Public Member Functions inherited from QgsTemporalProperty | |
| QgsTemporalProperty (QObject *parent=nullptr, bool enabled=false) | |
| Constructor for QgsTemporalProperty, with the specified parent object. More... | |
| virtual QgsTemporalProperty::Flags | flags () const |
| Returns flags associated to the temporal property. More... | |
| bool | isActive () const |
Returns true if the temporal property is active. More... | |
| void | setIsActive (bool active) |
| Sets whether the temporal property is active. More... | |
Additional Inherited Members | |
| Public Types inherited from QgsTemporalProperty | |
| enum | Flag { FlagDontInvalidateCachedRendersWhenRangeChanges = 1 } |
| Flags attached to the temporal property. More... | |
| Signals inherited from QgsTemporalProperty | |
| void | changed () |
| Emitted when the temporal properties have changed. More... | |
Detailed Description
Base class for storage of map layer temporal properties.
QgsMapLayerTemporalProperties exposes user-configurable settings for controlling how an individual QgsMapLayer behaves in a temporal context, e.g. while animating a map object.
- Since
- QGIS 3.14
Definition at line 42 of file qgsmaplayertemporalproperties.h.
Constructor & Destructor Documentation
◆ QgsMapLayerTemporalProperties()
| QgsMapLayerTemporalProperties::QgsMapLayerTemporalProperties | ( | QObject * | parent, |
| bool | enabled = false |
||
| ) |
Constructor for QgsMapLayerTemporalProperties, with the specified parent object.
The enabled argument specifies whether the temporal properties are initially enabled or not (see isActive()).
Definition at line 20 of file qgsmaplayertemporalproperties.cpp.
Member Function Documentation
◆ allTemporalRanges()
|
virtual |
Attempts to calculate the overall list of all temporal extents which are contained in the specified layer, using the settings defined by the temporal properties object.
May return an empty list if the ranges could not be calculated.
- Since
- QGIS 3.20
Reimplemented in QgsRasterLayerTemporalProperties.
Definition at line 35 of file qgsmaplayertemporalproperties.cpp.
◆ calculateTemporalExtent()
|
virtual |
Attempts to calculate the overall temporal extent for the specified layer, using the settings defined by the temporal properties object.
May return an infinite range if the extent could not be calculated.
- Note
- Not available in Python bindings
Reimplemented in QgsVectorLayerTemporalProperties, QgsRasterLayerTemporalProperties, and QgsMeshLayerTemporalProperties.
Definition at line 30 of file qgsmaplayertemporalproperties.cpp.
◆ isVisibleInTemporalRange()
|
virtual |
Returns true if the layer should be visible and rendered for the specified time range.
Reimplemented in QgsVectorLayerTemporalProperties, and QgsRasterLayerTemporalProperties.
Definition at line 25 of file qgsmaplayertemporalproperties.cpp.
◆ readXml()
|
pure virtual |
Reads temporal properties from a DOM element previously written by writeXml().
- See also
- writeXml()
Implemented in QgsVectorLayerTemporalProperties, QgsRasterLayerTemporalProperties, and QgsMeshLayerTemporalProperties.
◆ setDefaultsFromDataProviderTemporalCapabilities()
|
pure virtual |
Sets the layers temporal settings to appropriate defaults based on a provider's temporal capabilities.
Implemented in QgsVectorLayerTemporalProperties, QgsRasterLayerTemporalProperties, and QgsMeshLayerTemporalProperties.
◆ writeXml()
|
pure virtual |
Writes the properties to a DOM element, to be used later with readXml().
- See also
- readXml()
Implemented in QgsVectorLayerTemporalProperties, QgsRasterLayerTemporalProperties, and QgsMeshLayerTemporalProperties.
The documentation for this class was generated from the following files:
- /build/qgis-3.20.0+99unstable/src/core/qgsmaplayertemporalproperties.h
- /build/qgis-3.20.0+99unstable/src/core/qgsmaplayertemporalproperties.cpp
