#3868 Annotations. Draw spheres on polylines + toggles conotrolling visibility

ApplicationCode/ProjectDataModel/Annotations/CMakeLists_files.cmake

@@ -10,7 +10,6 @@ ${CMAKE_CURRENT_LIST_DIR}/RimTextAnnotation.h
 ${CMAKE_CURRENT_LIST_DIR}/RimAnnotationInViewCollection.h
 ${CMAKE_CURRENT_LIST_DIR}/RimAnnotationLineAppearance.h
 ${CMAKE_CURRENT_LIST_DIR}/RimAnnotationTextAppearance.h
-${CMAKE_CURRENT_LIST_DIR}/RimLineBasedAnnotation.h
 ${CMAKE_CURRENT_LIST_DIR}/RimPolylinesFromFileAnnotationInView.h
 ${CMAKE_CURRENT_LIST_DIR}/RimUserDefinedPolylinesAnnotationInView.h
 ${CMAKE_CURRENT_LIST_DIR}/RimPolylinesAnnotationInView.h
@@ -31,7 +30,6 @@ ${CMAKE_CURRENT_LIST_DIR}/RimTextAnnotation.cpp
 ${CMAKE_CURRENT_LIST_DIR}/RimAnnotationInViewCollection.cpp
 ${CMAKE_CURRENT_LIST_DIR}/RimAnnotationLineAppearance.cpp
 ${CMAKE_CURRENT_LIST_DIR}/RimAnnotationTextAppearance.cpp
-${CMAKE_CURRENT_LIST_DIR}/RimLineBasedAnnotation.cpp
 ${CMAKE_CURRENT_LIST_DIR}/RimPolylinesFromFileAnnotationInView.cpp
 ${CMAKE_CURRENT_LIST_DIR}/RimUserDefinedPolylinesAnnotationInView.cpp
 ${CMAKE_CURRENT_LIST_DIR}/RimPolylinesAnnotationInView.cpp

ApplicationCode/ProjectDataModel/Annotations/RimAnnotationCollection.cpp

@@ -26,6 +26,7 @@
 #include "RimReachCircleAnnotation.h"
 #include "RimPolylinesFromFileAnnotation.h"
 #include "RimUserDefinedPolylinesAnnotation.h"
+#include "RimAnnotationLineAppearance.h"
 
 #include "RimProject.h"
 #include "RimGridView.h"

ApplicationCode/ProjectDataModel/Annotations/RimAnnotationLineAppearance.cpp

@@ -40,10 +40,10 @@ CAF_PDM_SOURCE_INIT(RimAnnotationLineAppearance, "RimAnnotationLineAppearance");
 //--------------------------------------------------------------------------------------------------
 RimAnnotationLineAppearance::RimAnnotationLineAppearance()
 {
-    CAF_PDM_InitObject("TextAnnotation", ":/WellCollection.png", "", "");
+    CAF_PDM_InitObject("AnnotationLineAppearance", ":/WellCollection.png", "", "");
 
-    CAF_PDM_InitField(&m_color,     "Color",     cvf::Color3f(cvf::Color3f::BLACK),  "Color", "", "", "");
-    CAF_PDM_InitField(&m_thickness, "Thickness", 2,                                  "Thickness", "", "", "");
+    CAF_PDM_InitField(&m_color,     "Color",     cvf::Color3f(cvf::Color3f::BLACK),  "Line Color", "", "", "");
+    CAF_PDM_InitField(&m_thickness, "Thickness", 2,                                  "Line Thickness", "", "", "");
 
     // Stippling not yet supported. Needs new stuff in VizFwk
     CAF_PDM_InitField(&m_style,     "Style",     LineStyle(),                        "Style", "", "", "");
@@ -107,3 +107,71 @@ void RimAnnotationLineAppearance::fieldChangedByUi(const caf::PdmFieldHandle* ch
     this->firstAncestorOrThisOfTypeAsserted(annColl);
     annColl->scheduleRedrawOfRelevantViews(); 
 }
+
+CAF_PDM_SOURCE_INIT(RimPolylineAppearance, "RimPolylineAppearance");
+
+//--------------------------------------------------------------------------------------------------
+///
+//--------------------------------------------------------------------------------------------------
+RimPolylineAppearance::RimPolylineAppearance()
+{
+    CAF_PDM_InitObject("PolylineAppearance", ":/WellCollection.png", "", "");
+
+    CAF_PDM_InitField(&m_sphereColor, "SphereColor", cvf::Color3f(cvf::Color3f::BLACK), "Sphere Color", "", "", "");
+    CAF_PDM_InitField(&m_sphereRadius, "SphereRadius", 15, "Sphere Radius", "", "", "");
+}
+
+//--------------------------------------------------------------------------------------------------
+///
+//--------------------------------------------------------------------------------------------------
+void RimPolylineAppearance::setSphereColor(const cvf::Color3f& color)
+{
+    m_sphereColor = color;
+}
+
+//--------------------------------------------------------------------------------------------------
+///
+//--------------------------------------------------------------------------------------------------
+cvf::Color3f RimPolylineAppearance::sphereColor() const
+{
+    return m_sphereColor();
+}
+
+//--------------------------------------------------------------------------------------------------
+///
+//--------------------------------------------------------------------------------------------------
+void RimPolylineAppearance::setSphereRadius(int radius)
+{
+    m_sphereRadius = radius;
+}
+
+//--------------------------------------------------------------------------------------------------
+///
+//--------------------------------------------------------------------------------------------------
+int RimPolylineAppearance::sphereRadius() const
+{
+    return m_sphereRadius();
+}
+
+//--------------------------------------------------------------------------------------------------
+///
+//--------------------------------------------------------------------------------------------------
+void RimPolylineAppearance::defineUiOrdering(QString uiConfigName, caf::PdmUiOrdering& uiOrdering)
+{
+    RimAnnotationLineAppearance::defineUiOrdering(uiConfigName, uiOrdering);
+
+    uiOrdering.add(&m_sphereColor);
+    uiOrdering.add(&m_sphereRadius);
+
+    uiOrdering.skipRemainingFields(true);
+}
+
+//--------------------------------------------------------------------------------------------------
+///
+//--------------------------------------------------------------------------------------------------
+void RimPolylineAppearance::fieldChangedByUi(const caf::PdmFieldHandle* changedField,
+                                             const QVariant&            oldValue,
+                                             const QVariant&            newValue)
+{
+    RimAnnotationLineAppearance::fieldChangedByUi(changedField, oldValue, newValue);
+}

ApplicationCode/ProjectDataModel/Annotations/RimAnnotationLineAppearance.h

@@ -60,3 +60,38 @@ private:
 
 };
 
+
+//==================================================================================================
+///
+///
+//==================================================================================================
+class RimReachCircleLineAppearance : public RimAnnotationLineAppearance
+{
+
+};
+
+
+//==================================================================================================
+///
+///
+//==================================================================================================
+class RimPolylineAppearance : public RimAnnotationLineAppearance
+{
+    CAF_PDM_HEADER_INIT;
+
+public:
+    RimPolylineAppearance();
+
+    void            setSphereColor(const cvf::Color3f& color);
+    cvf::Color3f    sphereColor() const;
+    void            setSphereRadius(int radius);
+    int             sphereRadius() const;
+
+protected:
+    void defineUiOrdering(QString uiConfigName, caf::PdmUiOrdering& uiOrdering) override;
+    void fieldChangedByUi(const caf::PdmFieldHandle* changedField, const QVariant& oldValue, const QVariant& newValue) override;
+
+private:
+    caf::PdmField<cvf::Color3f>     m_sphereColor;
+    caf::PdmField<int>              m_sphereRadius;
+};

ApplicationCode/ProjectDataModel/Annotations/RimLineBasedAnnotation.cpp

@@ -1,77 +0,0 @@
-/////////////////////////////////////////////////////////////////////////////////
-//
-//  Copyright (C) 2018-     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 "RimLineBasedAnnotation.h"
-
-#include "RimAnnotationLineAppearance.h"
-#include "RimAnnotationCollectionBase.h"
-
-
-CAF_PDM_SOURCE_INIT(RimLineBasedAnnotation, "RimLineBasedAnnotation");
-
-//--------------------------------------------------------------------------------------------------
-///
-//--------------------------------------------------------------------------------------------------
-RimLineBasedAnnotation::RimLineBasedAnnotation()
-{
-    CAF_PDM_InitFieldNoDefault(&m_appearance, "LineAppearance", "Line Appearance", "", "", "");
-
-    m_appearance = new RimAnnotationLineAppearance();
-    m_appearance.uiCapability()->setUiTreeHidden(true);
-    m_appearance.uiCapability()->setUiTreeChildrenHidden(true);
-
-    CAF_PDM_InitField(&m_isActive, "IsActive", true, "Is Active", "", "", "");
-    m_isActive.uiCapability()->setUiHidden(true);
-}
-
-//--------------------------------------------------------------------------------------------------
-///
-//--------------------------------------------------------------------------------------------------
-RimAnnotationLineAppearance* RimLineBasedAnnotation::appearance() const
-{
-    return m_appearance;
-}
-//--------------------------------------------------------------------------------------------------
-/// 
-//--------------------------------------------------------------------------------------------------
-bool RimLineBasedAnnotation::isActive()
-{
-    return m_isActive();
-}
-
-//--------------------------------------------------------------------------------------------------
-///
-//--------------------------------------------------------------------------------------------------
-bool RimLineBasedAnnotation::isVisible()
-{
-    RimAnnotationCollectionBase* coll;
-    firstAncestorOrThisOfType(coll);
-
-    return coll && coll->isActive() && m_isActive;
-}
-
-//--------------------------------------------------------------------------------------------------
-/// 
-//--------------------------------------------------------------------------------------------------
-caf::PdmFieldHandle* RimLineBasedAnnotation::objectToggleField()
-{
-    return &m_isActive;
-}
-
-
-

ApplicationCode/ProjectDataModel/Annotations/RimLineBasedAnnotation.h

@@ -1,52 +0,0 @@
-/////////////////////////////////////////////////////////////////////////////////
-//
-//  Copyright (C) 2018-     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 "cafPdmObject.h"
-
-#include "cafPdmChildField.h"
-#include "cafPdmField.h"
-
-class RimGridView;
-class RimAnnotationLineAppearance;
-
-//==================================================================================================
-///
-///
-//==================================================================================================
-class RimLineBasedAnnotation : public caf::PdmObject
-{
-    CAF_PDM_HEADER_INIT;
-
-public:
-    RimLineBasedAnnotation();
-    RimAnnotationLineAppearance* appearance() const;
-
-    bool isActive();
-    bool isVisible();
-
-protected:
-    virtual caf::PdmFieldHandle* objectToggleField() override;
-
-private:
-    caf::PdmField<bool> m_isActive;
-
-private:
-    caf::PdmChildField<RimAnnotationLineAppearance*> m_appearance;
-};

ApplicationCode/ProjectDataModel/Annotations/RimPolylinesAnnotation.cpp

@@ -24,6 +24,8 @@
 #include "RimTools.h"
 #include "QFile"
 #include "RimAnnotationCollection.h"
+#include "RimAnnotationLineAppearance.h"
+
 #include "QFileInfo"
 
 CAF_PDM_ABSTRACT_SOURCE_INIT(RimPolylinesAnnotation, "RimPolylinesAnnotation");
@@ -35,7 +37,19 @@ RimPolylinesAnnotation::RimPolylinesAnnotation()
 {
     CAF_PDM_InitObject("PolylineAnnotation", ":/WellCollection.png", "", "");
 
+    CAF_PDM_InitField(&m_isActive, "IsActive", true, "Is Active", "", "", "");
+    m_isActive.uiCapability()->setUiHidden(true);
+
     CAF_PDM_InitField(&m_closePolyline, "ClosePolyline", false, "Close Polyline", "", "", "");
+    CAF_PDM_InitField(&m_showLines, "ShowLines", true, "Show Lines", "", "", "");
+    CAF_PDM_InitField(&m_showSpheres, "ShowSpheres", false, "Show Spheres", "", "", "");
+
+    CAF_PDM_InitFieldNoDefault(&m_appearance, "Appearance", "Appearance", "", "", "");
+
+    m_appearance = new RimPolylineAppearance();
+    m_appearance.uiCapability()->setUiTreeHidden(true);
+    m_appearance.uiCapability()->setUiTreeChildrenHidden(true);
+
 }
 
 //--------------------------------------------------------------------------------------------------
@@ -46,6 +60,25 @@ RimPolylinesAnnotation::~RimPolylinesAnnotation()
 
 }
 
+//--------------------------------------------------------------------------------------------------
+///
+//--------------------------------------------------------------------------------------------------
+bool RimPolylinesAnnotation::isActive()
+{
+    return m_isActive();
+}
+
+//--------------------------------------------------------------------------------------------------
+///
+//--------------------------------------------------------------------------------------------------
+bool RimPolylinesAnnotation::isVisible()
+{
+    RimAnnotationCollectionBase* coll;
+    firstAncestorOrThisOfType(coll);
+
+    return coll && coll->isActive() && m_isActive;
+}
+
 //--------------------------------------------------------------------------------------------------
 ///
 //--------------------------------------------------------------------------------------------------
@@ -54,3 +87,35 @@ bool RimPolylinesAnnotation::closePolyline() const
     return m_closePolyline;
 }
 
+//--------------------------------------------------------------------------------------------------
+///
+//--------------------------------------------------------------------------------------------------
+bool RimPolylinesAnnotation::showLines() const
+{
+    return m_showLines;
+}
+
+//--------------------------------------------------------------------------------------------------
+///
+//--------------------------------------------------------------------------------------------------
+bool RimPolylinesAnnotation::showSpheres() const
+{
+    return m_showSpheres;
+}
+
+//--------------------------------------------------------------------------------------------------
+///
+//--------------------------------------------------------------------------------------------------
+RimPolylineAppearance* RimPolylinesAnnotation::appearance() const
+{
+    return m_appearance;
+}
+
+//--------------------------------------------------------------------------------------------------
+///
+//--------------------------------------------------------------------------------------------------
+caf::PdmFieldHandle* RimPolylinesAnnotation::objectToggleField()
+{
+    return &m_isActive;
+}
+

ApplicationCode/ProjectDataModel/Annotations/RimPolylinesAnnotation.h

@@ -17,21 +17,22 @@
 /////////////////////////////////////////////////////////////////////////////////
 
 #pragma once
-#include "RimLineBasedAnnotation.h"
-
+#include "cafPdmChildField.h"
 #include "cafPdmField.h"
+#include "cafPdmObject.h"
 
 // Include to make Pdm work for cvf::Color
 #include "cvfBase.h"
 #include "cvfObject.h"
 
 class RigPolyLinesData;
+class RimPolylineAppearance;
 
 //==================================================================================================
 ///
 ///
 //==================================================================================================
-class RimPolylinesAnnotation : public RimLineBasedAnnotation
+class RimPolylinesAnnotation : public caf::PdmObject
 {
     CAF_PDM_HEADER_INIT;
 
@@ -42,8 +43,24 @@ public:
     virtual cvf::ref<RigPolyLinesData> polyLinesData() = 0;
     virtual bool isEmpty() = 0;
 
+    bool         isActive();
+    bool         isVisible();
+
     bool         closePolyline() const;
+    bool         showLines() const;
+    bool         showSpheres() const;
+
+    RimPolylineAppearance* appearance() const;
 
 protected:
+    virtual caf::PdmFieldHandle* objectToggleField() override;
+
+protected:
+    caf::PdmField<bool>   m_isActive;
+
     caf::PdmField<bool>   m_closePolyline;
+    caf::PdmField<bool>   m_showLines;
+    caf::PdmField<bool>   m_showSpheres;
+
+    caf::PdmChildField<RimPolylineAppearance*> m_appearance;
 };

ApplicationCode/ProjectDataModel/Annotations/RimReachCircleAnnotation.cpp

@@ -19,6 +19,7 @@
 #include "RimReachCircleAnnotation.h"
 
 #include "RimAnnotationInViewCollection.h"
+#include "RimAnnotationLineAppearance.h"
 #include "RimGridView.h"
 #include "RimProject.h"
 #include "RimAnnotationCollection.h"
@@ -34,9 +35,37 @@ RimReachCircleAnnotation::RimReachCircleAnnotation()
 {
     CAF_PDM_InitObject("CircleAnnotation", ":/ReachCircle16x16.png", "", "");
 
+    CAF_PDM_InitField(&m_isActive, "IsActive", true, "Is Active", "", "", "");
+    m_isActive.uiCapability()->setUiHidden(true);
+
     CAF_PDM_InitField(&m_centerPointXyd, "CenterPointXyd", Vec3d::ZERO, "Center Point", "", "", "");
     CAF_PDM_InitField(&m_radius, "Radius", 0.0, "Radius", "", "", "");
     CAF_PDM_InitField(&m_name, "Name", QString("Circle Annotation"), "Name", "", "", "");
+
+    CAF_PDM_InitFieldNoDefault(&m_appearance, "Appearance", "Appearance", "", "", "");
+
+    m_appearance = new RimReachCircleLineAppearance();
+    m_appearance.uiCapability()->setUiTreeHidden(true);
+    m_appearance.uiCapability()->setUiTreeChildrenHidden(true);
+}
+
+//--------------------------------------------------------------------------------------------------
+///
+//--------------------------------------------------------------------------------------------------
+bool RimReachCircleAnnotation::isActive()
+{
+    return m_isActive();
+}
+
+//--------------------------------------------------------------------------------------------------
+///
+//--------------------------------------------------------------------------------------------------
+bool RimReachCircleAnnotation::isVisible()
+{
+    RimAnnotationCollectionBase* coll;
+    firstAncestorOrThisOfType(coll);
+
+    return coll && coll->isActive() && m_isActive;
 }
 
 //--------------------------------------------------------------------------------------------------
@@ -65,6 +94,14 @@ QString RimReachCircleAnnotation::name() const
     return m_name;
 }
 
+//--------------------------------------------------------------------------------------------------
+///
+//--------------------------------------------------------------------------------------------------
+RimReachCircleLineAppearance* RimReachCircleAnnotation::appearance() const
+{
+    return m_appearance;
+}
+
 //--------------------------------------------------------------------------------------------------
 ///
 //--------------------------------------------------------------------------------------------------
@@ -74,7 +111,7 @@ void RimReachCircleAnnotation::defineUiOrdering(QString uiConfigName, caf::PdmUi
     uiOrdering.add(&m_centerPointXyd);
     uiOrdering.add(&m_radius);
 
-    auto appearanceGroup = uiOrdering.addNewGroup("Line Appearance");
+    auto appearanceGroup = uiOrdering.addNewGroup("Appearance");
     appearance()->uiOrdering(uiConfigName, *appearanceGroup);
 
     uiOrdering.skipRemainingFields(true);
@@ -101,3 +138,11 @@ caf::PdmFieldHandle* RimReachCircleAnnotation::userDescriptionField()
     return &m_name;
 }
 
+//--------------------------------------------------------------------------------------------------
+///
+//--------------------------------------------------------------------------------------------------
+caf::PdmFieldHandle* RimReachCircleAnnotation::objectToggleField()
+{
+    return &m_isActive;
+}
+

ApplicationCode/ProjectDataModel/Annotations/RimReachCircleAnnotation.h

@@ -18,9 +18,6 @@
 
 #pragma once
 
-#include "RimAnnotationLineAppearance.h"
-#include "RimLineBasedAnnotation.h"
-
 #include "cafPdmChildArrayField.h"
 #include "cafPdmField.h"
 #include "cafPdmObject.h"
@@ -32,6 +29,7 @@
 #include "cafPdmFieldCvfColor.h"    
 #include "cafPdmChildField.h"
 #include "cafPdmFieldCvfVec3d.h"
+#include "cafPdmObject.h"
 
 #include "cvfObject.h"
 #include "cvfVector3.h"
@@ -40,13 +38,13 @@
 
 class QString;
 class RimGridView;
-
+class RimReachCircleLineAppearance;
 
 //==================================================================================================
 ///
 ///
 //==================================================================================================
-class RimReachCircleAnnotation : public RimLineBasedAnnotation
+class RimReachCircleAnnotation : public caf::PdmObject
 {
     friend class RimReachCircleAnnotationInView;
 
@@ -58,17 +56,25 @@ public:
     RimReachCircleAnnotation();
     ~RimReachCircleAnnotation() override {}
 
+    bool            isActive();
+    bool            isVisible();
+
     Vec3d           centerPoint() const;
     double          radius() const;
     QString         name() const;
+    RimReachCircleLineAppearance* appearance() const;
 
 protected:
     void defineUiOrdering(QString uiConfigName, caf::PdmUiOrdering& uiOrdering) override;
     void fieldChangedByUi(const caf::PdmFieldHandle* changedField, const QVariant& oldValue, const QVariant& newValue) override;
     caf::PdmFieldHandle* userDescriptionField() override;
+    virtual caf::PdmFieldHandle* objectToggleField() override;
 
 private:
+    caf::PdmField<bool>     m_isActive;
+
     caf::PdmField<Vec3d>    m_centerPointXyd;
     caf::PdmField<double>   m_radius;
     caf::PdmField<QString>  m_name;
+    caf::PdmChildField<RimReachCircleLineAppearance*> m_appearance;
 };

ApplicationCode/ProjectDataModel/Annotations/RimReachCircleAnnotationInView.h

@@ -19,7 +19,6 @@
 #pragma once
 
 #include "RimAnnotationLineAppearance.h"
-#include "RimLineBasedAnnotation.h"
 
 #include "cafPdmChildArrayField.h"
 #include "cafPdmField.h"

ApplicationCode/ProjectDataModel/Annotations/RimUserDefinedPolylinesAnnotation.cpp

@@ -230,7 +230,10 @@ void RimUserDefinedPolylinesAnnotation::defineUiOrdering(QString uiConfigName, c
     uiOrdering.add(&m_enablePicking);
     uiOrdering.add(&m_closePolyline);
 
-    auto appearanceGroup = uiOrdering.addNewGroup("Line Appearance");
+    uiOrdering.add(&m_showLines);
+    uiOrdering.add(&m_showSpheres);
+
+    auto appearanceGroup = uiOrdering.addNewGroup("Appearance");
     appearance()->uiOrdering(uiConfigName, *appearanceGroup);
 
     uiOrdering.skipRemainingFields(true);