QGIS API Documentation 3.41.0-Master (a6c88b06562)
|
An abstract layout item that provides generic methods for node based shapes such as polygon or polylines. More...
#include <qgslayoutitemnodeitem.h>
Public Member Functions | |
bool | addNode (QPointF point, bool checkArea=true, double radius=10) |
Add a node in current shape. | |
QRectF | boundingRect () const override |
void | deselectNode () |
Deselects any selected nodes. | |
double | estimatedFrameBleed () const override |
Returns the estimated amount the item's frame bleeds outside the item's actual rectangle. | |
virtual bool | isValid () const =0 |
Must be reimplemented in subclasses. | |
bool | moveNode (int index, QPointF node) |
Moves a node to a new position. | |
int | nodeAtPosition (QPointF point, bool searchInRadius=true, double radius=10) const |
Search for the nearest node in the shape within a maximal area. | |
bool | nodePosition (int index, QPointF &position) const |
Gets the position of a node in scene coordinates. | |
QPolygonF | nodes () const |
Returns the nodes the shape consists of. | |
int | nodesSize () const |
Returns the number of nodes in the shape. | |
bool | removeNode (int index) |
Remove a node with specified index from the shape. | |
int | selectedNode () const |
Returns the currently selected node, or -1 if no node is selected. | |
void | setDisplayNodes (bool display=true) |
Set whether the item's nodes should be displayed. | |
void | setNodes (const QPolygonF &nodes) |
Sets the nodes the shape consists of. | |
bool | setSelectedNode (int index) |
Selects a node by index. | |
Public Member Functions inherited from QgsLayoutItem | |
QgsLayoutItem (QgsLayout *layout, bool manageZValue=true) | |
Constructor for QgsLayoutItem, with the specified parent layout. | |
~QgsLayoutItem () override | |
virtual bool | accept (QgsStyleEntityVisitorInterface *visitor) const |
Accepts the specified style entity visitor, causing it to visit all style entities associated with the layout item. | |
virtual void | attemptMove (const QgsLayoutPoint &point, bool useReferencePoint=true, bool includesFrame=false, int page=-1) |
Attempts to move the item to a specified point. | |
void | attemptMoveBy (double deltaX, double deltaY) |
Attempts to shift the item's position by a specified deltaX and deltaY, in layout units. | |
virtual void | attemptResize (const QgsLayoutSize &size, bool includesFrame=false) |
Attempts to resize the item to a specified target size. | |
void | attemptSetSceneRect (const QRectF &rect, bool includesFrame=false) |
Attempts to update the item's position and size to match the passed rect in layout coordinates. | |
QColor | backgroundColor (bool useDataDefined=true) const |
Returns the background color for this item. | |
void | beginCommand (const QString &commandText, UndoCommand command=UndoNone) |
Starts new undo command for this item. | |
QPainter::CompositionMode | blendMode () const |
Returns the item's composition blending mode. | |
void | cancelCommand () |
Cancels the current item command and discards it. | |
virtual void | cleanup () |
Called just before a batch of items are deleted, allowing them to run cleanup tasks. | |
virtual QgsGeometry | clipPath () const |
Returns the clipping path generated by this item, in layout coordinates. | |
virtual bool | containsAdvancedEffects () const |
Returns true if the item contains contents with blend modes or transparency effects which can only be reproduced by rastering the item. | |
QgsAbstractLayoutUndoCommand * | createCommand (const QString &text, int id, QUndoCommand *parent=nullptr) override |
Creates a new layout undo command with the specified text and parent. | |
QgsExpressionContext | createExpressionContext () const override |
This method needs to be reimplemented in all classes which implement this interface and return an expression context. | |
virtual QString | displayName () const |
Gets item display name. | |
void | endCommand () |
Completes the current item command and push it onto the layout's undo stack. | |
bool | excludeFromExports () const |
Returns whether the item should be excluded from layout exports and prints. | |
virtual ExportLayerBehavior | exportLayerBehavior () const |
Returns the behavior of this item during exporting to layered exports (e.g. | |
virtual QgsLayoutItem::ExportLayerDetail | exportLayerDetails () const |
Returns the details for the specified current export layer. | |
virtual void | finalizeRestoreFromXml () |
Called after all pending items have been restored from XML. | |
virtual QgsLayoutSize | fixedSize () const |
Returns the fixed size of the item, if applicable, or an empty size if item can be freely resized. | |
bool | frameEnabled () const |
Returns true if the item includes a frame. | |
Qt::PenJoinStyle | frameJoinStyle () const |
Returns the join style used for drawing the item's frame. | |
QColor | frameStrokeColor () const |
Returns the frame's stroke color. | |
QgsLayoutMeasurement | frameStrokeWidth () const |
Returns the frame's stroke width. | |
bool | hasBackground () const |
Returns true if the item has a background. | |
virtual QIcon | icon () const |
Returns the item's icon. | |
QString | id () const |
Returns the item's ID name. | |
bool | isGroupMember () const |
Returns true if the item is part of a QgsLayoutItemGroup group. | |
bool | isLocked () const |
Returns true if the item is locked, and cannot be interacted with using the mouse. | |
virtual bool | isRefreshing () const |
Returns true if the item is currently refreshing content in the background. | |
double | itemOpacity () const |
Returns the item's opacity. | |
double | itemRotation () const |
Returns the current rotation for the item, in degrees clockwise. | |
virtual QgsLayoutSize | minimumSize () const |
Returns the minimum allowed size of the item, if applicable, or an empty size if item can be freely resized. | |
virtual void | moveContent (double dx, double dy) |
Moves the content of the item, by a specified dx and dy in layout units. | |
virtual bool | nextExportPart () |
Moves to the next export part for a multi-layered export item, during a multi-layered export. | |
virtual Q_DECL_DEPRECATED int | numberExportLayers () const |
Returns the number of layers that this item requires for exporting during layered exports (e.g. | |
int | page () const |
Returns the page the item is currently on, with the first page returning 0. | |
QPointF | pagePos () const |
Returns the item's position (in layout units) relative to the top left corner of its current page. | |
QgsLayoutPoint | pagePositionWithUnits () const |
Returns the item's position (in item units) relative to the top left corner of its current page. | |
void | paint (QPainter *painter, const QStyleOptionGraphicsItem *itemStyle, QWidget *pWidget) override |
Handles preparing a paint surface for the layout item and painting the item's content. | |
QgsLayoutItemGroup * | parentGroup () const |
Returns the item's parent group, if the item is part of a QgsLayoutItemGroup group. | |
QgsLayoutPoint | positionWithUnits () const |
Returns the item's current position, including units. | |
bool | readXml (const QDomElement &itemElement, const QDomDocument &document, const QgsReadWriteContext &context) |
Sets the item state from a DOM element. | |
virtual QRectF | rectWithFrame () const |
Returns the item's rectangular bounds, including any bleed caused by the item's frame. | |
ReferencePoint | referencePoint () const |
Returns the reference point for positioning of the layout item. | |
virtual bool | requiresRasterization () const |
Returns true if the item is drawn in such a way that forces the whole layout to be rasterized when exporting to vector formats. | |
void | setBackgroundColor (const QColor &color) |
Sets the background color for this item. | |
void | setBackgroundEnabled (bool drawBackground) |
Sets whether this item has a background drawn under it or not. | |
void | setBlendMode (QPainter::CompositionMode mode) |
Sets the item's composition blending mode. | |
void | setExcludeFromExports (bool exclude) |
Sets whether the item should be excluded from layout exports and prints. | |
virtual void | setFrameEnabled (bool drawFrame) |
Sets whether this item has a frame drawn around it or not. | |
void | setFrameJoinStyle (Qt::PenJoinStyle style) |
Sets the join style used when drawing the item's frame. | |
void | setFrameStrokeColor (const QColor &color) |
Sets the frame stroke color. | |
virtual void | setFrameStrokeWidth (QgsLayoutMeasurement width) |
Sets the frame stroke width. | |
virtual void | setId (const QString &id) |
Set the item's id name. | |
void | setItemOpacity (double opacity) |
Sets the item's opacity. | |
void | setLocked (bool locked) |
Sets whether the item is locked, preventing mouse interactions with the item. | |
virtual void | setMoveContentPreviewOffset (double dx, double dy) |
Sets temporary offset for the item, by a specified dx and dy in layout units. | |
void | setParentGroup (QgsLayoutItemGroup *group) |
Sets the item's parent group. | |
void | setReferencePoint (ReferencePoint point) |
Sets the reference point for positioning of the layout item. | |
virtual void | setSelected (bool selected) |
Sets whether the item should be selected. | |
virtual void | setVisibility (bool visible) |
Sets whether the item is visible. | |
bool | shouldDrawItem () const |
Returns whether the item should be drawn in the current context. | |
QgsLayoutSize | sizeWithUnits () const |
Returns the item's current size, including units. | |
virtual void | startLayeredExport () |
Starts a multi-layer export operation. | |
virtual void | stopLayeredExport () |
Stops a multi-layer export operation. | |
int | type () const override |
Returns a unique graphics item type identifier. | |
virtual QString | uuid () const |
Returns the item identification string. | |
bool | writeXml (QDomElement &parentElement, QDomDocument &document, const QgsReadWriteContext &context) const |
Stores the item state in a DOM element. | |
virtual void | zoomContent (double factor, QPointF point) |
Zooms content of item. | |
Public Member Functions inherited from QgsLayoutObject | |
QgsLayoutObject (QgsLayout *layout) | |
Constructor for QgsLayoutObject, with the specified parent layout. | |
QgsExpressionContext | createExpressionContext () const override |
Creates an expression context relating to the objects' current state. | |
QStringList | customProperties () const |
Returns list of keys stored in custom properties for the object. | |
QVariant | customProperty (const QString &key, const QVariant &defaultValue=QVariant()) const |
Read a custom property from the object. | |
QgsPropertyCollection & | dataDefinedProperties () |
Returns a reference to the object's property collection, used for data defined overrides. | |
const QgsPropertyCollection & | dataDefinedProperties () const |
Returns a reference to the object's property collection, used for data defined overrides. | |
QgsLayout * | layout () |
Returns the layout the object is attached to. | |
const QgsLayout * | layout () const |
Returns the layout the object is attached to. | |
void | removeCustomProperty (const QString &key) |
Remove a custom property from the object. | |
void | setCustomProperty (const QString &key, const QVariant &value) |
Set a custom property for the object. | |
void | setDataDefinedProperties (const QgsPropertyCollection &collection) |
Sets the objects's property collection, used for data defined overrides. | |
Public Member Functions inherited from QgsExpressionContextGenerator | |
virtual | ~QgsExpressionContextGenerator ()=default |
Public Member Functions inherited from QgsLayoutUndoObjectInterface | |
virtual | ~QgsLayoutUndoObjectInterface ()=default |
Protected Slots | |
virtual void | updateBoundingRect () |
Called when the bounding rect of the item should recalculated. | |
Protected Member Functions | |
QgsLayoutNodesItem (const QPolygonF &polygon, QgsLayout *layout) | |
Constructor for a QgsLayoutNodesItem with the given polygon nodes, attached to the specified layout. | |
QgsLayoutNodesItem (QgsLayout *layout) | |
Constructor for QgsLayoutNodesItem, attached to the specified layout. | |
virtual bool | _addNode (int nodeIndex, QPointF newNode, double radius)=0 |
Method called in addNode. | |
virtual void | _draw (QgsLayoutItemRenderContext &context, const QStyleOptionGraphicsItem *itemStyle=nullptr)=0 |
Method called in paint. | |
virtual void | _readXmlStyle (const QDomElement &elmt, const QgsReadWriteContext &context)=0 |
Method called in readXml. | |
virtual bool | _removeNode (int nodeIndex)=0 |
Method called in removeNode. | |
virtual void | _writeXmlStyle (QDomDocument &doc, QDomElement &elmt, const QgsReadWriteContext &context) const =0 |
Method called in writeXml. | |
double | computeDistance (QPointF pt1, QPointF pt2) const |
Compute an euclidean distance between 2 nodes. | |
void | draw (QgsLayoutItemRenderContext &context) override |
Draws the item's contents using the specified item render context. | |
QgsLayoutItem::Flags | itemFlags () const override |
Returns the item's flags, which indicate how the item behaves. | |
bool | readPropertiesFromElement (const QDomElement &element, const QDomDocument &document, const QgsReadWriteContext &context) override |
Sets item state from a DOM element. | |
void | rescaleToFitBoundingBox () |
Rescale the current shape according to the item's bounding box. | |
void | updateSceneRect () |
Update the current scene rectangle for this item. | |
bool | writePropertiesToElement (QDomElement &element, QDomDocument &document, const QgsReadWriteContext &context) const override |
Stores item state within an XML DOM element. | |
Protected Member Functions inherited from QgsLayoutItem | |
QPointF | adjustPointForReferencePosition (QPointF point, QSizeF size, ReferencePoint reference) const |
Adjusts the specified point at which a reference position of the item sits and returns the top left corner of the item, if reference point were placed at the specified position. | |
QgsLayoutSize | applyDataDefinedSize (const QgsLayoutSize &size) |
Applies any present data defined size overrides to the specified layout size. | |
virtual QSizeF | applyItemSizeConstraint (QSizeF targetSize) |
Applies any item-specific size constraint handling to a given targetSize in layout units. | |
virtual void | drawBackground (QgsRenderContext &context) |
Draws the background for the item. | |
virtual void | drawDebugRect (QPainter *painter) |
Draws a debugging rectangle of the item's current bounds within the specified painter. | |
virtual void | drawFrame (QgsRenderContext &context) |
Draws the frame around the item. | |
void | drawRefreshingOverlay (QPainter *painter, const QStyleOptionGraphicsItem *itemStyle) |
Draws a "refreshing" overlay icon on the item. | |
virtual QPainterPath | framePath () const |
Returns the path to use when drawing the item's frame or background. | |
QPointF | positionAtReferencePoint (ReferencePoint reference) const |
Returns the current position (in layout units) of a reference point for the item. | |
void | refreshBackgroundColor (bool updateItem=true) |
Refresh item's background color, considering data defined colors. | |
void | refreshBlendMode () |
Refresh item's blend mode, considering data defined blend mode. | |
void | refreshFrame (bool updateItem=true) |
Refresh item's frame, considering data defined colors and frame size. | |
void | refreshItemPosition () |
Refreshes an item's position by rechecking it against any possible overrides such as data defined positioning. | |
void | refreshItemRotation (QPointF *origin=nullptr) |
Refreshes an item's rotation by rechecking it against any possible overrides such as data defined rotation. | |
void | refreshItemSize () |
Refreshes an item's size by rechecking it against any possible item fixed or minimum sizes. | |
void | refreshOpacity (bool updateItem=true) |
Refresh item's opacity, considering data defined opacity. | |
virtual void | setFixedSize (const QgsLayoutSize &size) |
Sets a fixed size for the layout item, which prevents it from being freely resized. | |
virtual void | setMinimumSize (const QgsLayoutSize &size) |
Sets the minimum allowed size for the layout item. | |
QgsLayoutPoint | topLeftToReferencePoint (const QgsLayoutPoint &point) const |
Returns the position for the reference point of the item, if the top-left of the item was placed at the specified point. | |
Protected Member Functions inherited from QgsLayoutObject | |
bool | readObjectPropertiesFromElement (const QDomElement &parentElement, const QDomDocument &document, const QgsReadWriteContext &context) |
Sets object properties from a DOM element. | |
bool | writeObjectPropertiesToElement (QDomElement &parentElement, QDomDocument &document, const QgsReadWriteContext &context) const |
Stores object properties within an XML DOM element. | |
Protected Attributes | |
QRectF | mCurrentRectangle |
Current bounding rectangle of shape. | |
double | mMaxSymbolBleed = 0.0 |
Max symbol bleed. | |
QPolygonF | mPolygon |
Shape's nodes. | |
Protected Attributes inherited from QgsLayoutObject | |
QgsObjectCustomProperties | mCustomProperties |
Custom properties for object. | |
QgsPropertyCollection | mDataDefinedProperties |
QPointer< QgsLayout > | mLayout |
An abstract layout item that provides generic methods for node based shapes such as polygon or polylines.
Definition at line 28 of file qgslayoutitemnodeitem.h.
|
protected |
Constructor for QgsLayoutNodesItem, attached to the specified layout.
Definition at line 45 of file qgslayoutitemnodeitem.cpp.
|
protected |
Constructor for a QgsLayoutNodesItem with the given polygon nodes, attached to the specified layout.
Definition at line 51 of file qgslayoutitemnodeitem.cpp.
|
protectedpure virtual |
Method called in addNode.
Implemented in QgsLayoutItemPolygon, and QgsLayoutItemPolyline.
|
protectedpure virtual |
Method called in paint.
Implemented in QgsLayoutItemPolygon, and QgsLayoutItemPolyline.
|
protectedpure virtual |
Method called in readXml.
Implemented in QgsLayoutItemPolygon, and QgsLayoutItemPolyline.
|
protectedpure virtual |
Method called in removeNode.
Implemented in QgsLayoutItemPolygon, and QgsLayoutItemPolyline.
|
protectedpure virtual |
Method called in writeXml.
Implemented in QgsLayoutItemPolygon, and QgsLayoutItemPolyline.
bool QgsLayoutNodesItem::addNode | ( | QPointF | point, |
bool | checkArea = true , |
||
double | radius = 10 |
||
) |
Add a node in current shape.
point | is the location of the new node (in scene coordinates) |
checkArea | is a flag to indicate if there's a space constraint. |
radius | is the space constraint and is used only if checkArea is true . Typically, if this flag is TRUE, the new node has to be nearer than radius to the shape to be added. |
Definition at line 100 of file qgslayoutitemnodeitem.cpp.
|
override |
Definition at line 35 of file qgslayoutitemnodeitem.cpp.
|
protected |
Compute an euclidean distance between 2 nodes.
Definition at line 94 of file qgslayoutitemnodeitem.cpp.
|
inline |
Deselects any selected nodes.
Definition at line 107 of file qgslayoutitemnodeitem.h.
|
overrideprotectedvirtual |
Draws the item's contents using the specified item render context.
Note that the context's painter has been scaled so that painter units are pixels. Use the QgsRenderContext methods to convert from millimeters or other units to the painter's units.
Implements QgsLayoutItem.
Definition at line 75 of file qgslayoutitemnodeitem.cpp.
|
overridevirtual |
Returns the estimated amount the item's frame bleeds outside the item's actual rectangle.
For instance, if the item has a 2mm frame stroke, then 1mm of this frame is drawn outside the item's rect. In this case the return value will be 1.0.
Returned values are in layout units.
Reimplemented from QgsLayoutItem.
Definition at line 40 of file qgslayoutitemnodeitem.cpp.
|
pure virtual |
Must be reimplemented in subclasses.
Typically a polyline is valid if it has at least 2 distinct nodes, while a polygon is valid if it has at least 3 distinct nodes.
Implemented in QgsLayoutItemPolygon, and QgsLayoutItemPolyline.
|
overrideprotectedvirtual |
Returns the item's flags, which indicate how the item behaves.
Reimplemented from QgsLayoutItem.
Definition at line 89 of file qgslayoutitemnodeitem.cpp.
bool QgsLayoutNodesItem::moveNode | ( | int | index, |
QPointF | node | ||
) |
Moves a node to a new position.
index | the index of the node to move |
node | is the new position in scene coordinate |
Definition at line 264 of file qgslayoutitemnodeitem.cpp.
int QgsLayoutNodesItem::nodeAtPosition | ( | QPointF | point, |
bool | searchInRadius = true , |
||
double | radius = 10 |
||
) | const |
Search for the nearest node in the shape within a maximal area.
Returns the index of the nearest node or -1 if no node was found.
point | is the location to search for nodes from (in scene coordinates) |
searchInRadius | is a flag to indicate if the area of research is limited in space. |
radius | is only used if searchInRadius is true |
Definition at line 215 of file qgslayoutitemnodeitem.cpp.
bool QgsLayoutNodesItem::nodePosition | ( | int | index, |
QPointF & | position | ||
) | const |
Gets the position of a node in scene coordinates.
index | of the node |
position | the position of the node |
true
if the index is valid and the position is set, false
otherwise Definition at line 240 of file qgslayoutitemnodeitem.cpp.
|
inline |
Returns the nodes the shape consists of.
Definition at line 44 of file qgslayoutitemnodeitem.h.
|
inline |
Returns the number of nodes in the shape.
Definition at line 92 of file qgslayoutitemnodeitem.h.
|
overrideprotectedvirtual |
Sets item state from a DOM element.
element | is the DOM element for the item |
document | DOM document |
context | read write context |
Note that item subclasses should not rely on all other items being present in the layout at the time this method is called. Instead, any connections and links to other items must be made in the finalizeRestoreFromXml() method. E.g. when restoring a scalebar, the connection to the linked map's signals should be implemented in finalizeRestoreFromXml(), not readPropertiesFromElement().
Reimplemented from QgsLayoutItem.
Definition at line 280 of file qgslayoutitemnodeitem.cpp.
bool QgsLayoutNodesItem::removeNode | ( | int | index | ) |
Remove a node with specified index from the shape.
Definition at line 253 of file qgslayoutitemnodeitem.cpp.
|
protected |
Rescale the current shape according to the item's bounding box.
Useful when the shape is resized thanks to the rubber band.
Definition at line 305 of file qgslayoutitemnodeitem.cpp.
|
inline |
Returns the currently selected node, or -1 if no node is selected.
Definition at line 102 of file qgslayoutitemnodeitem.h.
|
inline |
Set whether the item's nodes should be displayed.
Definition at line 59 of file qgslayoutitemnodeitem.h.
void QgsLayoutNodesItem::setNodes | ( | const QPolygonF & | nodes | ) |
Sets the nodes the shape consists of.
Definition at line 28 of file qgslayoutitemnodeitem.cpp.
bool QgsLayoutNodesItem::setSelectedNode | ( | int | index | ) |
Selects a node by index.
Definition at line 323 of file qgslayoutitemnodeitem.cpp.
|
protectedvirtualslot |
Called when the bounding rect of the item should recalculated.
Subclasses should update currentRectangle in their implementations.
Definition at line 349 of file qgslayoutitemnodeitem.cpp.
|
protected |
Update the current scene rectangle for this item.
Definition at line 336 of file qgslayoutitemnodeitem.cpp.
|
overrideprotectedvirtual |
Stores item state within an XML DOM element.
element | is the DOM element to store the item's properties in |
document | DOM document |
context | read write context |
Reimplemented from QgsLayoutItem.
Definition at line 360 of file qgslayoutitemnodeitem.cpp.
|
protected |
Current bounding rectangle of shape.
Definition at line 176 of file qgslayoutitemnodeitem.h.
|
protected |
Max symbol bleed.
Definition at line 146 of file qgslayoutitemnodeitem.h.
|
protected |
Shape's nodes.
Definition at line 143 of file qgslayoutitemnodeitem.h.