Description
A red outline around nodes and cables involved in a composition build error.
Definition at line 20 of file VuoErrorMark.hh.
Public Member Functions | |
| VuoErrorMark () | |
| Creates (but does not yet show) the error mark. More... | |
| void | addMarkedComponents (set< VuoRendererNode * > nodes, set< VuoRendererCable * > cables) |
| Adds the provided nodes and cables to the set of components to be encompassed in the error mark. More... | |
| QRectF | boundingRect (void) const |
| Returns a bounding rect that encompasses all nodes and cables marked. More... | |
| void | paint (QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget) |
| Paints a red outline around the nodes and cables. More... | |
| void | removeFromScene () |
| Removes the error mark from the canvas and performs other necessary cleanup. More... | |
| void | updateErrorMarkPath () |
| Calculates and updates the cached painter path of the error mark based on its current set of included nodes and cables. More... | |
 Public Member Functions inherited from VuoRendererItem | |
| void | setSelectable (bool selectable) |
| Enables or disables selection for the item. More... | |
Additional Inherited Members | |
| Public Types inherited from VuoRendererItem | |
| enum | activityState { notTrackingActivity = -1 , activityInProgress = 0 } |
| Special composition component activity states. More... | |
| enum | zValues { triggerAnimationZValue = 1 , nodeZValue = 0 , portZValue = -1 , attachmentZValue = -2 , cableZValue = -3 , errorMarkZValue = -4 , commentZValue = -5 } |
| Stacking order for canvas elements. More... | |
| Static Public Member Functions inherited from VuoRendererItem | |
| static void | setSnapToGrid (bool snap) |
| Specifies whether graphics items should be snapped to a grid. More... | |
| static void | setDrawBoundingRects (bool drawBoundingRects) |
| Specifies whether bounding rects will be shown the next time the QGraphicsScene is rendered. More... | |
| static bool | shouldDrawBoundingRects (void) |
| Returns whether bounding rects are currently being shown. More... | |
| static void | drawRect (QPainter *painter, QRectF rect) |
| Draws a rect, for debugging. More... | |
| static bool | getSnapToGrid () |
| Retrieves the boolean indicating whether graphics items should be snapped to a grid. More... | |
| Protected Member Functions inherited from VuoRendererItem | |
| void | drawBoundingRect (QPainter *painter) |
| Draws this item's bounding rect, for debugging. More... | |
| bool | getRenderActivity () const |
| Retrieves the composition-wide boolean indicating whether recent activity (e.g., a node execution or event firing) by this item should be reflected in its rendering. More... | |
| bool | getRenderHiddenCables () const |
| Retrieves the composition-wide boolean indicating whether hidden ("wireless") cables should be rendered as if they were not hidden. More... | |
| QGraphicsItem::CacheMode | getCurrentDefaultCacheMode () const |
| Returns the current default cache mode for components of this composition. More... | |
| Static Protected Member Functions inherited from VuoRendererItem | |
| static void | addRoundedCorner (QPainterPath &path, bool drawLine, QPointF sharpCornerPoint, qreal radius, bool isTop, bool isLeft) |
Appends a line (or move) and curve to path, to produce a clockwise-wound rounded corner near sharpCornerPoint. More... | |
Constructor & Destructor Documentation
◆ VuoErrorMark()
| VuoErrorMark::VuoErrorMark | ( | ) |
Creates (but does not yet show) the error mark.
Definition at line 18 of file VuoErrorMark.cc.
Member Function Documentation
◆ addMarkedComponents()
| void VuoErrorMark::addMarkedComponents | ( | set< VuoRendererNode * > | nodes, |
| set< VuoRendererCable * > | cables | ||
| ) |
Adds the provided nodes and cables to the set of components to be encompassed in the error mark.
Definition at line 27 of file VuoErrorMark.cc.
◆ boundingRect()
| QRectF VuoErrorMark::boundingRect | ( | void | ) | const |
Returns a bounding rect that encompasses all nodes and cables marked.
Definition at line 41 of file VuoErrorMark.cc.
◆ paint()
| void VuoErrorMark::paint | ( | QPainter * | painter, |
| const QStyleOptionGraphicsItem * | option, | ||
| QWidget * | widget | ||
| ) |
Paints a red outline around the nodes and cables.
Assumes this VuoErrorMark will be added to the QGraphicsScene at a z level behind the nodes and cables.
Definition at line 57 of file VuoErrorMark.cc.
◆ removeFromScene()
| void VuoErrorMark::removeFromScene | ( | ) |
Removes the error mark from the canvas and performs other necessary cleanup.
Definition at line 75 of file VuoErrorMark.cc.
◆ updateErrorMarkPath()
| void VuoErrorMark::updateErrorMarkPath | ( | void | ) |
Calculates and updates the cached painter path of the error mark based on its current set of included nodes and cables.
Definition at line 89 of file VuoErrorMark.cc.
The documentation for this class was generated from the following files:
- editor/VuoErrorMark.hh
- editor/VuoErrorMark.cc
