41void QgsCallout::initPropertyDefinitions()
43 const QString origin = QStringLiteral(
"callouts" );
54 "<b>TR</b>=Top right|<br>"
55 "<b>L</b>=Left|<b>R</b>=Right|<br>"
56 "<b>BL</b>=Bottom left|<b>B</b>=Bottom middle|"
57 "<b>BR</b>=Bottom right]", origin )
68 static_cast< int >(
QgsCallout::Property::Margins ),
QgsPropertyDefinition(
"Margins",
QgsPropertyDefinition::DataTypeString, QObject::tr(
"Margins" ), QObject::tr(
"string of four doubles '<b>top,right,bottom,left</b>' or array of doubles <b>[top, right, bottom, left]</b>" ) )
84 props.insert( QStringLiteral(
"enabled" ), mEnabled ?
"1" :
"0" );
85 props.insert( QStringLiteral(
"anchorPoint" ),
encodeAnchorPoint( mAnchorPoint ) );
94 mEnabled = props.value( QStringLiteral(
"enabled" ), QStringLiteral(
"0" ) ).toInt();
95 mAnchorPoint =
decodeAnchorPoint( props.value( QStringLiteral(
"anchorPoint" ), QString() ).toString() );
96 mLabelAnchorPoint =
decodeLabelAnchorPoint( props.value( QStringLiteral(
"labelAnchorPoint" ), QString() ).toString() );
104 if ( element.isNull() )
111 QDomElement calloutElement = doc.createElement( QStringLiteral(
"callout" ) );
112 calloutElement.setAttribute( QStringLiteral(
"type" ),
type() );
113 calloutElement.appendChild( calloutPropsElement );
115 element.appendChild( calloutElement );
152 QPainter *painter = context.
painter();
156 const QPainter::CompositionMode
blendMode = mBlendMode;
163 painter->setCompositionMode(
blendMode );
168 painter->setRenderHint( QPainter::Antialiasing,
false );
169 painter->translate( rect.center() );
170 painter->rotate( -angle );
172 painter->setBrush( QColor( 255, 0, 0, 100 ) );
173 painter->setPen( QColor( 255, 0, 0, 150 ) );
175 painter->drawRect( rect.width() * -0.5, rect.height() * -0.5, rect.width(), rect.height() );
178 painter->setBrush( QColor( 0, 255, 0, 100 ) );
179 painter->setPen( QColor( 0, 255, 0, 150 ) );
184 draw( context, rect, angle, anchor, calloutContext );
186 painter->setCompositionMode( QPainter::CompositionMode_SourceOver );
196 static std::once_flag initialized;
197 std::call_once( initialized, initPropertyDefinitions );
198 return sPropertyDefinitions;
205 const QString cleaned = name.toLower().trimmed();
207 if ( cleaned == QLatin1String(
"pole_of_inaccessibility" ) )
209 else if ( cleaned == QLatin1String(
"point_on_exterior" ) )
211 else if ( cleaned == QLatin1String(
"point_on_surface" ) )
213 else if ( cleaned == QLatin1String(
"centroid" ) )
226 return QStringLiteral(
"pole_of_inaccessibility" );
228 return QStringLiteral(
"point_on_exterior" );
230 return QStringLiteral(
"point_on_surface" );
232 return QStringLiteral(
"centroid" );
242 return QStringLiteral(
"point_on_exterior" );
244 return QStringLiteral(
"centroid" );
246 return QStringLiteral(
"tl" );
248 return QStringLiteral(
"t" );
250 return QStringLiteral(
"tr" );
252 return QStringLiteral(
"l" );
254 return QStringLiteral(
"r" );
256 return QStringLiteral(
"bl" );
258 return QStringLiteral(
"b" );
260 return QStringLiteral(
"br" );
270 const QString cleaned = name.toLower().trimmed();
272 if ( cleaned == QLatin1String(
"point_on_exterior" ) )
274 else if ( cleaned == QLatin1String(
"centroid" ) )
276 else if ( cleaned == QLatin1String(
"tl" ) )
278 else if ( cleaned == QLatin1String(
"t" ) )
280 else if ( cleaned == QLatin1String(
"tr" ) )
282 else if ( cleaned == QLatin1String(
"l" ) )
284 else if ( cleaned == QLatin1String(
"r" ) )
286 else if ( cleaned == QLatin1String(
"bl" ) )
288 else if ( cleaned == QLatin1String(
"b" ) )
290 else if ( cleaned == QLatin1String(
"br" ) )
344 label.
rotate( angle, rect.topLeft() );
421 label.
rotate( angle, rect.topLeft() );
430 std::unique_ptr< QgsAbstractGeometry > tempPartAnchor;
443 evaluatedPartAnchor = tempPartAnchor.get();
451 evaluatedPartAnchor = partGeometry;
478 if ( labelGeos.
intersects( evaluatedPartAnchor ) )
515 if ( !mOriginalFeatureToMapTransform.
isValid() )
520 return mOriginalFeatureToMapTransform;
538 , mLineSymbol( other.mLineSymbol ? other.mLineSymbol->
clone() : nullptr )
539 , mMinCalloutLength( other.mMinCalloutLength )
540 , mMinCalloutLengthUnit( other.mMinCalloutLengthUnit )
541 , mMinCalloutLengthScale( other.mMinCalloutLengthScale )
542 , mOffsetFromAnchorDistance( other.mOffsetFromAnchorDistance )
543 , mOffsetFromAnchorUnit( other.mOffsetFromAnchorUnit )
544 , mOffsetFromAnchorScale( other.mOffsetFromAnchorScale )
545 , mOffsetFromLabelDistance( other.mOffsetFromLabelDistance )
546 , mOffsetFromLabelUnit( other.mOffsetFromLabelUnit )
547 , mOffsetFromLabelScale( other.mOffsetFromLabelScale )
548 , mDrawCalloutToAllParts( other.mDrawCalloutToAllParts )
555 auto callout = std::make_unique< QgsSimpleLineCallout >();
556 callout->readProperties(
properties, context );
557 return callout.release();
562 return QStringLiteral(
"simple" );
578 props[ QStringLiteral(
"minLength" ) ] = mMinCalloutLength;
582 props[ QStringLiteral(
"offsetFromAnchor" ) ] = mOffsetFromAnchorDistance;
585 props[ QStringLiteral(
"offsetFromLabel" ) ] = mOffsetFromLabelDistance;
589 props[ QStringLiteral(
"drawToAllParts" ) ] = mDrawCalloutToAllParts;
598 const QString lineSymbolDef = props.value( QStringLiteral(
"lineSymbol" ) ).toString();
599 QDomDocument doc( QStringLiteral(
"symbol" ) );
600 doc.setContent( lineSymbolDef );
601 const QDomElement symbolElem = doc.firstChildElement( QStringLiteral(
"symbol" ) );
602 std::unique_ptr< QgsLineSymbol >
lineSymbol( QgsSymbolLayerUtils::loadSymbol< QgsLineSymbol >( symbolElem, context ) );
606 mMinCalloutLength = props.value( QStringLiteral(
"minLength" ), 0 ).toDouble();
610 mOffsetFromAnchorDistance = props.value( QStringLiteral(
"offsetFromAnchor" ), 0 ).toDouble();
613 mOffsetFromLabelDistance = props.value( QStringLiteral(
"offsetFromLabel" ), 0 ).toDouble();
617 mDrawCalloutToAllParts = props.value( QStringLiteral(
"drawToAllParts" ),
false ).toBool();
624 mLineSymbol->startRender( context );
631 mLineSymbol->stopRender( context );
638 fields.unite( mLineSymbol->usedAttributes( context ) );
644 return mLineSymbol.get();
649 mLineSymbol.reset( symbol );
662 bool originPinned =
false;
667 auto drawCalloutLine = [
this, &context, &calloutContext, &label, &rect, angle, &anchor, originPinned](
const QgsAbstractGeometry * partAnchor )
669 bool destinationPinned =
false;
674 const double lineLength = line.
length();
678 double minLength = mMinCalloutLength;
684 const double minLengthPixels = context.
convertToPainterUnits( minLength, mMinCalloutLengthUnit, mMinCalloutLengthScale );
685 if ( minLengthPixels > 0 && lineLength < minLengthPixels )
688 std::unique_ptr< QgsCurve > calloutCurve(
createCalloutLine( qgsgeometry_cast< const QgsLineString * >( line.
constGet() )->startPoint(),
689 qgsgeometry_cast< const QgsLineString * >( line.
constGet() )->endPoint(), context, rect, angle, anchor, calloutContext ) );
706 if ( offsetFromAnchorPixels > 0 || offsetFromLabelPixels > 0 )
708 calloutCurve.reset( calloutCurve->curveSubstring( offsetFromLabelPixels, calloutCurve->length() - offsetFromAnchorPixels ) );
711 const QPolygonF points = calloutCurve->asQPolygonF();
713 if ( points.empty() )
723 mLineSymbol->renderPolyline( points,
nullptr, context );
726 bool toAllParts = mDrawCalloutToAllParts;
734 drawCalloutLine( anchor.
constGet() );
738 drawCalloutLine( *it );
764 auto callout = std::make_unique< QgsManhattanLineCallout >();
765 callout->readProperties(
properties, context );
766 return callout.release();
771 return QStringLiteral(
"manhattan" );
782 return new QgsLineString( QVector< QgsPoint >() << start << mid1 << end );
796 , mOrientation( other.mOrientation )
797 , mCurvature( other.mCurvature )
804 auto callout = std::make_unique< QgsCurvedLineCallout >();
805 callout->readProperties(
properties, context );
807 callout->setCurvature(
properties.value( QStringLiteral(
"curvature" ), 0.1 ).toDouble() );
808 callout->setOrientation( decodeOrientation(
properties.value( QStringLiteral(
"orientation" ), QStringLiteral(
"auto" ) ).toString() ) );
810 return callout.release();
815 return QStringLiteral(
"curved" );
826 props.insert( QStringLiteral(
"curvature" ), mCurvature );
827 props.insert( QStringLiteral(
"orientation" ), encodeOrientation( mOrientation ) );
847 orientation = decodeOrientation( orientationString );
862 if ( start.
x() < ( rect.left() + 0.5 * rect.width() ) )
867 else if ( end.
x() > start.
x() )
875 if ( end.
x() < start.
x() )
877 else if ( end.
y() < start.
y() )
879 else if ( end.
x() - start.
x() < end.
y() - start.
y() )
890 if ( start.
y() < ( rect.top() + 0.5 * rect.height() ) )
895 else if ( end.
y() < start.
y() )
903 if ( end.
x() < start.
x() )
905 else if ( end.
y() > start.
y() )
907 else if ( end.
x() - start.
x() < start.
y() - end.
y() )
918 if ( start.
x() < ( rect.left() + 0.5 * rect.width() ) )
923 else if ( end.
x() < start.
x() )
931 if ( end.
x() > start.
x() )
933 else if ( end.
y() > start.
y() )
935 else if ( start.
x() - end.
x() < start.
y() - end.
y() )
946 if ( start.
y() < ( rect.top() + 0.5 * rect.height() ) )
951 else if ( end.
y() > start.
y() )
959 if ( end.
x() > start.
x() )
961 else if ( end.
y() < start.
y() )
963 else if ( start.
x() - end.
x() < end.
y() - start.
y() )
983 const QString cleaned =
string.toLower().trimmed();
984 if ( cleaned == QLatin1String(
"auto" ) )
986 if ( cleaned == QLatin1String(
"clockwise" ) )
988 if ( cleaned == QLatin1String(
"counterclockwise" ) )
998 return QStringLiteral(
"auto" );
1000 return QStringLiteral(
"clockwise" );
1002 return QStringLiteral(
"counterclockwise" );
1009 return mOrientation;
1042 , mFillSymbol( other.mFillSymbol ? other.mFillSymbol->clone() : nullptr )
1043 , mMarkerSymbol( other.mMarkerSymbol ? other.mMarkerSymbol->clone() : nullptr )
1044 , mOffsetFromAnchorDistance( other.mOffsetFromAnchorDistance )
1045 , mOffsetFromAnchorUnit( other.mOffsetFromAnchorUnit )
1046 , mOffsetFromAnchorScale( other.mOffsetFromAnchorScale )
1047 , mMargins( other.mMargins )
1048 , mMarginUnit( other.mMarginUnit )
1049 , mWedgeWidth( other.mWedgeWidth )
1050 , mWedgeWidthUnit( other.mWedgeWidthUnit )
1051 , mWedgeWidthScale( other.mWedgeWidthScale )
1052 , mCornerRadius( other.mCornerRadius )
1053 , mCornerRadiusUnit( other.mCornerRadiusUnit )
1054 , mCornerRadiusScale( other.mCornerRadiusScale )
1061 auto callout = std::make_unique< QgsBalloonCallout >();
1062 callout->readProperties(
properties, context );
1063 return callout.release();
1068 return QStringLiteral(
"balloon" );
1085 if ( mMarkerSymbol )
1090 props[ QStringLiteral(
"offsetFromAnchor" ) ] = mOffsetFromAnchorDistance;
1094 props[ QStringLiteral(
"margins" ) ] = mMargins.
toString();
1097 props[ QStringLiteral(
"wedgeWidth" ) ] = mWedgeWidth;
1101 props[ QStringLiteral(
"cornerRadius" ) ] = mCornerRadius;
1113 const QString fillSymbolDef = props.value( QStringLiteral(
"fillSymbol" ) ).toString();
1114 QDomDocument doc( QStringLiteral(
"symbol" ) );
1115 doc.setContent( fillSymbolDef );
1116 const QDomElement symbolElem = doc.firstChildElement( QStringLiteral(
"symbol" ) );
1117 std::unique_ptr< QgsFillSymbol >
fillSymbol( QgsSymbolLayerUtils::loadSymbol< QgsFillSymbol >( symbolElem, context ) );
1123 const QString markerSymbolDef = props.value( QStringLiteral(
"markerSymbol" ) ).toString();
1124 QDomDocument doc( QStringLiteral(
"symbol" ) );
1125 doc.setContent( markerSymbolDef );
1126 const QDomElement symbolElem = doc.firstChildElement( QStringLiteral(
"symbol" ) );
1127 std::unique_ptr< QgsMarkerSymbol >
markerSymbol( QgsSymbolLayerUtils::loadSymbol< QgsMarkerSymbol >( symbolElem, context ) );
1132 mOffsetFromAnchorDistance = props.value( QStringLiteral(
"offsetFromAnchor" ), 0 ).toDouble();
1139 mWedgeWidth = props.value( QStringLiteral(
"wedgeWidth" ), 2.64 ).toDouble();
1143 mCornerRadius = props.value( QStringLiteral(
"cornerRadius" ), 0 ).toDouble();
1152 mFillSymbol->startRender( context );
1153 if ( mMarkerSymbol )
1154 mMarkerSymbol->startRender( context );
1161 mFillSymbol->stopRender( context );
1162 if ( mMarkerSymbol )
1163 mMarkerSymbol->stopRender( context );
1170 fields.unite( mFillSymbol->usedAttributes( context ) );
1171 if ( mMarkerSymbol )
1172 fields.unite( mMarkerSymbol->usedAttributes( context ) );
1178 return mFillSymbol.get();
1183 mFillSymbol.reset( symbol );
1188 return mMarkerSymbol.get();
1193 mMarkerSymbol.reset( symbol );
1198 bool destinationIsPinned =
false;
1201 if ( mMarkerSymbol )
1206 mMarkerSymbol->renderPoint(
anchorPoint.toQPointF(),
nullptr, context );
1218 if ( offsetFromAnchorPixels > 0 )
1222 line =
QgsGeometry( ls->curveSubstring( 0, ls->length() - offsetFromAnchorPixels ) );
1230 origin = ls->startPoint();
1231 destination = ls->endPoint();
1238 const QPolygonF points = getPoints( context, destination, rect );
1239 if ( points.empty() )
1252 mFillSymbol->renderPolygon( points,
nullptr,
nullptr, context );
1257 double segmentPointWidth = mWedgeWidth;
1263 segmentPointWidth = context.
convertToPainterUnits( segmentPointWidth, mWedgeWidthUnit, mWedgeWidthScale );
1273 double left = mMargins.
left();
1274 double right = mMargins.
right();
1275 double top = mMargins.
top();
1276 double bottom = mMargins.
bottom();
1283 if ( value.userType() == QMetaType::Type::QVariantList )
1285 const QVariantList list = value.toList();
1286 if ( list.size() == 4 )
1289 bool rightOk =
false;
1290 bool bottomOk =
false;
1291 bool leftOk =
false;
1292 const double evaluatedTop = list.at( 0 ).toDouble( &topOk );
1293 const double evaluatedRight = list.at( 1 ).toDouble( &rightOk );
1294 const double evaluatedBottom = list.at( 2 ).toDouble( &bottomOk );
1295 const double evaluatedLeft = list.at( 3 ).toDouble( &leftOk );
1296 if ( topOk && rightOk && bottomOk && leftOk )
1298 left = evaluatedLeft;
1300 right = evaluatedRight;
1301 bottom = evaluatedBottom;
1307 const QStringList list = value.toString().trimmed().split(
',' );
1308 if ( list.count() == 4 )
1311 bool rightOk =
false;
1312 bool bottomOk =
false;
1313 bool leftOk =
false;
1314 const double evaluatedTop = list.at( 0 ).toDouble( &topOk );
1315 const double evaluatedRight = list.at( 1 ).toDouble( &rightOk );
1316 const double evaluatedBottom = list.at( 2 ).toDouble( &bottomOk );
1317 const double evaluatedLeft = list.at( 3 ).toDouble( &leftOk );
1318 if ( topOk && rightOk && bottomOk && leftOk )
1320 left = evaluatedLeft;
1322 right = evaluatedRight;
1323 bottom = evaluatedBottom;
1335 const QRectF expandedRect = rect.height() < 0 ?
1336 QRectF( rect.left() - marginLeft, rect.top() + marginBottom,
1337 rect.width() + marginLeft + marginRight,
1338 rect.height() - marginTop - marginBottom ) :
1339 QRectF( rect.left() - marginLeft, rect.top() - marginTop,
1340 rect.width() + marginLeft + marginRight,
1341 rect.height() + marginTop + marginBottom );
1345 if ( expandedRect.width() <= 0 || ( rect.height() < 0 && expandedRect.height() >= 0 ) || ( rect.height() > 0 && expandedRect.height() <= 0 ) )
1349 const QTransform t = QTransform::fromScale( 100, 100 );
1350 const QTransform ti = t.inverted();
1351 const QPolygonF poly = path.toFillPolygon( t );
1352 return ti.map( poly );
BlendMode
Blending modes defining the available composition modes that can be used when painting.
Abstract base class for all geometries.
virtual QgsRectangle boundingBox() const
Returns the minimal bounding box for the geometry.
Qgis::WkbType wkbType() const
Returns the WKB type of the geometry.
virtual void transform(const QgsCoordinateTransform &ct, Qgis::TransformDirection d=Qgis::TransformDirection::Forward, bool transformZ=false)=0
Transforms the geometry using a coordinate transform.
virtual QgsAbstractGeometry * clone() const =0
Clones the geometry by performing a deep copy.
bool valueAsBool(int key, const QgsExpressionContext &context, bool defaultValue=false, bool *ok=nullptr) const
Calculates the current value of the property with the specified key and interprets it as an boolean.
double valueAsDouble(int key, const QgsExpressionContext &context, double defaultValue=0.0, bool *ok=nullptr) const
Calculates the current value of the property with the specified key and interprets it as a double.
A cartoon talking bubble callout style.
QgsFillSymbol * fillSymbol()
Returns the fill symbol used to render the callout.
double cornerRadius() const
Returns the corner radius of the balloon shapes.
QString type() const override
Returns a unique string representing the callout type.
QgsMarkerSymbol * markerSymbol()
Returns the marker symbol used to render the callout endpoint.
void startRender(QgsRenderContext &context) override
Prepares the callout for rendering on the specified render context.
QSet< QString > referencedFields(const QgsRenderContext &context) const override
Returns the set of attributes referenced by the callout.
void stopRender(QgsRenderContext &context) override
Finalises the callout after a set of rendering operations on the specified render context.
QVariantMap properties(const QgsReadWriteContext &context) const override
Returns the properties describing the callout encoded in a string format.
void setFillSymbol(QgsFillSymbol *symbol)
Sets the fill symbol used to render the callout.
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.
void setMarkerSymbol(QgsMarkerSymbol *symbol)
Sets the marker symbol used to render the callout endpoint.
~QgsBalloonCallout() override
QgsBalloonCallout * clone() const override
Duplicates a callout by creating a deep copy of the callout.
static QgsCallout * create(const QVariantMap &properties=QVariantMap(), const QgsReadWriteContext &context=QgsReadWriteContext())
Creates a new QgsBalloonCallout, using the settings serialized in the properties map (corresponding t...
double offsetFromAnchor() const
Returns the offset distance from the anchor point at which to start the line.
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 ...
Represents the calculated placement of a map label callout line.
void setDestination(const QPointF &destination)
Sets the destination of the callout line, in map coordinates.
void setOrigin(const QPointF &origin)
Sets the origin of the callout line, in map coordinates.
void setDestinationIsPinned(bool pinned)
Sets whether the destination of the callout has pinned (manually placed).
void setOriginIsPinned(bool pinned)
Sets whether the origin of the callout has pinned (manually placed).
Contains additional contextual information about the context in which a callout is being rendered.
QgsCoordinateTransform originalFeatureToMapTransform(const QgsRenderContext &renderContext) const
Returns the coordinate transform to convert from the original layer associated with the callout to th...
void addCalloutPosition(const QgsCalloutPosition &position)
Adds a rendered callout position.
bool allFeaturePartsLabeled
true if all parts of associated feature were labeled
QgsCoordinateReferenceSystem originalFeatureCrs
Contains the CRS of the original feature associated with this callout.
Abstract base class for callout renderers.
static QString encodeAnchorPoint(AnchorPoint anchor)
Encodes an anchor point to its string representation.
bool containsAdvancedEffects() const
Returns true if the callout requires advanced effects such as blend modes, which require output in ra...
virtual bool saveProperties(QDomDocument &doc, QDomElement &element, const QgsReadWriteContext &context) const
Saves the current state of the callout to a DOM element.
virtual void stopRender(QgsRenderContext &context)
Finalises the callout after a set of rendering operations on the specified render context.
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 c...
void setEnabled(bool enabled)
Sets whether the callout is enabled.
virtual QString type() const =0
Returns a unique string representing the callout type.
virtual QgsCallout * clone() const =0
Duplicates a callout by creating a deep copy of the callout.
QgsPropertyCollection & dataDefinedProperties()
Returns a reference to the callout's property collection, used for data defined overrides.
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.
static QgsPropertiesDefinition propertyDefinitions()
Returns the definitions for data defined properties available for use in callouts.
AnchorPoint anchorPoint() const
Returns the feature's anchor point position.
LabelAnchorPoint labelAnchorPoint() const
Returns the label's anchor point position.
AnchorPoint
Feature's anchor point position.
@ PointOnExterior
A point on the surface's outline closest to the label is used as anchor for polygon geometries.
@ Centroid
The surface's centroid is used as anchor for polygon geometries.
@ PointOnSurface
A point guaranteed to be on the surface is used as anchor for polygon geometries.
@ PoleOfInaccessibility
The surface's pole of inaccessibility used as anchor for polygon geometries.
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 void draw(QgsRenderContext &context, const QRectF &bodyBoundingBox, const double angle, const QgsGeometry &anchor, QgsCalloutContext &calloutContext)=0
Performs the actual rendering of the callout implementation onto the specified render context.
static QString encodeLabelAnchorPoint(LabelAnchorPoint anchor)
Encodes a label anchor point to its string representation.
virtual void startRender(QgsRenderContext &context)
Prepares the callout for rendering on the specified render context.
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 p...
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.
QgsCallout()
Constructor for QgsCallout.
DrawOrder
Options for draw order (stacking) of callouts.
@ OrderBelowAllLabels
Render callouts below all labels.
virtual DrawOrder drawOrder() const
Returns the desired drawing order (stacking) to use while rendering this callout.
QPainter::CompositionMode blendMode() const
Returns the blending mode used for drawing callouts.
LabelAnchorPoint
Label's anchor point position.
@ LabelPointOnExterior
The point on the label's boundary closest to the feature.
@ LabelBottomLeft
Bottom left corner of the label's boundary.
@ LabelBottomMiddle
Bottom middle of the label's boundary.
@ LabelMiddleLeft
Middle left of the label's boundary.
@ LabelBottomRight
Bottom right corner of the label's boundary.
@ LabelMiddleRight
Middle right of the label's boundary.
@ LabelTopMiddle
Top middle of the label's boundary.
@ LabelTopLeft
Top left corner of the label's boundary.
@ LabelCentroid
The labe's centroid.
@ LabelTopRight
Top right corner of the label's boundary.
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.
virtual void readProperties(const QVariantMap &props, const QgsReadWriteContext &context)
Reads a string map of an callout's properties and restores the callout to the state described by the ...
virtual QSet< QString > referencedFields(const QgsRenderContext &context) const
Returns the set of attributes referenced by the callout.
@ MinimumCalloutLength
Minimum length of callouts.
@ LabelAnchorPointPosition
Label's anchor point position.
@ CornerRadius
Balloon callout corner radius.
@ OffsetFromAnchor
Distance to offset lines from anchor points.
@ OffsetFromLabel
Distance to offset lines from label area.
@ DestinationX
X-coordinate of callout destination (feature anchor)
@ DestinationY
Y-coordinate of callout destination (feature anchor)
@ WedgeWidth
Balloon callout wedge width.
@ AnchorPointPosition
Feature's anchor point position.
@ OriginX
X-coordinate of callout origin (label anchor)
@ OriginY
Y-coordinate of callout origin (label anchor)
@ Curvature
Curvature of curved line callouts.
@ BlendMode
Callout blend mode.
@ Orientation
Orientation of curved line callouts.
@ Margins
Margin from text.
@ DrawCalloutToAllParts
Whether callout lines should be drawn to all feature parts.
virtual QVariantMap properties(const QgsReadWriteContext &context) const
Returns the properties describing the callout encoded in a string format.
bool enabled() const
Returns true if the the callout is enabled.
Circular string geometry type.
Custom exception class for Coordinate Reference System related exceptions.
Abstract base class for curved geometry type.
Draws curved lines as callouts.
QgsCurvedLineCallout * clone() const override
Duplicates a callout by creating a deep copy of the callout.
QgsCurve * createCalloutLine(const QgsPoint &start, const QgsPoint &end, QgsRenderContext &context, const QRectF &bodyBoundingBox, const double angle, const QgsGeometry &anchor, QgsCalloutContext &calloutContext) const override
Creates a callout line between start and end in the desired style.
QVariantMap properties(const QgsReadWriteContext &context) const override
Returns the properties describing the callout encoded in a string format.
void setOrientation(Orientation orientation)
Sets the callout line's curve orientation.
void setCurvature(double curvature)
Sets the callout line's curvature.
static QgsCallout * create(const QVariantMap &properties=QVariantMap(), const QgsReadWriteContext &context=QgsReadWriteContext())
Creates a new QgsCurvedLineCallout, using the settings serialized in the properties map (correspondin...
QString type() const override
Returns a unique string representing the callout type.
double curvature() const
Returns the callout line's curvature.
Orientation
Curve orientation.
@ Clockwise
Curve lines in a clockwise direction.
@ CounterClockwise
Curve lines in a counter-clockwise direction.
@ Automatic
Automatically choose most cartographically pleasing orientation based on label and callout arrangemen...
Orientation orientation() const
Returns the callout line's curve orientation.
void setOriginalValueVariable(const QVariant &value)
Sets the original value variable value for the context.
A fill symbol type, for rendering Polygon and MultiPolygon geometries.
static int closestSideOfRectangle(double right, double bottom, double left, double top, double x, double y)
Returns a number representing the closest side of a rectangle defined by /a right,...
static void perpendicularOffsetPointAlongSegment(double x1, double y1, double x2, double y2, double proportion, double offset, double *x, double *y)
Calculates a point a certain proportion of the way along the segment from (x1, y1) to (x2,...
A geometry is the spatial representation of a feature.
static QgsGeometry fromRect(const QgsRectangle &rect)
Creates a new geometry from a QgsRectangle.
double length() const
Returns the planar, 2-dimensional length of geometry.
QgsGeometry poleOfInaccessibility(double precision, double *distanceToBoundary=nullptr) const
Calculates the approximate pole of inaccessibility for a surface, which is the most distant internal ...
QgsAbstractGeometry::const_part_iterator const_parts_begin() const
Returns STL-style const iterator pointing to the first part of the geometry.
QgsGeometry pointOnSurface() const
Returns a point guaranteed to lie on the surface of a geometry.
Qgis::GeometryOperationResult transform(const QgsCoordinateTransform &ct, Qgis::TransformDirection direction=Qgis::TransformDirection::Forward, bool transformZ=false)
Transforms this geometry as described by the coordinate transform ct.
const QgsAbstractGeometry * constGet() const
Returns a non-modifiable (const) reference to the underlying abstract geometry primitive.
static QgsGeometry fromPointXY(const QgsPointXY &point)
Creates a new geometry from a QgsPointXY object.
QgsGeometry centroid() const
Returns the center of mass of a geometry.
bool isEmpty() const
Returns true if the geometry is empty (eg a linestring with no vertices, or a collection with no geom...
QgsAbstractGeometry::const_part_iterator const_parts_end() const
Returns STL-style iterator pointing to the imaginary part after the last part of the geometry.
QgsRectangle boundingBox() const
Returns the bounding box of the geometry.
Qgis::GeometryOperationResult rotate(double rotation, const QgsPointXY ¢er)
Rotate this geometry around the Z axis.
Does vector analysis using the GEOS library and handles import, export, and exception handling.
std::unique_ptr< QgsAbstractGeometry > shortestLine(const QgsGeometry &other, QString *errorMsg=nullptr) const
Returns the shortest line joining this geometry to the other geometry.
bool intersects(const QgsAbstractGeometry *geom, QString *errorMsg=nullptr) const override
Checks if geom intersects this.
Line string geometry type, with support for z-dimension and m-values.
A line symbol type, for rendering LineString and MultiLineString geometries.
Draws straight (right angled) lines as callouts.
QgsManhattanLineCallout()
QString type() const override
Returns a unique string representing the callout type.
QgsCurve * createCalloutLine(const QgsPoint &start, const QgsPoint &end, QgsRenderContext &context, const QRectF &bodyBoundingBox, const double angle, const QgsGeometry &anchor, QgsCallout::QgsCalloutContext &calloutContext) const override
Creates a callout line between start and end in the desired style.
static QgsCallout * create(const QVariantMap &properties=QVariantMap(), const QgsReadWriteContext &context=QgsReadWriteContext())
Creates a new QgsManhattanLineCallout, using the settings serialized in the properties map (correspon...
QgsManhattanLineCallout * clone() const override
Duplicates a callout by creating a deep copy of the callout.
QgsPointXY toMapCoordinates(int x, int y) const
Transforms device coordinates to map (world) coordinates.
QgsPointXY transform(const QgsPointXY &p) const
Transforms a point p from map (world) coordinates to device coordinates.
double top() const
Returns the top margin.
static QgsMargins fromString(const QString &string)
Returns a QgsMargins object decoded from a string, or a null QgsMargins if the string could not be in...
double right() const
Returns the right margin.
double bottom() const
Returns the bottom margin.
QString toString() const
Returns the margins encoded to a string.
double left() const
Returns the left margin.
A marker symbol type, for rendering Point and MultiPoint geometries.
static Qgis::BlendMode getBlendModeEnum(QPainter::CompositionMode blendMode)
Returns a Qgis::BlendMode corresponding to a QPainter::CompositionMode.
static QPainter::CompositionMode getCompositionMode(Qgis::BlendMode blendMode)
Returns a QPainter::CompositionMode corresponding to a Qgis::BlendMode.
bool isEmpty() const
Returns true if the geometry is empty.
QPointF toQPointF() const
Converts a point to a QPointF.
Point geometry type, with support for z-dimension and m-values.
double distance(double x, double y) const
Returns the Cartesian 2D distance between this point and a specified x, y coordinate.
QVariant toVariant(const QgsPropertiesDefinition &definitions) const final
Saves this property collection to a QVariantMap, wrapped in a QVariant.
QVariant value(int key, const QgsExpressionContext &context, const QVariant &defaultValue=QVariant()) const final
Returns the calculated value of the property with the specified key from within the collection.
bool isActive(int key) const final
Returns true if the collection contains an active property with the specified key.
bool loadVariant(const QVariant &configuration, const QgsPropertiesDefinition &definitions) final
Loads this property collection from a QVariantMap, wrapped in a QVariant.
bool prepare(const QgsExpressionContext &context=QgsExpressionContext()) const final
Prepares the collection against a specified expression context.
QgsProperty property(int key) const final
Returns a matching property from the collection, if one exists.
QSet< QString > referencedFields(const QgsExpressionContext &context=QgsExpressionContext(), bool ignoreContext=false) const final
Returns the set of any fields referenced by the active properties from the collection.
Definition for a property.
@ Double
Double value (including negative values)
@ DoublePositive
Positive double value (including 0)
@ DataTypeString
Property requires a string value.
QString valueAsString(const QgsExpressionContext &context, const QString &defaultString=QString(), bool *ok=nullptr) const
Calculates the current value of the property and interprets it as a string.
A container for the context for various read/write operations on objects.
QRectF toRectF() const
Returns a QRectF with same coordinates as the rectangle.
QgsRectangle buffered(double width) const
Gets rectangle enlarged by buffer.
Contains information about the context of a rendering operation.
bool useAdvancedEffects() const
Returns true if advanced effects such as blend modes such be used.
double convertToPainterUnits(double size, Qgis::RenderUnit unit, const QgsMapUnitScale &scale=QgsMapUnitScale(), Qgis::RenderSubcomponentProperty property=Qgis::RenderSubcomponentProperty::Generic) const
Converts a size from the specified units to painter units (pixels).
QPainter * painter()
Returns the destination QPainter for the render operation.
QgsExpressionContext & expressionContext()
Gets the expression context.
QgsCoordinateTransformContext transformContext() const
Returns the context's coordinate transform context, which stores various information regarding which ...
const QgsMapToPixel & mapToPixel() const
Returns the context's map to pixel transform, which transforms between map coordinates and device coo...
QgsCoordinateTransform coordinateTransform() const
Returns the current coordinate transform for the context.
static QPolygonF createBalloon(const QgsPointXY &origin, const QRectF &rect, double wedgeWidth)
Generates a "balloon"/"talking bubble" style shape (as a QPolygonF).
Renders polygons using a single fill and stroke color.
A simple direct line callout style.
void startRender(QgsRenderContext &context) override
Prepares the callout for rendering on the specified render context.
void setLineSymbol(QgsLineSymbol *symbol)
Sets the line symbol used to render the callout line.
void stopRender(QgsRenderContext &context) override
Finalises the callout after a set of rendering operations on the specified render context.
QSet< QString > referencedFields(const QgsRenderContext &context) const override
Returns the set of attributes referenced by the callout.
double offsetFromLabel() const
Returns the offset distance from label area at which to end the line.
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 ...
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.
QString type() const override
Returns a unique string representing the callout type.
double offsetFromAnchor() const
Returns the offset distance from the anchor point at which to start the line.
~QgsSimpleLineCallout() override
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.
static QgsCallout * create(const QVariantMap &properties=QVariantMap(), const QgsReadWriteContext &context=QgsReadWriteContext())
Creates a new QgsSimpleLineCallout, using the settings serialized in the properties map (correspondin...
QVariantMap properties(const QgsReadWriteContext &context) const override
Returns the properties describing the callout encoded in a string format.
QgsSimpleLineCallout * clone() const override
Duplicates a callout by creating a deep copy of the callout.
QgsLineSymbol * lineSymbol()
Returns the line symbol used to render the callout line.
A simple line symbol layer, which renders lines using a line in a variety of styles (e....
static QString encodeMapUnitScale(const QgsMapUnitScale &mapUnitScale)
static QgsMapUnitScale decodeMapUnitScale(const QString &str)
static QPainter::CompositionMode decodeBlendMode(const QString &s)
static QString symbolProperties(QgsSymbol *symbol)
Returns a string representing the symbol.
static Q_INVOKABLE Qgis::RenderUnit decodeRenderUnit(const QString &string, bool *ok=nullptr)
Decodes a render unit from a string.
static Q_INVOKABLE QString encodeUnit(Qgis::DistanceUnit unit)
Encodes a distance unit to a string.
static bool isNull(const QVariant &variant, bool silenceNullWarnings=false)
Returns true if the specified variant should be considered a NULL value.
static Qgis::GeometryType geometryType(Qgis::WkbType type)
Returns the geometry type for a WKB type, e.g., both MultiPolygon and CurvePolygon would have a Polyg...
static QDomElement writeVariant(const QVariant &value, QDomDocument &doc)
Write a QVariant to a QDomElement.
static QVariant readVariant(const QDomElement &element)
Read a QVariant from a QDomElement.
bool qgsDoubleNear(double a, double b, double epsilon=4 *std::numeric_limits< double >::epsilon())
Compare two doubles (but allow some difference)
QMap< int, QgsPropertyDefinition > QgsPropertiesDefinition
Definition of available properties.
QList< QgsSymbolLayer * > QgsSymbolLayerList
record about vertex coordinates and index of anchor to which it is snapped