Review fixes, sip, doc fixes, icons, style panel fix

qgis · Jan 18, 2019 · 9875821 · 9875821
1 parent f069342
commit 9875821
Show file tree

Hide file tree

Showing 11 changed files with 344 additions and 44 deletions.
diff --git a/python/3d/3d_auto.sip b/python/3d/3d_auto.sip
@@ -1,6 +1,7 @@
 // Include auto-generated SIP files
 %Include auto_generated/qgs3dtypes.sip
 %Include auto_generated/qgsphongmaterialsettings.sip
+%Include auto_generated/qgsrulebased3drenderer.sip
 %Include auto_generated/qgsvectorlayer3drenderer.sip
 %Include auto_generated/symbols/qgsabstract3dsymbol.sip
 %Include auto_generated/symbols/qgsline3dsymbol.sip

diff --git a/python/3d/auto_generated/qgsrulebased3drenderer.sip.in b/python/3d/auto_generated/qgsrulebased3drenderer.sip.in
@@ -0,0 +1,280 @@
+/************************************************************************
+ * This file has been generated automatically from                      *
+ *                                                                      *
+ * src/3d/qgsrulebased3drenderer.h                                      *
+ *                                                                      *
+ * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
+ ************************************************************************/
+
+
+
+
+
+
+
+class QgsRuleBased3DRendererMetadata : Qgs3DRendererAbstractMetadata
+{
+%Docstring
+Metadata for rule-based 3D renderer to allow creation of its instances from XML
+
+.. warning::
+
+   This is not considered stable API, and may change in future QGIS releases. It is
+   exposed to the Python bindings as a tech preview only.
+
+.. versionadded:: 3.6
+%End
+
+%TypeHeaderCode
+#include "qgsrulebased3drenderer.h"
+%End
+  public:
+    QgsRuleBased3DRendererMetadata();
+
+    virtual QgsAbstract3DRenderer *createRenderer( QDomElement &elem, const QgsReadWriteContext &context ) /Factory/;
+
+%Docstring
+Creates an instance of a 3D renderer based on a DOM element with renderer configuration
+%End
+};
+
+
+class QgsRuleBased3DRenderer : QgsAbstract3DRenderer
+{
+%Docstring
+Rule-based 3D renderer.
+
+Similar to rule-based 2D renderer and rule-based labeling, it allows specification of rules for 3D symbols.
+
+.. warning::
+
+   This is not considered stable API, and may change in future QGIS releases. It is
+   exposed to the Python bindings as a tech preview only.
+
+.. versionadded:: 3.6
+%End
+
+%TypeHeaderCode
+#include "qgsrulebased3drenderer.h"
+%End
+  public:
+
+    typedef QList<QgsRuleBased3DRenderer::Rule *> RuleList;
+    typedef QMap<const QgsRuleBased3DRenderer::Rule *, QgsFeature3DHandler *> RuleToHandlerMap;
+
+    class Rule
+{
+%Docstring
+
+.. versionadded:: 3.6
+%End
+
+%TypeHeaderCode
+#include "qgsrulebased3drenderer.h"
+%End
+      public:
+        Rule( QgsAbstract3DSymbol *symbol /Transfer/, const QString &filterExp = QString(), const QString &description = QString(), bool elseRule = false );
+%Docstring
+takes ownership of symbol, symbol may be None
+%End
+        ~Rule();
+
+
+        enum RegisterResult
+        {
+          Filtered,
+          Inactive,
+          Registered
+        };
+
+        QgsAbstract3DSymbol *symbol() const;
+%Docstring
+Gets the labeling settings. May return a null pointer.
+%End
+
+        QString filterExpression() const;
+%Docstring
+A filter that will check if this rule applies
+
+:return: An expression
+%End
+
+        QString description() const;
+%Docstring
+A human readable description for this rule
+
+:return: Description
+%End
+
+        bool active() const;
+%Docstring
+Returns if this rule is active
+
+:return: True if the rule is active
+%End
+
+        bool isElse() const;
+%Docstring
+Check if this rule is an ELSE rule
+
+:return: True if this rule is an else rule
+%End
+
+        QString ruleKey() const;
+%Docstring
+Unique rule identifier (for identification of rule within labeling, used as provider ID)
+%End
+
+        void setSymbol( QgsAbstract3DSymbol *symbol /Transfer/ );
+%Docstring
+Sets new symbol (or NULL). Deletes old symbol if any.
+%End
+
+        void setFilterExpression( const QString &filterExp );
+%Docstring
+Set the expression used to check if a given feature shall be rendered with this rule
+
+:param filterExp: An expression
+%End
+
+        void setDescription( const QString &description );
+%Docstring
+Set a human readable description for this rule
+
+:param description: Description
+%End
+
+        void setActive( bool state );
+%Docstring
+Sets if this rule is active
+
+:param state: Determines if the rule should be activated or deactivated
+%End
+
+        void setIsElse( bool iselse );
+%Docstring
+Sets if this rule is an ELSE rule
+
+:param iselse: If true, this rule is an ELSE rule
+%End
+
+        void setRuleKey( const QString &key );
+%Docstring
+Override the assigned rule key (should be used just internally by rule-based renderer)
+%End
+
+
+        const QgsRuleBased3DRenderer::RuleList &children() const;
+%Docstring
+Returns all children rules of this rule
+
+:return: A list of rules
+%End
+
+
+        QgsRuleBased3DRenderer::RuleList descendants() const;
+%Docstring
+Returns all children, grand-children, grand-grand-children, grand-gra... you get it
+
+:return: A list of descendant rules
+%End
+
+
+        QgsRuleBased3DRenderer::Rule *parent();
+%Docstring
+The parent rule
+
+:return: Parent rule
+%End
+
+        void appendChild( QgsRuleBased3DRenderer::Rule *rule /Transfer/ );
+%Docstring
+add child rule, take ownership, sets this as parent
+%End
+
+        void insertChild( int i, QgsRuleBased3DRenderer::Rule *rule /Transfer/ );
+%Docstring
+add child rule, take ownership, sets this as parent
+%End
+
+        void removeChildAt( int i );
+%Docstring
+delete child rule
+%End
+
+        const QgsRuleBased3DRenderer::Rule *findRuleByKey( const QString &key ) const;
+%Docstring
+Try to find a rule given its unique key
+%End
+
+
+        QgsRuleBased3DRenderer::Rule *clone() const /Factory/;
+%Docstring
+clone this rule, return new instance
+%End
+
+
+        static QgsRuleBased3DRenderer::Rule *create( const QDomElement &ruleElem, const QgsReadWriteContext &context ) /Factory/;
+%Docstring
+Create a rule from an XML definition
+
+:param ruleElem: The XML rule element
+:param context: reading context
+
+:return: A new rule
+%End
+
+        QDomElement save( QDomDocument &doc, const QgsReadWriteContext &context ) const;
+%Docstring
+store labeling info to XML element
+%End
+
+
+
+
+
+      private:
+        Rule( const QgsRuleBased3DRenderer::Rule &rh );
+    };
+
+
+    QgsRuleBased3DRenderer( QgsRuleBased3DRenderer::Rule *root /Transfer/ );
+%Docstring
+Construct renderer with the given root rule (takes ownership)
+%End
+    ~QgsRuleBased3DRenderer();
+
+    void setLayer( QgsVectorLayer *layer );
+%Docstring
+Sets vector layer associated with the renderer
+%End
+    QgsVectorLayer *layer() const;
+%Docstring
+Returns vector layer associated with the renderer
+%End
+
+    QgsRuleBased3DRenderer::Rule *rootRule();
+%Docstring
+Returns pointer to the root rule
+%End
+
+    virtual QString type() const;
+    virtual QgsRuleBased3DRenderer *clone() const /Factory/;
+
+
+    virtual void writeXml( QDomElement &elem, const QgsReadWriteContext &context ) const;
+
+    virtual void readXml( const QDomElement &elem, const QgsReadWriteContext &context );
+
+    virtual void resolveReferences( const QgsProject &project );
+
+
+};
+
+/************************************************************************
+ * This file has been generated automatically from                      *
+ *                                                                      *
+ * src/3d/qgsrulebased3drenderer.h                                      *
+ *                                                                      *
+ * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
+ ************************************************************************/
diff --git a/src/3d/qgs3dutils.cpp b/src/3d/qgs3dutils.cpp
@@ -378,18 +378,26 @@ QgsVector3D Qgs3DUtils::transformWorldCoordinates( const QgsVector3D &worldPoint
   return mapToWorldCoordinates( mapPoint2, origin2 );
 }
 
-QgsAbstract3DSymbol *Qgs3DUtils::symbolForGeometryType( QgsWkbTypes::GeometryType geomType )
+std::unique_ptr<QgsAbstract3DSymbol> Qgs3DUtils::symbolForGeometryType( QgsWkbTypes::GeometryType geomType )
 {
   switch ( geomType )
   {
     case QgsWkbTypes::PointGeometry:
-      return new QgsPoint3DSymbol;
+      return std::unique_ptr<QgsAbstract3DSymbol>( new QgsPoint3DSymbol );
     case QgsWkbTypes::LineGeometry:
-      return new QgsLine3DSymbol;
+      return std::unique_ptr<QgsAbstract3DSymbol>( new QgsLine3DSymbol );
     case QgsWkbTypes::PolygonGeometry:
-      return new QgsPolygon3DSymbol;
+      return std::unique_ptr<QgsAbstract3DSymbol>( new QgsPolygon3DSymbol );
     default:
       return nullptr;
   }
 }
 
+QgsExpressionContext Qgs3DUtils::globalProjectLayerExpressionContext( QgsVectorLayer *layer )
+{
+  QgsExpressionContext exprContext;
+  exprContext << QgsExpressionContextUtils::globalScope()
+              << QgsExpressionContextUtils::projectScope( QgsProject::instance() )
+              << QgsExpressionContextUtils::layerScope( layer );
+  return exprContext;
+}
diff --git a/src/3d/qgs3dutils.h b/src/3d/qgs3dutils.h
@@ -29,6 +29,7 @@ class Qgs3DMapScene;
 #include "qgs3dtypes.h"
 #include "qgsaabb.h"
 
+#include <memory>
 
 #ifndef SIP_RUN
 
@@ -101,7 +102,11 @@ class _3D_EXPORT Qgs3DUtils
     static QgsVector3D transformWorldCoordinates( const QgsVector3D &worldPoint1, const QgsVector3D &origin1, const QgsCoordinateReferenceSystem &crs1, const QgsVector3D &origin2, const QgsCoordinateReferenceSystem &crs2,
         const QgsCoordinateTransformContext &context );
 
-    static QgsAbstract3DSymbol *symbolForGeometryType( QgsWkbTypes::GeometryType geomType );
+    //! Returns a new 3D symbol based on given geometry type (or null pointer if geometry type is not supported)
+    static std::unique_ptr<QgsAbstract3DSymbol> symbolForGeometryType( QgsWkbTypes::GeometryType geomType );
+
+    //! Returns expression context for use in preparation of 3D data of a layer
+    static QgsExpressionContext globalProjectLayerExpressionContext( QgsVectorLayer *layer );
 };
 
 #endif

diff --git a/src/3d/qgsfeature3dhandler_p.cpp b/src/3d/qgsfeature3dhandler_p.cpp
@@ -20,6 +20,7 @@
 #include "qgsvectorlayer.h"
 
 #include "qgs3dmapsettings.h"
+#include "qgs3dutils.h"
 
 /// @cond PRIVATE
 
@@ -31,9 +32,7 @@ namespace Qgs3DSymbolImpl
   {
     Qgs3DRenderContext context( map );
 
-    QgsExpressionContext exprContext;
-    exprContext << QgsExpressionContextUtils::globalScope()
-                << QgsExpressionContextUtils::projectScope( QgsProject::instance() );
+    QgsExpressionContext exprContext( Qgs3DUtils::globalProjectLayerExpressionContext( layer ) );
     exprContext.setFields( layer->fields() );
     context.setExpressionContext( exprContext );
 

diff --git a/src/3d/qgsrulebased3drenderer.cpp b/src/3d/qgsrulebased3drenderer.cpp
@@ -19,6 +19,7 @@
 #include "qgsxmlutils.h"
 
 #include "qgs3dmapsettings.h"
+#include "qgs3dutils.h"
 #include "qgsline3dsymbol.h"
 #include "qgspoint3dsymbol.h"
 #include "qgspolygon3dsymbol.h"
@@ -415,7 +416,10 @@ Qt3DCore::QEntity *QgsRuleBased3DRenderer::createEntity( const Qgs3DMapSettings
     return nullptr;
 
   Qgs3DRenderContext context( map );
-  // TODO: add expr. context
+
+  QgsExpressionContext exprContext( Qgs3DUtils::globalProjectLayerExpressionContext( vl ) );
+  exprContext.setFields( vl->fields() );
+  context.setExpressionContext( exprContext );
 
   RuleToHandlerMap handlers;
   mRootRule->createHandlers( vl, handlers );
@@ -431,7 +435,7 @@ Qt3DCore::QEntity *QgsRuleBased3DRenderer::createEntity( const Qgs3DMapSettings
   QgsFeatureIterator fi = vl->getFeatures( req );
   while ( fi.nextFeature( f ) )
   {
-    // TODO: set feature in expr context?
+    context.expressionContext().setFeature( f );
     mRootRule->registerFeature( f, context, handlers );
   }