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

Description

Represents the compact drawer form of a "Make List" node.

Public Member Functions

 VuoRendererInputDrawer (VuoNode *baseNode, VuoRendererSignaler *signaler)
 Creates a collapsed "Make List" node that takes the form of an input drawer.
 
qreal getMaxDrawerLabelWidth (void) const
 Returns the maximum width in pixels of the port labels within this drawer.
 
qreal getMaxDrawerChainedLabelWidth (void) const
 Returns the maximum width in pixels of the port labels within this drawer, also accounting for the width of the child port as well as any constant flags or collapsed typecasts attached to the child port.
 
vector< VuoRendererPort * > getDrawerPorts (void) const
 Returns the vector of the input ports whose values will be incorporated into the output list.
 
void setHorizontalDrawerOffset (qreal offset)
 Sets the distance, in pixels, left of its attached port that the rightmost point of this drawer should be rendered.
 
- Public Member Functions inherited from VuoRendererInputAttachment
 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.
 
void setAlwaysDisplayPortNames (bool displayPortNames)
 Sets the boolean indicating whether this node's ports, including unambiguous ones, should always have their names displayed.
 
bool nameDisplayEnabledForPort (const VuoRendererPort *port)
 Returns a boolean indicating whether the name of the provided port should be rendered within the node.
 
bool nameDisplayEnabledForInputPorts ()
 Returns a boolean indicating whether the names of input ports should be rendered within the node.
 
bool nameDisplayEnabledForOutputPorts ()
 Returns a boolean indicating whether the names of output ports should be rendered within the node.
 
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 Public Attributes

static const qreal drawerInteriorHorizontalPadding = VuoRendererFonts::thickPenWidth*3./4.+5
 The amount of horizontal padding, in pixels, added to each drawer beyond what its text strictly requires.
 
static const qreal drawerHorizontalSpacing = VuoRendererFonts::thickPenWidth*1./4.
 The amount of space, in pixels, left as horizontal padding between underhangs of drawers attached to ports of the same node.
 

Protected Member Functions

void layoutPorts (void)
 Calculates and sets the positions of the node's child ports relative to the node.
 

Protected Attributes

vector< VuoRendererPort * > drawerPorts
 The vector of input ports whose values will be incorporated into the output list.
 
qreal horizontalDrawerOffset
 The distance, in pixels, left of its attached port that the rightmost point of this drawer should be rendered.
 
qreal drawerBottomExtensionHeight
 The height, in pixels, of the input drawer (excluding the arm and drag handle).
 

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)
 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 QPainterPath getStatefulIndicatorOutline (QRectF nodeInnerFrameRect, bool isStateful)
 Returns the (cableOutline, 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, bool isSubcomposition)
 Returns the path of the "Antenna" icon for a node with the provided nodeInnerFrameRect, or an empty path if isInterface is false.
 
static QPainterPath getSubcompositionIndicatorPath (QRectF nodeInnerFrameRect, bool isSubcomposition)
 Returns the path of the subcomposition icon for a node with the provided nodeInnerFrameRect, or an empty path if isSubcomposition 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, string smallTextColor)
 Generates a formatted description to be incorporated into the tooltip for the input nodeClass.
 
- Static Protected Member Functions inherited from VuoRendererInputAttachment
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.
 

Constructor & Destructor Documentation

VuoRendererInputDrawer::VuoRendererInputDrawer ( VuoNode baseNode,
VuoRendererSignaler signaler 
)

Creates a collapsed "Make List" node that takes the form of an input drawer.

Member Function Documentation

vector< VuoRendererPort * > VuoRendererInputDrawer::getDrawerPorts ( void  ) const

Returns the vector of the input ports whose values will be incorporated into the output list.

qreal VuoRendererInputDrawer::getMaxDrawerChainedLabelWidth ( void  ) const

Returns the maximum width in pixels of the port labels within this drawer, also accounting for the width of the child port as well as any constant flags or collapsed typecasts attached to the child port.

qreal VuoRendererInputDrawer::getMaxDrawerLabelWidth ( void  ) const

Returns the maximum width in pixels of the port labels within this drawer.

void VuoRendererInputDrawer::layoutPorts ( void  )
protectedvirtual

Calculates and sets the positions of the node's child ports relative to the node.

Reimplemented from VuoRendererNode.

void VuoRendererInputDrawer::setHorizontalDrawerOffset ( qreal  offset)

Sets the distance, in pixels, left of its attached port that the rightmost point of this drawer should be rendered.

Member Data Documentation

qreal VuoRendererInputDrawer::drawerBottomExtensionHeight
protected

The height, in pixels, of the input drawer (excluding the arm and drag handle).

const qreal VuoRendererInputDrawer::drawerHorizontalSpacing = VuoRendererFonts::thickPenWidth*1./4.
static

The amount of space, in pixels, left as horizontal padding between underhangs of drawers attached to ports of the same node.

const qreal VuoRendererInputDrawer::drawerInteriorHorizontalPadding = VuoRendererFonts::thickPenWidth*3./4.+5
static

The amount of horizontal padding, in pixels, added to each drawer beyond what its text strictly requires.

vector<VuoRendererPort *> VuoRendererInputDrawer::drawerPorts
protected

The vector of input ports whose values will be incorporated into the output list.

qreal VuoRendererInputDrawer::horizontalDrawerOffset
protected

The distance, in pixels, left of its attached port that the rightmost point of this drawer should be rendered.


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