QGIS API Documentation  3.1.0-Master (97726d6)
Public Types | Public Member Functions | Static Public Member Functions | List of all members
QgsShapeburstFillSymbolLayer Class Reference

#include <qgsfillsymbollayer.h>

Inheritance diagram for QgsShapeburstFillSymbolLayer:
Inheritance graph
[legend]

Public Types

enum  ShapeburstColorType { SimpleTwoColor, ColorRamp }
 
- Public Types inherited from QgsSymbolLayer
enum  Property {
  PropertySize = 0, PropertyAngle, PropertyName, PropertyFillColor,
  PropertyStrokeColor, PropertyStrokeWidth, PropertyStrokeStyle, PropertyOffset,
  PropertyCharacter, PropertyWidth, PropertyHeight, PropertyPreserveAspectRatio,
  PropertyFillStyle, PropertyJoinStyle, PropertySecondaryColor, PropertyLineAngle,
  PropertyLineDistance, PropertyGradientType, PropertyCoordinateMode, PropertyGradientSpread,
  PropertyGradientReference1X, PropertyGradientReference1Y, PropertyGradientReference2X, PropertyGradientReference2Y,
  PropertyGradientReference1IsCentroid, PropertyGradientReference2IsCentroid, PropertyBlurRadius, PropertyShapeburstUseWholeShape,
  PropertyShapeburstMaxDistance, PropertyShapeburstIgnoreRings, PropertyFile, PropertyDistanceX,
  PropertyDistanceY, PropertyDisplacementX, PropertyDisplacementY, PropertyOpacity,
  PropertyCustomDash, PropertyCapStyle, PropertyPlacement, PropertyInterval,
  PropertyOffsetAlongLine, PropertyHorizontalAnchor, PropertyVerticalAnchor, PropertyLayerEnabled,
  PropertyArrowWidth, PropertyArrowStartWidth, PropertyArrowHeadLength, PropertyArrowHeadThickness,
  PropertyArrowHeadType, PropertyArrowType
}
 Data definable properties. More...
 

Public Member Functions

 QgsShapeburstFillSymbolLayer (const QColor &color=DEFAULT_SIMPLEFILL_COLOR, const QColor &color2=Qt::white, ShapeburstColorType colorType=SimpleTwoColor, int blurRadius=0, bool useWholeShape=true, double maxDistance=5)
 
 QgsShapeburstFillSymbolLayer (const QgsShapeburstFillSymbolLayer &other)=delete
 QgsShapeburstFillSymbolLayer cannot be copied. More...
 
 ~QgsShapeburstFillSymbolLayer () override
 
int blurRadius () const
 Returns the blur radius, which controls the amount of blurring applied to the fill. More...
 
QgsShapeburstFillSymbolLayerclone () const override
 Shall be reimplemented by subclasses to create a deep copy of the instance. More...
 
QColor color2 () const
 Returns the color used for the endpoint of the shapeburst fill. More...
 
QgsColorRampcolorRamp ()
 Returns the color ramp used for the shapeburst fill. More...
 
ShapeburstColorType colorType () const
 Returns the color mode used for the shapeburst fill. More...
 
const QgsMapUnitScaledistanceMapUnitScale () const
 
QgsUnitTypes::RenderUnit distanceUnit () const
 Returns the unit for the maximum distance to shade inside of the shape from the polygon's boundary. More...
 
double estimateMaxBleed (const QgsRenderContext &context) const override
 Returns the estimated maximum distance which the layer style will bleed outside the drawn shape when drawn in the specified /a context. More...
 
bool ignoreRings () const
 Returns whether the shapeburst fill is set to ignore polygon interior rings. More...
 
QString layerType () const override
 Returns a string that represents this layer type. More...
 
QgsMapUnitScale mapUnitScale () const override
 
double maxDistance () const
 Returns the maximum distance from the shape's boundary which is shaded. More...
 
QPointF offset () const
 Returns the offset for the shapeburst fill. More...
 
const QgsMapUnitScaleoffsetMapUnitScale () const
 
QgsUnitTypes::RenderUnit offsetUnit () const
 Returns the units used for the offset of the shapeburst fill. More...
 
QgsShapeburstFillSymbolLayeroperator= (const QgsShapeburstFillSymbolLayer &other)=delete
 QgsShapeburstFillSymbolLayer cannot be copied. More...
 
QgsUnitTypes::RenderUnit outputUnit () const override
 Returns the units to use for sizes and widths within the symbol layer. More...
 
QgsStringMap properties () const override
 Should be reimplemented by subclasses to return a string map that contains the configuration information for the symbol layer. More...
 
void renderPolygon (const QPolygonF &points, QList< QPolygonF > *rings, QgsSymbolRenderContext &context) override
 
void setBlurRadius (int blurRadius)
 Sets the blur radius, which controls the amount of blurring applied to the fill. More...
 
void setColor2 (const QColor &color2)
 Sets the color for the endpoint of the shapeburst fill. More...
 
void setColorRamp (QgsColorRamp *ramp)
 Sets the color ramp used to draw the shapeburst fill. More...
 
void setColorType (ShapeburstColorType colorType)
 Sets the color mode to use for the shapeburst fill. More...
 
void setDistanceMapUnitScale (const QgsMapUnitScale &scale)
 
void setDistanceUnit (QgsUnitTypes::RenderUnit unit)
 Sets the unit for the maximum distance to shade inside of the shape from the polygon's boundary. More...
 
void setIgnoreRings (bool ignoreRings)
 Sets whether the shapeburst fill should ignore polygon rings when calculating the buffered shading. More...
 
void setMapUnitScale (const QgsMapUnitScale &scale) override
 
void setMaxDistance (double maxDistance)
 Sets the maximum distance to shape inside of the shape from the polygon's boundary. More...
 
void setOffset (QPointF offset)
 Sets the offset for the shapeburst fill. More...
 
void setOffsetMapUnitScale (const QgsMapUnitScale &scale)
 
void setOffsetUnit (QgsUnitTypes::RenderUnit unit)
 Sets the units used for the offset for the shapeburst fill. More...
 
void setOutputUnit (QgsUnitTypes::RenderUnit unit) override
 Sets the units to use for sizes and widths within the symbol layer. More...
 
void setUseWholeShape (bool useWholeShape)
 Sets whether the shapeburst fill should be drawn using the entire shape. More...
 
void startRender (QgsSymbolRenderContext &context) override
 
void stopRender (QgsSymbolRenderContext &context) override
 
bool useWholeShape () const
 Returns whether the shapeburst fill is set to cover the entire shape. More...
 
- Public Member Functions inherited from QgsFillSymbolLayer
double angle () const
 
void drawPreviewIcon (QgsSymbolRenderContext &context, QSize size) override
 
void setAngle (double angle)
 
- Public Member Functions inherited from QgsSymbolLayer
virtual ~QgsSymbolLayer ()
 
virtual QColor color () const
 The fill color. More...
 
QgsPropertyCollectiondataDefinedProperties ()
 Returns a reference to the symbol layer's property collection, used for data defined overrides. More...
 
const QgsPropertyCollectiondataDefinedProperties () const
 Returns a reference to the symbol layer's property collection, used for data defined overrides. More...
 
virtual double dxfAngle (QgsSymbolRenderContext &context) const
 Gets angle. More...
 
virtual QColor dxfBrushColor (QgsSymbolRenderContext &context) const
 Gets brush/fill color. More...
 
virtual Qt::BrushStyle dxfBrushStyle () const
 Gets brush/fill style. More...
 
virtual QColor dxfColor (QgsSymbolRenderContext &context) const
 Gets color. More...
 
virtual QVector< qreal > dxfCustomDashPattern (QgsUnitTypes::RenderUnit &unit) const
 Gets dash pattern. More...
 
virtual double dxfOffset (const QgsDxfExport &e, QgsSymbolRenderContext &context) const
 Gets offset. More...
 
virtual Qt::PenStyle dxfPenStyle () const
 Gets pen style. More...
 
virtual double dxfWidth (const QgsDxfExport &e, QgsSymbolRenderContext &context) const
 Gets line width. More...
 
bool enabled () const
 Returns true if symbol layer is enabled and will be drawn. More...
 
virtual QColor fillColor () const
 Gets fill color. More...
 
virtual bool isCompatibleWithSymbol (QgsSymbol *symbol) const
 Returns if the layer can be used below the specified symbol. More...
 
bool isLocked () const
 
virtual QString ogrFeatureStyle (double mmScaleFactor, double mapUnitScaleFactor) const
 
QgsPaintEffectpaintEffect () const
 Returns the current paint effect for the layer. More...
 
virtual void prepareExpressions (const QgsSymbolRenderContext &context)
 Prepares all data defined property expressions for evaluation. More...
 
int renderingPass () const
 
virtual void setColor (const QColor &color)
 The fill color. More...
 
void setDataDefinedProperties (const QgsPropertyCollection &collection)
 Sets the symbol layer's property collection, used for data defined overrides. More...
 
virtual void setDataDefinedProperty (Property key, const QgsProperty &property)
 Sets a data defined property for the layer. More...
 
void setEnabled (bool enabled)
 Sets whether symbol layer is enabled and should be drawn. More...
 
virtual void setFillColor (const QColor &color)
 Set fill color. More...
 
void setLocked (bool locked)
 
void setPaintEffect (QgsPaintEffect *effect)
 Sets the current paint effect for the layer. More...
 
void setRenderingPass (int renderingPass)
 
virtual void setStrokeColor (const QColor &color)
 Set stroke color. More...
 
virtual bool setSubSymbol (QgsSymbol *symbol)
 Sets layer's subsymbol. takes ownership of the passed symbol. More...
 
virtual QColor strokeColor () const
 Gets stroke color. More...
 
virtual QgsSymbolsubSymbol ()
 Returns the symbol's sub symbol, if present. More...
 
virtual void toSld (QDomDocument &doc, QDomElement &element, const QgsStringMap &props) const
 
QgsSymbol::SymbolType type () const
 
virtual QSet< QString > usedAttributes (const QgsRenderContext &context) const
 Returns the set of attributes referenced by the layer. More...
 
virtual bool writeDxf (QgsDxfExport &e, double mmMapUnitScaleFactor, const QString &layerName, QgsSymbolRenderContext &context, QPointF shift=QPointF(0.0, 0.0)) const
 write as DXF More...
 

Static Public Member Functions

static QgsSymbolLayercreate (const QgsStringMap &properties=QgsStringMap())
 
- Static Public Member Functions inherited from QgsSymbolLayer
static const QgsPropertiesDefinitionpropertyDefinitions ()
 Returns the symbol layer property definitions. More...
 

Additional Inherited Members

- Protected Member Functions inherited from QgsFillSymbolLayer
 QgsFillSymbolLayer (bool locked=false)
 
void _renderPolygon (QPainter *p, const QPolygonF &points, const QList< QPolygonF > *rings, QgsSymbolRenderContext &context)
 Default method to render polygon. More...
 
- Protected Member Functions inherited from QgsSymbolLayer
 QgsSymbolLayer (QgsSymbol::SymbolType type, bool locked=false)
 
void copyDataDefinedProperties (QgsSymbolLayer *destLayer) const
 Copies all data defined properties of this layer to another symbol layer. More...
 
void copyPaintEffect (QgsSymbolLayer *destLayer) const
 Copies paint effect of this layer to another symbol layer. More...
 
void restoreOldDataDefinedProperties (const QgsStringMap &stringMap)
 Restores older data defined properties from string map. More...
 
- Protected Attributes inherited from QgsFillSymbolLayer
double mAngle = 0.0
 
- Protected Attributes inherited from QgsSymbolLayer
QColor mColor
 
QgsPropertyCollection mDataDefinedProperties
 
bool mEnabled
 True if layer is enabled and should be drawn. More...
 
QgsFields mFields
 
bool mLocked
 
QgsPaintEffectmPaintEffect = nullptr
 
int mRenderingPass
 
QgsSymbol::SymbolType mType
 
- Static Protected Attributes inherited from QgsSymbolLayer
static const bool SELECT_FILL_BORDER = false
 Whether fill styles for selected features also highlight symbol stroke. More...
 
static const bool SELECT_FILL_STYLE = false
 Whether fill styles for selected features uses symbol layer style. More...
 
static const bool SELECTION_IS_OPAQUE = true
 Whether styles for selected features ignore symbol alpha. More...
 

Detailed Description

Definition at line 339 of file qgsfillsymbollayer.h.

Member Enumeration Documentation

◆ ShapeburstColorType

Enumerator
SimpleTwoColor 
ColorRamp 

Definition at line 343 of file qgsfillsymbollayer.h.

Constructor & Destructor Documentation

◆ QgsShapeburstFillSymbolLayer() [1/2]

QgsShapeburstFillSymbolLayer::QgsShapeburstFillSymbolLayer ( const QColor &  color = DEFAULT_SIMPLEFILL_COLOR,
const QColor &  color2 = Qt::white,
ShapeburstColorType  colorType = SimpleTwoColor,
int  blurRadius = 0,
bool  useWholeShape = true,
double  maxDistance = 5 
)

Definition at line 940 of file qgsfillsymbollayer.cpp.

◆ ~QgsShapeburstFillSymbolLayer()

QgsShapeburstFillSymbolLayer::~QgsShapeburstFillSymbolLayer ( )
overridedefault

◆ QgsShapeburstFillSymbolLayer() [2/2]

QgsShapeburstFillSymbolLayer::QgsShapeburstFillSymbolLayer ( const QgsShapeburstFillSymbolLayer other)
delete

QgsShapeburstFillSymbolLayer cannot be copied.

See also
clone()

Member Function Documentation

◆ blurRadius()

int QgsShapeburstFillSymbolLayer::blurRadius ( ) const
inline

Returns the blur radius, which controls the amount of blurring applied to the fill.

Returns
Integer representing the radius for fill blur. Higher values indicate a stronger blur. A 0 value indicates that blurring is disabled.
See also
setBlurRadius
Since
QGIS 2.3

Definition at line 401 of file qgsfillsymbollayer.h.

◆ clone()

QgsShapeburstFillSymbolLayer * QgsShapeburstFillSymbolLayer::clone ( ) const
overridevirtual

Shall be reimplemented by subclasses to create a deep copy of the instance.

Implements QgsSymbolLayer.

Definition at line 1493 of file qgsfillsymbollayer.cpp.

◆ color2()

QColor QgsShapeburstFillSymbolLayer::color2 ( ) const
inline

Returns the color used for the endpoint of the shapeburst fill.

This color is only used if the colorType is set to ShapeburstColorType::SimpleTwoColor

Returns
a QColor indicating the color of the endpoint of the gradient
See also
setColor2
colorType
Since
QGIS 2.3

Definition at line 521 of file qgsfillsymbollayer.h.

◆ colorRamp()

QgsColorRamp* QgsShapeburstFillSymbolLayer::colorRamp ( )
inline

Returns the color ramp used for the shapeburst fill.

The color ramp is only used if the colorType is set to ShapeburstColorType::ColorRamp

Returns
a QgsColorRamp color ramp
See also
setColorRamp
colorType
Since
QGIS 2.3

Definition at line 503 of file qgsfillsymbollayer.h.

◆ colorType()

ShapeburstColorType QgsShapeburstFillSymbolLayer::colorType ( ) const
inline

Returns the color mode used for the shapeburst fill.

Shapeburst can either be drawn using a QgsColorRamp color ramp or by simply specificing a start and end color.

Returns
current color mode used for the shapeburst fill
See also
setColorType
color
color2
colorRamp
Since
QGIS 2.3

Definition at line 485 of file qgsfillsymbollayer.h.

◆ create()

QgsSymbolLayer * QgsShapeburstFillSymbolLayer::create ( const QgsStringMap properties = QgsStringMap())
static

Definition at line 953 of file qgsfillsymbollayer.cpp.

◆ distanceMapUnitScale()

const QgsMapUnitScale& QgsShapeburstFillSymbolLayer::distanceMapUnitScale ( ) const
inline

Definition at line 461 of file qgsfillsymbollayer.h.

◆ distanceUnit()

QgsUnitTypes::RenderUnit QgsShapeburstFillSymbolLayer::distanceUnit ( ) const
inline

Returns the unit for the maximum distance to shade inside of the shape from the polygon's boundary.

Returns
distance unit for the maximum distance
See also
maxDistance
setDistanceUnit
Since
QGIS 2.3

Definition at line 458 of file qgsfillsymbollayer.h.

◆ estimateMaxBleed()

double QgsShapeburstFillSymbolLayer::estimateMaxBleed ( const QgsRenderContext context) const
overridevirtual

Returns the estimated maximum distance which the layer style will bleed outside the drawn shape when drawn in the specified /a context.

For example, polygons drawn with an stroke will draw half the width of the stroke outside of the polygon. This amount is estimated, since it may be affected by data defined symbology rules.

Reimplemented from QgsSymbolLayer.

Definition at line 1511 of file qgsfillsymbollayer.cpp.

◆ ignoreRings()

bool QgsShapeburstFillSymbolLayer::ignoreRings ( ) const
inline

Returns whether the shapeburst fill is set to ignore polygon interior rings.

Returns
True if the shapeburst fill will ignore interior rings when calculating buffered shading.
See also
setIgnoreRings
Since
QGIS 2.3

Definition at line 538 of file qgsfillsymbollayer.h.

◆ layerType()

QString QgsShapeburstFillSymbolLayer::layerType ( ) const
overridevirtual

Returns a string that represents this layer type.

Used for serialization. Should match with the string used to register this symbol layer in the registry.

Implements QgsSymbolLayer.

Definition at line 1048 of file qgsfillsymbollayer.cpp.

◆ mapUnitScale()

QgsMapUnitScale QgsShapeburstFillSymbolLayer::mapUnitScale ( ) const
overridevirtual

Reimplemented from QgsSymbolLayer.

Definition at line 1538 of file qgsfillsymbollayer.cpp.

◆ maxDistance()

double QgsShapeburstFillSymbolLayer::maxDistance ( ) const
inline

Returns the maximum distance from the shape's boundary which is shaded.

This parameter is only effective if useWholeShape is false.

Returns
the maximum distance from the polygon's boundary which is shaded. Distance units are indicated by distanceUnit.
See also
useWholeShape
setMaxDistance
distanceUnit
Since
QGIS 2.3

Definition at line 440 of file qgsfillsymbollayer.h.

◆ offset()

QPointF QgsShapeburstFillSymbolLayer::offset ( ) const
inline

Returns the offset for the shapeburst fill.

Returns
a QPointF indicating the horizontal/vertical offset amount
See also
setOffset
offsetUnit
Since
QGIS 2.3

Definition at line 556 of file qgsfillsymbollayer.h.

◆ offsetMapUnitScale()

const QgsMapUnitScale& QgsShapeburstFillSymbolLayer::offsetMapUnitScale ( ) const
inline

Definition at line 577 of file qgsfillsymbollayer.h.

◆ offsetUnit()

QgsUnitTypes::RenderUnit QgsShapeburstFillSymbolLayer::offsetUnit ( ) const
inline

Returns the units used for the offset of the shapeburst fill.

Returns
units used for the fill offset
See also
offset
setOffsetUnit
Since
QGIS 2.3

Definition at line 574 of file qgsfillsymbollayer.h.

◆ operator=()

QgsShapeburstFillSymbolLayer& QgsShapeburstFillSymbolLayer::operator= ( const QgsShapeburstFillSymbolLayer other)
delete

QgsShapeburstFillSymbolLayer cannot be copied.

See also
clone()

◆ outputUnit()

QgsUnitTypes::RenderUnit QgsShapeburstFillSymbolLayer::outputUnit ( ) const
overridevirtual

Returns the units to use for sizes and widths within the symbol layer.

Individual symbol layer subclasses will interpret this in different ways, e.g., a marker symbol layer may use it to specify the units for the marker size, while a line symbol layer may use it to specify the units for the line width.

Returns
output unit, or QgsUnitTypes::RenderUnknownUnit if the symbol layer contains mixed units
See also
setOutputUnit()

Reimplemented from QgsSymbolLayer.

Definition at line 1523 of file qgsfillsymbollayer.cpp.

◆ properties()

QgsStringMap QgsShapeburstFillSymbolLayer::properties ( ) const
overridevirtual

Should be reimplemented by subclasses to return a string map that contains the configuration information for the symbol layer.

This is used to serialize a symbol layer perstistently.

Implements QgsSymbolLayer.

Definition at line 1470 of file qgsfillsymbollayer.cpp.

◆ renderPolygon()

void QgsShapeburstFillSymbolLayer::renderPolygon ( const QPolygonF &  points,
QList< QPolygonF > *  rings,
QgsSymbolRenderContext context 
)
overridevirtual

Implements QgsFillSymbolLayer.

Definition at line 1128 of file qgsfillsymbollayer.cpp.

◆ setBlurRadius()

void QgsShapeburstFillSymbolLayer::setBlurRadius ( int  blurRadius)
inline

Sets the blur radius, which controls the amount of blurring applied to the fill.

Parameters
blurRadiusRadius for fill blur. Values between 0 - 17 are valid, where higher values results in a stronger blur. Set to 0 to disable blur.
See also
blurRadius
Since
QGIS 2.3

Definition at line 393 of file qgsfillsymbollayer.h.

◆ setColor2()

void QgsShapeburstFillSymbolLayer::setColor2 ( const QColor &  color2)
inline

Sets the color for the endpoint of the shapeburst fill.

This color is only used if setColorType is set ShapeburstColorType::SimpleTwoColor.

Parameters
color2QColor to use for endpoint of gradient
See also
setColorType
color2
Since
QGIS 2.3

Definition at line 512 of file qgsfillsymbollayer.h.

◆ setColorRamp()

void QgsShapeburstFillSymbolLayer::setColorRamp ( QgsColorRamp ramp)

Sets the color ramp used to draw the shapeburst fill.

Color ramps are only used if setColorType is set ShapeburstColorType::ColorRamp.

Parameters
rampcolor ramp to use for shapeburst fill
See also
setColorType
colorRamp
Since
QGIS 2.3

Definition at line 1053 of file qgsfillsymbollayer.cpp.

◆ setColorType()

void QgsShapeburstFillSymbolLayer::setColorType ( ShapeburstColorType  colorType)
inline

Sets the color mode to use for the shapeburst fill.

Shapeburst can either be drawn using a QgsColorRamp color ramp or by simply specificing a start and end color. setColorType is used to specify which mode to use for the fill.

Parameters
colorTypecolor type to use for shapeburst fill
See also
colorType
setColor
setColor2
setColorRamp
Since
QGIS 2.3

Definition at line 473 of file qgsfillsymbollayer.h.

◆ setDistanceMapUnitScale()

void QgsShapeburstFillSymbolLayer::setDistanceMapUnitScale ( const QgsMapUnitScale scale)
inline

Definition at line 460 of file qgsfillsymbollayer.h.

◆ setDistanceUnit()

void QgsShapeburstFillSymbolLayer::setDistanceUnit ( QgsUnitTypes::RenderUnit  unit)
inline

Sets the unit for the maximum distance to shade inside of the shape from the polygon's boundary.

Parameters
unitdistance unit for the maximum distance
See also
setMaxDistance
distanceUnit
Since
QGIS 2.3

Definition at line 449 of file qgsfillsymbollayer.h.

◆ setIgnoreRings()

void QgsShapeburstFillSymbolLayer::setIgnoreRings ( bool  ignoreRings)
inline

Sets whether the shapeburst fill should ignore polygon rings when calculating the buffered shading.

Parameters
ignoreRingsSet to true if buffers should ignore interior rings for polygons.
See also
ignoreRings
Since
QGIS 2.3

Definition at line 530 of file qgsfillsymbollayer.h.

◆ setMapUnitScale()

void QgsShapeburstFillSymbolLayer::setMapUnitScale ( const QgsMapUnitScale scale)
overridevirtual

Reimplemented from QgsSymbolLayer.

Definition at line 1532 of file qgsfillsymbollayer.cpp.

◆ setMaxDistance()

void QgsShapeburstFillSymbolLayer::setMaxDistance ( double  maxDistance)
inline

Sets the maximum distance to shape inside of the shape from the polygon's boundary.

Parameters
maxDistancedistance from boundary to shade. setUseWholeShape must be set to false for this parameter to take effect. Distance unit is controlled by setDistanceUnit.
See also
maxDistance
setUseWholeShape
setDistanceUnit
Since
QGIS 2.3

Definition at line 430 of file qgsfillsymbollayer.h.

◆ setOffset()

void QgsShapeburstFillSymbolLayer::setOffset ( QPointF  offset)
inline

Sets the offset for the shapeburst fill.

Parameters
offsetQPointF indicating the horizontal/vertical offset amount
See also
offset
setOffsetUnit
Since
QGIS 2.3

Definition at line 547 of file qgsfillsymbollayer.h.

◆ setOffsetMapUnitScale()

void QgsShapeburstFillSymbolLayer::setOffsetMapUnitScale ( const QgsMapUnitScale scale)
inline

Definition at line 576 of file qgsfillsymbollayer.h.

◆ setOffsetUnit()

void QgsShapeburstFillSymbolLayer::setOffsetUnit ( QgsUnitTypes::RenderUnit  unit)
inline

Sets the units used for the offset for the shapeburst fill.

Parameters
unitunits for fill offset
See also
setOffset
offsetUnit
Since
QGIS 2.3

Definition at line 565 of file qgsfillsymbollayer.h.

◆ setOutputUnit()

void QgsShapeburstFillSymbolLayer::setOutputUnit ( QgsUnitTypes::RenderUnit  unit)
overridevirtual

Sets the units to use for sizes and widths within the symbol layer.

Individual symbol layer subclasses will interpret this in different ways, e.g., a marker symbol layer may use it to specify the units for the marker size, while a line symbol layer may use it to specify the units for the line width.

Parameters
unitoutput units
See also
outputUnit()

Reimplemented from QgsSymbolLayer.

Definition at line 1517 of file qgsfillsymbollayer.cpp.

◆ setUseWholeShape()

void QgsShapeburstFillSymbolLayer::setUseWholeShape ( bool  useWholeShape)
inline

Sets whether the shapeburst fill should be drawn using the entire shape.

Parameters
useWholeShapeSet to true if shapeburst should cover entire shape. If false, setMaxDistance is used to calculate how far from the boundary of the shape should be shaded
See also
useWholeShape
setMaxDistance
Since
QGIS 2.3

Definition at line 411 of file qgsfillsymbollayer.h.

◆ startRender()

void QgsShapeburstFillSymbolLayer::startRender ( QgsSymbolRenderContext context)
overridevirtual

Implements QgsSymbolLayer.

Definition at line 1114 of file qgsfillsymbollayer.cpp.

◆ stopRender()

void QgsShapeburstFillSymbolLayer::stopRender ( QgsSymbolRenderContext context)
overridevirtual

Implements QgsSymbolLayer.

Definition at line 1123 of file qgsfillsymbollayer.cpp.

◆ useWholeShape()

bool QgsShapeburstFillSymbolLayer::useWholeShape ( ) const
inline

Returns whether the shapeburst fill is set to cover the entire shape.

Returns
True if shapeburst fill will cover the entire shape. If false, shapeburst is drawn to a distance of maxDistance from the polygon's boundary.
See also
setUseWholeShape
maxDistance
Since
QGIS 2.3

Definition at line 420 of file qgsfillsymbollayer.h.


The documentation for this class was generated from the following files: