ResInsight/ApplicationLibCode/ProjectDataModel/RimCellEdgeColors.h
2023-05-11 08:37:58 +02:00

134 lines
4.4 KiB
C++

/////////////////////////////////////////////////////////////////////////////////
//
// Copyright (C) 2011- Statoil ASA
// Copyright (C) 2013- Ceetron Solutions AS
// Copyright (C) 2011-2012 Ceetron AS
//
// 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.
//
/////////////////////////////////////////////////////////////////////////////////
#pragma once
#include "RigCaseCellResultsData.h"
#include "RigEclipseResultAddress.h"
#include "cafAppEnum.h"
#include "cafPdmChildField.h"
#include "cafPdmField.h"
#include "cafPdmObject.h"
#include <array>
class RigCaseCellResultsData;
class RimEclipseCase;
class RimEclipseCellColors;
class RimEclipseView;
class RimRegularLegendConfig;
class RimCellEdgeMetaData
{
public:
RigEclipseResultAddress m_eclipseResultAddress;
QString m_resultVariable;
bool m_isStatic;
};
//==================================================================================================
///
///
//==================================================================================================
class RimCellEdgeColors : public caf::PdmObject
{
CAF_PDM_HEADER_INIT;
public:
RimCellEdgeColors();
~RimCellEdgeColors() override;
enum EdgeFaceType
{
X,
NEG_X,
Y,
NEG_Y,
Z,
NEG_Z
};
enum PropertyType
{
MULTI_AXIS_STATIC_PROPERTY,
CUSTOM_PROPERTIES
};
using EdgeFaceEnum = caf::AppEnum<RimCellEdgeColors::EdgeFaceType>;
void setReservoirView( RimEclipseView* ownerReservoirView );
void setResultVariable( const QString& variableName );
QString resultVariableUiShortName() const;
void setActive( bool active );
double ignoredScalarValue() { return m_ignoredResultScalar; }
std::array<RigEclipseResultAddress, 6> resultAddresses() const;
void cellEdgeMetaData( std::vector<RimCellEdgeMetaData>* metaData );
void loadResult();
bool hasResult() const;
bool showTextResult() const;
bool isUserDefinedPropertiesActive() const;
RimRegularLegendConfig* legendConfig();
PropertyType propertyType() const;
void minMaxCellEdgeValues( double& min, double& max );
void posNegClosestToZero( double& pos, double& neg );
protected:
void initAfterRead() override;
void fieldChangedByUi( const caf::PdmFieldHandle* changedField, const QVariant& oldValue, const QVariant& newValue ) override;
QList<caf::PdmOptionItemInfo> calculateValueOptions( const caf::PdmFieldHandle* fieldNeedingOptions ) override;
void defineUiOrdering( QString uiConfigName, caf::PdmUiOrdering& uiOrdering ) override;
void defineUiTreeOrdering( caf::PdmUiTreeOrdering& uiTreeOrdering, QString uiConfigName = "" ) override;
QStringList findResultVariableNames();
private:
void resetResultAddresses();
void updateIgnoredScalarValue();
void gridScalarResultNames( std::vector<QString>* resultNames );
caf::PdmFieldHandle* objectToggleField() override;
caf::PdmField<bool> m_enableCellEdgeColors;
caf::PdmField<QString> m_resultVariable;
caf::PdmField<bool> useXVariable;
caf::PdmField<bool> useYVariable;
caf::PdmField<bool> useZVariable;
std::array<std::pair<QString, RigEclipseResultAddress>, 6> m_resultNameToAddressPairs;
caf::PdmPointer<RimEclipseView> m_reservoirView;
double m_ignoredResultScalar;
caf::PdmField<caf::AppEnum<PropertyType>> m_propertyType;
caf::PdmChildField<RimRegularLegendConfig*> m_legendConfig;
caf::PdmField<std::vector<QString>> m_selectedKeywords;
caf::PdmField<bool> m_showTextValuesIfItemIsUnchecked;
// Obsolete fields
caf::PdmChildField<RimEclipseCellColors*> m_singleVarEdgeResultColors_OBSOLETE;
};