Promote QgsMapSettings and QgsRenderContext enums to enum class, move…

… to Qgis
qgis · Sep 26, 2021 · 0ab6113 · 0ab6113
1 parent c5238d8
commit 0ab6113
Show file tree

Hide file tree

Showing 158 changed files with 703 additions and 548 deletions.
diff --git a/python/core/auto_additions/qgis.py b/python/core/auto_additions/qgis.py
@@ -772,3 +772,114 @@
 Qgis.TransformDirection.__doc__ = 'Indicates the direction (forward or inverse) of a transform.\n\n.. versionadded:: 3.22\n\n' + '* ``ForwardTransform``: ' + Qgis.TransformDirection.Forward.__doc__ + '\n' + '* ``ReverseTransform``: ' + Qgis.TransformDirection.Reverse.__doc__
 # --
 Qgis.TransformDirection.baseClass = Qgis
+QgsMapSettings.Flag = Qgis.MapSettingsFlag
+# monkey patching scoped based enum
+QgsMapSettings.Antialiasing = Qgis.MapSettingsFlag.Antialiasing
+QgsMapSettings.Antialiasing.is_monkey_patched = True
+QgsMapSettings.Antialiasing.__doc__ = "Enable anti-aliasing for map rendering"
+QgsMapSettings.DrawEditingInfo = Qgis.MapSettingsFlag.DrawEditingInfo
+QgsMapSettings.DrawEditingInfo.is_monkey_patched = True
+QgsMapSettings.DrawEditingInfo.__doc__ = "Enable drawing of vertex markers for layers in editing mode"
+QgsMapSettings.ForceVectorOutput = Qgis.MapSettingsFlag.ForceVectorOutput
+QgsMapSettings.ForceVectorOutput.is_monkey_patched = True
+QgsMapSettings.ForceVectorOutput.__doc__ = "Vector graphics should not be cached and drawn as raster images"
+QgsMapSettings.UseAdvancedEffects = Qgis.MapSettingsFlag.UseAdvancedEffects
+QgsMapSettings.UseAdvancedEffects.is_monkey_patched = True
+QgsMapSettings.UseAdvancedEffects.__doc__ = "Enable layer opacity and blending effects"
+QgsMapSettings.DrawLabeling = Qgis.MapSettingsFlag.DrawLabeling
+QgsMapSettings.DrawLabeling.is_monkey_patched = True
+QgsMapSettings.DrawLabeling.__doc__ = "Enable drawing of labels on top of the map"
+QgsMapSettings.UseRenderingOptimization = Qgis.MapSettingsFlag.UseRenderingOptimization
+QgsMapSettings.UseRenderingOptimization.is_monkey_patched = True
+QgsMapSettings.UseRenderingOptimization.__doc__ = "Enable vector simplification and other rendering optimizations"
+QgsMapSettings.DrawSelection = Qgis.MapSettingsFlag.DrawSelection
+QgsMapSettings.DrawSelection.is_monkey_patched = True
+QgsMapSettings.DrawSelection.__doc__ = "Whether vector selections should be shown in the rendered map"
+QgsMapSettings.DrawSymbolBounds = Qgis.MapSettingsFlag.DrawSymbolBounds
+QgsMapSettings.DrawSymbolBounds.is_monkey_patched = True
+QgsMapSettings.DrawSymbolBounds.__doc__ = "Draw bounds of symbols (for debugging/testing)"
+QgsMapSettings.RenderMapTile = Qgis.MapSettingsFlag.RenderMapTile
+QgsMapSettings.RenderMapTile.is_monkey_patched = True
+QgsMapSettings.RenderMapTile.__doc__ = "Draw map such that there are no problems between adjacent tiles"
+QgsMapSettings.RenderPartialOutput = Qgis.MapSettingsFlag.RenderPartialOutput
+QgsMapSettings.RenderPartialOutput.is_monkey_patched = True
+QgsMapSettings.RenderPartialOutput.__doc__ = "Whether to make extra effort to update map image with partially rendered layers (better for interactive map canvas). Added in QGIS 3.0"
+QgsMapSettings.RenderPreviewJob = Qgis.MapSettingsFlag.RenderPreviewJob
+QgsMapSettings.RenderPreviewJob.is_monkey_patched = True
+QgsMapSettings.RenderPreviewJob.__doc__ = "Render is a 'canvas preview' render, and shortcuts should be taken to ensure fast rendering"
+QgsMapSettings.RenderBlocking = Qgis.MapSettingsFlag.RenderBlocking
+QgsMapSettings.RenderBlocking.is_monkey_patched = True
+QgsMapSettings.RenderBlocking.__doc__ = "Render and load remote sources in the same thread to ensure rendering remote sources (svg and images). WARNING: this flag must NEVER be used from GUI based applications (like the main QGIS application) or crashes will result. Only for use in external scripts or QGIS server."
+QgsMapSettings.LosslessImageRendering = Qgis.MapSettingsFlag.LosslessImageRendering
+QgsMapSettings.LosslessImageRendering.is_monkey_patched = True
+QgsMapSettings.LosslessImageRendering.__doc__ = "Render images losslessly whenever possible, instead of the default lossy jpeg rendering used for some destination devices (e.g. PDF). This flag only works with builds based on Qt 5.13 or later."
+QgsMapSettings.Render3DMap = Qgis.MapSettingsFlag.Render3DMap
+QgsMapSettings.Render3DMap.is_monkey_patched = True
+QgsMapSettings.Render3DMap.__doc__ = "Render is for a 3D map"
+Qgis.MapSettingsFlag.__doc__ = 'Flags which adjust the way maps are rendered.\n\n.. versionadded:: 3.22\n\n' + '* ``Antialiasing``: ' + Qgis.MapSettingsFlag.Antialiasing.__doc__ + '\n' + '* ``DrawEditingInfo``: ' + Qgis.MapSettingsFlag.DrawEditingInfo.__doc__ + '\n' + '* ``ForceVectorOutput``: ' + Qgis.MapSettingsFlag.ForceVectorOutput.__doc__ + '\n' + '* ``UseAdvancedEffects``: ' + Qgis.MapSettingsFlag.UseAdvancedEffects.__doc__ + '\n' + '* ``DrawLabeling``: ' + Qgis.MapSettingsFlag.DrawLabeling.__doc__ + '\n' + '* ``UseRenderingOptimization``: ' + Qgis.MapSettingsFlag.UseRenderingOptimization.__doc__ + '\n' + '* ``DrawSelection``: ' + Qgis.MapSettingsFlag.DrawSelection.__doc__ + '\n' + '* ``DrawSymbolBounds``: ' + Qgis.MapSettingsFlag.DrawSymbolBounds.__doc__ + '\n' + '* ``RenderMapTile``: ' + Qgis.MapSettingsFlag.RenderMapTile.__doc__ + '\n' + '* ``RenderPartialOutput``: ' + Qgis.MapSettingsFlag.RenderPartialOutput.__doc__ + '\n' + '* ``RenderPreviewJob``: ' + Qgis.MapSettingsFlag.RenderPreviewJob.__doc__ + '\n' + '* ``RenderBlocking``: ' + Qgis.MapSettingsFlag.RenderBlocking.__doc__ + '\n' + '* ``LosslessImageRendering``: ' + Qgis.MapSettingsFlag.LosslessImageRendering.__doc__ + '\n' + '* ``Render3DMap``: ' + Qgis.MapSettingsFlag.Render3DMap.__doc__
+# --
+Qgis.MapSettingsFlag.baseClass = Qgis
+QgsRenderContext.Flag = Qgis.RenderContextFlag
+# monkey patching scoped based enum
+QgsRenderContext.DrawEditingInfo = Qgis.RenderContextFlag.DrawEditingInfo
+QgsRenderContext.DrawEditingInfo.is_monkey_patched = True
+QgsRenderContext.DrawEditingInfo.__doc__ = "Enable drawing of vertex markers for layers in editing mode"
+QgsRenderContext.ForceVectorOutput = Qgis.RenderContextFlag.ForceVectorOutput
+QgsRenderContext.ForceVectorOutput.is_monkey_patched = True
+QgsRenderContext.ForceVectorOutput.__doc__ = "Vector graphics should not be cached and drawn as raster images"
+QgsRenderContext.UseAdvancedEffects = Qgis.RenderContextFlag.UseAdvancedEffects
+QgsRenderContext.UseAdvancedEffects.is_monkey_patched = True
+QgsRenderContext.UseAdvancedEffects.__doc__ = "Enable layer opacity and blending effects"
+QgsRenderContext.UseRenderingOptimization = Qgis.RenderContextFlag.UseRenderingOptimization
+QgsRenderContext.UseRenderingOptimization.is_monkey_patched = True
+QgsRenderContext.UseRenderingOptimization.__doc__ = "Enable vector simplification and other rendering optimizations"
+QgsRenderContext.DrawSelection = Qgis.RenderContextFlag.DrawSelection
+QgsRenderContext.DrawSelection.is_monkey_patched = True
+QgsRenderContext.DrawSelection.__doc__ = "Whether vector selections should be shown in the rendered map"
+QgsRenderContext.DrawSymbolBounds = Qgis.RenderContextFlag.DrawSymbolBounds
+QgsRenderContext.DrawSymbolBounds.is_monkey_patched = True
+QgsRenderContext.DrawSymbolBounds.__doc__ = "Draw bounds of symbols (for debugging/testing)"
+QgsRenderContext.RenderMapTile = Qgis.RenderContextFlag.RenderMapTile
+QgsRenderContext.RenderMapTile.is_monkey_patched = True
+QgsRenderContext.RenderMapTile.__doc__ = "Draw map such that there are no problems between adjacent tiles"
+QgsRenderContext.Antialiasing = Qgis.RenderContextFlag.Antialiasing
+QgsRenderContext.Antialiasing.is_monkey_patched = True
+QgsRenderContext.Antialiasing.__doc__ = "Use antialiasing while drawing"
+QgsRenderContext.RenderPartialOutput = Qgis.RenderContextFlag.RenderPartialOutput
+QgsRenderContext.RenderPartialOutput.is_monkey_patched = True
+QgsRenderContext.RenderPartialOutput.__doc__ = "Whether to make extra effort to update map image with partially rendered layers (better for interactive map canvas). Added in QGIS 3.0"
+QgsRenderContext.RenderPreviewJob = Qgis.RenderContextFlag.RenderPreviewJob
+QgsRenderContext.RenderPreviewJob.is_monkey_patched = True
+QgsRenderContext.RenderPreviewJob.__doc__ = "Render is a 'canvas preview' render, and shortcuts should be taken to ensure fast rendering"
+QgsRenderContext.RenderBlocking = Qgis.RenderContextFlag.RenderBlocking
+QgsRenderContext.RenderBlocking.is_monkey_patched = True
+QgsRenderContext.RenderBlocking.__doc__ = "Render and load remote sources in the same thread to ensure rendering remote sources (svg and images). WARNING: this flag must NEVER be used from GUI based applications (like the main QGIS application) or crashes will result. Only for use in external scripts or QGIS server."
+QgsRenderContext.RenderSymbolPreview = Qgis.RenderContextFlag.RenderSymbolPreview
+QgsRenderContext.RenderSymbolPreview.is_monkey_patched = True
+QgsRenderContext.RenderSymbolPreview.__doc__ = "The render is for a symbol preview only and map based properties may not be available, so care should be taken to handle map unit based sizes in an appropriate way."
+QgsRenderContext.LosslessImageRendering = Qgis.RenderContextFlag.LosslessImageRendering
+QgsRenderContext.LosslessImageRendering.is_monkey_patched = True
+QgsRenderContext.LosslessImageRendering.__doc__ = "Render images losslessly whenever possible, instead of the default lossy jpeg rendering used for some destination devices (e.g. PDF). This flag only works with builds based on Qt 5.13 or later."
+QgsRenderContext.ApplyScalingWorkaroundForTextRendering = Qgis.RenderContextFlag.ApplyScalingWorkaroundForTextRendering
+QgsRenderContext.ApplyScalingWorkaroundForTextRendering.is_monkey_patched = True
+QgsRenderContext.ApplyScalingWorkaroundForTextRendering.__doc__ = "Whether a scaling workaround designed to stablise the rendering of small font sizes (or for painters scaled out by a large amount) when rendering text. Generally this is recommended, but it may incur some performance cost."
+QgsRenderContext.Render3DMap = Qgis.RenderContextFlag.Render3DMap
+QgsRenderContext.Render3DMap.is_monkey_patched = True
+QgsRenderContext.Render3DMap.__doc__ = "Render is for a 3D map"
+QgsRenderContext.ApplyClipAfterReprojection = Qgis.RenderContextFlag.ApplyClipAfterReprojection
+QgsRenderContext.ApplyClipAfterReprojection.is_monkey_patched = True
+QgsRenderContext.ApplyClipAfterReprojection.__doc__ = "Feature geometry clipping to mapExtent() must be performed after the geometries are transformed using coordinateTransform(). Usually feature geometry clipping occurs using the extent() in the layer's CRS prior to geometry transformation, but in some cases when extent() could not be accurately calculated it is necessary to clip geometries to mapExtent() AFTER transforming them using coordinateTransform()."
+Qgis.RenderContextFlag.__doc__ = 'Flags which affect rendering operations.\n\n.. versionadded:: 3.22\n\n' + '* ``DrawEditingInfo``: ' + Qgis.RenderContextFlag.DrawEditingInfo.__doc__ + '\n' + '* ``ForceVectorOutput``: ' + Qgis.RenderContextFlag.ForceVectorOutput.__doc__ + '\n' + '* ``UseAdvancedEffects``: ' + Qgis.RenderContextFlag.UseAdvancedEffects.__doc__ + '\n' + '* ``UseRenderingOptimization``: ' + Qgis.RenderContextFlag.UseRenderingOptimization.__doc__ + '\n' + '* ``DrawSelection``: ' + Qgis.RenderContextFlag.DrawSelection.__doc__ + '\n' + '* ``DrawSymbolBounds``: ' + Qgis.RenderContextFlag.DrawSymbolBounds.__doc__ + '\n' + '* ``RenderMapTile``: ' + Qgis.RenderContextFlag.RenderMapTile.__doc__ + '\n' + '* ``Antialiasing``: ' + Qgis.RenderContextFlag.Antialiasing.__doc__ + '\n' + '* ``RenderPartialOutput``: ' + Qgis.RenderContextFlag.RenderPartialOutput.__doc__ + '\n' + '* ``RenderPreviewJob``: ' + Qgis.RenderContextFlag.RenderPreviewJob.__doc__ + '\n' + '* ``RenderBlocking``: ' + Qgis.RenderContextFlag.RenderBlocking.__doc__ + '\n' + '* ``RenderSymbolPreview``: ' + Qgis.RenderContextFlag.RenderSymbolPreview.__doc__ + '\n' + '* ``LosslessImageRendering``: ' + Qgis.RenderContextFlag.LosslessImageRendering.__doc__ + '\n' + '* ``ApplyScalingWorkaroundForTextRendering``: ' + Qgis.RenderContextFlag.ApplyScalingWorkaroundForTextRendering.__doc__ + '\n' + '* ``Render3DMap``: ' + Qgis.RenderContextFlag.Render3DMap.__doc__ + '\n' + '* ``ApplyClipAfterReprojection``: ' + Qgis.RenderContextFlag.ApplyClipAfterReprojection.__doc__
+# --
+Qgis.RenderContextFlag.baseClass = Qgis
+QgsRenderContext.TextRenderFormat = Qgis.TextRenderFormat
+# monkey patching scoped based enum
+QgsRenderContext.TextFormatAlwaysOutlines = Qgis.TextRenderFormat.AlwaysOutlines
+QgsRenderContext.TextFormatAlwaysOutlines.is_monkey_patched = True
+QgsRenderContext.TextFormatAlwaysOutlines.__doc__ = "Always render text using path objects (AKA outlines/curves). This setting guarantees the best quality rendering, even when using a raster paint surface (where sub-pixel path based text rendering is superior to sub-pixel text-based rendering). The downside is that text is converted to paths only, so users cannot open created vector outputs for post-processing in other applications and retain text editability.  This setting also guarantees complete compatibility with the full range of formatting options available through QgsTextRenderer and QgsTextFormat, some of which may not be possible to reproduce when using a vector-based paint surface and TextFormatAlwaysText mode. A final benefit to this setting is that vector exports created using text as outlines do not require all users to have the original fonts installed in order to display the text in its original style."
+QgsRenderContext.TextFormatAlwaysText = Qgis.TextRenderFormat.AlwaysText
+QgsRenderContext.TextFormatAlwaysText.is_monkey_patched = True
+QgsRenderContext.TextFormatAlwaysText.__doc__ = "Always render text as text objects. While this mode preserves text objects as text for post-processing in external vector editing applications, it can result in rendering artifacts or poor quality rendering, depending on the text format settings. Even with raster based paint devices, TextFormatAlwaysText can result in inferior rendering quality to TextFormatAlwaysOutlines. When rendering using TextFormatAlwaysText to a vector based device (e.g. PDF or SVG), care must be taken to ensure that the required fonts are available to users when opening the created files, or default fallback fonts will be used to display the output instead. (Although PDF exports MAY automatically embed some fonts when possible, depending on the user's platform)."
+Qgis.TextRenderFormat.__doc__ = 'Options for rendering text.\n\n.. versionadded:: 3.22\n\n' + '* ``TextFormatAlwaysOutlines``: ' + Qgis.TextRenderFormat.AlwaysOutlines.__doc__ + '\n' + '* ``TextFormatAlwaysText``: ' + Qgis.TextRenderFormat.AlwaysText.__doc__
+# --
+Qgis.TextRenderFormat.baseClass = Qgis
diff --git a/python/core/auto_generated/annotations/qgsannotationmarkeritem.sip.in b/python/core/auto_generated/annotations/qgsannotationmarkeritem.sip.in
@@ -9,7 +9,6 @@
 
 
 
-
 class QgsAnnotationMarkerItem : QgsAnnotationItem
 {
 %Docstring(signature="appended")

diff --git a/python/core/auto_generated/labeling/qgslabelingenginesettings.sip.in b/python/core/auto_generated/labeling/qgslabelingenginesettings.sip.in
@@ -152,7 +152,7 @@ Write configuration of the labeling engine to a project
 %End
 
 
-    QgsRenderContext::TextRenderFormat defaultTextRenderFormat() const;
+    Qgis::TextRenderFormat defaultTextRenderFormat() const;
 %Docstring
 Returns the default text rendering format for the labels.
 
@@ -161,7 +161,7 @@ Returns the default text rendering format for the labels.
 .. versionadded:: 3.4.3
 %End
 
-    void setDefaultTextRenderFormat( QgsRenderContext::TextRenderFormat format );
+    void setDefaultTextRenderFormat( Qgis::TextRenderFormat format );
 %Docstring
 Sets the default text rendering ``format`` for the labels.
 

diff --git a/python/core/auto_generated/layout/qgslayoutexporter.sip.in b/python/core/auto_generated/layout/qgslayoutexporter.sip.in
@@ -192,7 +192,7 @@ Constructor for PdfExportSettings
 
       QgsLayoutRenderContext::Flags flags;
 
-      QgsRenderContext::TextRenderFormat textRenderFormat;
+      Qgis::TextRenderFormat textRenderFormat;
 
       bool simplifyGeometries;
 
@@ -312,7 +312,7 @@ Constructor for SvgExportSettings
 
       QgsLayoutRenderContext::Flags flags;
 
-      QgsRenderContext::TextRenderFormat textRenderFormat;
+      Qgis::TextRenderFormat textRenderFormat;
 
       bool simplifyGeometries;
 

diff --git a/python/core/auto_generated/layout/qgslayoutrendercontext.sip.in b/python/core/auto_generated/layout/qgslayoutrendercontext.sip.in
@@ -87,7 +87,7 @@ Check whether a particular rendering ``flag`` is enabled for the layout.
 .. seealso:: :py:func:`flags`
 %End
 
-    QgsRenderContext::Flags renderContextFlags() const;
+    Qgis::RenderContextFlags renderContextFlags() const;
 %Docstring
 Returns the combination of render context flags matched to the layout context's settings.
 %End
@@ -213,7 +213,7 @@ If ``layer`` is -1, all item layers should be rendered.
    Items should now handle this themselves, via :py:func:`QgsLayoutItem.exportLayerBehavior()` and returning :py:func:`QgsLayoutItem.nextExportPart()`.
 %End
 
-    QgsRenderContext::TextRenderFormat textRenderFormat() const;
+    Qgis::TextRenderFormat textRenderFormat() const;
 %Docstring
 Returns the text render format, which dictates how text is rendered (e.g. as paths or real text objects).
 
@@ -222,7 +222,7 @@ Returns the text render format, which dictates how text is rendered (e.g. as pat
 .. versionadded:: 3.4.3
 %End
 
-    void setTextRenderFormat( QgsRenderContext::TextRenderFormat format );
+    void setTextRenderFormat( Qgis::TextRenderFormat format );
 %Docstring
 Sets the text render ``format``, which dictates how text is rendered (e.g. as paths or real text objects).
 

diff --git a/python/core/auto_generated/qgis.sip.in b/python/core/auto_generated/qgis.sip.in
@@ -551,6 +551,55 @@ The development version
       Reverse
     };
 
+    enum class MapSettingsFlag
+      {
+      Antialiasing,
+      DrawEditingInfo,
+      ForceVectorOutput,
+      UseAdvancedEffects,
+      DrawLabeling,
+      UseRenderingOptimization,
+      DrawSelection,
+      DrawSymbolBounds,
+      RenderMapTile,
+      RenderPartialOutput,
+      RenderPreviewJob,
+      RenderBlocking,
+      LosslessImageRendering,
+      Render3DMap,
+    };
+    typedef QFlags<Qgis::MapSettingsFlag> MapSettingsFlags;
+
+
+    enum class RenderContextFlag
+      {
+      DrawEditingInfo,
+      ForceVectorOutput,
+      UseAdvancedEffects,
+      UseRenderingOptimization,
+      DrawSelection,
+      DrawSymbolBounds,
+      RenderMapTile,
+      Antialiasing,
+      RenderPartialOutput,
+      RenderPreviewJob,
+      RenderBlocking,
+      RenderSymbolPreview,
+      LosslessImageRendering,
+      ApplyScalingWorkaroundForTextRendering,
+      Render3DMap,
+      ApplyClipAfterReprojection,
+    };
+    typedef QFlags<Qgis::RenderContextFlag> RenderContextFlags;
+
+
+
+    enum class TextRenderFormat
+      {
+      AlwaysOutlines,
+      AlwaysText,
+    };
+
     static const double DEFAULT_SEARCH_RADIUS_MM;
 
     static const float DEFAULT_MAPTOPIXEL_THRESHOLD;
@@ -644,6 +693,11 @@ QFlags<Qgis::AnnotationItemFlag> operator|(Qgis::AnnotationItemFlag f1, QFlags<Q
 
 QFlags<Qgis::AnnotationItemGuiFlag> operator|(Qgis::AnnotationItemGuiFlag f1, QFlags<Qgis::AnnotationItemGuiFlag> f2);
 
+QFlags<Qgis::MapSettingsFlag> operator|(Qgis::MapSettingsFlag f1, QFlags<Qgis::MapSettingsFlag> f2);
+
+QFlags<Qgis::RenderContextFlag> operator|(Qgis::RenderContextFlag f1, QFlags<Qgis::RenderContextFlag> f2);
+
+
 
 
 

diff --git a/python/core/auto_generated/qgsmapdecoration.sip.in b/python/core/auto_generated/qgsmapdecoration.sip.in
@@ -9,6 +9,7 @@
 
 
 
+
 class QgsMapDecoration
 {
 %Docstring(signature="appended")