|
QGIS API Documentation
2.8.2-Wien
|
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
|
QGIS API Documentation
2.8.2-Wien
|
A layer of spacial entites. More...
#include <layer.h>
Public Types | |
| enum | LabelMode { LabelPerFeature, LabelPerFeaturePart } |
| enum | UpsideDownLabels { Upright, ShowDefined, ShowAll } |
Public Member Functions | |
| void | chopFeaturesAtRepeatDistance () |
| chop layer features at the repeat distance | |
| Arrangement | getArrangement () |
| get arrangement policy | |
| unsigned long | getArrangementFlags () const |
| bool | getCentroidInside () const |
| bool | getDisplayAll () const |
| Feature * | getFeature (const char *geom_id) |
| return pointer to feature or NULL if doesn't exist | |
| LabelMode | getLabelMode () const |
| Units | getLabelUnit () |
| get units for label size | |
| double | getMaxScale () |
| return the maximum valid scale | |
| bool | getMergeConnectedLines () const |
| double | getMinScale () |
| return the minimum valid scale | |
| const char * | getName () |
| get layer's name | |
| int | getNbFeatures () |
| get the number of features into layer | |
| double | getPriority () |
| return the layer's priority | |
| UpsideDownLabels | getUpsidedownLabels () const |
| bool | isActive () |
| return the layer's activity status | |
| bool | isObstacle () |
| return the obstacle status | |
| bool | isToLabel () |
| return if the layer will be labelled or not | |
| void | joinConnectedFeatures () |
| join connected features with the same label text | |
| bool | registerFeature (const char *geom_id, PalGeometry *userGeom, double label_x=-1, double label_y=-1, const char *labelText=NULL, double labelPosX=0.0, double labelPosY=0.0, bool fixedPos=false, double angle=0.0, bool fixedAngle=false, int xQuadOffset=0, int yQuadOffset=0, double xOffset=0.0, double yOffset=0.0, bool alwaysShow=false, double repeatDistance=0) |
| register a feature in the layer | |
| void | setActive (bool active) |
| activate or desactivate the layer | |
| void | setArrangement (Arrangement arrangement) |
| set arrangement policy | |
| void | setArrangementFlags (unsigned long flags) |
| void | setCentroidInside (bool forceInside) |
| void | setLabelMode (LabelMode m) |
| void | setLabelUnit (Units label_unit) |
| set unit for label size | |
| void | setMaxScale (double max_scale) |
| set the maximum valid scale, upon this scale the layer will not be labelled | |
| void | setMergeConnectedLines (bool m) |
| void | setMinScale (double min_scale) |
| set the minimum valid scale, below this scale the layer will not be labelled | |
| void | setObstacle (bool obstacle) |
| mark layer's features as obstacles | |
| void | setPriority (double priority) |
| \ brief set the layer priority | |
| void | setToLabel (bool toLabel) |
| tell pal whether the layer has to be labelled. | |
| void | setUpsidedownLabels (UpsideDownLabels ud) |
Protected Member Functions | |
| Layer (const char *lyrName, double min_scale, double max_scale, Arrangement arrangement, Units label_unit, double defaultPriority, bool obstacle, bool active, bool toLabel, Pal *pal, bool displayAll=false) | |
| Create a new layer. | |
| virtual | ~Layer () |
| Delete the layer. | |
| void | addFeaturePart (FeaturePart *fpart, const char *labelText=NULL) |
| add newly creted feature part into r tree and to the list | |
| bool | isScaleValid (double scale) |
| check if the scal is in the scale range min_scale -> max_scale | |
Protected Attributes | |
| bool | active |
| Arrangement | arrangement |
| optional flags used for some placement methods | |
| unsigned long | arrangementFlags |
| bool | centroidInside |
| HashTable< LinkedList < FeaturePart * > * > * | connectedHashtable |
| LinkedList< char * > * | connectedTexts |
| double | defaultPriority |
| bool | displayAll |
| LinkedList< FeaturePart * > * | featureParts |
| list of feature parts | |
| LinkedList< Feature * > * | features |
| list of features - for deletion | |
| HashTable< Feature * > * | hashtable |
| Units | label_unit |
| double | max_scale |
| bool | mergeLines |
| double | min_scale |
| LabelMode | mode |
| SimpleMutex * | modMutex |
| char * | name |
| bool | obstacle |
| Pal * | pal |
| RTree< FeaturePart *, double, 2, double, 8, 4 > * | rtree |
| bool | toLabel |
| UpsideDownLabels | upsidedownLabels |
Friends | |
| bool | extractFeatCallback (FeaturePart *ft_ptr, void *ctx) |
| class | FeaturePart |
| class | LabelPosition |
| class | Pal |
| class | Problem |
| void | toSVGPath (int nbPoints, double *x, double *y, int dpi, Layer *layer, int type, char *uid, std::ostream &out, double scale, int xmin, int ymax, bool exportInfo, char *color) |
A layer of spacial entites.
a layer is a bog of feature with some data which influence the labelling process
|
protected |
Create a new layer.
| lyrName | layer's name |
| min_scale | bellow this scale: no labeling |
| max_scale | above this scale: no labeling |
| arrangement | Arrangement mode : how to place candidates |
| label_unit | Unit for labels sizes |
| defaultPriority | layer's prioriry (0 is the best, 1 the worst) |
| obstacle | 'true' will discourage other label to be placed above features of this layer |
| active | is the layer is active (currently displayed) |
| toLabel | the layer will be labeled whether toLablel is true |
| pal | pointer to the pal object |
| displayAll | if true, all features will be labelled even though overlaps occur |
|
protected |
| void pal::Layer::chopFeaturesAtRepeatDistance | ( | ) |
| Arrangement pal::Layer::getArrangement | ( | ) |
|
inline |
| Feature * pal::Layer::getFeature | ( | const char * | geom_id | ) |
| Units pal::Layer::getLabelUnit | ( | ) |
| double pal::Layer::getMaxScale | ( | ) |
| double pal::Layer::getMinScale | ( | ) |
| int pal::Layer::getNbFeatures | ( | ) |
| double pal::Layer::getPriority | ( | ) |
|
inline |
| bool pal::Layer::isActive | ( | ) |
| bool pal::Layer::isObstacle | ( | ) |
|
protected |
| bool pal::Layer::isToLabel | ( | ) |
| void pal::Layer::joinConnectedFeatures | ( | ) |
| bool pal::Layer::registerFeature | ( | const char * | geom_id, |
| PalGeometry * | userGeom, | ||
| double | label_x = -1, |
||
| double | label_y = -1, |
||
| const char * | labelText = NULL, |
||
| double | labelPosX = 0.0, |
||
| double | labelPosY = 0.0, |
||
| bool | fixedPos = false, |
||
| double | angle = 0.0, |
||
| bool | fixedAngle = false, |
||
| int | xQuadOffset = 0, |
||
| int | yQuadOffset = 0, |
||
| double | xOffset = 0.0, |
||
| double | yOffset = 0.0, |
||
| bool | alwaysShow = false, |
||
| double | repeatDistance = 0 |
||
| ) |
register a feature in the layer
| geom_id | unique identifier |
| userGeom | user's geometry that implements the PalGeometry interface |
| label_x | label width |
| label_y | label height |
| labelText | label text |
| labelPosX | x position of the label (in case of fixed label position) |
| labelPosY | y position of the label (in case of fixed label position) |
| fixedPos | true if a single fixed position for this label is needed |
| angle | fixed angle (in radians) to rotate the label |
| fixedAngle | whether to use provided fixed angle |
| xQuadOffset | move label to quadrant: left, don't move, right (-1, 0, 1) |
| yQuadOffset | move label to quadrant: down, don't move, up (-1, 0, 1) |
| xOffset | map unit (+/-) to x-offset the label |
| yOffset | map unit (+/-) to y-offset the label |
| alwaysShow | whether to skip priority and always show the label (causes overlapping) |
| repeatDistance | distance for repeating the label |
| PalException::FeatureExists |
| void pal::Layer::setActive | ( | bool | active | ) |
| void pal::Layer::setArrangement | ( | Arrangement | arrangement | ) |
|
inline |
|
inline |
| void pal::Layer::setLabelUnit | ( | Units | label_unit | ) |
| void pal::Layer::setMaxScale | ( | double | max_scale | ) |
| void pal::Layer::setMinScale | ( | double | min_scale | ) |
| void pal::Layer::setObstacle | ( | bool | obstacle | ) |
| void pal::Layer::setPriority | ( | double | priority | ) |
| void pal::Layer::setToLabel | ( | bool | toLabel | ) |
|
inline |
|
friend |
|
friend |
|
friend |
|
friend |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
1.8.1.2