Surface python interface (#6370)

* Add python interface for importing surfaces with example.

ApplicationCode/ProjectDataModel/Surfaces/RimFileSurface.cpp

@@ -23,6 +23,9 @@
 #include "RigSurface.h"
 #include "RimSurfaceCollection.h"
 
+#include "cafPdmFieldScriptingCapability.h"
+#include "cafPdmObjectScriptingCapability.h"
+
 #include <QFileInfo>
 
 // TODO: Use the alias concept prototyped below when the alias concept for class is ready
@@ -35,7 +38,7 @@ CAF_PDM_SOURCE_INIT( RimFileSurface, "Surface" );
 //--------------------------------------------------------------------------------------------------
 RimFileSurface::RimFileSurface()
 {
-    CAF_PDM_InitObject( "Surface", ":/ReservoirSurface16x16.png", "", "" );
+    CAF_PDM_InitScriptableObject( "Surface", ":/ReservoirSurface16x16.png", "", "" );
 
     CAF_PDM_InitFieldNoDefault( &m_surfaceDefinitionFilePath, "SurfaceFilePath", "File", "", "", "" );
 }

ApplicationCode/ProjectDataModel/Surfaces/RimSurface.cpp

@@ -24,6 +24,9 @@
 
 #include "RifSurfaceImporter.h"
 
+#include "cafPdmFieldScriptingCapability.h"
+#include "cafPdmObjectScriptingCapability.h"
+
 #include "cafPdmUiDoubleSliderEditor.h"
 
 #include <cmath>
@@ -35,13 +38,14 @@ CAF_PDM_ABSTRACT_SOURCE_INIT( RimSurface, "SurfaceInterface" );
 //--------------------------------------------------------------------------------------------------
 RimSurface::RimSurface()
 {
-    CAF_PDM_InitObject( "Surface", ":/ReservoirSurface16x16.png", "", "" );
+    CAF_PDM_InitScriptableObject( "Surface", ":/ReservoirSurface16x16.png", "", "" );
 
-    CAF_PDM_InitFieldNoDefault( &m_userDescription, "SurfaceUserDecription", "Name", "", "", "" );
+    CAF_PDM_InitScriptableFieldNoDefault( &m_userDescription, "SurfaceUserDecription", "Name", "", "", "" );
     CAF_PDM_InitField( &m_color, "SurfaceColor", cvf::Color3f( 0.5f, 0.3f, 0.2f ), "Color", "", "", "" );
 
-    CAF_PDM_InitField( &m_depthOffset, "DepthOffset", 0.0, "Depth Offset", "", "", "" );
+    CAF_PDM_InitScriptableField( &m_depthOffset, "DepthOffset", 0.0, "Depth Offset", "", "", "" );
     m_depthOffset.uiCapability()->setUiEditorTypeName( caf::PdmUiDoubleSliderEditor::uiEditorTypeName() );
+    m_depthOffset.capability<caf::PdmAbstractFieldScriptingCapability>()->setIOWriteable( true );
 
     CAF_PDM_InitFieldNoDefault( &m_nameProxy, "NameProxy", "Name Proxy", "", "", "" );
     m_nameProxy.registerGetMethod( this, &RimSurface::fullName );

ApplicationCode/ProjectDataModel/Surfaces/RimSurfaceCollection.cpp

@@ -30,6 +30,9 @@
 
 #include "cafPdmFieldReorderCapability.h"
 
+#include "cafPdmFieldScriptingCapability.h"
+#include "cafPdmObjectScriptingCapability.h"
+
 CAF_PDM_SOURCE_INIT( RimSurfaceCollection, "SurfaceCollection" );
 
 //--------------------------------------------------------------------------------------------------
@@ -37,17 +40,17 @@ CAF_PDM_SOURCE_INIT( RimSurfaceCollection, "SurfaceCollection" );
 //--------------------------------------------------------------------------------------------------
 RimSurfaceCollection::RimSurfaceCollection()
 {
-    CAF_PDM_InitObject( "Surfaces", ":/ReservoirSurfaces16x16.png", "", "" );
+    CAF_PDM_InitScriptableObject( "Surfaces", ":/ReservoirSurfaces16x16.png", "", "" );
 
-    CAF_PDM_InitFieldNoDefault( &m_collectionname, "SurfaceUserDecription", "Name", "", "", "" );
-    m_collectionname = "Surfaces";
+    CAF_PDM_InitScriptableFieldNoDefault( &m_collectionName, "SurfaceUserDecription", "Name", "", "", "" );
+    m_collectionName = "Surfaces";
 
-    CAF_PDM_InitFieldNoDefault( &m_subcollections, "SubCollections", "Surfaces", "", "", "" );
-    m_subcollections.uiCapability()->setUiTreeHidden( true );
-    auto reorderability = caf::PdmFieldReorderCapability::addToField( &m_subcollections );
+    CAF_PDM_InitScriptableFieldNoDefault( &m_subCollections, "SubCollections", "Surfaces", "", "", "" );
+    m_subCollections.uiCapability()->setUiTreeHidden( true );
+    auto reorderability = caf::PdmFieldReorderCapability::addToField( &m_subCollections );
     reorderability->orderChanged.connect( this, &RimSurfaceCollection::orderChanged );
 
-    CAF_PDM_InitFieldNoDefault( &m_surfaces, "SurfacesField", "Surfaces", "", "", "" );
+    CAF_PDM_InitScriptableFieldNoDefault( &m_surfaces, "SurfacesField", "Surfaces", "", "", "" );
     m_surfaces.uiCapability()->setUiTreeHidden( true );
 
     setDeletable( true );
@@ -65,16 +68,24 @@ RimSurfaceCollection::~RimSurfaceCollection()
 //--------------------------------------------------------------------------------------------------
 void RimSurfaceCollection::setAsTopmostFolder()
 {
-    m_collectionname.uiCapability()->setUiHidden( true );
+    m_collectionName.uiCapability()->setUiHidden( true );
     setDeletable( false );
 }
 
 //--------------------------------------------------------------------------------------------------
 ///
 //--------------------------------------------------------------------------------------------------
-QString RimSurfaceCollection::collectionname() const
+QString RimSurfaceCollection::collectionName() const
 {
-    return m_collectionname.value();
+    return m_collectionName.value();
+}
+
+//--------------------------------------------------------------------------------------------------
+///
+//--------------------------------------------------------------------------------------------------
+void RimSurfaceCollection::setCollectionName( const QString name )
+{
+    return m_collectionName.setValue( name );
 }
 
 //--------------------------------------------------------------------------------------------------
@@ -82,7 +93,7 @@ QString RimSurfaceCollection::collectionname() const
 //--------------------------------------------------------------------------------------------------
 caf::PdmFieldHandle* RimSurfaceCollection::userDescriptionField()
 {
-    return &m_collectionname;
+    return &m_collectionName;
 }
 
 //--------------------------------------------------------------------------------------------------
@@ -235,9 +246,9 @@ std::vector<RimSurface*> RimSurfaceCollection::surfaces() const
 //--------------------------------------------------------------------------------------------------
 ///
 //--------------------------------------------------------------------------------------------------
-std::vector<RimSurfaceCollection*> RimSurfaceCollection::subcollections() const
+std::vector<RimSurfaceCollection*> RimSurfaceCollection::subCollections() const
 {
-    return m_subcollections.childObjects();
+    return m_subCollections.childObjects();
 }
 
 //--------------------------------------------------------------------------------------------------
@@ -346,7 +357,7 @@ void RimSurfaceCollection::removeSurface( RimSurface* surface )
 RimSurface* RimSurfaceCollection::addSurfacesAtIndex( int position, std::vector<RimSurface*> surfaces )
 {
     // adjust index for number of folders we have
-    position = position - static_cast<int>( m_subcollections.size() );
+    position = position - static_cast<int>( m_subCollections.size() );
 
     RimSurface* returnSurface = nullptr;
     if ( !surfaces.empty() ) returnSurface = surfaces[0];
@@ -401,10 +412,23 @@ RimSurface* RimSurfaceCollection::addSurfacesAtIndex( int position, std::vector<
 //--------------------------------------------------------------------------------------------------
 void RimSurfaceCollection::addSubCollection( RimSurfaceCollection* subcoll )
 {
-    m_subcollections.push_back( subcoll );
+    m_subCollections.push_back( subcoll );
     this->updateConnectedEditors();
 
     updateViews();
 
     return;
 }
+
+//--------------------------------------------------------------------------------------------------
+///
+//--------------------------------------------------------------------------------------------------
+RimSurfaceCollection* RimSurfaceCollection::getSubCollection( const QString name )
+{
+    for ( auto coll : m_subCollections )
+    {
+        if ( coll->collectionName() == name ) return coll;
+    }
+
+    return nullptr;
+}

ApplicationCode/ProjectDataModel/Surfaces/RimSurfaceCollection.h

@@ -41,7 +41,8 @@ public:
     RimSurface* copySurfaces( std::vector<RimSurface*> surfaces );
     RimSurface* addSurfacesAtIndex( int index, std::vector<RimSurface*> surfaces );
 
-    void addSubCollection( RimSurfaceCollection* collection );
+    void                  addSubCollection( RimSurfaceCollection* collection );
+    RimSurfaceCollection* getSubCollection( const QString name );
 
     void reloadSurfaces( std::vector<RimSurface*> surfaces );
     void removeSurface( RimSurface* surface );
@@ -54,10 +55,11 @@ public:
     void onChildDeleted( caf::PdmChildArrayFieldHandle*      childArray,
                          std::vector<caf::PdmObjectHandle*>& referringObjects ) override;
 
-    QString collectionname() const;
+    QString collectionName() const;
+    void    setCollectionName( const QString name );
 
     std::vector<RimSurface*>           surfaces() const;
-    std::vector<RimSurfaceCollection*> subcollections() const;
+    std::vector<RimSurfaceCollection*> subCollections() const;
 
 protected:
     caf::PdmFieldHandle* userDescriptionField() override;
@@ -65,7 +67,7 @@ protected:
 private:
     void orderChanged( const caf::SignalEmitter* emitter );
 
-    caf::PdmField<QString>                         m_collectionname;
+    caf::PdmField<QString>                         m_collectionName;
     caf::PdmChildArrayField<RimSurface*>           m_surfaces;
-    caf::PdmChildArrayField<RimSurfaceCollection*> m_subcollections;
+    caf::PdmChildArrayField<RimSurfaceCollection*> m_subCollections;
 };

ApplicationCode/ProjectDataModel/Surfaces/RimSurfaceInViewCollection.cpp

@@ -40,10 +40,10 @@ RimSurfaceInViewCollection::RimSurfaceInViewCollection()
 {
     CAF_PDM_InitObject( "Surfaces", ":/ReservoirSurfaces16x16.png", "", "" );
 
-    CAF_PDM_InitFieldNoDefault( &m_collectionname, "CollectionName", "Name", "", "", "" );
-    m_collectionname.registerGetMethod( this, &RimSurfaceInViewCollection::name );
-    m_collectionname.uiCapability()->setUiReadOnly( true );
-    m_collectionname.xmlCapability()->disableIO();
+    CAF_PDM_InitFieldNoDefault( &m_collectionName, "CollectionName", "Name", "", "", "" );
+    m_collectionName.registerGetMethod( this, &RimSurfaceInViewCollection::name );
+    m_collectionName.uiCapability()->setUiReadOnly( true );
+    m_collectionName.xmlCapability()->disableIO();
 
     CAF_PDM_InitFieldNoDefault( &m_collectionsInView,
                                 "SurfacesInViewFieldCollections",
@@ -56,8 +56,8 @@ RimSurfaceInViewCollection::RimSurfaceInViewCollection()
     CAF_PDM_InitFieldNoDefault( &m_surfacesInView, "SurfacesInViewField", "SurfacesInViewField", "", "", "" );
     m_surfacesInView.uiCapability()->setUiTreeHidden( true );
 
-    CAF_PDM_InitFieldNoDefault( &m_surfacecollection, "SurfaceCollectionRef", "SurfaceCollection", "", "", "" );
-    m_surfacecollection.uiCapability()->setUiHidden( true );
+    CAF_PDM_InitFieldNoDefault( &m_surfaceCollection, "SurfaceCollectionRef", "SurfaceCollection", "", "", "" );
+    m_surfaceCollection.uiCapability()->setUiHidden( true );
 
     nameField()->uiCapability()->setUiHidden( true );
 }
@@ -74,7 +74,7 @@ RimSurfaceInViewCollection::~RimSurfaceInViewCollection()
 //--------------------------------------------------------------------------------------------------
 caf::PdmFieldHandle* RimSurfaceInViewCollection::userDescriptionField()
 {
-    return &m_collectionname;
+    return &m_collectionName;
 }
 
 //--------------------------------------------------------------------------------------------------
@@ -82,7 +82,7 @@ caf::PdmFieldHandle* RimSurfaceInViewCollection::userDescriptionField()
 //--------------------------------------------------------------------------------------------------
 QString RimSurfaceInViewCollection::name() const
 {
-    if ( m_surfacecollection ) return m_surfacecollection->collectionname();
+    if ( m_surfaceCollection ) return m_surfaceCollection->collectionName();
 
     return "";
 }
@@ -92,7 +92,7 @@ QString RimSurfaceInViewCollection::name() const
 //--------------------------------------------------------------------------------------------------
 RimSurfaceCollection* RimSurfaceInViewCollection::surfaceCollection() const
 {
-    return m_surfacecollection;
+    return m_surfaceCollection;
 }
 
 //--------------------------------------------------------------------------------------------------
@@ -100,7 +100,7 @@ RimSurfaceCollection* RimSurfaceInViewCollection::surfaceCollection() const
 //--------------------------------------------------------------------------------------------------
 void RimSurfaceInViewCollection::setSurfaceCollection( RimSurfaceCollection* surfcoll )
 {
-    m_surfacecollection = surfcoll;
+    m_surfaceCollection = surfcoll;
 }
 
 //--------------------------------------------------------------------------------------------------
@@ -132,10 +132,10 @@ void RimSurfaceInViewCollection::syncCollectionsWithView()
 
     // Create new collection entries and reorder
     std::vector<RimSurfaceInViewCollection*> orderedColls;
-    if ( m_surfacecollection )
+    if ( m_surfaceCollection )
     {
         // pick up the collections and the order from the surface collection
-        std::vector<RimSurfaceCollection*> surfcolls = m_surfacecollection->subcollections();
+        std::vector<RimSurfaceCollection*> surfcolls = m_surfaceCollection->subCollections();
         for ( auto surfcoll : surfcolls )
         {
             // check if this is a collection we need to create
@@ -184,10 +184,10 @@ void RimSurfaceInViewCollection::syncSurfacesWithView()
     // Create new surfade entries and reorder
     std::vector<RimSurfaceInView*> orderedSurfs;
 
-    if ( m_surfacecollection )
+    if ( m_surfaceCollection )
     {
         // pick up the surfaces and the order from the surface collection
-        std::vector<RimSurface*> surfs = m_surfacecollection->surfaces();
+        std::vector<RimSurface*> surfs = m_surfaceCollection->surfaces();
         for ( auto surf : surfs )
         {
             // check if this is a surface we need to create

ApplicationCode/ProjectDataModel/Surfaces/RimSurfaceInViewCollection.h

@@ -78,8 +78,8 @@ private:
     void syncCollectionsWithView();
     void syncSurfacesWithView();
 
-    caf::PdmProxyValueField<QString>                     m_collectionname;
+    caf::PdmProxyValueField<QString>                     m_collectionName;
     caf::PdmChildArrayField<RimSurfaceInViewCollection*> m_collectionsInView;
     caf::PdmChildArrayField<RimSurfaceInView*>           m_surfacesInView;
-    caf::PdmPtrField<RimSurfaceCollection*>              m_surfacecollection;
+    caf::PdmPtrField<RimSurfaceCollection*>              m_surfaceCollection;
 };