QGIS API Documentation
2.12.0-Lyon
|
LabelPosition is a candidate feature label position. More...
#include <labelposition.h>
Classes | |
struct | CountContext |
struct | PruneCtx |
Public Types | |
enum | Quadrant { QuadrantAboveLeft, QuadrantAbove, QuadrantAboveRight, QuadrantLeft, QuadrantOver, QuadrantRight, QuadrantBelowLeft, QuadrantBelow, QuadrantBelowRight } |
Position of label candidate relative to feature. More... | |
Public Member Functions | |
LabelPosition (int id, double x1, double y1, double w, double h, double alpha, double cost, FeaturePart *feature, bool isReversed=false, Quadrant quadrant=QuadrantOver) | |
create a new LabelPosition More... | |
LabelPosition (const LabelPosition &other) | |
Copy constructor. More... | |
~LabelPosition () | |
bool | conflictsWithObstacle () const |
Returns whether the position is marked as conflicting with an obstacle feature. More... | |
double | cost () const |
Returns the candidate label position's geographical cost. More... | |
bool | crossesBoundary (PointSet *polygon) const |
Returns true if this label crosses the boundary of the specified polygon. More... | |
bool | crossesLine (PointSet *line) const |
Returns true if this label crosses the specified line. More... | |
double | getAlpha () const |
get alpha More... | |
void | getBoundingBox (double amin[2], double amax[2]) const |
Return bounding box - amin: xmin,ymin - amax: xmax,ymax. More... | |
double | getDistanceToPoint (double xp, double yp) const |
Get distance from this label to a point. More... | |
FeaturePart * | getFeaturePart () |
return the feature corresponding to this labelposition More... | |
double | getHeight () const |
int | getId () const |
return id More... | |
LabelPosition * | getNextPart () const |
double | getNumOverlaps () const |
int | getPartId () const |
int | getProblemFeatureId () const |
Quadrant | getQuadrant () const |
bool | getReversed () const |
bool | getUpsideDown () const |
double | getWidth () const |
double | getX (int i=0) const |
get the down-left x coordinate More... | |
double | getY (int i=0) const |
get the down-left y coordinate More... | |
void | insertIntoIndex (RTree< LabelPosition *, double, 2, double > *index) |
bool | isIn (double *bbox) |
Is the labelposition in the bounding-box ? (intersect or inside????) More... | |
bool | isInConflict (LabelPosition *ls) |
Check whether or not this overlap with another labelPosition. More... | |
bool | isInside (double *bbox) |
Is the labelposition inside the bounding-box ? More... | |
bool | isIntersect (double *bbox) |
Is the labelposition intersect the bounding-box ? More... | |
void | offsetPosition (double xOffset, double yOffset) |
Shift the label by specified offset. More... | |
int | polygonIntersectionCost (PointSet *polygon) const |
Returns cost of position intersection with polygon (testing area of intersection and center). More... | |
void | print () |
void | removeFromIndex (RTree< LabelPosition *, double, 2, double > *index) |
void | resetNumOverlaps () |
void | setConflictsWithObstacle (bool conflicts) |
Sets whether the position is marked as conflicting with an obstacle feature. More... | |
void | setCost (double newCost) |
Sets the candidate label position's geographical cost. More... | |
void | setNextPart (LabelPosition *next) |
void | setPartId (int id) |
void | setProblemIds (int probFid, int lpId) |
Set problem feature ID and assigned label candidate ID. More... | |
void | validateCost () |
Make sure the cost is less than 1. More... | |
Public Member Functions inherited from pal::PointSet | |
PointSet () | |
PointSet (int nbPoints, double *x, double *y) | |
virtual | ~PointSet () |
CHullBox * | compute_chull_bbox () |
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... | |
PointSet * | extractShape (int nbPtSh, int imin, int imax, int fps, int fpe, double fptx, double fpty) |
const GEOSGeometry * | geos () const |
Returns the point set's GEOS geometry. More... | |
void | getBoundingBox (double min[2], double max[2]) const |
void | getCentroid (double &px, double &py, bool forceInside=false) const |
int | getGeosType () const |
PointSet * | getHoleOf () |
Returns NULL if this isn't a hole. More... | |
int | getNumPoints () const |
void | getPointByDistance (double *d, double *ad, double dl, double *px, double *py) |
Get a point a set distance along a line geometry. More... | |
double | length () const |
Returns length of line geometry. More... | |
double | minDistanceToPoint (double px, double py, double *rx=0, double *ry=0) 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... | |
Static Public Member Functions | |
static bool | costGrow (void *l, void *r) |
static bool | costShrink (void *l, void *r) |
static bool | countFullOverlapCallback (LabelPosition *lp, void *ctx) |
static bool | countOverlapCallback (LabelPosition *lp, void *ctx) |
static bool | polygonObstacleCallback (pal::FeaturePart *obstacle, void *ctx) |
static bool | pruneCallback (LabelPosition *lp, void *ctx) |
Check whether the candidate in ctx overlap with obstacle feat. More... | |
static bool | removeOverlapCallback (LabelPosition *lp, void *ctx) |
Static Public Member Functions inherited from pal::PointSet | |
static void | splitPolygons (QLinkedList< PointSet * > &shapes_toProcess, QLinkedList< PointSet * > &shapes_final, double xrm, double yrm, const QgsFeatureId &uid) |
Split a concave shape into several convex shapes. More... | |
Protected Member Functions | |
bool | isInConflictMultiPart (LabelPosition *lp) |
bool | isInConflictSinglePart (LabelPosition *lp) |
Protected Member Functions inherited from pal::PointSet | |
PointSet (double x, double y) | |
PointSet (const PointSet &ps) | |
void | createGeosGeom () const |
void | deleteCoords () |
void | invalidateGeos () |
const GEOSPreparedGeometry * | preparedGeom () const |
Protected Attributes | |
double | alpha |
FeaturePart * | feature |
double | h |
int | id |
int | nbOverlap |
LabelPosition * | nextPart |
int | partId |
int | probFeat |
LabelPosition::Quadrant | quadrant |
bool | reversed |
bool | upsideDown |
double | w |
Protected Attributes inherited from pal::PointSet | |
int * | cHull |
int | cHullSize |
PointSet * | holeOf |
GEOSGeometry * | mGeos |
bool | mOwnsGeom |
int | nbPoints |
PointSet * | parent |
int | type |
double * | x |
double | xmax |
double | xmin |
double * | y |
double | ymax |
double | ymin |
Friends | |
class | CostCalculator |
class | PolygonCostCalculator |
LabelPosition is a candidate feature label position.
Definition at line 48 of file labelposition.h.
Position of label candidate relative to feature.
Enumerator | |
---|---|
QuadrantAboveLeft | |
QuadrantAbove | |
QuadrantAboveRight | |
QuadrantLeft | |
QuadrantOver | |
QuadrantRight | |
QuadrantBelowLeft | |
QuadrantBelow | |
QuadrantBelowRight |
Definition at line 58 of file labelposition.h.
pal::LabelPosition::LabelPosition | ( | int | id, |
double | x1, | ||
double | y1, | ||
double | w, | ||
double | h, | ||
double | alpha, | ||
double | cost, | ||
FeaturePart * | feature, | ||
bool | isReversed = false , |
||
Quadrant | quadrant = QuadrantOver |
||
) |
create a new LabelPosition
id | id of this labelposition |
x1 | down-left x coordinate |
y1 | down-left y coordinate |
w | label width |
h | label height |
alpha | rotation in rad |
cost | geographic cost |
feature | labelpos owners |
isReversed | label is reversed |
quadrant | relative position of label to feature |
Definition at line 52 of file labelposition.cpp.
pal::LabelPosition::LabelPosition | ( | const LabelPosition & | other | ) |
Copy constructor.
Definition at line 169 of file labelposition.cpp.
|
inline |
Definition at line 93 of file labelposition.h.
|
inline |
Returns whether the position is marked as conflicting with an obstacle feature.
Definition at line 188 of file labelposition.h.
|
inline |
Returns the candidate label position's geographical cost.
Definition at line 170 of file labelposition.h.
|
static |
Definition at line 403 of file labelposition.cpp.
|
static |
Definition at line 398 of file labelposition.cpp.
|
static |
Definition at line 473 of file labelposition.cpp.
|
static |
Definition at line 459 of file labelposition.cpp.
bool pal::LabelPosition::crossesBoundary | ( | PointSet * | polygon | ) | const |
Returns true if this label crosses the boundary of the specified polygon.
Definition at line 549 of file labelposition.cpp.
bool pal::LabelPosition::crossesLine | ( | PointSet * | line | ) | const |
Returns true if this label crosses the specified line.
Definition at line 520 of file labelposition.cpp.
double pal::LabelPosition::getAlpha | ( | ) | const |
void pal::LabelPosition::getBoundingBox | ( | double | amin[2], |
double | amax[2] | ||
) | const |
Return bounding box - amin: xmin,ymin - amax: xmax,ymax.
Definition at line 364 of file labelposition.cpp.
double pal::LabelPosition::getDistanceToPoint | ( | double | xp, |
double | yp | ||
) | const |
Get distance from this label to a point.
If point lies inside, returns negative number.
Definition at line 508 of file labelposition.cpp.
FeaturePart * pal::LabelPosition::getFeaturePart | ( | ) |
return the feature corresponding to this labelposition
Definition at line 359 of file labelposition.cpp.
|
inline |
Definition at line 205 of file labelposition.h.
int pal::LabelPosition::getId | ( | ) | const |
|
inline |
Definition at line 219 of file labelposition.h.
|
inline |
Definition at line 155 of file labelposition.h.
|
inline |
Definition at line 223 of file labelposition.h.
|
inline |
Definition at line 158 of file labelposition.h.
|
inline |
Definition at line 215 of file labelposition.h.
|
inline |
Definition at line 212 of file labelposition.h.
|
inline |
Definition at line 213 of file labelposition.h.
|
inline |
Definition at line 204 of file labelposition.h.
double pal::LabelPosition::getX | ( | int | i = 0 | ) | const |
get the down-left x coordinate
Definition at line 335 of file labelposition.cpp.
double pal::LabelPosition::getY | ( | int | i = 0 | ) | const |
get the down-left y coordinate
Definition at line 340 of file labelposition.cpp.
void pal::LabelPosition::insertIntoIndex | ( | RTree< LabelPosition *, double, 2, double > * | index | ) |
Definition at line 433 of file labelposition.cpp.
bool pal::LabelPosition::isIn | ( | double * | bbox | ) |
Is the labelposition in the bounding-box ? (intersect or inside????)
bbox | the bounding-box double[4] = {xmin, ymin, xmax, ymax} |
Definition at line 193 of file labelposition.cpp.
bool pal::LabelPosition::isInConflict | ( | LabelPosition * | ls | ) |
Check whether or not this overlap with another labelPosition.
ls | other labelposition |
Definition at line 256 of file labelposition.cpp.
|
protected |
Definition at line 288 of file labelposition.cpp.
|
protected |
Definition at line 267 of file labelposition.cpp.
bool pal::LabelPosition::isInside | ( | double * | bbox | ) |
Is the labelposition inside the bounding-box ?
bbox | the bounding-box double[4] = {xmin, ymin, xmax, ymax} |
Definition at line 228 of file labelposition.cpp.
bool pal::LabelPosition::isIntersect | ( | double * | bbox | ) |
Is the labelposition intersect the bounding-box ?
bbox | the bounding-box double[4] = {xmin, ymin, xmax, ymax} |
Definition at line 211 of file labelposition.cpp.
void pal::LabelPosition::offsetPosition | ( | double | xOffset, |
double | yOffset | ||
) |
Shift the label by specified offset.
Definition at line 316 of file labelposition.cpp.
int pal::LabelPosition::polygonIntersectionCost | ( | PointSet * | polygon | ) | const |
Returns cost of position intersection with polygon (testing area of intersection and center).
Cost ranges between 0 and 12, with extra cost if center of label position is covered.
Definition at line 579 of file labelposition.cpp.
|
static |
Definition at line 408 of file labelposition.cpp.
void pal::LabelPosition::print | ( | ) |
Definition at line 244 of file labelposition.cpp.
|
static |
Check whether the candidate in ctx overlap with obstacle feat.
Definition at line 444 of file labelposition.cpp.
void pal::LabelPosition::removeFromIndex | ( | RTree< LabelPosition *, double, 2, double > * | index | ) |
Definition at line 424 of file labelposition.cpp.
|
static |
Definition at line 494 of file labelposition.cpp.
|
inline |
Definition at line 156 of file labelposition.h.
void pal::LabelPosition::setConflictsWithObstacle | ( | bool | conflicts | ) |
Sets whether the position is marked as conflicting with an obstacle feature.
conflicts | set to true to mark candidate as being in conflict |
Definition at line 391 of file labelposition.cpp.
|
inline |
Sets the candidate label position's geographical cost.
newCost | new cost for position |
Definition at line 176 of file labelposition.h.
|
inline |
Definition at line 220 of file labelposition.h.
|
inline |
Definition at line 224 of file labelposition.h.
|
inline |
Set problem feature ID and assigned label candidate ID.
called from pal.cpp during extraction
Definition at line 161 of file labelposition.h.
void pal::LabelPosition::validateCost | ( | ) |
Make sure the cost is less than 1.
Definition at line 350 of file labelposition.cpp.
|
friend |
Definition at line 50 of file labelposition.h.
|
friend |
Definition at line 51 of file labelposition.h.
|
protected |
Definition at line 276 of file labelposition.h.
|
protected |
Definition at line 269 of file labelposition.h.
|
protected |
Definition at line 278 of file labelposition.h.
|
protected |
Definition at line 267 of file labelposition.h.
|
protected |
Definition at line 274 of file labelposition.h.
|
protected |
Definition at line 280 of file labelposition.h.
|
protected |
Definition at line 281 of file labelposition.h.
|
protected |
Definition at line 272 of file labelposition.h.
|
protected |
Definition at line 290 of file labelposition.h.
|
protected |
Definition at line 286 of file labelposition.h.
|
protected |
Definition at line 288 of file labelposition.h.
|
protected |
Definition at line 277 of file labelposition.h.