/
qgsmodelcomponentgraphicitem.h
564 lines (450 loc) · 16.8 KB
/
qgsmodelcomponentgraphicitem.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
/***************************************************************************
qgsmodelcomponentgraphicitem.h
----------------------------------
Date : March 2020
Copyright : (C) 2020 Nyall Dawson
Email : nyall dot dawson at gmail dot com
***************************************************************************
* *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation; either version 2 of the License, or *
* (at your option) any later version. *
* *
***************************************************************************/
#ifndef QGSMODELCOMPONENTGRAPHICITEM_H
#define QGSMODELCOMPONENTGRAPHICITEM_H
#include "qgis.h"
#include "qgis_gui.h"
#include <QGraphicsObject>
#include <QFont>
#include <QPicture>
#include <QPointer>
class QgsProcessingModelComponent;
class QgsProcessingModelParameter;
class QgsProcessingModelChildAlgorithm;
class QgsProcessingModelOutput;
class QgsProcessingModelComment;
class QgsProcessingModelAlgorithm;
class QgsModelDesignerFlatButtonGraphicItem;
class QgsModelDesignerFoldButtonGraphicItem;
class QgsModelGraphicsView;
class QgsModelViewMouseEvent;
///@cond NOT_STABLE
/**
* \ingroup gui
* \brief Base class for graphic items representing model components in the model designer.
* \warning Not stable API
* \since QGIS 3.14
*/
class GUI_EXPORT QgsModelComponentGraphicItem : public QGraphicsObject
{
Q_OBJECT
public:
//! Available item states
enum State
{
Normal, //!< Normal state
Selected, //!< Item is selected
Hover, //!< Cursor is hovering over an deselected item
};
//! Available flags
enum Flag
{
};
Q_DECLARE_FLAGS( Flags, Flag )
/**
* Constructor for QgsModelComponentGraphicItem for the specified \a component, with the specified \a parent item.
*
* The \a model argument specifies the associated processing model. Ownership of \a model is not transferred, and
* it must exist for the lifetime of this object.
*
* Ownership of \a component is transferred to the item.
*/
QgsModelComponentGraphicItem( QgsProcessingModelComponent *component SIP_TRANSFER,
QgsProcessingModelAlgorithm *model,
QGraphicsItem *parent SIP_TRANSFERTHIS );
~QgsModelComponentGraphicItem() override;
/**
* Returns item flags.
*/
virtual Flags flags() const;
/**
* Returns the model component associated with this item.
*/
QgsProcessingModelComponent *component();
/**
* Returns the model component associated with this item.
*/
const QgsProcessingModelComponent *component() const SIP_SKIP;
/**
* Returns the model associated with this item.
*/
QgsProcessingModelAlgorithm *model();
/**
* Returns the associated view.
*/
QgsModelGraphicsView *view();
/**
* Returns the font used to render text in the item.
* \see setFont()
*/
QFont font() const;
/**
* Sets the \a font used to render text in the item.
* \see font()
*/
void setFont( const QFont &font );
/**
* Moves the component by the specified \a dx and \a dy.
*
* \warning Call this method, not QGraphicsItem::moveBy!
*/
void moveComponentBy( qreal dx, qreal dy );
/**
* Shows a preview of moving the item from its stored position by \a dx, \a dy.
*/
void previewItemMove( qreal dx, qreal dy );
/**
* Sets a new scene \a rect for the item.
*/
void setItemRect( QRectF rect );
/**
* Shows a preview of setting a new \a rect for the item.
*/
void previewItemRectChange( QRectF rect );
#ifndef SIP_RUN
/**
* Handles a model hover enter \a event.
*/
virtual void modelHoverEnterEvent( QgsModelViewMouseEvent *event );
/**
* Handles a model hover move \a event.
*/
virtual void modelHoverMoveEvent( QgsModelViewMouseEvent *event );
/**
* Handles a model hover leave \a event.
*/
virtual void modelHoverLeaveEvent( QgsModelViewMouseEvent *event );
/**
* Handles a model double click \a event.
*/
virtual void modelDoubleClickEvent( QgsModelViewMouseEvent *event );
#endif
void mouseDoubleClickEvent( QGraphicsSceneMouseEvent *event ) override;
void hoverEnterEvent( QGraphicsSceneHoverEvent *event ) override;
void hoverMoveEvent( QGraphicsSceneHoverEvent *event ) override;
void hoverLeaveEvent( QGraphicsSceneHoverEvent *event ) override;
QVariant itemChange( GraphicsItemChange change, const QVariant &value ) override;
QRectF boundingRect() const override;
void paint( QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget = nullptr ) override;
/**
* Returns the rectangle representing the body of the item.
*/
QRectF itemRect( bool storedRect = false ) const;
/**
* Returns the item's label text.
*
* \see setLabel()
*/
QString label() const;
/**
* Returns the item's \a label text.
*
* \see label()
*/
void setLabel( const QString &label );
/**
* Returns the item's current state.
*/
State state() const;
/**
* Returns the number of link points associated with the component on the specified \a edge.
*/
virtual int linkPointCount( Qt::Edge edge ) const;
/**
* Returns the text to use for the link point with the specified \a index on the specified \a edge.
*/
virtual QString linkPointText( Qt::Edge edge, int index ) const;
/**
* Returns the location of the link point with the specified \a index on the specified \a edge.
*/
QPointF linkPoint( Qt::Edge edge, int index ) const;
/**
* Returns the best link point to use for a link originating at a specified \a other item.
*
* \param other item at other end of link
* \param edge item edge for calculated best link point
* \returns calculated link point in item coordinates.
*/
QPointF calculateAutomaticLinkPoint( QgsModelComponentGraphicItem *other, Qt::Edge &edge SIP_OUT ) const;
/**
* Returns the best link point to use for a link originating at a specified \a other point.
*
* \param other point for other end of link (in scene coordinates)
* \param edge item edge for calculated best link point
* \returns calculated link point in item coordinates.
*/
QPointF calculateAutomaticLinkPoint( const QPointF &point, Qt::Edge &edge SIP_OUT ) const;
/**
* Called when the comment attached to the item should be edited.
*
* The default implementation does nothing.
*/
virtual void editComment() {}
/**
* Returns TRUE if the component can be deleted.
*/
virtual bool canDeleteComponent() { return false; }
/**
* Called when the component should be deleted.
*
* The default implementation does nothing.
*/
virtual void deleteComponent() {}
signals:
// TODO - rework this, should be triggered externally when the model actually changes!
/**
* Emitted by the item to request a repaint of the parent model scene.
*/
void requestModelRepaint();
/**
* Emitted when the definition of the associated component is about to be changed
* by the item.
*
* The \a text argument gives the translated text describing the change about to occur, and the
* optional \a id can be used to group the associated undo commands.
*/
void aboutToChange( const QString &text, int id = 0 );
/**
* Emitted when the definition of the associated component is changed
* by the item.
*/
void changed();
/**
* Emitted when item requests that all connected arrows are repainted.
*/
void repaintArrows();
/**
* Emitted when item requires that all connected arrow paths are recalculated.
*/
void updateArrowPaths();
/**
* Emitted when the item's size or position changes.
*/
void sizePositionChanged();
protected slots:
/**
* Called when the component should be edited.
*
* The default implementation does nothing.
*/
virtual void editComponent() {}
protected:
/**
* Truncates a \a text string so that it fits nicely within the item's width,
* accounting for margins and interactive buttons.
*/
QString truncatedTextForItem( const QString &text ) const;
/**
* Returns the fill color for the item for the specified \a state.
*/
virtual QColor fillColor( State state ) const = 0;
/**
* Returns the stroke color for the item for the specified \a state.
*/
virtual QColor strokeColor( State state ) const = 0;
/**
* Returns the label text color for the item for the specified \a state.
*/
virtual QColor textColor( State state ) const = 0;
/**
* Returns the stroke style to use while rendering the outline of the item.
*/
virtual Qt::PenStyle strokeStyle( State state ) const;
/**
* Returns a QPicture version of the item's icon, if available.
*/
virtual QPicture iconPicture() const;
/**
* Returns a QPixmap version of the item's icon, if available.
*/
virtual QPixmap iconPixmap() const;
/**
* Updates the position and size stored in the model for the associated comment
*/
virtual void updateStoredComponentPosition( const QPointF &pos, const QSizeF &size ) = 0;
/**
* Updates the item's button positions, based on the current item rect.
*/
void updateButtonPositions();
private:
QSizeF itemSize() const;
void updateToolTip( const QPointF &pos );
void fold( Qt::Edge edge, bool folded );
std::unique_ptr< QgsProcessingModelComponent > mComponent;
QgsProcessingModelAlgorithm *mModel = nullptr;
bool mInitialized = false;
QgsModelDesignerFoldButtonGraphicItem *mExpandTopButton = nullptr;
QgsModelDesignerFoldButtonGraphicItem *mExpandBottomButton = nullptr;
QString mLabel;
QgsModelDesignerFlatButtonGraphicItem *mEditButton = nullptr;
QgsModelDesignerFlatButtonGraphicItem *mDeleteButton = nullptr;
static constexpr double DEFAULT_BUTTON_WIDTH = 16;
static constexpr double DEFAULT_BUTTON_HEIGHT = 16;
QSizeF mButtonSize { DEFAULT_BUTTON_WIDTH, DEFAULT_BUTTON_HEIGHT };
QFont mFont;
bool mIsHovering = false;
bool mIsMoving = false;
QSizeF mTempSize;
};
Q_DECLARE_OPERATORS_FOR_FLAGS( QgsModelComponentGraphicItem::Flags )
/**
* \ingroup gui
* \brief A graphic item representing a model parameter (input) in the model designer.
* \warning Not stable API
* \since QGIS 3.14
*/
class GUI_EXPORT QgsModelParameterGraphicItem : public QgsModelComponentGraphicItem
{
Q_OBJECT
public:
/**
* Constructor for QgsModelParameterGraphicItem for the specified \a parameter, with the specified \a parent item.
*
* The \a model argument specifies the associated processing model. Ownership of \a model is not transferred, and
* it must exist for the lifetime of this object.
*
* Ownership of \a parameter is transferred to the item.
*/
QgsModelParameterGraphicItem( QgsProcessingModelParameter *parameter SIP_TRANSFER,
QgsProcessingModelAlgorithm *model,
QGraphicsItem *parent SIP_TRANSFERTHIS );
void contextMenuEvent( QGraphicsSceneContextMenuEvent *event ) override;
bool canDeleteComponent() override;
protected:
QColor fillColor( State state ) const override;
QColor strokeColor( State state ) const override;
QColor textColor( State state ) const override;
QPicture iconPicture() const override;
void updateStoredComponentPosition( const QPointF &pos, const QSizeF &size ) override;
protected slots:
void deleteComponent() override;
private:
QPicture mPicture;
};
/**
* \ingroup gui
* \brief A graphic item representing a child algorithm in the model designer.
* \warning Not stable API
* \since QGIS 3.14
*/
class GUI_EXPORT QgsModelChildAlgorithmGraphicItem : public QgsModelComponentGraphicItem
{
Q_OBJECT
public:
/**
* Constructor for QgsModelChildAlgorithmGraphicItem for the specified \a child, with the specified \a parent item.
*
* The \a model argument specifies the associated processing model. Ownership of \a model is not transferred, and
* it must exist for the lifetime of this object.
*
* Ownership of \a child is transferred to the item.
*/
QgsModelChildAlgorithmGraphicItem( QgsProcessingModelChildAlgorithm *child SIP_TRANSFER,
QgsProcessingModelAlgorithm *model,
QGraphicsItem *parent SIP_TRANSFERTHIS );
void contextMenuEvent( QGraphicsSceneContextMenuEvent *event ) override;
bool canDeleteComponent() override;
protected:
QColor fillColor( State state ) const override;
QColor strokeColor( State state ) const override;
QColor textColor( State state ) const override;
QPixmap iconPixmap() const override;
QPicture iconPicture() const override;
int linkPointCount( Qt::Edge edge ) const override;
QString linkPointText( Qt::Edge edge, int index ) const override;
void updateStoredComponentPosition( const QPointF &pos, const QSizeF &size ) override;
protected slots:
void deleteComponent() override;
private slots:
void deactivateAlgorithm();
void activateAlgorithm();
private:
QPicture mPicture;
QPixmap mPixmap;
};
/**
* \ingroup gui
* \brief A graphic item representing a model output in the model designer.
* \warning Not stable API
* \since QGIS 3.14
*/
class GUI_EXPORT QgsModelOutputGraphicItem : public QgsModelComponentGraphicItem
{
Q_OBJECT
public:
/**
* Constructor for QgsModelOutputGraphicItem for the specified \a output, with the specified \a parent item.
*
* The \a model argument specifies the associated processing model. Ownership of \a model is not transferred, and
* it must exist for the lifetime of this object.
*
* Ownership of \a output is transferred to the item.
*/
QgsModelOutputGraphicItem( QgsProcessingModelOutput *output SIP_TRANSFER,
QgsProcessingModelAlgorithm *model,
QGraphicsItem *parent SIP_TRANSFERTHIS );
bool canDeleteComponent() override;
protected:
QColor fillColor( State state ) const override;
QColor strokeColor( State state ) const override;
QColor textColor( State state ) const override;
QPicture iconPicture() const override;
void updateStoredComponentPosition( const QPointF &pos, const QSizeF &size ) override;
protected slots:
void deleteComponent() override;
private:
QPicture mPicture;
};
/**
* \ingroup gui
* \brief A graphic item representing a model comment in the model designer.
* \warning Not stable API
* \since QGIS 3.14
*/
class GUI_EXPORT QgsModelCommentGraphicItem : public QgsModelComponentGraphicItem
{
Q_OBJECT
public:
/**
* Constructor for QgsModelCommentGraphicItem for the specified \a comment, with the specified \a parent item.
*
* The \a model argument specifies the associated processing model. Ownership of \a model is not transferred, and
* it must exist for the lifetime of this object.
*
* Ownership of \a output is transferred to the item.
*/
QgsModelCommentGraphicItem( QgsProcessingModelComment *comment SIP_TRANSFER,
QgsModelComponentGraphicItem *parentItem,
QgsProcessingModelAlgorithm *model,
QGraphicsItem *parent SIP_TRANSFERTHIS );
~QgsModelCommentGraphicItem() override;
void contextMenuEvent( QGraphicsSceneContextMenuEvent *event ) override;
bool canDeleteComponent() override;
protected:
QColor fillColor( State state ) const override;
QColor strokeColor( State state ) const override;
QColor textColor( State state ) const override;
Qt::PenStyle strokeStyle( State state ) const override;
void updateStoredComponentPosition( const QPointF &pos, const QSizeF &size ) override;
protected slots:
void deleteComponent() override;
void editComponent() override;
private:
QgsProcessingModelComment *modelComponent();
std::unique_ptr< QgsProcessingModelComponent > mParentComponent;
QPointer< QgsModelComponentGraphicItem > mParentItem;
};
///@endcond
#endif // QGSMODELCOMPONENTGRAPHICITEM_H