QGIS API Documentation
3.22.4-Białowieża (ce8e65e95e)
|
Main class to handle feature. More...
#include <feature.h>
Public Types | |
enum | PathOffset { NoOffset , PositiveOffset , NegativeOffset } |
Path offset variances used in curved placement. More... | |
Public Member Functions | |
FeaturePart (const FeaturePart &other) | |
FeaturePart (QgsLabelFeature *lf, const GEOSGeometry *geom) | |
Creates a new generic feature. More... | |
~FeaturePart () override | |
Deletes the feature. More... | |
void | addSizePenalty (std::vector< std::unique_ptr< LabelPosition > > &lPos, double bbx[4], double bby[4]) |
Increases the cost of the label candidates for this feature, based on the size of the feature. More... | |
bool | alwaysShow () const |
Returns true if the feature's label should always been shown, even when it collides with other labels. More... | |
double | calculatePriority () const |
Calculates the priority for the feature. More... | |
std::size_t | createCandidateCenteredOverPoint (double x, double y, std::vector< std::unique_ptr< LabelPosition > > &lPos, double angle) |
Generate one candidate centered over the specified point. More... | |
std::unique_ptr< LabelPosition > | createCandidatePointOnSurface (PointSet *mapShape) |
Creates a single candidate using the "point on sruface" algorithm. More... | |
std::vector< std::unique_ptr< LabelPosition > > | createCandidates (Pal *pal) |
Generates a list of candidate positions for labels for this feature. More... | |
std::size_t | createCandidatesAlongLine (std::vector< std::unique_ptr< LabelPosition > > &lPos, PointSet *mapShape, bool allowOverrun, Pal *pal) |
Generate candidates for line feature. More... | |
std::size_t | createCandidatesAlongLineNearMidpoint (std::vector< std::unique_ptr< LabelPosition > > &lPos, PointSet *mapShape, double initialCost=0.0, Pal *pal=nullptr) |
Generate candidates for line feature, by trying to place candidates as close as possible to the line's midpoint. More... | |
std::size_t | createCandidatesAlongLineNearStraightSegments (std::vector< std::unique_ptr< LabelPosition > > &lPos, PointSet *mapShape, Pal *pal) |
Generate candidates for line feature, by trying to place candidates towards the middle of the longest straightish segments of the line. More... | |
std::size_t | createCandidatesAroundPoint (double x, double y, std::vector< std::unique_ptr< LabelPosition > > &lPos, double angle) |
Generate candidates for point feature, located around a specified point. More... | |
std::size_t | createCandidatesAtOrderedPositionsOverPoint (double x, double y, std::vector< std::unique_ptr< LabelPosition > > &lPos, double angle) |
Generates candidates following a prioritized list of predefined positions around a point. More... | |
std::size_t | createCandidatesForPolygon (std::vector< std::unique_ptr< LabelPosition > > &lPos, PointSet *mapShape, Pal *pal) |
Generate candidates for polygon features. More... | |
std::size_t | createCandidatesOutsidePolygon (std::vector< std::unique_ptr< LabelPosition > > &lPos, Pal *pal) |
Generate candidates outside of polygon features. More... | |
std::size_t | createCandidatesOverPoint (double x, double y, std::vector< std::unique_ptr< LabelPosition > > &lPos, double angle) |
Generate one candidate over or offset the specified point. More... | |
std::size_t | createCurvedCandidatesAlongLine (std::vector< std::unique_ptr< LabelPosition > > &lPos, PointSet *mapShape, bool allowOverrun, Pal *pal) |
Generate curved candidates for line features. More... | |
std::size_t | createHorizontalCandidatesAlongLine (std::vector< std::unique_ptr< LabelPosition > > &lPos, PointSet *mapShape, Pal *pal) |
Generate horizontal candidates for line feature. More... | |
std::unique_ptr< LabelPosition > | curvedPlacementAtOffset (PointSet *mapShape, const std::vector< double > &pathDistances, QgsTextRendererUtils::LabelLineDirection direction, double distance, bool &labeledLineSegmentIsRightToLeft, bool applyAngleConstraints) |
Returns the label position for a curved label at a specific offset along a path. More... | |
QgsLabelFeature * | feature () |
Returns the parent feature. More... | |
QgsFeatureId | featureId () const |
Returns the unique ID of the feature. More... | |
double | fixedAngle () const |
Returns the fixed angle for the feature's label. More... | |
double | getLabelDistance () const |
Returns the distance from the anchor point to the label. More... | |
double | getLabelHeight (double angle=0.0) const |
Returns the height of the label, optionally taking an angle into account. More... | |
double | getLabelWidth (double angle=0.0) const |
Returns the width of the label, optionally taking an angle into account. More... | |
int | getNumSelfObstacles () const |
Gets number of holes (inner rings) - they are considered as obstacles. More... | |
FeaturePart * | getSelfObstacle (int i) |
Gets hole (inner ring) - considered as obstacle. More... | |
bool | hasFixedPosition () const |
Returns true if the feature's label has a fixed position. More... | |
bool | hasFixedRotation () const |
Returns true if the feature's label has a fixed rotation. More... | |
bool | hasSameLabelFeatureAs (FeaturePart *part) const |
Tests whether this feature part belongs to the same QgsLabelFeature as another feature part. More... | |
bool | isConnected (FeaturePart *p2) |
Check whether this part is connected with some other part. More... | |
Layer * | layer () |
Returns the layer that feature belongs to. More... | |
std::size_t | maximumLineCandidates () const |
Returns the maximum number of line candidates to generate for this feature. More... | |
std::size_t | maximumPointCandidates () const |
Returns the maximum number of point candidates to generate for this feature. More... | |
std::size_t | maximumPolygonCandidates () const |
Returns the maximum number of polygon candidates to generate for this feature. More... | |
bool | mergeWithFeaturePart (FeaturePart *other) |
Merge other (connected) part with this one and save the result in this part (other is unchanged). More... | |
const QgsLabelObstacleSettings & | obstacleSettings () const |
Returns the feature's obstacle settings. More... | |
bool | onlyShowUprightLabels () const |
Returns true if feature's label must be displayed upright. More... | |
double | repeatDistance () const |
Returns the distance between repeating labels for this feature. More... | |
void | setTotalRepeats (int repeats) |
Returns the total number of repeating labels associated with this label. More... | |
int | totalRepeats () const |
Returns the total number of repeating labels associated with this label. More... | |
Public Member Functions inherited from pal::PointSet | |
PointSet () | |
PointSet (int nbPoints, double *x, double *y) | |
virtual | ~PointSet () |
double | area () const |
Returns area of polygon geometry. More... | |
QgsRectangle | boundingBox () const |
Returns the point set bounding box. More... | |
bool | boundingBoxIntersects (const PointSet *other) const |
Returns true if the bounding box of this pointset intersects the bounding box of another pointset. More... | |
std::unique_ptr< PointSet > | clone () const |
Returns a copy of the point set. More... | |
OrientedConvexHullBoundingBox | computeConvexHullOrientedBoundingBox (bool &ok) |
Computes an oriented bounding box for the shape's convex hull. More... | |
bool | containsLabelCandidate (double x, double y, double width, double height, double alpha=0) const |
Tests whether a possible label candidate will fit completely within the shape. More... | |
bool | containsPoint (double x, double y) const |
Tests whether point set contains a specified point. More... | |
std::tuple< std::vector< double >, double > | edgeDistances () const |
Returns a vector of edge distances as well as its total length. More... | |
void | extendLineByDistance (double startDistance, double endDistance, double smoothDistance) |
Extends linestrings by the specified amount at the start and end of the line, by extending the existing lines following the same direction as the original line start or end. More... | |
std::unique_ptr< PointSet > | extractShape (int nbPtSh, int imin, int imax, int fps, int fpe, double fptx, double fpty) |
Does... More... | |
const GEOSGeometry * | geos () const |
Returns the point set's GEOS geometry. More... | |
void | getCentroid (double &px, double &py, bool forceInside=false) const |
int | getGeosType () const |
PointSet * | getHoleOf () const |
Returns nullptr if this isn't a hole. Otherwise returns pointer to parent pointset. More... | |
int | getNumPoints () const |
void | getPointByDistance (double *d, double *ad, double dl, double *px, double *py) |
Gets a point a set distance along a line geometry. More... | |
bool | isClosed () const |
Returns true if pointset is closed. More... | |
double | length () const |
Returns length of line geometry. More... | |
double | minDistanceToPoint (double px, double py, double *rx=nullptr, double *ry=nullptr) const |
Returns the squared minimum distance between the point set geometry and the point (px,py) Optionally, the nearest point is stored in (rx,ry). More... | |
void | offsetCurveByDistance (double distance) |
Offsets linestrings by the specified distance. More... | |
QString | toWkt () const |
Returns a WKT representation of the point set. More... | |
Protected Member Functions | |
void | extractCoords (const GEOSGeometry *geom) |
read coordinates from a GEOS geom More... | |
Protected Member Functions inherited from pal::PointSet | |
PointSet (const PointSet &ps) | |
PointSet (double x, double y) | |
void | createGeosGeom () const |
void | deleteCoords () |
void | invalidateGeos () |
const GEOSPreparedGeometry * | preparedGeom () const |
Protected Attributes | |
QList< FeaturePart * > | mHoles |
QgsLabelFeature * | mLF = nullptr |
Protected Attributes inherited from pal::PointSet | |
std::vector< int > | convexHull |
PointSet * | holeOf = nullptr |
double | mArea = -1 |
GEOSGeometry * | mGeos = nullptr |
double | mLength = -1 |
bool | mOwnsGeom = false |
PointSet * | parent = nullptr |
int | type |
double | xmax = std::numeric_limits<double>::lowest() |
double | xmin = std::numeric_limits<double>::max() |
double | ymax = std::numeric_limits<double>::lowest() |
double | ymin = std::numeric_limits<double>::max() |
Additional Inherited Members | |
Static Public Member Functions inherited from pal::PointSet | |
static QLinkedList< PointSet * > | splitPolygons (PointSet *inputShape, double labelWidth, double labelHeight) |
Split a polygon using some random logic into some other polygons. More... | |
Public Attributes inherited from pal::PointSet | |
int | nbPoints |
std::vector< double > | x |
std::vector< double > | y |
Main class to handle feature.
FeaturePart::FeaturePart | ( | QgsLabelFeature * | lf, |
const GEOSGeometry * | geom | ||
) |
Creates a new generic feature.
lf | a pointer for a feature which contains the spatial entites |
geom | a pointer to a GEOS geometry |
Definition at line 55 of file feature.cpp.
FeaturePart::FeaturePart | ( | const FeaturePart & | other | ) |
Definition at line 72 of file feature.cpp.
|
override |
Deletes the feature.
Definition at line 83 of file feature.cpp.
void FeaturePart::addSizePenalty | ( | std::vector< std::unique_ptr< LabelPosition > > & | lPos, |
double | bbx[4], | ||
double | bby[4] | ||
) |
Increases the cost of the label candidates for this feature, based on the size of the feature.
E.g. small lines or polygons get higher cost so that larger features are more likely to be labeled.
Definition at line 2064 of file feature.cpp.
|
inline |
double FeaturePart::calculatePriority | ( | ) | const |
Calculates the priority for the feature.
This will be the feature's priority if set, otherwise the layer's default priority.
Definition at line 2200 of file feature.cpp.
std::size_t FeaturePart::createCandidateCenteredOverPoint | ( | double | x, |
double | y, | ||
std::vector< std::unique_ptr< LabelPosition > > & | lPos, | ||
double | angle | ||
) |
Generate one candidate centered over the specified point.
x | x coordinate of the point |
y | y coordinate of the point |
lPos | pointer to an array of candidates, will be filled by generated candidate |
angle | orientation of the label |
Definition at line 293 of file feature.cpp.
std::unique_ptr< LabelPosition > FeaturePart::createCandidatePointOnSurface | ( | PointSet * | mapShape | ) |
Creates a single candidate using the "point on sruface" algorithm.
Definition at line 401 of file feature.cpp.
std::vector< std::unique_ptr< LabelPosition > > FeaturePart::createCandidates | ( | Pal * | pal | ) |
Generates a list of candidate positions for labels for this feature.
Definition at line 1959 of file feature.cpp.
std::size_t FeaturePart::createCandidatesAlongLine | ( | std::vector< std::unique_ptr< LabelPosition > > & | lPos, |
PointSet * | mapShape, | ||
bool | allowOverrun, | ||
Pal * | pal | ||
) |
Generate candidates for line feature.
lPos | pointer to an array of candidates, will be filled by generated candidates |
mapShape | a pointer to the line |
allowOverrun | set to true to allow labels to overrun features |
pal | point to pal settings object, for cancellation support |
Definition at line 737 of file feature.cpp.
std::size_t FeaturePart::createCandidatesAlongLineNearMidpoint | ( | std::vector< std::unique_ptr< LabelPosition > > & | lPos, |
PointSet * | mapShape, | ||
double | initialCost = 0.0 , |
||
Pal * | pal = nullptr |
||
) |
Generate candidates for line feature, by trying to place candidates as close as possible to the line's midpoint.
Candidates can "cut corners" if it helps them place near this mid point.
lPos | pointer to an array of candidates, will be filled by generated candidates |
mapShape | a pointer to the line |
initialCost | initial cost for candidates generated using this method. If set, cost can be increased by a preset amount. |
pal | point to pal settings object, for cancellation support |
Definition at line 1071 of file feature.cpp.
std::size_t FeaturePart::createCandidatesAlongLineNearStraightSegments | ( | std::vector< std::unique_ptr< LabelPosition > > & | lPos, |
PointSet * | mapShape, | ||
Pal * | pal | ||
) |
Generate candidates for line feature, by trying to place candidates towards the middle of the longest straightish segments of the line.
Segments closer to horizontal are preferred over vertical segments.
lPos | pointer to an array of candidates, will be filled by generated candidates |
mapShape | a pointer to the line |
pal | point to pal settings object, for cancellation support |
Definition at line 837 of file feature.cpp.
std::size_t FeaturePart::createCandidatesAroundPoint | ( | double | x, |
double | y, | ||
std::vector< std::unique_ptr< LabelPosition > > & | lPos, | ||
double | angle | ||
) |
Generate candidates for point feature, located around a specified point.
x | x coordinate of the point |
y | y coordinate of the point |
lPos | pointer to an array of candidates, will be filled by generated candidates |
angle | orientation of the label |
Definition at line 579 of file feature.cpp.
std::size_t FeaturePart::createCandidatesAtOrderedPositionsOverPoint | ( | double | x, |
double | y, | ||
std::vector< std::unique_ptr< LabelPosition > > & | lPos, | ||
double | angle | ||
) |
Generates candidates following a prioritized list of predefined positions around a point.
x | x coordinate of the point |
y | y coordinate of the point |
lPos | pointer to an array of candidates, will be filled by generated candidate |
angle | orientation of the label |
Definition at line 540 of file feature.cpp.
std::size_t FeaturePart::createCandidatesForPolygon | ( | std::vector< std::unique_ptr< LabelPosition > > & | lPos, |
PointSet * | mapShape, | ||
Pal * | pal | ||
) |
Generate candidates for polygon features.
lPos | pointer to an array of candidates, will be filled by generated candidates |
mapShape | a pointer to the polygon |
pal | point to pal settings object, for cancellation support |
Definition at line 1513 of file feature.cpp.
std::size_t FeaturePart::createCandidatesOutsidePolygon | ( | std::vector< std::unique_ptr< LabelPosition > > & | lPos, |
Pal * | pal | ||
) |
Generate candidates outside of polygon features.
lPos | pointer to an array of candidates, will be filled by generated candidates |
pal | point to pal settings object, for cancellation support |
Definition at line 1756 of file feature.cpp.
std::size_t FeaturePart::createCandidatesOverPoint | ( | double | x, |
double | y, | ||
std::vector< std::unique_ptr< LabelPosition > > & | lPos, | ||
double | angle | ||
) |
Generate one candidate over or offset the specified point.
x | x coordinate of the point |
y | y coordinate of the point |
lPos | pointer to an array of candidates, will be filled by generated candidate |
angle | orientation of the label |
Definition at line 322 of file feature.cpp.
std::size_t FeaturePart::createCurvedCandidatesAlongLine | ( | std::vector< std::unique_ptr< LabelPosition > > & | lPos, |
PointSet * | mapShape, | ||
bool | allowOverrun, | ||
Pal * | pal | ||
) |
Generate curved candidates for line features.
lPos | pointer to an array of candidates, will be filled by generated candidates |
mapShape | a pointer to the line |
allowOverrun | set to true to allow labels to overrun features |
pal | point to pal settings object, for cancellation support |
Definition at line 1283 of file feature.cpp.
std::size_t FeaturePart::createHorizontalCandidatesAlongLine | ( | std::vector< std::unique_ptr< LabelPosition > > & | lPos, |
PointSet * | mapShape, | ||
Pal * | pal | ||
) |
Generate horizontal candidates for line feature.
lPos | pointer to an array of candidates, will be filled by generated candidates |
mapShape | a pointer to the line |
pal | point to pal settings object, for cancellation support |
Definition at line 766 of file feature.cpp.
std::unique_ptr< LabelPosition > FeaturePart::curvedPlacementAtOffset | ( | PointSet * | mapShape, |
const std::vector< double > & | pathDistances, | ||
QgsTextRendererUtils::LabelLineDirection | direction, | ||
double | distance, | ||
bool & | labeledLineSegmentIsRightToLeft, | ||
bool | applyAngleConstraints | ||
) |
Returns the label position for a curved label at a specific offset along a path.
mapShape | line path to place label on |
pathDistances | array of distances to each segment on path |
direction | either RespectPainterOrientation or FollowLineDirection |
distance | distance to offset label along curve by |
labeledLineSegmentIsRightToLeft | if true label is reversed from lefttoright to righttoleft |
applyAngleConstraints | true if label feature character angle constraints should be applied |
Definition at line 1245 of file feature.cpp.
|
protected |
read coordinates from a GEOS geom
Definition at line 91 of file feature.cpp.
|
inline |
QgsFeatureId FeaturePart::featureId | ( | ) | const |
Returns the unique ID of the feature.
Definition at line 161 of file feature.cpp.
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
bool FeaturePart::hasSameLabelFeatureAs | ( | FeaturePart * | part | ) | const |
Tests whether this feature part belongs to the same QgsLabelFeature as another feature part.
part | part to compare to |
true
if both parts belong to same QgsLabelFeature Definition at line 215 of file feature.cpp.
bool FeaturePart::isConnected | ( | FeaturePart * | p2 | ) |
Check whether this part is connected with some other part.
Definition at line 2105 of file feature.cpp.
Layer * FeaturePart::layer | ( | ) |
Returns the layer that feature belongs to.
Definition at line 156 of file feature.cpp.
std::size_t FeaturePart::maximumLineCandidates | ( | ) | const |
Returns the maximum number of line candidates to generate for this feature.
Definition at line 171 of file feature.cpp.
std::size_t FeaturePart::maximumPointCandidates | ( | ) | const |
Returns the maximum number of point candidates to generate for this feature.
Definition at line 166 of file feature.cpp.
std::size_t FeaturePart::maximumPolygonCandidates | ( | ) | const |
Returns the maximum number of polygon candidates to generate for this feature.
Definition at line 193 of file feature.cpp.
bool FeaturePart::mergeWithFeaturePart | ( | FeaturePart * | other | ) |
Merge other (connected) part with this one and save the result in this part (other is unchanged).
Returns true
on success, false
if the feature wasn't modified.
Definition at line 2159 of file feature.cpp.
|
inline |
bool FeaturePart::onlyShowUprightLabels | ( | ) | const |
Returns true
if feature's label must be displayed upright.
Definition at line 2213 of file feature.cpp.
|
inline |
void FeaturePart::setTotalRepeats | ( | int | repeats | ) |
Returns the total number of repeating labels associated with this label.
Definition at line 288 of file feature.cpp.
int FeaturePart::totalRepeats | ( | ) | const |
Returns the total number of repeating labels associated with this label.
Definition at line 283 of file feature.cpp.
|
protected |
|
protected |