QGIS API Documentation
3.14.0-Pi (9f7028fd23)
|
#include <qgsrasterlayertemporalproperties.h>
Public Types | |
enum | TemporalMode { ModeFixedTemporalRange = 0, ModeTemporalRangeFromDataProvider = 1 } |
Mode of the raster temporal properties. More... | |
![]() | |
enum | Flag { FlagDontInvalidateCachedRendersWhenRangeChanges = 1 } |
Flags attached to the temporal property. More... | |
Public Member Functions | |
QgsRasterLayerTemporalProperties (QObject *parent=nullptr, bool enabled=false) | |
Constructor for QgsRasterLayerTemporalProperties, with the specified parent object. More... | |
QgsDateTimeRange | calculateTemporalExtent (QgsMapLayer *layer) const override |
Attempts to calculate the overall temporal extent for the specified layer, using the settings defined by the temporal properties object. More... | |
const QgsDateTimeRange & | fixedTemporalRange () const |
Returns the fixed temporal range for the layer. More... | |
QgsTemporalProperty::Flags | flags () const override |
Returns flags associated to the temporal property. More... | |
QgsRasterDataProviderTemporalCapabilities::IntervalHandlingMethod | intervalHandlingMethod () const |
Returns the desired method to use when resolving a temporal interval to matching layers or bands in the data provider. More... | |
bool | isVisibleInTemporalRange (const QgsDateTimeRange &range) const override |
Returns true if the layer should be visible and rendered for the specified time range. More... | |
TemporalMode | mode () const |
Returns the temporal properties mode. More... | |
bool | readXml (const QDomElement &element, const QgsReadWriteContext &context) override |
Reads temporal properties from a DOM element previously written by writeXml(). More... | |
void | setDefaultsFromDataProviderTemporalCapabilities (const QgsDataProviderTemporalCapabilities *capabilities) override |
Sets the layers temporal settings to appropriate defaults based on a provider's temporal capabilities. More... | |
void | setFixedTemporalRange (const QgsDateTimeRange &range) |
Sets a temporal range to apply to the whole layer. More... | |
void | setIntervalHandlingMethod (QgsRasterDataProviderTemporalCapabilities::IntervalHandlingMethod method) |
Sets the desired method to use when resolving a temporal interval to matching layers or bands in the data provider. More... | |
void | setMode (TemporalMode mode) |
Sets the temporal properties mode. More... | |
QDomElement | writeXml (QDomElement &element, QDomDocument &doc, const QgsReadWriteContext &context) override |
Writes the properties to a DOM element, to be used later with readXml(). More... | |
![]() | |
QgsMapLayerTemporalProperties (QObject *parent, bool enabled=false) | |
Constructor for QgsMapLayerTemporalProperties, with the specified parent object. More... | |
![]() | |
QgsTemporalProperty (QObject *parent=nullptr, bool enabled=false) | |
Constructor for QgsTemporalProperty, with the specified parent object. 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 | |
![]() | |
void | changed () |
Emitted when the temporal properties have changed. More... | |
Implementation of map layer temporal properties for raster layers.
Definition at line 35 of file qgsrasterlayertemporalproperties.h.
Mode of the raster temporal properties.
Definition at line 54 of file qgsrasterlayertemporalproperties.h.
QgsRasterLayerTemporalProperties::QgsRasterLayerTemporalProperties | ( | QObject * | parent = nullptr , |
bool | enabled = false |
||
) |
Constructor for QgsRasterLayerTemporalProperties, with the specified parent object.
The enabled argument specifies whether the temporal properties are initially enabled or not (see isActive()).
Definition at line 22 of file qgsrasterlayertemporalproperties.cpp.
|
overridevirtual |
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.
Reimplemented from QgsMapLayerTemporalProperties.
Definition at line 43 of file qgsrasterlayertemporalproperties.cpp.
const QgsDateTimeRange & QgsRasterLayerTemporalProperties::fixedTemporalRange | ( | ) | const |
Returns the fixed temporal range for the layer.
Definition at line 95 of file qgsrasterlayertemporalproperties.cpp.
|
overridevirtual |
Returns flags associated to the temporal property.
Reimplemented from QgsTemporalProperty.
Definition at line 73 of file qgsrasterlayertemporalproperties.cpp.
QgsRasterDataProviderTemporalCapabilities::IntervalHandlingMethod QgsRasterLayerTemporalProperties::intervalHandlingMethod | ( | ) | const |
Returns the desired method to use when resolving a temporal interval to matching layers or bands in the data provider.
Definition at line 78 of file qgsrasterlayertemporalproperties.cpp.
|
overridevirtual |
Returns true
if the layer should be visible and rendered for the specified time range.
Reimplemented from QgsMapLayerTemporalProperties.
Definition at line 27 of file qgsrasterlayertemporalproperties.cpp.
QgsRasterLayerTemporalProperties::TemporalMode QgsRasterLayerTemporalProperties::mode | ( | ) | const |
Returns the temporal properties mode.
Definition at line 61 of file qgsrasterlayertemporalproperties.cpp.
|
overridevirtual |
Reads temporal properties from a DOM element previously written by writeXml().
Implements QgsMapLayerTemporalProperties.
Definition at line 100 of file qgsrasterlayertemporalproperties.cpp.
|
overridevirtual |
Sets the layers temporal settings to appropriate defaults based on a provider's temporal capabilities.
Implements QgsMapLayerTemporalProperties.
Definition at line 156 of file qgsrasterlayertemporalproperties.cpp.
void QgsRasterLayerTemporalProperties::setFixedTemporalRange | ( | const QgsDateTimeRange & | range | ) |
Sets a temporal range to apply to the whole layer.
All bands from the raster layer will be rendered whenever the current datetime range of a render context intersects the specified range.
Definition at line 90 of file qgsrasterlayertemporalproperties.cpp.
void QgsRasterLayerTemporalProperties::setIntervalHandlingMethod | ( | QgsRasterDataProviderTemporalCapabilities::IntervalHandlingMethod | method | ) |
Sets the desired method to use when resolving a temporal interval to matching layers or bands in the data provider.
Definition at line 83 of file qgsrasterlayertemporalproperties.cpp.
void QgsRasterLayerTemporalProperties::setMode | ( | QgsRasterLayerTemporalProperties::TemporalMode | mode | ) |
Sets the temporal properties mode.
Definition at line 66 of file qgsrasterlayertemporalproperties.cpp.
|
overridevirtual |
Writes the properties to a DOM element, to be used later with readXml().
Implements QgsMapLayerTemporalProperties.
Definition at line 126 of file qgsrasterlayertemporalproperties.cpp.