[feature][temporal] Add a new "Redraw Layer Only" mode for temporal vector layers

nyalldawson · nyalldawson · commit cd1f4f337841 · 2020-05-09T18:06:36.000+10:00
When set to this mode, the layer will automatically be redrawn whenever
the temporal range is changed, but no time based filtering will be applied
to the features.

This configuration is useful when the layer has symbology settings which
vary based on the temporal range. For instance, when a layer is using
time-dependent rule-based renderer expressions or data-defined symbology
expressions.
diff --git a/python/core/auto_generated/qgsvectorlayertemporalproperties.sip.in b/python/core/auto_generated/qgsvectorlayertemporalproperties.sip.in
@@ -39,6 +39,7 @@ The ``enabled`` argument specifies whether the temporal properties are initially
       ModeFixedTemporalRange,
       ModeFeatureDateTimeInstantFromField,
       ModeFeatureDateTimeStartAndEndFromFields,
+      ModeRedrawLayerOnly,
     };
 
     TemporalMode mode() const;
diff --git a/src/core/qgstemporalutils.cpp b/src/core/qgstemporalutils.cpp
@@ -101,6 +101,9 @@ QgsDateTimeRange QgsTemporalUtils::calculateTemporalRangeForProject( QgsProject
             }
             break;
           }
+
+          case QgsVectorLayerTemporalProperties::ModeRedrawLayerOnly:
+            break;
         }
         break;
       }
diff --git a/src/core/qgsvectorlayertemporalproperties.cpp b/src/core/qgsvectorlayertemporalproperties.cpp
@@ -36,6 +36,7 @@ bool QgsVectorLayerTemporalProperties::isVisibleInTemporalRange( const QgsDateTi
 
     case ModeFeatureDateTimeInstantFromField:
     case ModeFeatureDateTimeStartAndEndFromFields:
+    case ModeRedrawLayerOnly:
       return true;
   }
   return true;
@@ -183,6 +184,7 @@ QString QgsVectorLayerTemporalProperties::createFilterString( QgsVectorLayer *,
   switch ( mMode )
   {
     case ModeFixedTemporalRange:
+    case ModeRedrawLayerOnly:
       return QString();
 
     case ModeFeatureDateTimeInstantFromField:
diff --git a/src/core/qgsvectorlayertemporalproperties.h b/src/core/qgsvectorlayertemporalproperties.h
@@ -57,6 +57,7 @@ class CORE_EXPORT QgsVectorLayerTemporalProperties : public QgsMapLayerTemporalP
       ModeFixedTemporalRange = 0, //!< Mode when temporal properties have fixed start and end datetimes.
       ModeFeatureDateTimeInstantFromField, //!< Mode when features have a datetime instant taken from a single field
       ModeFeatureDateTimeStartAndEndFromFields, //!< Mode when features have separate fields for start and end times
+      ModeRedrawLayerOnly, //!< Redraw the layer when temporal range changes, but don't apply any filtering. Useful when symbology or rule based renderer expressions depend on the time range.
     };
 
     /**
diff --git a/src/gui/qgsvectorlayertemporalpropertieswidget.cpp b/src/gui/qgsvectorlayertemporalpropertieswidget.cpp
@@ -34,6 +34,7 @@ QgsVectorLayerTemporalPropertiesWidget::QgsVectorLayerTemporalPropertiesWidget(
   mModeComboBox->addItem( tr( "Fixed Time Range" ), QgsVectorLayerTemporalProperties::ModeFixedTemporalRange );
   mModeComboBox->addItem( tr( "Single Field with Date/Time" ), QgsVectorLayerTemporalProperties::ModeFeatureDateTimeInstantFromField );
   mModeComboBox->addItem( tr( "Separate Fields for Start and End Date/Time" ), QgsVectorLayerTemporalProperties::ModeFeatureDateTimeStartAndEndFromFields );
+  mModeComboBox->addItem( tr( "Redraw Layer Only" ), QgsVectorLayerTemporalProperties::ModeRedrawLayerOnly );
 
   const QgsVectorLayerTemporalProperties *properties = qobject_cast< QgsVectorLayerTemporalProperties * >( layer->temporalProperties() );
   mTemporalGroupBox->setChecked( properties->isActive() );
@@ -86,6 +87,7 @@ void QgsVectorLayerTemporalPropertiesWidget::saveTemporalProperties()
   {
     case QgsVectorLayerTemporalProperties::ModeFeatureDateTimeInstantFromField:
     case QgsVectorLayerTemporalProperties::ModeFixedTemporalRange:
+    case QgsVectorLayerTemporalProperties::ModeRedrawLayerOnly:
       properties->setStartField( mSingleFieldComboBox->currentField() );
       break;
 
diff --git a/src/ui/qgsvectorlayertemporalpropertieswidgetbase.ui b/src/ui/qgsvectorlayertemporalpropertieswidgetbase.ui
@@ -94,7 +94,7 @@ background: white;QgsCollapsibleGroupBoxBasic::title, QgsCollapsibleGroupBox::ti
           <item row="1" column="0" colspan="2">
            <widget class="QStackedWidget" name="mStackedWidget">
             <property name="currentIndex">
-             <number>1</number>
+             <number>0</number>
             </property>
             <widget class="QWidget" name="page_3">
              <layout class="QGridLayout" name="gridLayout_6">
@@ -211,6 +211,33 @@ background: white;QgsCollapsibleGroupBoxBasic::title, QgsCollapsibleGroupBox::ti
               </item>
              </layout>
             </widget>
+            <widget class="QWidget" name="page_4">
+             <layout class="QVBoxLayout" name="verticalLayout">
+              <item>
+               <widget class="QLabel" name="label_7">
+                <property name="text">
+                 <string>&lt;p&gt;&lt;b&gt;The layer will automatically be redrawn whenever the temporal range is changed, but no time based filtering will be applied to the features.&lt;b&gt;&lt;/p&gt;&lt;p&gt;This configuration is useful when the layer has symbology settings which vary based on the temporal range. For instance, when it is using time-dependent rule-based renderer expressions or data-defined symbology expressions.&lt;/p&gt;</string>
+                </property>
+                <property name="wordWrap">
+                 <bool>true</bool>
+                </property>
+               </widget>
+              </item>
+              <item>
+               <spacer name="verticalSpacer_4">
+                <property name="orientation">
+                 <enum>Qt::Vertical</enum>
+                </property>
+                <property name="sizeHint" stdset="0">
+                 <size>
+                  <width>20</width>
+                  <height>40</height>
+                 </size>
+                </property>
+               </spacer>
+              </item>
+             </layout>
+            </widget>
            </widget>
           </item>
           <item row="2" column="0">

Original file line number	Diff line number	Diff line change
`@@ -101,6 +101,9 @@ QgsDateTimeRange QgsTemporalUtils::calculateTemporalRangeForProject( QgsProject`
`101`	`101`	`}`
`102`	`102`	`break;`
`103`	`103`	`}`
	`104`	`+`
	`105`	`+ case QgsVectorLayerTemporalProperties::ModeRedrawLayerOnly:`
	`106`	`+ break;`
`104`	`107`	`}`
`105`	`108`	`break;`
`106`	`109`	`}`
Original file line number	Diff line number	Diff line change
`@@ -36,6 +36,7 @@ bool QgsVectorLayerTemporalProperties::isVisibleInTemporalRange( const QgsDateTi`
`36`	`36`
`37`	`37`	`case ModeFeatureDateTimeInstantFromField:`
`38`	`38`	`case ModeFeatureDateTimeStartAndEndFromFields:`
	`39`	`+ case ModeRedrawLayerOnly:`
`39`	`40`	`return true;`
`40`	`41`	`}`
`41`	`42`	`return true;`
`@@ -183,6 +184,7 @@ QString QgsVectorLayerTemporalProperties::createFilterString( QgsVectorLayer *,`
`183`	`184`	`switch ( mMode )`
`184`	`185`	`{`
`185`	`186`	`case ModeFixedTemporalRange:`
	`187`	`+ case ModeRedrawLayerOnly:`
`186`	`188`	`return QString();`
`187`	`189`
`188`	`190`	`case ModeFeatureDateTimeInstantFromField:`