QGIS API Documentation 3.34.0-Prizren (ffbdd678812)
|
A simple direct line callout style. More...
#include <qgscallout.h>
Public Member Functions | |
QgsSimpleLineCallout () | |
QgsSimpleLineCallout (const QgsSimpleLineCallout &other) | |
Copy constructor. | |
~QgsSimpleLineCallout () override | |
QgsSimpleLineCallout * | clone () const override |
Duplicates a callout by creating a deep copy of the callout. | |
bool | drawCalloutToAllParts () const |
Returns true if callout lines should be drawn to all feature parts. | |
QgsLineSymbol * | lineSymbol () |
Returns the line symbol used to render the callout line. | |
double | minimumLength () const |
Returns the minimum length of callout lines. | |
const QgsMapUnitScale & | minimumLengthMapUnitScale () const |
Returns the map unit scale for the minimum callout length. | |
Qgis::RenderUnit | minimumLengthUnit () const |
Returns the units for the minimum length of callout lines. | |
double | offsetFromAnchor () const |
Returns the offset distance from the anchor point at which to start the line. | |
const QgsMapUnitScale & | offsetFromAnchorMapUnitScale () const |
Returns the map unit scale for the offset from anchor. | |
Qgis::RenderUnit | offsetFromAnchorUnit () const |
Returns the units for the offset from anchor point. | |
double | offsetFromLabel () const |
Returns the offset distance from label area at which to end the line. | |
const QgsMapUnitScale & | offsetFromLabelMapUnitScale () const |
Returns the map unit scale for the minimum callout length. | |
Qgis::RenderUnit | offsetFromLabelUnit () const |
Returns the units for the offset from label area. | |
QgsSimpleLineCallout & | operator= (const QgsSimpleLineCallout &)=delete |
QVariantMap | properties (const QgsReadWriteContext &context) const override |
Returns the properties describing the callout encoded in a string format. | |
void | readProperties (const QVariantMap &props, const QgsReadWriteContext &context) override |
Reads a string map of an callout's properties and restores the callout to the state described by the properties map. | |
QSet< QString > | referencedFields (const QgsRenderContext &context) const override |
Returns the set of attributes referenced by the callout. | |
void | setDrawCalloutToAllParts (bool drawToAllParts) |
Sets whether callout lines should be drawn to all feature parts. | |
void | setLineSymbol (QgsLineSymbol *symbol) |
Sets the line symbol used to render the callout line. | |
void | setMinimumLength (double length) |
Sets the minimum length of callout lines. | |
void | setMinimumLengthMapUnitScale (const QgsMapUnitScale &scale) |
Sets the map unit scale for the minimum callout length. | |
void | setMinimumLengthUnit (Qgis::RenderUnit unit) |
Sets the unit for the minimum length of callout lines. | |
void | setOffsetFromAnchor (double distance) |
Sets the offset distance from the anchor point at which to start the line. | |
void | setOffsetFromAnchorMapUnitScale (const QgsMapUnitScale &scale) |
Sets the map unit scale for the offset from anchor. | |
void | setOffsetFromAnchorUnit (Qgis::RenderUnit unit) |
Sets the unit for the offset from anchor distance. | |
void | setOffsetFromLabel (double distance) |
Sets the offset distance from label area at which to end the line. | |
void | setOffsetFromLabelMapUnitScale (const QgsMapUnitScale &scale) |
Sets the map unit scale for the offset from label area. | |
void | setOffsetFromLabelUnit (Qgis::RenderUnit unit) |
Sets the unit for the offset from label area distance. | |
void | startRender (QgsRenderContext &context) override |
Prepares the callout for rendering on the specified render context. | |
void | stopRender (QgsRenderContext &context) override |
Finalises the callout after a set of rendering operations on the specified render context. | |
QString | type () const override |
Returns a unique string representing the callout type. | |
Public Member Functions inherited from QgsCallout | |
QgsCallout () | |
Constructor for QgsCallout. | |
virtual | ~QgsCallout ()=default |
AnchorPoint | anchorPoint () const |
Returns the feature's anchor point position. | |
QPainter::CompositionMode | blendMode () const |
Returns the blending mode used for drawing callouts. | |
bool | containsAdvancedEffects () const |
Returns true if the callout requires advanced effects such as blend modes, which require output in raster formats to be fully respected. | |
QgsPropertyCollection & | dataDefinedProperties () |
Returns a reference to the callout's property collection, used for data defined overrides. | |
const QgsPropertyCollection & | dataDefinedProperties () const |
Returns a reference to the callout's property collection, used for data defined overrides. | |
virtual DrawOrder | drawOrder () const |
Returns the desired drawing order (stacking) to use while rendering this callout. | |
bool | enabled () const |
Returns true if the the callout is enabled. | |
LabelAnchorPoint | labelAnchorPoint () const |
Returns the label's anchor point position. | |
void | render (QgsRenderContext &context, const QRectF &rect, const double angle, const QgsGeometry &anchor, QgsCalloutContext &calloutContext) |
Renders the callout onto the specified render context. | |
virtual void | restoreProperties (const QDomElement &element, const QgsReadWriteContext &context) |
Restores the callout's properties from a DOM element. | |
virtual bool | saveProperties (QDomDocument &doc, QDomElement &element, const QgsReadWriteContext &context) const |
Saves the current state of the callout to a DOM element. | |
void | setAnchorPoint (AnchorPoint anchor) |
Sets the feature's anchor point position. | |
void | setBlendMode (QPainter::CompositionMode mode) |
Sets the blending mode used for drawing callouts. | |
void | setDataDefinedProperties (const QgsPropertyCollection &collection) |
Sets the callout's property collection, used for data defined overrides. | |
void | setEnabled (bool enabled) |
Sets whether the callout is enabled. | |
void | setLabelAnchorPoint (LabelAnchorPoint anchor) |
Sets the label's anchor point position. | |
Static Public Member Functions | |
static QgsCallout * | create (const QVariantMap &properties=QVariantMap(), const QgsReadWriteContext &context=QgsReadWriteContext()) |
Creates a new QgsSimpleLineCallout, using the settings serialized in the properties map (corresponding to the output from QgsSimpleLineCallout::properties() ). | |
Static Public Member Functions inherited from QgsCallout | |
static QgsCallout::AnchorPoint | decodeAnchorPoint (const QString &name, bool *ok=nullptr) |
Attempts to decode a string representation of an anchor point name to the corresponding anchor point. | |
static QgsCallout::LabelAnchorPoint | decodeLabelAnchorPoint (const QString &name, bool *ok=nullptr) |
Attempts to decode a string representation of a label anchor point name to the corresponding anchor point. | |
static QString | encodeAnchorPoint (AnchorPoint anchor) |
Encodes an anchor point to its string representation. | |
static QString | encodeLabelAnchorPoint (LabelAnchorPoint anchor) |
Encodes a label anchor point to its string representation. | |
static QgsPropertiesDefinition | propertyDefinitions () |
Returns the definitions for data defined properties available for use in callouts. | |
Protected Member Functions | |
virtual QgsCurve * | createCalloutLine (const QgsPoint &start, const QgsPoint &end, QgsRenderContext &context, const QRectF &bodyBoundingBox, const double angle, const QgsGeometry &anchor, QgsCallout::QgsCalloutContext &calloutContext) const |
Creates a callout line between start and end in the desired style. | |
void | draw (QgsRenderContext &context, const QRectF &bodyBoundingBox, const double angle, const QgsGeometry &anchor, QgsCallout::QgsCalloutContext &calloutContext) override |
Performs the actual rendering of the callout implementation onto the specified render context. | |
Protected Member Functions inherited from QgsCallout | |
QgsGeometry | calloutLabelPoint (const QRectF &bodyBoundingBox, double angle, LabelAnchorPoint anchor, QgsRenderContext &context, const QgsCalloutContext &calloutContext, bool &pinned) const |
Returns the anchor point geometry for a label with the given bounding box and anchor point mode. | |
QgsGeometry | calloutLineToPart (const QgsGeometry &labelGeometry, const QgsAbstractGeometry *partGeometry, QgsRenderContext &context, const QgsCalloutContext &calloutContext, bool &pinned) const |
Calculates the direct line from a label geometry to an anchor geometry part, respecting the various callout settings which influence how the callout end should be placed in the anchor geometry. | |
Q_DECL_DEPRECATED QgsGeometry | labelAnchorGeometry (const QRectF &bodyBoundingBox, const double angle, LabelAnchorPoint anchor) const |
Returns the anchor point geometry for a label with the given bounding box and anchor point mode. | |
Additional Inherited Members | |
Public Types inherited from QgsCallout | |
enum | AnchorPoint { PoleOfInaccessibility = 0 , PointOnExterior , PointOnSurface , Centroid } |
Feature's anchor point position. More... | |
enum | DrawOrder { OrderBelowAllLabels , OrderBelowIndividualLabels } |
Options for draw order (stacking) of callouts. More... | |
enum | LabelAnchorPoint { LabelPointOnExterior , LabelCentroid , LabelTopLeft , LabelTopMiddle , LabelTopRight , LabelMiddleLeft , LabelMiddleRight , LabelBottomLeft , LabelBottomMiddle , LabelBottomRight } |
Label's anchor point position. More... | |
enum | Property { MinimumCalloutLength , OffsetFromAnchor , OffsetFromLabel , DrawCalloutToAllParts , AnchorPointPosition , LabelAnchorPointPosition , OriginX , OriginY , DestinationX , DestinationY , Curvature , Orientation , Margins , WedgeWidth , CornerRadius , BlendMode } |
Data definable properties. More... | |
QgsSimpleLineCallout::QgsSimpleLineCallout | ( | ) |
Definition at line 530 of file qgscallout.cpp.
|
overridedefault |
QgsSimpleLineCallout::QgsSimpleLineCallout | ( | const QgsSimpleLineCallout & | other | ) |
Copy constructor.
Definition at line 538 of file qgscallout.cpp.
|
overridevirtual |
Duplicates a callout by creating a deep copy of the callout.
Caller takes ownership of the returned object.
Implements QgsCallout.
Definition at line 567 of file qgscallout.cpp.
|
static |
Creates a new QgsSimpleLineCallout, using the settings serialized in the properties map (corresponding to the output from QgsSimpleLineCallout::properties() ).
Definition at line 555 of file qgscallout.cpp.
|
protectedvirtual |
Creates a callout line between start and end in the desired style.
The base class method returns a straight line.
Reimplemented in QgsManhattanLineCallout, and QgsCurvedLineCallout.
Definition at line 744 of file qgscallout.cpp.
|
overrideprotectedvirtual |
Performs the actual rendering of the callout implementation onto the specified render context.
The bodyBoundingBox argument gives the desired size and position of the body of the callout (e.g. the actual label geometry). The angle argument specifies the rotation of the callout body (in degrees clockwise from horizontal). It is assumed that angle rotation specified via angle is applied around the center of rect.
The anchor argument dictates the geometry which the callout should connect to. Depending on the callout subclass and anchor geometry type, the actual shape of the rendered callout may vary. E.g. a subclass may prefer to attach to the centroid of the anchor, while another subclass may prefer to attach to the closest point on anchor instead.
Both rect and anchor are specified in painter coordinates (i.e. pixels).
The calloutContext argument is used to specify additional contextual information about how a callout is being rendered.
Implements QgsCallout.
Definition at line 654 of file qgscallout.cpp.
|
inline |
Returns true
if callout lines should be drawn to all feature parts.
Definition at line 696 of file qgscallout.h.
QgsLineSymbol * QgsSimpleLineCallout::lineSymbol | ( | ) |
Returns the line symbol used to render the callout line.
Ownership is not transferred.
Definition at line 644 of file qgscallout.cpp.
|
inline |
Returns the minimum length of callout lines.
Units are specified through minimumLengthUnits().
Definition at line 563 of file qgscallout.h.
|
inline |
Returns the map unit scale for the minimum callout length.
Definition at line 600 of file qgscallout.h.
|
inline |
Returns the units for the minimum length of callout lines.
Definition at line 584 of file qgscallout.h.
|
inline |
Returns the offset distance from the anchor point at which to start the line.
Units are specified through offsetFromAnchorUnit().
Definition at line 608 of file qgscallout.h.
|
inline |
Returns the map unit scale for the offset from anchor.
Definition at line 645 of file qgscallout.h.
|
inline |
Returns the units for the offset from anchor point.
Definition at line 629 of file qgscallout.h.
|
inline |
Returns the offset distance from label area at which to end the line.
Units are specified through offsetFromLabelUnit().
Definition at line 652 of file qgscallout.h.
|
inline |
Returns the map unit scale for the minimum callout length.
Definition at line 689 of file qgscallout.h.
|
inline |
Returns the units for the offset from label area.
Definition at line 673 of file qgscallout.h.
|
delete |
|
overridevirtual |
Returns the properties describing the callout encoded in a string format.
Subclasses must ensure that they include the base class' properties() in their returned value.
Reimplemented from QgsCallout.
Definition at line 572 of file qgscallout.cpp.
|
overridevirtual |
Reads a string map of an callout's properties and restores the callout to the state described by the properties map.
Subclasses must ensure that they call the base class' readProperties() method.
Reimplemented from QgsCallout.
Definition at line 596 of file qgscallout.cpp.
|
overridevirtual |
Returns the set of attributes referenced by the callout.
This includes attributes required by any data defined properties associated with the callout.
Reimplemented from QgsCallout.
Definition at line 636 of file qgscallout.cpp.
|
inline |
Sets whether callout lines should be drawn to all feature parts.
Definition at line 703 of file qgscallout.h.
void QgsSimpleLineCallout::setLineSymbol | ( | QgsLineSymbol * | symbol | ) |
Sets the line symbol used to render the callout line.
Ownership of symbol is transferred to the callout.
Definition at line 649 of file qgscallout.cpp.
|
inline |
Sets the minimum length of callout lines.
Units are specified through setMinimumLengthUnit().
Definition at line 570 of file qgscallout.h.
|
inline |
Sets the map unit scale for the minimum callout length.
Definition at line 592 of file qgscallout.h.
|
inline |
Sets the unit for the minimum length of callout lines.
Definition at line 577 of file qgscallout.h.
|
inline |
Sets the offset distance from the anchor point at which to start the line.
Units are specified through setOffsetFromAnchorUnit().
Definition at line 615 of file qgscallout.h.
|
inline |
Sets the map unit scale for the offset from anchor.
Definition at line 637 of file qgscallout.h.
|
inline |
Sets the unit for the offset from anchor distance.
Definition at line 622 of file qgscallout.h.
|
inline |
Sets the offset distance from label area at which to end the line.
Units are specified through setOffsetFromLabelUnit().
Definition at line 659 of file qgscallout.h.
|
inline |
Sets the map unit scale for the offset from label area.
Definition at line 681 of file qgscallout.h.
|
inline |
Sets the unit for the offset from label area distance.
Definition at line 666 of file qgscallout.h.
|
overridevirtual |
Prepares the callout for rendering on the specified render context.
Reimplemented from QgsCallout.
Definition at line 622 of file qgscallout.cpp.
|
overridevirtual |
Finalises the callout after a set of rendering operations on the specified render context.
Reimplemented from QgsCallout.
Definition at line 629 of file qgscallout.cpp.
|
overridevirtual |
Returns a unique string representing the callout type.
Implements QgsCallout.
Definition at line 562 of file qgscallout.cpp.