#5583 Add data model object and ui for RimElementVectorResult.

2025-02-25 18:55:39 -06:00 · 2020-02-27 13:35:14 +01:00
parent dde5d09791
commit eb97ee0de8
5 changed files with 555 additions and 0 deletions
--- a/ApplicationCode/ProjectDataModel/RimElementVectorResult.h
+++ b/ApplicationCode/ProjectDataModel/RimElementVectorResult.h
@@ -0,0 +1,112 @@
+/////////////////////////////////////////////////////////////////////////////////
+//
+//  Copyright (C) 2020-     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.
+//
+/////////////////////////////////////////////////////////////////////////////////
+
+#pragma once
+
+#include "cafPdmChildField.h"
+#include "cafPdmField.h"
+#include "cafPdmFieldCvfColor.h" // Include to make Pdm work for cvf::Color
+#include "cafPdmObject.h"
+
+#include "RigEclipseResultAddress.h"
+
+#include "RimRegularLegendConfig.h"
+
+#include <QList>
+
+#include <vector>
+
+class RimRegularLegendConfig;
+
+class RiuViewer;
+
+//==================================================================================================
+///
+///
+//==================================================================================================
+class RimElementVectorResult : public caf::PdmObject
+{
+    CAF_PDM_HEADER_INIT;
+
+public:
+    enum TensorColors
+    {
+        UNIFORM_COLOR,
+        RESULT_COLORS
+    };
+
+    enum ScaleMethod
+    {
+        RESULT,
+        CONSTANT
+    };
+
+public:
+    RimElementVectorResult();
+    ~RimElementVectorResult() override;
+
+    void         setShowResult( bool enableResult );
+    bool         showResult() const;
+    bool         showVectorI() const;
+    bool         showVectorJ() const;
+    bool         showVectorK() const;
+    float        threshold() const;
+    float        sizeScale() const;
+    TensorColors vectorColors() const;
+    ScaleMethod  scaleMethod() const;
+
+    const cvf::Color3f&           getUniformVectorColor() const;
+    const RimRegularLegendConfig* legendConfig() const;
+
+    void mappingRange( double& min, double& max ) const;
+
+    RigEclipseResultAddress resultAddressCombined() const;
+    bool                    resultAddressIJK( std::vector<RigEclipseResultAddress>& addresses ) const;
+
+    QString resultName() const;
+
+    void updateLegendRangesTextAndVisibility( RiuViewer* nativeOrOverrideViewer, bool isUsingOverrideViewer );
+
+private:
+    std::vector<std::string>      getResultMetaDataForUIFieldSetting();
+    void                          fieldChangedByUi( const caf::PdmFieldHandle* changedField, const QVariant& oldValue, const QVariant& newValue ) override;
+    caf::PdmFieldHandle*          objectToggleField() override;
+    QList<caf::PdmOptionItemInfo> calculateValueOptions( const caf::PdmFieldHandle* fieldNeedingOptions,
+                                                         bool*                      useOptionsOnly ) override;
+    void                          defineUiOrdering( QString uiConfigName, caf::PdmUiOrdering& uiOrdering ) override;
+    void                          defineEditorAttribute( const caf::PdmFieldHandle* field,
+                                                         QString                    uiConfigName,
+                                                         caf::PdmUiEditorAttribute* attribute ) override;
+    void defineUiTreeOrdering( caf::PdmUiTreeOrdering& uiTreeOrdering, QString uiConfigName = "" ) override;
+
+    static QString fieldNameFromUi( const QString& uiFieldName );
+
+private:
+    caf::PdmField<bool>                                  m_showResult;
+    caf::PdmField<QString>                               m_resultName;
+    caf::PdmField<bool>                                  m_showVectorI;
+    caf::PdmField<bool>                                  m_showVectorJ;
+    caf::PdmField<bool>                                  m_showVectorK;
+    caf::PdmField<float>                                 m_threshold;
+    caf::PdmField<caf::AppEnum<TensorColors>>            m_vectorColor;
+    caf::PdmField<cvf::Color3f>                          m_uniformVectorColor;
+    caf::PdmField<caf::AppEnum<ScaleMethod>>             m_scaleMethod;
+    caf::PdmField<float>                                 m_sizeScale;
+    caf::PdmField<RimRegularLegendConfig::RangeModeEnum> m_rangeMode;
+    caf::PdmChildField<RimRegularLegendConfig*>          m_legendConfig;
+};