Skip to content
Permalink
Browse files

Add some missing dox and reference

(cherry picked from commit 224d6bc)
  • Loading branch information
DelazJ authored and nyalldawson committed Feb 5, 2020
1 parent 834b822 commit aa40b1946a4307d136dbb515147482ff8393635d
Showing with 56 additions and 6 deletions.
  1. +27 −2 python/core/auto_generated/qgsrendercontext.sip.in
  2. +29 −4 src/core/qgsrendercontext.h
@@ -238,11 +238,15 @@ of any faster raster shortcuts.
bool useAdvancedEffects() const;
%Docstring
Returns ``True`` if advanced effects such as blend modes such be used

.. seealso:: :py:func:`setUseAdvancedEffects`
%End

void setUseAdvancedEffects( bool enabled );
%Docstring
Used to enable or disable advanced effects such as blend modes

.. seealso:: :py:func:`useAdvancedEffects`
%End

bool drawEditingInformation() const;
@@ -411,9 +415,16 @@ Sets whether vector selections should be shown in the rendered map
bool useRenderingOptimization() const;
%Docstring
Returns ``True`` if the rendering optimization (geometry simplification) can be executed

.. seealso:: :py:func:`setUseRenderingOptimization`
%End

void setUseRenderingOptimization( bool enabled );
%Docstring
Sets whether the rendering optimization (geometry simplification) should be executed

.. seealso:: :py:func:`useRenderingOptimization`
%End

const QgsVectorSimplifyMethod &vectorSimplifyMethod() const;
%Docstring
@@ -497,22 +508,36 @@ Gets the filter feature provider used for additional filtering of rendered featu
%Docstring
Sets the segmentation tolerance applied when rendering curved geometries

:param tolerance: the segmentation tolerance*
:param tolerance: the segmentation tolerance

.. seealso:: :py:func:`segmentationTolerance`

.. seealso:: :py:func:`segmentationToleranceType`
%End

double segmentationTolerance() const;
%Docstring
Gets the segmentation tolerance applied when rendering curved geometries

.. seealso:: :py:func:`setSegmentationTolerance`
%End

void setSegmentationToleranceType( QgsAbstractGeometry::SegmentationToleranceType type );
%Docstring
Sets segmentation tolerance type (maximum angle or maximum difference between curve and approximation)

:param type: the segmentation tolerance typename*
:param type: the segmentation tolerance typename

.. seealso:: :py:func:`segmentationToleranceType`

.. seealso:: :py:func:`segmentationTolerance`
%End

QgsAbstractGeometry::SegmentationToleranceType segmentationToleranceType() const;
%Docstring
Gets segmentation tolerance type (maximum angle or maximum difference between curve and approximation)

.. seealso:: :py:func:`setSegmentationToleranceType`
%End


@@ -284,11 +284,15 @@ class CORE_EXPORT QgsRenderContext

/**
* Returns TRUE if advanced effects such as blend modes such be used
*
* \see setUseAdvancedEffects()
*/
bool useAdvancedEffects() const;

/**
* Used to enable or disable advanced effects such as blend modes
*
* \see useAdvancedEffects()
*/
void setUseAdvancedEffects( bool enabled );

@@ -452,9 +456,16 @@ class CORE_EXPORT QgsRenderContext

/**
* Returns TRUE if the rendering optimization (geometry simplification) can be executed
*
* \see setUseRenderingOptimization()
*/
bool useRenderingOptimization() const;

/**
* Sets whether the rendering optimization (geometry simplification) should be executed
*
* \see useRenderingOptimization()
*/
void setUseRenderingOptimization( bool enabled );

/**
@@ -530,16 +541,30 @@ class CORE_EXPORT QgsRenderContext

/**
* Sets the segmentation tolerance applied when rendering curved geometries
\param tolerance the segmentation tolerance*/
* \param tolerance the segmentation tolerance
* \see segmentationTolerance()
* \see segmentationToleranceType()
*/
void setSegmentationTolerance( double tolerance ) { mSegmentationTolerance = tolerance; }
//! Gets the segmentation tolerance applied when rendering curved geometries

/**
* Gets the segmentation tolerance applied when rendering curved geometries
* \see setSegmentationTolerance()
*/
double segmentationTolerance() const { return mSegmentationTolerance; }

/**
* Sets segmentation tolerance type (maximum angle or maximum difference between curve and approximation)
\param type the segmentation tolerance typename*/
* \param type the segmentation tolerance typename
* \see segmentationToleranceType()
* \see segmentationTolerance()
*/
void setSegmentationToleranceType( QgsAbstractGeometry::SegmentationToleranceType type ) { mSegmentationToleranceType = type; }
//! Gets segmentation tolerance type (maximum angle or maximum difference between curve and approximation)

/**
* Gets segmentation tolerance type (maximum angle or maximum difference between curve and approximation)
* \see setSegmentationToleranceType()
*/
QgsAbstractGeometry::SegmentationToleranceType segmentationToleranceType() const { return mSegmentationToleranceType; }

// Conversions

0 comments on commit aa40b19

Please sign in to comment.
You can’t perform that action at this time.