QGIS API Documentation 3.40.0-Bratislava (b56115d8743)
|
Encapsulates the context for a labeling engine run. More...
#include <qgslabelingenginerule.h>
Public Member Functions | |
QgsLabelingEngineContext (const QgsLabelingEngineContext &other)=delete | |
QgsLabelingEngineContext (QgsRenderContext &renderContext) | |
Constructor for QgsLabelingEngineContext. | |
QgsRectangle | extent () const |
Returns the map extent defining the limits for labeling. | |
QgsGeometry | mapBoundaryGeometry () const |
Returns the map label boundary geometry, which defines the limits within which labels may be placed in the map. | |
QgsLabelingEngineContext & | operator= (const QgsLabelingEngineContext &other)=delete |
QgsRenderContext & | renderContext () |
Returns a reference to the context's render context. | |
const QgsRenderContext & | renderContext () const |
Returns a reference to the context's render context. | |
void | setExtent (const QgsRectangle &extent) |
Sets the map extent defining the limits for labeling. | |
void | setMapBoundaryGeometry (const QgsGeometry &geometry) |
Sets the map label boundary geometry, which defines the limits within which labels may be placed in the map. | |
Encapsulates the context for a labeling engine run.
Definition at line 40 of file qgslabelingenginerule.h.
QgsLabelingEngineContext::QgsLabelingEngineContext | ( | QgsRenderContext & | renderContext | ) |
Constructor for QgsLabelingEngineContext.
Definition at line 23 of file qgslabelingenginerule.cpp.
|
delete |
QgsRectangle QgsLabelingEngineContext::extent | ( | ) | const |
Returns the map extent defining the limits for labeling.
Definition at line 39 of file qgslabelingenginerule.cpp.
QgsGeometry QgsLabelingEngineContext::mapBoundaryGeometry | ( | ) | const |
Returns the map label boundary geometry, which defines the limits within which labels may be placed in the map.
The map boundary geometry specifies the actual geometry of the map boundary, which will be used to detect whether a label is visible (or partially visible) in the rendered map. This may differ from extent() in the case of rotated or non-rectangular maps.
Definition at line 29 of file qgslabelingenginerule.cpp.
|
delete |
|
inline |
Returns a reference to the context's render context.
Definition at line 57 of file qgslabelingenginerule.h.
|
inline |
Returns a reference to the context's render context.
Definition at line 63 of file qgslabelingenginerule.h.
void QgsLabelingEngineContext::setExtent | ( | const QgsRectangle & | extent | ) |
Sets the map extent defining the limits for labeling.
Definition at line 44 of file qgslabelingenginerule.cpp.
void QgsLabelingEngineContext::setMapBoundaryGeometry | ( | const QgsGeometry & | geometry | ) |
Sets the map label boundary geometry, which defines the limits within which labels may be placed in the map.
The map boundary geometry specifies the actual geometry of the map boundary, which will be used to detect whether a label is visible (or partially visible) in the rendered map. This may differ from extent() in the case of rotated or non-rectangular maps.
Definition at line 34 of file qgslabelingenginerule.cpp.