mirror of
https://github.com/OPM/ResInsight.git
synced 2026-11-22 05:48:13 -06:00
Review follow-up for #15127: onProjectBeingSaved() returns false when the surface has data that could not be written, and saveProjectAs() then fails with a message naming the surface before the project file is written, so a write error no longer reports a successful save with the surface data lost.
289 lines
11 KiB
C++
289 lines
11 KiB
C++
/////////////////////////////////////////////////////////////////////////////////
|
|
//
|
|
// Copyright (C) 2026- Equinor 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 "RimTriangulatedSurface.h"
|
|
|
|
#include "RiaLogging.h"
|
|
#include "RiaQStringFormatter.h"
|
|
|
|
#include "RimProject.h"
|
|
|
|
#include "RifSurfaceExporter.h"
|
|
#include "RifSurfaceImporter.h"
|
|
|
|
#include "Surface/RigSurface.h"
|
|
#include "Surface/RigTriangleMeshData.h"
|
|
|
|
#include "cafPdmFieldScriptingCapability.h"
|
|
#include "cafPdmObjectScriptingCapability.h"
|
|
|
|
#include <QDir>
|
|
#include <QFileInfo>
|
|
#include <QRegularExpression>
|
|
#include <QUuid>
|
|
|
|
#include <algorithm>
|
|
|
|
CAF_PDM_SOURCE_INIT( RimTriangulatedSurface, "TriangulatedSurface" );
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
RimTriangulatedSurface::RimTriangulatedSurface()
|
|
: m_hasUnsavedChanges( false )
|
|
{
|
|
CAF_PDM_InitScriptableObject( "Triangulated Surface", ":/ReservoirSurface16x16.png" );
|
|
|
|
CAF_PDM_InitFieldNoDefault( &m_surfaceFilePath, "SurfaceFilePath", "File" );
|
|
m_surfaceFilePath.uiCapability()->setUiReadOnly( true );
|
|
|
|
// Created once, so every save of the project writes the same file
|
|
CAF_PDM_InitFieldNoDefault( &m_fileId, "FileId", "File Id" );
|
|
m_fileId.uiCapability()->setUiHidden( true );
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
RimTriangulatedSurface::~RimTriangulatedSurface()
|
|
{
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
bool RimTriangulatedSurface::onLoadData()
|
|
{
|
|
return updateSurfaceData();
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
RimSurface* RimTriangulatedSurface::createCopy()
|
|
{
|
|
if ( !m_triangleMeshData ) loadDataFromFile();
|
|
|
|
auto newSurface = copyObject<RimTriangulatedSurface>();
|
|
if ( m_triangleMeshData ) newSurface->m_triangleMeshData = std::make_unique<RigTriangleMeshData>( *m_triangleMeshData );
|
|
|
|
// The copy gets a file of its own when the project is saved
|
|
newSurface->m_fileId = QString();
|
|
newSurface->m_surfaceFilePath = QString();
|
|
newSurface->m_hasUnsavedChanges = true;
|
|
|
|
if ( !newSurface->onLoadData() )
|
|
{
|
|
delete newSurface;
|
|
return nullptr;
|
|
}
|
|
|
|
return newSurface;
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
void RimTriangulatedSurface::setGeometry( const std::vector<cvf::Vec3d>& vertices, const std::vector<unsigned>& triangleIndices )
|
|
{
|
|
// Properties are per vertex, so a new geometry removes them
|
|
m_triangleMeshData = std::make_unique<RigTriangleMeshData>();
|
|
m_triangleMeshData->setGeometryData( vertices, triangleIndices );
|
|
m_hasUnsavedChanges = true;
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
void RimTriangulatedSurface::setProperty( const QString& key, const std::vector<float>& values )
|
|
{
|
|
if ( !m_triangleMeshData ) return;
|
|
CAF_ASSERT( values.size() == vertexCount() );
|
|
|
|
auto names = m_triangleMeshData->propertyNames();
|
|
std::vector<std::vector<float>> propertyValues;
|
|
for ( const auto& name : names )
|
|
{
|
|
propertyValues.push_back( m_triangleMeshData->propertyValues( name ) );
|
|
}
|
|
|
|
auto it = std::find( names.begin(), names.end(), key );
|
|
if ( it != names.end() )
|
|
{
|
|
propertyValues[std::distance( names.begin(), it )] = values;
|
|
}
|
|
else
|
|
{
|
|
names.push_back( key );
|
|
propertyValues.push_back( values );
|
|
}
|
|
|
|
m_triangleMeshData->setPropertyData( names, propertyValues );
|
|
m_hasUnsavedChanges = true;
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
size_t RimTriangulatedSurface::vertexCount() const
|
|
{
|
|
if ( !m_triangleMeshData ) return 0;
|
|
|
|
return m_triangleMeshData->geometry().first.size();
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
std::vector<float> RimTriangulatedSurface::getProperty( const QString& key ) const
|
|
{
|
|
if ( !m_triangleMeshData ) return {};
|
|
|
|
return m_triangleMeshData->propertyValues( key );
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
std::vector<QString> RimTriangulatedSurface::propertyNames() const
|
|
{
|
|
if ( !m_triangleMeshData ) return {};
|
|
|
|
return m_triangleMeshData->propertyNames();
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
/// Write the surface to the project folder before the project file is written. Returns false when the surface has data
|
|
/// that could not be written, so the project save can fail instead of losing the data.
|
|
//--------------------------------------------------------------------------------------------------
|
|
bool RimTriangulatedSurface::onProjectBeingSaved()
|
|
{
|
|
if ( !m_triangleMeshData ) loadDataFromFile();
|
|
if ( !m_triangleMeshData || m_triangleMeshData->geometry().first.empty() ) return true;
|
|
|
|
const QString fileName = fileNameInProjectFolder();
|
|
if ( fileName.isEmpty() )
|
|
{
|
|
RiaLogging::error( std::format( "Could not create the surface folder for '{}' in the project folder", m_userDescription() ) );
|
|
return false;
|
|
}
|
|
|
|
auto [vertices, triangleIndices] = m_triangleMeshData->geometry();
|
|
|
|
auto names = m_triangleMeshData->propertyNames();
|
|
std::vector<std::vector<float>> propertyValues;
|
|
for ( const auto& name : names )
|
|
{
|
|
propertyValues.push_back( m_triangleMeshData->propertyValues( name ) );
|
|
}
|
|
|
|
if ( !RifSurfaceExporter::writeGocadTSurfFile( fileName, m_userDescription(), vertices, triangleIndices, names, propertyValues ) )
|
|
{
|
|
RiaLogging::error( std::format( "Could not write surface '{}' to {}", m_userDescription(), fileName ) );
|
|
return false;
|
|
}
|
|
|
|
m_surfaceFilePath = fileName;
|
|
m_hasUnsavedChanges = false;
|
|
|
|
return true;
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
/// Returns false for fatal failure
|
|
//--------------------------------------------------------------------------------------------------
|
|
bool RimTriangulatedSurface::updateSurfaceData()
|
|
{
|
|
bool result = true;
|
|
if ( !m_triangleMeshData )
|
|
{
|
|
result = loadDataFromFile();
|
|
}
|
|
|
|
if ( !m_triangleMeshData ) return false;
|
|
|
|
auto [vertices, triangleIndices] = m_triangleMeshData->geometry();
|
|
|
|
auto surface = new RigSurface;
|
|
if ( !vertices.empty() && !triangleIndices.empty() )
|
|
{
|
|
RimSurface::applyDepthOffsetIfNeeded( &vertices );
|
|
|
|
surface->setTriangleData( triangleIndices, vertices );
|
|
}
|
|
|
|
for ( const auto& name : m_triangleMeshData->propertyNames() )
|
|
{
|
|
auto values = m_triangleMeshData->propertyValues( name );
|
|
surface->addVertexResult( name, values );
|
|
}
|
|
|
|
setSurfaceData( surface );
|
|
|
|
return result;
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
void RimTriangulatedSurface::clearCachedNativeData()
|
|
{
|
|
// Only drop data that can be read back from the file: the geometry exists only in memory until the project is
|
|
// saved, and changes made after the last save are not in the file yet
|
|
if ( m_hasUnsavedChanges || m_surfaceFilePath().path().isEmpty() ) return;
|
|
|
|
m_triangleMeshData.reset();
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
bool RimTriangulatedSurface::loadDataFromFile()
|
|
{
|
|
QString path = m_surfaceFilePath().path();
|
|
if ( path.isEmpty() ) return false;
|
|
|
|
m_triangleMeshData = std::make_unique<RigTriangleMeshData>();
|
|
RifSurfaceImporter::readGocadFile( path, m_triangleMeshData.get() );
|
|
|
|
return !( m_triangleMeshData->geometry().first.empty() );
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
/// <project folder>/<project name>_surfaces/<surface name>_<file id>.ts
|
|
///
|
|
/// The file id keeps surfaces with names that sanitize to the same string apart, and keeps the files of this project
|
|
/// apart from a project saved under another name in the same folder. The file id is kept stable once assigned.
|
|
//--------------------------------------------------------------------------------------------------
|
|
QString RimTriangulatedSurface::fileNameInProjectFolder()
|
|
{
|
|
const QString projectFileName = RimProject::current() ? RimProject::current()->fileName() : QString();
|
|
if ( projectFileName.isEmpty() ) return {};
|
|
|
|
if ( m_fileId().isEmpty() ) m_fileId = QUuid::createUuid().toString( QUuid::WithoutBraces ).left( 8 );
|
|
|
|
QString name = m_userDescription();
|
|
name.replace( QRegularExpression( "[^A-Za-z0-9._-]" ), "_" );
|
|
|
|
const QFileInfo projectFileInfo( projectFileName );
|
|
QDir surfaceDir( projectFileInfo.dir().absoluteFilePath( projectFileInfo.completeBaseName() + "_surfaces" ) );
|
|
if ( !surfaceDir.mkpath( "." ) ) return {};
|
|
|
|
return surfaceDir.absoluteFilePath( name + "_" + m_fileId() + ".ts" );
|
|
}
|