Vuo  0.8.0
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | Static Protected Member Functions | List of all members
VuoRendererInputAttachment Class Reference

Description

Represents a node that is rendered as an attachment to another node's input port.

Public Member Functions

 VuoRendererInputAttachment (VuoNode *baseNode, VuoRendererSignaler *signaler)
 Creates a node that is rendered as an attachment to another node's input port.
 
VuoPortgetUnderlyingHostPort ()
 Returns the input port to which this item is attached in the underlying composition.
 
VuoNodegetUnderlyingHostNode ()
 Returns the node to which this item is attached in the underlying composition.
 
virtual VuoPortgetRenderedHostPort ()
 Returns the input port to which this item is visually attached in the rendered composition.
 
virtual VuoNodegetRenderedHostNode ()
 Returns the node to which this item is visually attached in the composition rendering.
 
virtual set< VuoNode * > getCoattachments (void)
 Returns the set of co-attachments expected to co-exist with this attachment.
 
- Public Member Functions inherited from VuoRendererNode
 VuoRendererNode (VuoNode *baseNode, VuoRendererSignaler *signaler)
 Creates a renderer detail for the specified base node.
 
virtual QRectF boundingRect (void) const
 Returns a rectangle that completely encloses the rendered node (accounting for the thick line width).
 
virtual void paint (QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget)
 Draws a standard node, including rectangular frame, and input and output ports.
 
virtual QRectF getOuterNodeFrameBoundingRect (void) const
 Returns the bounding rect for the node's outer frame (excluding ports).
 
virtual bool paintingDisabled (void) const
 Returns a boolean indicating whether painting is currently disabled for this node.
 
vector< VuoRendererInputDrawer * > getAttachedInputDrawers (void) const
 Returns a vector containing all of the drawers attached to any of this node's input ports.
 
qreal getInputDrawerOffset (unsigned int portIndex) const
 Returns the horizontal offset necessary to prevent the drawer at portIndex from overlapping any drawers beneath it.
 
void updateNodeFrameRect (void)
 Calculates and updates the cached inner frame of a node based on its current attributes.
 
void setMissingImplementation (bool missingImplementation)
 Sets whether the node is rendered as though its implementation is missing.
 
void setProxyNode (VuoRendererNode *proxyNode)
 If set, this node will not be drawn; its drawing will be handled by proxyNode.
 
VuoRendererNodegetProxyNode (void) const
 Returns this node's rendering proxy.
 
VuoRendererTypecastPortgetProxyCollapsedTypecast (void) const
 Returns the collapsed typecast port rendered in place of this node, or NULL if none.
 
QVariant itemChange (GraphicsItemChange change, const QVariant &value)
 Updates the node and its connected cables to reflect changes in state.
 
void updateGeometry (void)
 Schedules a redraw of this node.
 
void updateConnectedCableGeometry (void)
 Schedules a redraw of this node's connected cables.
 
set< VuoCable * > getConnectedCables (bool includePublishedCables)
 Returns the set of cables connected to this node.
 
set< VuoCable * > getConnectedInputCables (bool includePublishedCables)
 Returns the set of input cables connected to this node.
 
set< VuoCable * > getConnectedOutputCables (bool includePublishedCables)
 Returns the set of output cables connected to this node.
 
VuoRendererPortListgetInputPorts (void)
 Returns this node's input ports, as a VuoRendererPortList.
 
VuoRendererPortListgetOutputPorts (void)
 Returns this node's output ports, as a VuoRendererPortList.
 
vector< pair< QString,
json_object * > > 
getConstantPortValues ()
 Returns an ordered list of port name-value pairs for the ports that belong to this node and whose values are currently constant.
 
void replaceInputPort (VuoRendererPort *oldPort, VuoRendererPort *newPort)
 Replaces input port old with new.
 
void addInputPort (VuoRendererPort *newPort)
 Adds input port port to the node.
 
bool hasGenericPort (void)
 Returns a boolean indicating whether this node has any ports with generic data types.
 
void setTitle (string title)
 Sets the title for this node; re-lays-out its ports to accommodate the new name.
 
void resetTimeLastExecuted ()
 Resets the time last executed to a value that causes the node to be painted as if activity-rendering were disabled.
 
void setExecutionEnded ()
 Updates the node's execution state to indicate that it has just finished executing.
 
void setExecutionBegun ()
 Updates the node's execution state to indicate that it is currently executing.
 
qint64 getTimeLastExecutionEnded ()
 Returns the time, in ms since epoch, that this node's most recent node execution ended, or if applicable, a special VuoRendererItem::activityState.
 
void layoutConnectedInputDrawers (void)
 Calculates and sets the positions of the node's connected input drawers relative to the node.
 
void layoutConnectedInputDrawersAtAndAbovePort (VuoRendererPort *port)
 Calculates and sets the positions of any input drawers connected to this node's ports beginning with the provided port and iterating through the ports rendered above (i.e., with indices lower than) that port.
 
void setCacheModeForNodeAndPorts (QGraphicsItem::CacheMode mode)
 Sets the cache mode of this node and its child ports to mode.
 
void setCacheModeForConnectedCables (QGraphicsItem::CacheMode mode)
 Sets the cache mode of this node's connected cables to mode.
 
- Public Member Functions inherited from VuoBaseDetail< VuoNode >
 VuoBaseDetail (string description, VuoNode *base)
 Creates a VuoNode detail class.
 
VuoNodegetBase (void) const
 Returns the VuoNode detail class instance's base class instance.
 
void setBase (VuoNode *base)
 Sets the VuoNode detail class instance's base class instance.
 

Static Protected Member Functions

static VuoPortgetUnderlyingHostPortForNode (VuoNode *node)
 Returns the input port to which the provided node is attached in the underlying composition.
 
static VuoNodegetUnderlyingHostNodeForNode (VuoNode *node)
 Returns the node to which the provided node is attached in the underlying composition.
 
static VuoNodegetListNodeConnectedToInputPort (VuoPort *port)
 Returns the collapsed list node attached to the provided input port, or NULL if none.
 

Additional Inherited Members

- Public Types inherited from VuoRendererNode
enum  Type { node, detachedConstant, detachedDrawer, detachedTypecast }
 Specifies how this node is graphically represented. More...
 
- Static Public Member Functions inherited from VuoRendererNode
static QPair< QPainterPath,
QPainterPath > 
getNodeFrames (QRectF nodeInnerFrameRect, QPainterPath portsPath, QPainterPath portsInsetPath, QPainterPath statefulIndicatorOutline, bool isSubcomposition)
 Returns the outer and inner node frames, in that order, for a node with the provided nodeInnerFrameRect, portsPath, portsInsetPath, statefulIndicatorOutline, and isSubcomposition attribute values.
 
static QVector< QPainterPath > getStatefulIndicatorOutlines (QRectF nodeInnerFrameRect, bool isStateful)
 Returns the (cableOutline, highlightOutline, cableOutline.subtracted(highlightOutline)) paths, in that order, required to paint a stateful indicator for a node with the provided nodeInnerFrameRect, or empty paths if isStateful is false.
 
static QPainterPath getAntennaPath (QRectF nodeInnerFrameRect, bool isInterface)
 Returns the path of the "Antenna" icon for a node with the provided nodeInnerFrameRect, or an empty path if isInterface is false.
 
static QPair< QPainterPath,
QPainterPath > 
getPortPaths (VuoRendererPortList *inputPorts, VuoRendererPortList *outputPorts)
 Returns the port path and portInset path, in that order, for a node with the provided inputPorts and outputPorts lists.
 
static QString generateNodeClassToolTipTitle (VuoNodeClass *nodeClass, VuoNode *node)
 Generates a formatted title to be incorporated into the tooltip for the input nodeClass.
 
static QString generateNodeClassToolTipTextBody (VuoNodeClass *nodeClass)
 Generates a formatted description to be incorporated into the tooltip for the input nodeClass.
 
- Static Public Attributes inherited from VuoRendererNode
static const qreal nodeTitleHeight = round(VuoRendererFonts::nodeTitleFontSize + VuoRendererFonts::thickPenWidth*1./8.)
 The height of the node's title.
 
static const qreal cornerRadius = VuoRendererFonts::thickPenWidth/8.0
 The radius of rounded corners.
 
- Protected Member Functions inherited from VuoRendererNode
virtual void hoverEnterEvent (QGraphicsSceneHoverEvent *event)
 Handle mouse hover start events.
 
virtual void hoverMoveEvent (QGraphicsSceneHoverEvent *event)
 Handle mouse hover move events.
 
virtual void hoverLeaveEvent (QGraphicsSceneHoverEvent *event)
 Handle mouse hover leave events.
 
void mouseReleaseEvent (QGraphicsSceneMouseEvent *event)
 Handle mouse release events.
 
void mouseDoubleClickEvent (QGraphicsSceneMouseEvent *event)
 Handle mouse double-click events.
 
void keyPressEvent (QKeyEvent *event)
 Handle key-press events.
 
virtual void layoutPorts (void)
 Calculates and sets the positions of the node's child ports relative to the node.
 
- Protected Attributes inherited from VuoRendererNode
VuoRendererSignalersignaler
 The object that sends signals on behalf of this renderer node.
 
VuoRendererPortListinputPorts
 The list of input renderer ports belonging to this renderer node.
 
VuoRendererPortListoutputPorts
 The list of output renderer ports belonging to this renderer node.
 
qint64 timeLastExecutionEnded
 The time at which this node's running counterpart last completed an execution.
 

Constructor & Destructor Documentation

VuoRendererInputAttachment::VuoRendererInputAttachment ( VuoNode baseNode,
VuoRendererSignaler signaler 
)

Creates a node that is rendered as an attachment to another node's input port.

Member Function Documentation

set< VuoNode * > VuoRendererInputAttachment::getCoattachments ( void  )
virtual

Returns the set of co-attachments expected to co-exist with this attachment.

Reimplemented in VuoRendererValueListForReadOnlyDictionary, VuoRendererReadOnlyDictionary, and VuoRendererKeyListForReadOnlyDictionary.

VuoNode * VuoRendererInputAttachment::getListNodeConnectedToInputPort ( VuoPort port)
staticprotected

Returns the collapsed list node attached to the provided input port, or NULL if none.

VuoNode * VuoRendererInputAttachment::getRenderedHostNode ( )
virtual

Returns the node to which this item is visually attached in the composition rendering.

Reimplemented in VuoRendererValueListForReadOnlyDictionary, and VuoRendererKeyListForReadOnlyDictionary.

VuoPort * VuoRendererInputAttachment::getRenderedHostPort ( )
virtual

Returns the input port to which this item is visually attached in the rendered composition.

Reimplemented in VuoRendererValueListForReadOnlyDictionary, and VuoRendererKeyListForReadOnlyDictionary.

VuoNode * VuoRendererInputAttachment::getUnderlyingHostNode ( )

Returns the node to which this item is attached in the underlying composition.

VuoNode * VuoRendererInputAttachment::getUnderlyingHostNodeForNode ( VuoNode node)
staticprotected

Returns the node to which the provided node is attached in the underlying composition.

VuoPort * VuoRendererInputAttachment::getUnderlyingHostPort ( )

Returns the input port to which this item is attached in the underlying composition.

VuoPort * VuoRendererInputAttachment::getUnderlyingHostPortForNode ( VuoNode node)
staticprotected

Returns the input port to which the provided node is attached in the underlying composition.


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