mirror of
https://github.com/OPM/ResInsight.git
synced 2026-10-25 06:38:13 -05:00
Kristian Bendiksen
77c32a3fa5
- Add RimViewWindow_exportSnapshot on RimViewWindow (3D views and plots) with explicit ExportFolder, Prefix, Width, Height and FileFormat parameters. Generated as ViewWindow.export_snapshot(). - Add RimProject_exportSnapshots for exporting all views and/or plots with a ContentType parameter. Generated as Project.export_snapshots(). - Add RiaDefines::SnapshotFileFormat and SnapshotContentType enums, registered as Python StrEnums. - Extract single-item exportSnapshotOfView()/exportSnapshotOfPlot() from the RicSnapshotAll*ToFileFeature loops so the object methods and the legacy loops share the implementation. - RicfExportSnapshots resolves the export folder from the command file executor and forwards to the object methods. Python: the hand-written ViewWindow.export_snapshot() wrapper is removed (generated method is compatible). PlotWindow.export_snapshot() and Project.export_snapshots() keep their legacy argument names (file_prefix, output_format, snapshot_type, plot_format) as deprecated aliases. Case.export_snapshots_of_all_views() is deprecated in favor of View.export_snapshot(). Also fix Case.views(), which compared the view id to the case id and therefore never returned any views.
164 lines
6.6 KiB
C++
164 lines
6.6 KiB
C++
/////////////////////////////////////////////////////////////////////////////////
|
|
//
|
|
// Copyright (C) 2016 Statoil ASA
|
|
//
|
|
// ResInsight is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// ResInsight is distributed in the hope that it will be useful, but WITHOUT ANY
|
|
// WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
|
// FITNESS FOR A PARTICULAR PURPOSE.
|
|
//
|
|
// See the GNU General Public License at <http://www.gnu.org/licenses/gpl.html>
|
|
// for more details.
|
|
//
|
|
/////////////////////////////////////////////////////////////////////////////////
|
|
|
|
#include "RicSnapshotAllPlotsToFileFeature.h"
|
|
|
|
#include "RiaGuiApplication.h"
|
|
#include "RiaLogging.h"
|
|
|
|
#include "RimMainPlotCollection.h"
|
|
#include "RimProject.h"
|
|
#include "RimViewWindow.h"
|
|
|
|
#include "RicSnapshotFilenameGenerator.h"
|
|
#include "RicSnapshotViewToFileFeature.h"
|
|
|
|
#include "RiuPlotMainWindowTools.h"
|
|
|
|
#include "cafUtils.h"
|
|
|
|
#include <QAction>
|
|
#include <QClipboard>
|
|
#include <QDebug>
|
|
#include <QDir>
|
|
#include <QFileInfo>
|
|
|
|
CAF_CMD_SOURCE_INIT( RicSnapshotAllPlotsToFileFeature, "RicSnapshotAllPlotsToFileFeature" );
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
void RicSnapshotAllPlotsToFileFeature::saveAllPlots()
|
|
{
|
|
RiaGuiApplication* app = RiaGuiApplication::instance();
|
|
|
|
RiuPlotMainWindow* mainPlotWindow = app->mainPlotWindow();
|
|
if ( !mainPlotWindow ) return;
|
|
|
|
RimProject* proj = app->project();
|
|
if ( !proj ) return;
|
|
|
|
// Save images in snapshot catalog relative to project directory
|
|
QString snapshotFolderName = app->createAbsolutePathFromProjectRelativePath( "snapshots" );
|
|
|
|
// save using existing plot sizes
|
|
exportSnapshotOfPlotsIntoFolder( snapshotFolderName, -1, -1, true /* activateWidget */ );
|
|
|
|
QString text = QString( "Exported snapshots to folder : \n%1" ).arg( snapshotFolderName );
|
|
RiaLogging::info( text.toStdString() );
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
void RicSnapshotAllPlotsToFileFeature::exportSnapshotOfPlotsIntoFolder( const QString& snapshotFolderName,
|
|
int width,
|
|
int height,
|
|
bool activateWidget,
|
|
const QString& prefix,
|
|
int viewId,
|
|
const QString& preferredFileSuffix /*=".png"*/ )
|
|
{
|
|
RiaApplication* app = RiaApplication::instance();
|
|
|
|
RimProject* proj = app->project();
|
|
if ( !proj ) return;
|
|
|
|
QDir snapshotPath( snapshotFolderName );
|
|
if ( !snapshotPath.exists() )
|
|
{
|
|
if ( !snapshotPath.mkpath( "." ) ) return;
|
|
}
|
|
|
|
std::vector<RimViewWindow*> viewWindows = RimMainPlotCollection::current()->descendantsIncludingThisOfType<RimViewWindow>();
|
|
for ( auto viewWindow : viewWindows )
|
|
{
|
|
if ( viewWindow->isMainDockedWindow() && viewWindow->viewWidget() && ( viewId == -1 || viewId == viewWindow->id() ) )
|
|
{
|
|
exportSnapshotOfPlot( viewWindow, snapshotPath.absolutePath(), width, height, activateWidget, prefix, preferredFileSuffix );
|
|
}
|
|
}
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
/// Export a snapshot of a single plot window into the given folder. The folder is created if it does not exist.
|
|
/// <= 0 for width and height means to use the existing size
|
|
//--------------------------------------------------------------------------------------------------
|
|
void RicSnapshotAllPlotsToFileFeature::exportSnapshotOfPlot( RimViewWindow* viewWindow,
|
|
const QString& snapshotFolderName,
|
|
int width,
|
|
int height,
|
|
bool activateWidget,
|
|
const QString& prefix,
|
|
const QString& preferredFileSuffix )
|
|
{
|
|
if ( !viewWindow ) return;
|
|
|
|
QDir snapshotPath( snapshotFolderName );
|
|
if ( !snapshotPath.exists() )
|
|
{
|
|
if ( !snapshotPath.mkpath( "." ) ) return;
|
|
}
|
|
|
|
QString fileName = RicSnapshotFilenameGenerator::generateSnapshotFileName( viewWindow );
|
|
if ( !prefix.isEmpty() )
|
|
{
|
|
fileName = prefix + fileName;
|
|
}
|
|
|
|
fileName.replace( " ", "_" );
|
|
|
|
if ( activateWidget )
|
|
{
|
|
RiuPlotMainWindowTools::selectAsCurrentItem( viewWindow );
|
|
QApplication::processEvents();
|
|
}
|
|
|
|
QString absoluteFileName = caf::Utils::constructFullFileName( snapshotPath.absolutePath(), fileName, preferredFileSuffix );
|
|
|
|
RicSnapshotViewToFileFeature::saveSnapshotAs( absoluteFileName, viewWindow, width, height );
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
void RicSnapshotAllPlotsToFileFeature::onActionTriggered( bool isChecked )
|
|
{
|
|
QString currentActiveViewerName;
|
|
if ( RiaGuiApplication::activeViewWindow() )
|
|
{
|
|
currentActiveViewerName = RiaGuiApplication::activeViewWindow()->dockWindowName();
|
|
}
|
|
|
|
RicSnapshotAllPlotsToFileFeature::saveAllPlots();
|
|
|
|
if ( !currentActiveViewerName.isEmpty() )
|
|
{
|
|
RiuPlotMainWindowTools::setActiveViewer( currentActiveViewerName );
|
|
}
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
void RicSnapshotAllPlotsToFileFeature::setupActionLook( QAction* actionToSetup )
|
|
{
|
|
actionToSetup->setText( "Snapshot All Plots To File" );
|
|
actionToSetup->setIcon( QIcon( ":/SnapShotSaveViews.svg" ) );
|
|
}
|