QGIS API Documentation  3.4.3-Madeira (2f64a3c)
Public Member Functions | Protected Slots | Protected Member Functions | Protected Attributes | List of all members
QgsLayoutNodesItem Class Referenceabstract

An abstract layout item that provides generic methods for node based shapes such as polygon or polylines. More...

#include <qgslayoutitemnodeitem.h>

Inheritance diagram for QgsLayoutNodesItem:
Inheritance graph
[legend]

Public Member Functions

bool addNode (QPointF point, bool checkArea=true, double radius=10)
 Add a node in current shape. More...
 
QRectF boundingRect () const override
 
void deselectNode ()
 Deselects any selected nodes. More...
 
double estimatedFrameBleed () const override
 Returns the estimated amount the item's frame bleeds outside the item's actual rectangle. More...
 
bool moveNode (int index, QPointF node)
 Moves a node to a new position. More...
 
int nodeAtPosition (QPointF point, bool searchInRadius=true, double radius=10) const
 Search for the nearest node in the shape within a maximal area. More...
 
bool nodePosition (int index, QPointF &position) const
 Gets the position of a node in scene coordinates. More...
 
QPolygonF nodes () const
 Returns the nodes the shape consists of. More...
 
int nodesSize () const
 Returns the number of nodes in the shape. More...
 
bool removeNode (int index)
 Remove a node with specified index from the shape. More...
 
int selectedNode () const
 Returns the currently selected node, or -1 if no node is selected. More...
 
void setDisplayNodes (bool display=true)
 Set whether the item's nodes should be displayed. More...
 
void setNodes (const QPolygonF &nodes)
 Sets the nodes the shape consists of. More...
 
bool setSelectedNode (int index)
 Selects a node by index. More...
 
- Public Member Functions inherited from QgsLayoutItem
 QgsLayoutItem (QgsLayout *layout, bool manageZValue=true)
 Constructor for QgsLayoutItem, with the specified parent layout. More...
 
 ~QgsLayoutItem () override
 
virtual void attemptMove (const QgsLayoutPoint &point, bool useReferencePoint=true, bool includesFrame=false, int page=-1)
 Attempts to move the item to a specified point. More...
 
void attemptMoveBy (double deltaX, double deltaY)
 Attempts to shift the item's position by a specified deltaX and deltaY, in layout units. More...
 
virtual void attemptResize (const QgsLayoutSize &size, bool includesFrame=false)
 Attempts to resize the item to a specified target size. More...
 
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. More...
 
QColor backgroundColor () const
 Returns the background color for this item. More...
 
void beginCommand (const QString &commandText, UndoCommand command=UndoNone)
 Starts new undo command for this item. More...
 
QPainter::CompositionMode blendMode () const
 Returns the item's composition blending mode. More...
 
void cancelCommand ()
 Cancels the current item command and discards it. More...
 
virtual void cleanup ()
 Called just before a batch of items are deleted, allowing them to run cleanup tasks. More...
 
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. More...
 
QgsAbstractLayoutUndoCommandcreateCommand (const QString &text, int id, QUndoCommand *parent=nullptr) override
 Creates a new layout undo command with the specified text and parent. More...
 
QgsExpressionContext createExpressionContext () const override
 This method needs to be reimplemented in all classes which implement this interface and return an expression context. More...
 
virtual QString displayName () const
 Gets item display name. More...
 
void endCommand ()
 Completes the current item command and push it onto the layout's undo stack. More...
 
bool excludeFromExports () const
 Returns whether the item should be excluded from layout exports and prints. More...
 
virtual void finalizeRestoreFromXml ()
 Called after all pending items have been restored from XML. More...
 
virtual QgsLayoutSize fixedSize () const
 Returns the fixed size of the item, if applicable, or an empty size if item can be freely resized. More...
 
bool frameEnabled () const
 Returns true if the item includes a frame. More...
 
Qt::PenJoinStyle frameJoinStyle () const
 Returns the join style used for drawing the item's frame. More...
 
QColor frameStrokeColor () const
 Returns the frame's stroke color. More...
 
QgsLayoutMeasurement frameStrokeWidth () const
 Returns the frame's stroke width. More...
 
bool hasBackground () const
 Returns true if the item has a background. More...
 
virtual QIcon icon () const
 Returns the item's icon. More...
 
QString id () const
 Returns the item's ID name. More...
 
bool isGroupMember () const
 Returns true if the item is part of a QgsLayoutItemGroup group. More...
 
bool isLocked () const
 Returns true if the item is locked, and cannot be interacted with using the mouse. More...
 
virtual Flags itemFlags () const
 Returns the item's flags, which indicate how the item behaves. More...
 
double itemOpacity () const
 Returns the item's opacity. More...
 
double itemRotation () const
 Returns the current rotation for the item, in degrees clockwise. More...
 
virtual QgsLayoutSize minimumSize () const
 Returns the minimum allowed size of the item, if applicable, or an empty size if item can be freely resized. More...
 
virtual void moveContent (double dx, double dy)
 Moves the content of the item, by a specified dx and dy in layout units. More...
 
virtual int numberExportLayers () const
 Returns the number of layers that this item requires for exporting during layered exports (e.g. More...
 
int page () const
 Returns the page the item is currently on, with the first page returning 0. More...
 
QPointF pagePos () const
 Returns the item's position (in layout units) relative to the top left corner of its current page. More...
 
QgsLayoutPoint pagePositionWithUnits () const
 Returns the item's position (in item units) relative to the top left corner of its current page. More...
 
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. More...
 
QgsLayoutItemGroupparentGroup () const
 Returns the item's parent group, if the item is part of a QgsLayoutItemGroup group. More...
 
QgsLayoutPoint positionWithUnits () const
 Returns the item's current position, including units. More...
 
bool readXml (const QDomElement &itemElement, const QDomDocument &document, const QgsReadWriteContext &context)
 Sets the item state from a DOM element. More...
 
virtual QRectF rectWithFrame () const
 Returns the item's rectangular bounds, including any bleed caused by the item's frame. More...
 
ReferencePoint referencePoint () const
 Returns the reference point for positioning of the layout item. More...
 
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. More...
 
void setBackgroundColor (const QColor &color)
 Sets the background color for this item. More...
 
void setBackgroundEnabled (bool drawBackground)
 Sets whether this item has a background drawn under it or not. More...
 
void setBlendMode (QPainter::CompositionMode mode)
 Sets the item's composition blending mode. More...
 
void setExcludeFromExports (bool exclude)
 Sets whether the item should be excluded from layout exports and prints. More...
 
virtual void setFrameEnabled (bool drawFrame)
 Sets whether this item has a frame drawn around it or not. More...
 
void setFrameJoinStyle (Qt::PenJoinStyle style)
 Sets the join style used when drawing the item's frame. More...
 
void setFrameStrokeColor (const QColor &color)
 Sets the frame stroke color. More...
 
virtual void setFrameStrokeWidth (QgsLayoutMeasurement width)
 Sets the frame stroke width. More...
 
virtual void setId (const QString &id)
 Set the item's id name. More...
 
void setItemOpacity (double opacity)
 Sets the item's opacity. More...
 
void setLocked (bool locked)
 Sets whether the item is locked, preventing mouse interactions with the item. More...
 
virtual void setMoveContentPreviewOffset (double dx, double dy)
 Sets temporary offset for the item, by a specified dx and dy in layout units. More...
 
void setParentGroup (QgsLayoutItemGroup *group)
 Sets the item's parent group. More...
 
void setReferencePoint (ReferencePoint point)
 Sets the reference point for positioning of the layout item. More...
 
virtual void setSelected (bool selected)
 Sets whether the item should be selected. More...
 
virtual void setVisibility (bool visible)
 Sets whether the item is visible. More...
 
bool shouldDrawItem () const
 Returns whether the item should be drawn in the current context. More...
 
QgsLayoutSize sizeWithUnits () const
 Returns the item's current size, including units. More...
 
int type () const override
 Returns a unique graphics item type identifier. More...
 
virtual QString uuid () const
 Returns the item identification string. More...
 
bool writeXml (QDomElement &parentElement, QDomDocument &document, const QgsReadWriteContext &context) const
 Stores the item state in a DOM element. More...
 
virtual void zoomContent (double factor, QPointF point)
 Zooms content of item. More...
 
- Public Member Functions inherited from QgsLayoutObject
 QgsLayoutObject (QgsLayout *layout)
 Constructor for QgsLayoutObject, with the specified parent layout. More...
 
QgsExpressionContext createExpressionContext () const override
 Creates an expression context relating to the objects' current state. More...
 
QStringList customProperties () const
 Returns list of keys stored in custom properties for the object. More...
 
QVariant customProperty (const QString &key, const QVariant &defaultValue=QVariant()) const
 Read a custom property from the object. More...
 
QgsPropertyCollectiondataDefinedProperties ()
 Returns a reference to the object's property collection, used for data defined overrides. More...
 
const QgsPropertyCollectiondataDefinedProperties () const
 Returns a reference to the object's property collection, used for data defined overrides. More...
 
const QgsLayoutlayout () const
 Returns the layout the object is attached to. More...
 
QgsLayoutlayout ()
 Returns the layout the object is attached to. More...
 
void removeCustomProperty (const QString &key)
 Remove a custom property from the object. More...
 
void setCustomProperty (const QString &key, const QVariant &value)
 Set a custom property for the object. More...
 
void setDataDefinedProperties (const QgsPropertyCollection &collection)
 Sets the objects's property collection, used for data defined overrides. More...
 
- Public Member Functions inherited from QgsExpressionContextGenerator
virtual ~QgsExpressionContextGenerator ()=default
 
- Public Member Functions inherited from QgsLayoutUndoObjectInterface
virtual ~QgsLayoutUndoObjectInterface ()=default
 Destructor for QgsLayoutUndoObjectInterface. More...
 

Protected Slots

virtual void updateBoundingRect ()
 Called when the bounding rect of the item should recalculated. More...
 

Protected Member Functions

 QgsLayoutNodesItem (QgsLayout *layout)
 Constructor for QgsLayoutNodesItem, attached to the specified layout. More...
 
 QgsLayoutNodesItem (const QPolygonF &polygon, QgsLayout *layout)
 Constructor for a QgsLayoutNodesItem with the given polygon nodes, attached to the specified layout. More...
 
virtual bool _addNode (int nodeIndex, QPointF newNode, double radius)=0
 Method called in addNode. More...
 
virtual void _draw (QgsLayoutItemRenderContext &context, const QStyleOptionGraphicsItem *itemStyle=nullptr)=0
 Method called in paint. More...
 
virtual void _readXmlStyle (const QDomElement &elmt, const QgsReadWriteContext &context)=0
 Method called in readXml. More...
 
virtual bool _removeNode (int nodeIndex)=0
 Method called in removeNode. More...
 
virtual void _writeXmlStyle (QDomDocument &doc, QDomElement &elmt, const QgsReadWriteContext &context) const =0
 Method called in writeXml. More...
 
double computeDistance (QPointF pt1, QPointF pt2) const
 Compute an euclidian distance between 2 nodes. More...
 
void draw (QgsLayoutItemRenderContext &context) override
 Draws the item's contents using the specified item render context. More...
 
bool readPropertiesFromElement (const QDomElement &element, const QDomDocument &document, const QgsReadWriteContext &context) override
 Sets item state from a DOM element. More...
 
void rescaleToFitBoundingBox ()
 Rescale the current shape according to the item's bounding box. More...
 
void updateSceneRect ()
 Update the current scene rectangle for this item. More...
 
bool writePropertiesToElement (QDomElement &element, QDomDocument &document, const QgsReadWriteContext &context) const override
 Stores item state within an XML DOM element. More...
 
- 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. More...
 
QgsLayoutSize applyDataDefinedSize (const QgsLayoutSize &size)
 Applies any present data defined size overrides to the specified layout size. More...
 
virtual QSizeF applyItemSizeConstraint (QSizeF targetSize)
 Applies any item-specific size constraint handling to a given targetSize in layout units. More...
 
virtual void drawBackground (QgsRenderContext &context)
 Draws the background for the item. More...
 
virtual void drawDebugRect (QPainter *painter)
 Draws a debugging rectangle of the item's current bounds within the specified painter. More...
 
virtual void drawFrame (QgsRenderContext &context)
 Draws the frame around the item. More...
 
QPointF positionAtReferencePoint (ReferencePoint reference) const
 Returns the current position (in layout units) of a reference point for the item. More...
 
void refreshBackgroundColor (bool updateItem=true)
 Refresh item's background color, considering data defined colors. More...
 
void refreshBlendMode ()
 Refresh item's blend mode, considering data defined blend mode. More...
 
void refreshFrame (bool updateItem=true)
 Refresh item's frame, considering data defined colors and frame size. More...
 
void refreshItemPosition ()
 Refreshes an item's position by rechecking it against any possible overrides such as data defined positioning. More...
 
void refreshItemRotation (QPointF *origin=nullptr)
 Refreshes an item's rotation by rechecking it against any possible overrides such as data defined rotation. More...
 
void refreshItemSize ()
 Refreshes an item's size by rechecking it against any possible item fixed or minimum sizes. More...
 
void refreshOpacity (bool updateItem=true)
 Refresh item's opacity, considering data defined opacity. More...
 
virtual void setFixedSize (const QgsLayoutSize &size)
 Sets a fixed size for the layout item, which prevents it from being freely resized. More...
 
virtual void setMinimumSize (const QgsLayoutSize &size)
 Sets the minimum allowed size for the layout item. More...
 
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. More...
 
- Protected Member Functions inherited from QgsLayoutObject
bool readObjectPropertiesFromElement (const QDomElement &parentElement, const QDomDocument &document, const QgsReadWriteContext &context)
 Sets object properties from a DOM element. More...
 
bool writeObjectPropertiesToElement (QDomElement &parentElement, QDomDocument &document, const QgsReadWriteContext &context) const
 Stores object properties within an XML DOM element. More...
 

Protected Attributes

QRectF mCurrentRectangle
 Current bounding rectangle of shape. More...
 
double mMaxSymbolBleed = 0.0
 Max symbol bleed. More...
 
QPolygonF mPolygon
 Shape's nodes. More...
 
- Protected Attributes inherited from QgsLayoutObject
QgsObjectCustomProperties mCustomProperties
 Custom properties for object. More...
 
QgsPropertyCollection mDataDefinedProperties
 
QPointer< QgsLayoutmLayout
 

Additional Inherited Members

- Public Types inherited from QgsLayoutItem
enum  Flag { FlagOverridesPaint = 1 << 1 }
 Flags for controlling how an item behaves. More...
 
enum  ReferencePoint {
  UpperLeft, UpperMiddle, UpperRight, MiddleLeft,
  Middle, MiddleRight, LowerLeft, LowerMiddle,
  LowerRight
}
 Fixed position reference point. More...
 
enum  UndoCommand {
  UndoNone = -1, UndoIncrementalMove = 1, UndoIncrementalResize, UndoStrokeColor,
  UndoStrokeWidth, UndoBackgroundColor, UndoOpacity, UndoSetId,
  UndoRotation, UndoShapeStyle, UndoShapeCornerRadius, UndoNodeMove,
  UndoAtlasMargin, UndoMapRotation, UndoZoomContent, UndoOverviewStyle,
  UndoGridFramePenColor, UndoMapGridFrameFill1Color, UndoMapGridFrameFill2Color, UndoMapAnnotationDistance,
  UndoMapGridAnnotationFontColor, UndoMapGridLineSymbol, UndoMapGridMarkerSymbol, UndoPictureRotation,
  UndoPictureFillColor, UndoPictureStrokeColor, UndoPictureStrokeWidth, UndoPictureNorthOffset,
  UndoLabelText, UndoLabelFont, UndoLabelMargin, UndoLabelFontColor,
  UndoLegendText, UndoLegendColumnCount, UndoLegendSymbolWidth, UndoLegendSymbolHeight,
  UndoLegendWmsLegendWidth, UndoLegendWmsLegendHeight, UndoLegendTitleSpaceBottom, UndoLegendGroupSpace,
  UndoLegendLayerSpace, UndoLegendSymbolSpace, UndoLegendIconSymbolSpace, UndoLegendFontColor,
  UndoLegendBoxSpace, UndoLegendColumnSpace, UndoLegendLineSpacing, UndoLegendRasterStrokeWidth,
  UndoLegendRasterStrokeColor, UndoLegendTitleFont, UndoLegendGroupFont, UndoLegendLayerFont,
  UndoLegendItemFont, UndoScaleBarLineWidth, UndoScaleBarSegmentSize, UndoScaleBarSegmentsLeft,
  UndoScaleBarSegments, UndoScaleBarHeight, UndoScaleBarFontColor, UndoScaleBarFillColor,
  UndoScaleBarFillColor2, UndoScaleBarStrokeColor, UndoScaleBarUnitText, UndoScaleBarMapUnitsSegment,
  UndoScaleBarLabelBarSize, UndoScaleBarBoxContentSpace, UndoArrowStrokeWidth, UndoArrowHeadWidth,
  UndoArrowHeadFillColor, UndoArrowHeadStrokeColor, UndoCustomCommand
}
 Layout item undo commands, used for collapsing undo commands. More...
 
- Public Types inherited from QgsLayoutObject
enum  DataDefinedProperty {
  NoProperty = 0, AllProperties, TestProperty, PresetPaperSize,
  PaperWidth, PaperHeight, NumPages, PaperOrientation,
  PageNumber, PositionX, PositionY, ItemWidth,
  ItemHeight, ItemRotation, Transparency, Opacity,
  BlendMode, ExcludeFromExports, FrameColor, BackgroundColor,
  MapRotation, MapScale, MapXMin, MapYMin,
  MapXMax, MapYMax, MapAtlasMargin, MapLayers,
  MapStylePreset, PictureSource, PictureSvgBackgroundColor, PictureSvgStrokeColor,
  PictureSvgStrokeWidth, SourceUrl, LegendTitle, LegendColumnCount,
  ScalebarFillColor, ScalebarFillColor2, ScalebarLineColor, ScalebarLineWidth,
  AttributeTableSourceLayer
}
 Data defined properties for different item types. More...
 
enum  PropertyValueType { EvaluatedValue = 0, OriginalValue }
 Specifies whether the value returned by a function should be the original, user set value, or the current evaluated value for the property. More...
 
- Public Slots inherited from QgsLayoutItem
virtual void invalidateCache ()
 Forces a deferred update of any cached image the item uses. More...
 
virtual void redraw ()
 Triggers a redraw (update) of the item. More...
 
void refresh () override
 Refreshes the item, causing a recalculation of any property overrides and recalculation of its position and size. More...
 
virtual void refreshDataDefinedProperty (QgsLayoutObject::DataDefinedProperty property=QgsLayoutObject::AllProperties)
 Refreshes a data defined property for the item by reevaluating the property's value and redrawing the item with this new value. More...
 
virtual void rotateItem (double angle, QPointF transformOrigin)
 Rotates the item by a specified angle in degrees clockwise around a specified reference point. More...
 
virtual void setItemRotation (double rotation, bool adjustPosition=true)
 Sets the layout item's rotation, in degrees clockwise. More...
 
- Public Slots inherited from QgsLayoutObject
virtual void refresh ()
 Refreshes the object, causing a recalculation of any property overrides. More...
 
- Signals inherited from QgsLayoutItem
void frameChanged ()
 Emitted if the item's frame style changes. More...
 
void lockChanged ()
 Emitted if the item's lock status changes. More...
 
void rotationChanged (double newRotation)
 Emitted on item rotation change. More...
 
void sizePositionChanged ()
 Emitted when the item's size or position changes. More...
 
- Signals inherited from QgsLayoutObject
void changed ()
 Emitted when the object's properties change. More...
 
- Static Public Member Functions inherited from QgsLayoutObject
static const QgsPropertiesDefinitionpropertyDefinitions ()
 Returns the layout object property definitions. More...
 
- Properties inherited from QgsLayoutItem
bool locked
 

Detailed Description

An abstract layout item that provides generic methods for node based shapes such as polygon or polylines.

Since
QGIS 3.0

Definition at line 29 of file qgslayoutitemnodeitem.h.

Constructor & Destructor Documentation

◆ QgsLayoutNodesItem() [1/2]

QgsLayoutNodesItem::QgsLayoutNodesItem ( QgsLayout layout)
protected

Constructor for QgsLayoutNodesItem, attached to the specified layout.

Definition at line 43 of file qgslayoutitemnodeitem.cpp.

◆ QgsLayoutNodesItem() [2/2]

QgsLayoutNodesItem::QgsLayoutNodesItem ( const QPolygonF &  polygon,
QgsLayout layout 
)
protected

Constructor for a QgsLayoutNodesItem with the given polygon nodes, attached to the specified layout.

Definition at line 49 of file qgslayoutitemnodeitem.cpp.

Member Function Documentation

◆ _addNode()

virtual bool QgsLayoutNodesItem::_addNode ( int  nodeIndex,
QPointF  newNode,
double  radius 
)
protectedpure virtual

Method called in addNode.

Implemented in QgsLayoutItemPolyline, and QgsLayoutItemPolygon.

◆ _draw()

virtual void QgsLayoutNodesItem::_draw ( QgsLayoutItemRenderContext context,
const QStyleOptionGraphicsItem *  itemStyle = nullptr 
)
protectedpure virtual

Method called in paint.

Implemented in QgsLayoutItemPolyline, and QgsLayoutItemPolygon.

◆ _readXmlStyle()

virtual void QgsLayoutNodesItem::_readXmlStyle ( const QDomElement &  elmt,
const QgsReadWriteContext context 
)
protectedpure virtual

Method called in readXml.

Implemented in QgsLayoutItemPolyline, and QgsLayoutItemPolygon.

◆ _removeNode()

virtual bool QgsLayoutNodesItem::_removeNode ( int  nodeIndex)
protectedpure virtual

Method called in removeNode.

Implemented in QgsLayoutItemPolyline, and QgsLayoutItemPolygon.

◆ _writeXmlStyle()

virtual void QgsLayoutNodesItem::_writeXmlStyle ( QDomDocument &  doc,
QDomElement &  elmt,
const QgsReadWriteContext context 
) const
protectedpure virtual

Method called in writeXml.

Implemented in QgsLayoutItemPolyline, and QgsLayoutItemPolygon.

◆ addNode()

bool QgsLayoutNodesItem::addNode ( QPointF  point,
bool  checkArea = true,
double  radius = 10 
)

Add a node in current shape.

Parameters
pointis the location of the new node (in scene coordinates)
checkAreais a flag to indicate if there's a space constraint.
radiusis the space contraint 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 93 of file qgslayoutitemnodeitem.cpp.

◆ boundingRect()

QRectF QgsLayoutNodesItem::boundingRect ( ) const
override

Definition at line 33 of file qgslayoutitemnodeitem.cpp.

◆ computeDistance()

double QgsLayoutNodesItem::computeDistance ( QPointF  pt1,
QPointF  pt2 
) const
protected

Compute an euclidian distance between 2 nodes.

Definition at line 87 of file qgslayoutitemnodeitem.cpp.

◆ deselectNode()

void QgsLayoutNodesItem::deselectNode ( )
inline

Deselects any selected nodes.

Definition at line 108 of file qgslayoutitemnodeitem.h.

◆ draw()

void QgsLayoutNodesItem::draw ( QgsLayoutItemRenderContext context)
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 73 of file qgslayoutitemnodeitem.cpp.

◆ estimatedFrameBleed()

double QgsLayoutNodesItem::estimatedFrameBleed ( ) const
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.

See also
rectWithFrame()

Reimplemented from QgsLayoutItem.

Definition at line 38 of file qgslayoutitemnodeitem.cpp.

◆ moveNode()

bool QgsLayoutNodesItem::moveNode ( int  index,
QPointF  node 
)

Moves a node to a new position.

Parameters
indexthe index of the node to move
nodeis the new position in scene coordinate

Definition at line 253 of file qgslayoutitemnodeitem.cpp.

◆ nodeAtPosition()

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.

Parameters
pointis the location to search for nodes from (in scene coordinates)
searchInRadiusis a flag to indicate if the area of research is limited in space.
radiusis only used if searchInRadius is true

Definition at line 207 of file qgslayoutitemnodeitem.cpp.

◆ nodePosition()

bool QgsLayoutNodesItem::nodePosition ( int  index,
QPointF &  position 
) const

Gets the position of a node in scene coordinates.

Parameters
indexof the node
positionthe position of the node
Returns
true if the index is valid and the position is set, false otherwise

Definition at line 232 of file qgslayoutitemnodeitem.cpp.

◆ nodes()

QPolygonF QgsLayoutNodesItem::nodes ( ) const
inline

Returns the nodes the shape consists of.

See also
setNodes()

Definition at line 45 of file qgslayoutitemnodeitem.h.

◆ nodesSize()

int QgsLayoutNodesItem::nodesSize ( ) const
inline

Returns the number of nodes in the shape.

Definition at line 93 of file qgslayoutitemnodeitem.h.

◆ readPropertiesFromElement()

bool QgsLayoutNodesItem::readPropertiesFromElement ( const QDomElement &  element,
const QDomDocument &  document,
const QgsReadWriteContext context 
)
overrideprotectedvirtual

Sets item state from a DOM element.

Parameters
elementis the DOM element for the item
documentDOM document
contextread 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().

See also
writePropertiesToElement()
readXml()

Reimplemented from QgsLayoutItem.

Reimplemented in QgsLayoutItemPolyline.

Definition at line 269 of file qgslayoutitemnodeitem.cpp.

◆ removeNode()

bool QgsLayoutNodesItem::removeNode ( int  index)

Remove a node with specified index from the shape.

Definition at line 245 of file qgslayoutitemnodeitem.cpp.

◆ rescaleToFitBoundingBox()

void QgsLayoutNodesItem::rescaleToFitBoundingBox ( )
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 293 of file qgslayoutitemnodeitem.cpp.

◆ selectedNode()

int QgsLayoutNodesItem::selectedNode ( ) const
inline

Returns the currently selected node, or -1 if no node is selected.

Definition at line 103 of file qgslayoutitemnodeitem.h.

◆ setDisplayNodes()

void QgsLayoutNodesItem::setDisplayNodes ( bool  display = true)
inline

Set whether the item's nodes should be displayed.

Definition at line 60 of file qgslayoutitemnodeitem.h.

◆ setNodes()

void QgsLayoutNodesItem::setNodes ( const QPolygonF &  nodes)

Sets the nodes the shape consists of.

See also
nodes()

Definition at line 27 of file qgslayoutitemnodeitem.cpp.

◆ setSelectedNode()

bool QgsLayoutNodesItem::setSelectedNode ( int  index)

Selects a node by index.

Definition at line 310 of file qgslayoutitemnodeitem.cpp.

◆ updateBoundingRect

void QgsLayoutNodesItem::updateBoundingRect ( )
protectedvirtualslot

Called when the bounding rect of the item should recalculated.

Subclasses should update currentRectangle in their implementations.

Definition at line 336 of file qgslayoutitemnodeitem.cpp.

◆ updateSceneRect()

void QgsLayoutNodesItem::updateSceneRect ( )
protected

Update the current scene rectangle for this item.

Definition at line 323 of file qgslayoutitemnodeitem.cpp.

◆ writePropertiesToElement()

bool QgsLayoutNodesItem::writePropertiesToElement ( QDomElement &  element,
QDomDocument &  document,
const QgsReadWriteContext context 
) const
overrideprotectedvirtual

Stores item state within an XML DOM element.

Parameters
elementis the DOM element to store the item's properties in
documentDOM document
contextread write context
See also
writeXml()
readPropertiesFromElement()

Reimplemented from QgsLayoutItem.

Reimplemented in QgsLayoutItemPolyline.

Definition at line 347 of file qgslayoutitemnodeitem.cpp.

Member Data Documentation

◆ mCurrentRectangle

QRectF QgsLayoutNodesItem::mCurrentRectangle
protected

Current bounding rectangle of shape.

Definition at line 168 of file qgslayoutitemnodeitem.h.

◆ mMaxSymbolBleed

double QgsLayoutNodesItem::mMaxSymbolBleed = 0.0
protected

Max symbol bleed.

Definition at line 138 of file qgslayoutitemnodeitem.h.

◆ mPolygon

QPolygonF QgsLayoutNodesItem::mPolygon
protected

Shape's nodes.

Definition at line 135 of file qgslayoutitemnodeitem.h.


The documentation for this class was generated from the following files: