Skip to content

Commit

Permalink
Move WMS-T specific temporal settings out of QgsRasterLayerProperties
Browse files Browse the repository at this point in the history 
and into a temporal subcomponent widget which is created by the
wms provider gui metadata

Keeps things much cleaner, and removes a whole bunch of provider
specific logic which doesn't belong in a generic class
  • Loading branch information
@nyalldawson
nyalldawson committed Mar 24, 2021
1 parent 207be1d commit 65c78aa
Show file tree
Hide file tree
Showing 11 changed files with 666 additions and 536 deletions.
223 changes: 0 additions & 223 deletions src/gui/raster/qgsrasterlayerproperties.cpp
View file
Expand Up @@ -122,16 +122,6 @@ QgsRasterLayerProperties::QgsRasterLayerProperties( QgsMapLayer *lyr, QgsMapCanv
initOptionsBase( false );
connect( buttonBox, &QDialogButtonBox::helpRequested, this, &QgsRasterLayerProperties::showHelp );

connect( mSetEndAsStartStaticButton, &QPushButton::clicked, this, &QgsRasterLayerProperties::setEndAsStartStaticButton_clicked );
connect( mProjectTemporalRange, &QRadioButton::toggled, this, &QgsRasterLayerProperties::passProjectTemporalRange_toggled );
connect( mStaticTemporalRange, &QRadioButton::toggled, this, &QgsRasterLayerProperties::staticTemporalRange_toggled );

connect( mStaticTemporalRange, &QRadioButton::toggled, mStaticWmstFrame, &QWidget::setEnabled );
connect( mReferenceTime, &QCheckBox::toggled, mWmstReferenceTimeFrame, &QWidget::setEnabled );

if ( mRasterLayer && mRasterLayer->temporalProperties() )
connect( mRasterLayer->temporalProperties(), &QgsRasterLayerTemporalProperties::changed, this, &QgsRasterLayerProperties::temporalPropertiesChange );

mSourceGroupBox->hide();

mBtnStyle = new QPushButton( tr( "Style" ) );
Expand Down Expand Up @@ -304,9 +294,6 @@ QgsRasterLayerProperties::QgsRasterLayerProperties( QgsMapLayer *lyr, QgsMapCanv
mTemporalWidget = new QgsRasterLayerTemporalPropertiesWidget( this, mRasterLayer );
temporalLayout->addWidget( mTemporalWidget );

setSourceStaticTimeState();
mWmstGroup->setVisible( mRasterLayer->providerType() == QLatin1String( "wms" ) && mRasterLayer->dataProvider() && mRasterLayer->dataProvider()->temporalCapabilities()->hasTemporalCapabilities() );

// This group is used to define the temporal capabilities of the PG raster layer
if ( mRasterLayer->dataProvider() && mRasterLayer->providerType() == QLatin1String( "postgresraster" ) )
{
Expand Down Expand Up @@ -1108,8 +1095,6 @@ void QgsRasterLayerProperties::apply()
//set the blend mode for the layer
mRasterLayer->setBlendMode( mBlendModeComboBox->blendMode() );

updateSourceStaticTime();

// Update temporal field
if ( mRasterLayer->dataProvider() )
{
Expand Down Expand Up @@ -1219,209 +1204,6 @@ void QgsRasterLayerProperties::apply()

// notify the project we've made a change
QgsProject::instance()->setDirty( true );
}//apply

void QgsRasterLayerProperties::updateSourceStaticTime()
{
QgsProviderMetadata *metadata = QgsProviderRegistry::instance()->providerMetadata(
mRasterLayer->providerType() );
const QVariantMap currentUri = metadata->decodeUri( mRasterLayer->dataProvider()->dataSourceUri() );

QVariantMap uri = currentUri;

if ( mWmstGroup->isVisibleTo( this ) )
uri[ QStringLiteral( "allowTemporalUpdates" ) ] = mWmstGroup->isChecked();


if ( mWmstGroup->isEnabled() &&
mRasterLayer->dataProvider() &&
mRasterLayer->dataProvider()->temporalCapabilities()->hasTemporalCapabilities() )
{
bool enableTime = !mDisableTime->isChecked();

uri[ QStringLiteral( "enableTime" ) ] = enableTime;
qobject_cast< QgsRasterLayerTemporalProperties * >( mRasterLayer->temporalProperties() )->setIntervalHandlingMethod( static_cast< QgsRasterDataProviderTemporalCapabilities::IntervalHandlingMethod >(
mFetchModeComboBox->currentData().toInt() ) );

// Don't do static temporal updates if temporal properties are active
if ( !mRasterLayer->temporalProperties()->isActive() )
{
if ( mStaticTemporalRange->isChecked() )
{
QString time = mStartStaticDateTimeEdit->dateTime().toString( Qt::ISODateWithMs ) + '/' +
mEndStaticDateTimeEdit->dateTime().toString( Qt::ISODateWithMs );
uri[ QStringLiteral( "time" ) ] = time;
uri[ QStringLiteral( "temporalSource" ) ] = QLatin1String( "provider" );
}

if ( mProjectTemporalRange->isChecked() )
{
QgsDateTimeRange range;

if ( QgsProject::instance()->timeSettings() )
range = QgsProject::instance()->timeSettings()->temporalRange();
if ( range.begin().isValid() && range.end().isValid() )
{
QString time = range.begin().toString( Qt::ISODateWithMs ) + '/' +
range.end().toString( Qt::ISODateWithMs );

uri[ QStringLiteral( "time" ) ] = time;
uri[ QStringLiteral( "temporalSource" ) ] = QLatin1String( "project" );
}
}
}

if ( mReferenceTime->isChecked() )
{
QString referenceTime = mReferenceDateTimeEdit->dateTime().toString( Qt::ISODateWithMs );
uri[ QStringLiteral( "referenceTime" ) ] = referenceTime;
}
else
{
if ( uri.contains( QStringLiteral( "referenceTime" ) ) )
uri.remove( QStringLiteral( "referenceTime" ) );
}
}

if ( currentUri != uri )
mRasterLayer->setDataSource( metadata->encodeUri( uri ), mRasterLayer->name(), mRasterLayer->providerType(), QgsDataProvider::ProviderOptions() );
}

void QgsRasterLayerProperties::setSourceStaticTimeState()
{
if ( mRasterLayer->dataProvider() && mRasterLayer->dataProvider()->temporalCapabilities()->hasTemporalCapabilities() )
{
const QgsDateTimeRange availableProviderRange = mRasterLayer->dataProvider()->temporalCapabilities()->availableTemporalRange();
const QgsDateTimeRange availableReferenceRange = mRasterLayer->dataProvider()->temporalCapabilities()->availableReferenceTemporalRange();

QgsProviderMetadata *metadata = QgsProviderRegistry::instance()->providerMetadata(
mRasterLayer->providerType() );

QVariantMap uri = metadata->decodeUri( mRasterLayer->dataProvider()->dataSourceUri() );

mStartStaticDateTimeEdit->setDisplayFormat( "yyyy-MM-dd HH:mm:ss" );
mEndStaticDateTimeEdit->setDisplayFormat( "yyyy-MM-dd HH:mm:ss" );
mReferenceDateTimeEdit->setDisplayFormat( "yyyy-MM-dd HH:mm:ss" );

// setup maximum extents for widgets, based on provider's capabilities
if ( availableProviderRange.begin().isValid() && availableProviderRange.end().isValid() )
{
mStartStaticDateTimeEdit->setDateTimeRange( availableProviderRange.begin(),
availableProviderRange.end() );
mStartStaticDateTimeEdit->setDateTime( availableProviderRange.begin() );
mEndStaticDateTimeEdit->setDateTimeRange( availableProviderRange.begin(),
availableProviderRange.end() );
mEndStaticDateTimeEdit->setDateTime( availableProviderRange.end() );
}
if ( availableReferenceRange.begin().isValid() && availableReferenceRange.end().isValid() )
{
mReferenceDateTimeEdit->setDateTimeRange( availableReferenceRange.begin(),
availableReferenceRange.end() );
mReferenceDateTimeEdit->setDateTime( availableReferenceRange.begin() );
}

const QString time = uri.value( QStringLiteral( "time" ) ).toString();
if ( !time.isEmpty() )
{
QStringList parts = time.split( '/' );
mStartStaticDateTimeEdit->setDateTime( QDateTime::fromString( parts.at( 0 ), Qt::ISODateWithMs ) );
mEndStaticDateTimeEdit->setDateTime( QDateTime::fromString( parts.at( 1 ), Qt::ISODateWithMs ) );
}

const QString referenceTimeExtent = uri.value( QStringLiteral( "referenceTimeDimensionExtent" ) ).toString();

mReferenceTime->setEnabled( !referenceTimeExtent.isEmpty() );
mReferenceDateTimeEdit->setVisible( !referenceTimeExtent.isEmpty() );

QString referenceTimeLabelText = referenceTimeExtent.isEmpty() ?
tr( "There is no reference time in the layer's capabilities." ) : QString();
mReferenceTimeLabel->setText( referenceTimeLabelText );

const QString referenceTime = uri.value( QStringLiteral( "referenceTime" ) ).toString();

mReferenceTime->setChecked( !referenceTime.isEmpty() );

if ( !referenceTime.isEmpty() && !referenceTimeExtent.isEmpty() )
{
mReferenceDateTimeEdit->setDateTime( QDateTime::fromString( referenceTime, Qt::ISODateWithMs ) );
}

mFetchModeComboBox->addItem( tr( "Use Whole Temporal Range" ), QgsRasterDataProviderTemporalCapabilities::MatchUsingWholeRange );
mFetchModeComboBox->addItem( tr( "Match to Start of Range" ), QgsRasterDataProviderTemporalCapabilities::MatchExactUsingStartOfRange );
mFetchModeComboBox->addItem( tr( "Match to End of Range" ), QgsRasterDataProviderTemporalCapabilities::MatchExactUsingEndOfRange );
mFetchModeComboBox->addItem( tr( "Closest Match to Start of Range" ), QgsRasterDataProviderTemporalCapabilities::FindClosestMatchToStartOfRange );
mFetchModeComboBox->addItem( tr( "Closest Match to End of Range" ), QgsRasterDataProviderTemporalCapabilities::FindClosestMatchToEndOfRange );
mFetchModeComboBox->setCurrentIndex( mFetchModeComboBox->findData( qobject_cast< QgsRasterLayerTemporalProperties * >( mRasterLayer->temporalProperties() )->intervalHandlingMethod() ) );

const QString temporalSource = uri.value( QStringLiteral( "temporalSource" ) ).toString();
bool enableTime = uri.value( QStringLiteral( "enableTime" ), true ).toBool();

if ( temporalSource == QLatin1String( "provider" ) )
mStaticTemporalRange->setChecked( !time.isEmpty() );
else if ( temporalSource == QLatin1String( "project" ) )
mProjectTemporalRange->setChecked( !time.isEmpty() );

mDisableTime->setChecked( !enableTime );

mWmstOptions->setEnabled( !mRasterLayer->temporalProperties()->isActive() );

if ( mRasterLayer->temporalProperties()->isActive() )
mWmstOptionsLabel->setText( tr( "The static temporal options below are disabled because the layer "
"temporal properties are active, to enable them disable temporal properties "
"in the temporal tab. " ) );
QgsDateTimeRange range;
if ( QgsProject::instance()->timeSettings() )
range = QgsProject::instance()->timeSettings()->temporalRange();

if ( !range.begin().isValid() || !range.end().isValid() )
{
mProjectTemporalRange->setEnabled( false );
mProjectTemporalRangeLabel->setText( tr( "The option below is disabled because the project temporal range "
"is not valid, update the project temporal range in the project properties "
"with valid values in order to use it here." ) );
}

mWmstGroup->setChecked( uri.contains( QStringLiteral( "allowTemporalUpdates" ) ) &&
uri.value( QStringLiteral( "allowTemporalUpdates" ), true ).toBool() );
}
}

void QgsRasterLayerProperties::staticTemporalRange_toggled( bool checked )
{
if ( checked )
{
mLabel->clear();
}
}

void QgsRasterLayerProperties::passProjectTemporalRange_toggled( bool checked )
{
if ( checked )
{
QgsDateTimeRange range;
if ( QgsProject::instance()->timeSettings() )
range = QgsProject::instance()->timeSettings()->temporalRange();

if ( range.begin().isValid() && range.end().isValid() )
mLabel->setText( tr( "Project temporal range is set from %1 to %2" ).arg(
range.begin().toString( "yyyy-MM-dd HH:mm:ss" ),
range.end().toString( "yyyy-MM-dd HH:mm:ss" )
) );
else
mLabel->setText( tr( "Project temporal range is not valid, can't use it here" ) );
}
}

void QgsRasterLayerProperties::temporalPropertiesChange()
{
mWmstOptions->setEnabled( !mRasterLayer->temporalProperties()->isActive() );

if ( mRasterLayer->temporalProperties()->isActive() )
mWmstOptionsLabel->setText( tr( "The static temporal options below are disabled because the layer "
"temporal properties are active, to enable them disable temporal properties "
"in the temporal tab. " ) );
else
mWmstOptionsLabel->clear();
}

void QgsRasterLayerProperties::mLayerOrigNameLineEd_textEdited( const QString &text )
Expand Down Expand Up @@ -1876,11 +1658,6 @@ void QgsRasterLayerProperties::optionsStackedWidget_CurrentChanged( int index )
}
}

void QgsRasterLayerProperties::setEndAsStartStaticButton_clicked()
{
mEndStaticDateTimeEdit->setDateTime( mStartStaticDateTimeEdit->dateTime() );
}

void QgsRasterLayerProperties::pbnImportTransparentPixelValues_clicked()
{
int myLineCounter = 0;
Expand Down
26 changes: 0 additions & 26 deletions src/gui/raster/qgsrasterlayerproperties.h
View file
Expand Up @@ -114,18 +114,6 @@ class GUI_EXPORT QgsRasterLayerProperties : public QgsOptionsDialogBase, private
//! \brief slot executed when user presses "Remove Selected Row" button on the transparency page
void pbnRemoveSelectedRow_clicked();

//! \brief slot executed when user "Set end same as start" button on time options in source page.
void setEndAsStartStaticButton_clicked();

//! \brief slot executed when user "Pass provider temporal range" radio button on time options in source page.
void passProjectTemporalRange_toggled( bool checked );

//! \brief slot executed when user "Static time range" radio button on time options in source page.
void staticTemporalRange_toggled( bool checked );

//! \brief slot executed when temporal properties status change.
void temporalPropertiesChange();

/**
* \brief slot executed when the single band radio button is pressed.
* \brief slot executed when the reset null value to file default icon is selected
Expand Down Expand Up @@ -248,20 +236,6 @@ class GUI_EXPORT QgsRasterLayerProperties : public QgsOptionsDialogBase, private
*/
void updateInformationContent();

/**
* Updates the layers date source URI with the new time.
*
* \since QGIS 3.14
*/
void updateSourceStaticTime();

/**
* Initializes the layers static time inputs state.
*
* \since QGIS 3.14
*/
void setSourceStaticTimeState();

void setupTransparencyTable( int nBands );

//! \brief Clear the current transparency table and populate the table with the correct types for current drawing mode and data type
Expand Down
7 changes: 5 additions & 2 deletions src/gui/raster/qgsrasterlayertemporalpropertieswidget.cpp
View file
Expand Up @@ -31,7 +31,10 @@ QgsRasterLayerTemporalPropertiesWidget::QgsRasterLayerTemporalPropertiesWidget(
Q_ASSERT( mLayer );
setupUi( this );

mExtraWidgetContainer->setLayout( new QVBoxLayout() );
mExtraWidgetLayout = new QVBoxLayout();
mExtraWidgetLayout->setContentsMargins( 0, 0, 0, 0 );
mExtraWidgetLayout->addStretch();
mExtraWidgetContainer->setLayout( mExtraWidgetLayout );

connect( mModeFixedRangeRadio, &QRadioButton::toggled, mFixedTimeRangeFrame, &QWidget::setEnabled );

Expand Down Expand Up @@ -96,5 +99,5 @@ void QgsRasterLayerTemporalPropertiesWidget::syncToLayer()
void QgsRasterLayerTemporalPropertiesWidget::addWidget( QgsMapLayerConfigWidget *widget )
{
mExtraWidgets << widget;
mExtraWidgetContainer->layout()->addWidget( widget );
mExtraWidgetLayout->insertWidget( mExtraWidgetLayout->count() - 1, widget );
}
1 change: 1 addition & 0 deletions src/gui/raster/qgsrasterlayertemporalpropertieswidget.h
View file
Expand Up @@ -65,6 +65,7 @@ class GUI_EXPORT QgsRasterLayerTemporalPropertiesWidget : public QWidget, privat
* The corresponding map layer with temporal attributes
*/
QgsRasterLayer *mLayer = nullptr;
QVBoxLayout *mExtraWidgetLayout = nullptr;

QList< QgsMapLayerConfigWidget * > mExtraWidgets;

Expand Down
12 changes: 10 additions & 2 deletions src/providers/wms/CMakeLists.txt
View file
Expand Up @@ -11,14 +11,16 @@ if (WITH_GUI)
qgswmsprovidergui.cpp
qgswmssourceselect.cpp
qgswmsdataitemguiproviders.cpp
qgswmstsettingswidget.cpp
qgstilescalewidget.cpp
qgswmtsdimensions.cpp
qgsxyzconnectiondialog.cpp
qgsxyzsourceselect.cpp
qgsxyzsourcewidget.cpp
)
endif()

set(WMS_UIS qgswmstsettingswidgetbase.ui)
endif()

# static library
add_library(wmsprovider_a STATIC ${WMS_SRCS})
Expand All @@ -27,7 +29,13 @@ add_library(wmsprovider_a STATIC ${WMS_SRCS})
target_compile_features(wmsprovider_a PRIVATE cxx_std_17)

if (WITH_GUI)
add_library(wmsprovider_gui_a STATIC ${WMS_GUI_SRCS})
include_directories (
${CMAKE_BINARY_DIR}/src/providers/wms
)

QT5_WRAP_UI(WMS_UIS_H ${WMS_UIS})

add_library(wmsprovider_gui_a STATIC ${WMS_GUI_SRCS} ${WMS_UIS_H})

# require c++17
target_compile_features(wmsprovider_gui_a PRIVATE cxx_std_17)
Expand Down
7 changes: 7 additions & 0 deletions src/providers/wms/qgswmsprovidergui.cpp
View file
Expand Up @@ -24,6 +24,7 @@
#include "qgswmsdataitems.h"
#include "qgsprovidersourcewidgetprovider.h"
#include "qgsxyzsourcewidget.h"
#include "qgswmstsettingswidget.h"

//! Provider for WMS layers source select
class QgsWmsSourceSelectProvider : public QgsSourceSelectProvider
Expand Down Expand Up @@ -90,6 +91,7 @@ class QgsXyzSourceWidgetProvider : public QgsProviderSourceWidgetProvider
QgsWmsProviderGuiMetadata::QgsWmsProviderGuiMetadata()
: QgsProviderGuiMetadata( QgsWmsProvider::WMS_KEY )
{
mWmstConfigWidgetFactory = std::make_unique< QgsWmstSettingsConfigWidgetFactory > () ;
}

QList<QgsSourceSelectProvider *> QgsWmsProviderGuiMetadata::sourceSelectProviders()
Expand Down Expand Up @@ -118,6 +120,11 @@ void QgsWmsProviderGuiMetadata::registerGui( QMainWindow *widget )
QgsTileScaleWidget::showTileScale( widget );
}

QList<const QgsMapLayerConfigWidgetFactory *> QgsWmsProviderGuiMetadata::mapLayerConfigWidgetFactories()
{
return { mWmstConfigWidgetFactory.get() };
}

#ifndef HAVE_STATIC_PROVIDERS
QGISEXTERN QgsProviderGuiMetadata *providerGuiMetadataFactory()
{
Expand Down
6 changes: 6 additions & 0 deletions src/providers/wms/qgswmsprovidergui.h
View file
Expand Up @@ -31,6 +31,12 @@ class QgsWmsProviderGuiMetadata: public QgsProviderGuiMetadata
QList<QgsProviderSourceWidgetProvider *> sourceWidgetProviders() override;

void registerGui( QMainWindow *widget ) override;
QList<const QgsMapLayerConfigWidgetFactory *> mapLayerConfigWidgetFactories() override;

private:

std::unique_ptr< QgsMapLayerConfigWidgetFactory > mWmstConfigWidgetFactory;

};

#endif // QGSWMSPROVIDERGUI_H

0 comments on commit 65c78aa

Please sign in to comment.