Vuo  0.4.6
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | List of all members
VuoRendererTypecastPort Class Reference

Description

Renders a typecast port.

Public Member Functions

 VuoRendererTypecastPort (VuoRendererNode *uncollapsedTypecastNode, VuoPort *basePort, VuoRendererSignaler *signaler, bool isRefreshPort, QString sourceType, QString destinationType, VuoRendererPort *childPort)
 Creates a typecast port.
 
QRectF boundingRect (void) const
 Returns a rectangle containing the rendered typecast port.
 
void paint (QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget)
 Displays the typecast port.
 
VuoRendererNodegetUncollapsedTypecastNode (void) const
 Returns the uncollapsed typecast node from which this typecast port was derived.
 
VuoRendererPortgetChildPort (void) const
 Returns the port of the left side of the collapsed typecast port (the original typecast node's input port).
 
VuoRendererPortgetReplacedPort (void) const
 Returns the target port that was replaced by this collapsed typecast.
 
void setReplacedPort (VuoRendererPort *port)
 Sets target port that was replaced by this collapsed typecast.
 
qreal getChildPortXOffset (void) const
 Returns the number of pixels between the center of basePort and childPort.
 
QPainterPath getPortPath (bool includeNormalPort, bool includeFlag, QPainterPath *outsetPath) const
 Returns a closed path representing the collapsed typecast port's frame.
 
- Public Member Functions inherited from VuoRendererPort
 VuoRendererPort (VuoPort *basePort, VuoRendererSignaler *signaler, bool isOutput, bool isRefreshPort, bool isDonePort, bool isFunctionPort)
 Creates a renderer detail for the specified base port.
 
QRectF boundingRect (void) const
 Returns the bounding rectangle of this port (and its optional name and plug).
 
QPainterPath shape (void) const
 Returns the shape of the rendered port, for use in collision detection, hit tests, and QGraphicsScene::items() functions.
 
void paint (QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget)
 Draws an input or output port (both standard ports and refresh/done/function ports).
 
VuoRendererPublishedPortgetProxyPublishedSidebarPort (void) const
 Returns this port's published port sidebar renderering proxy, or NULL if it has none.
 
void setProxyPublishedSidebarPort (VuoRendererPublishedPort *proxyPort)
 If set, this port will not be drawn; its drawing will be handled by proxySidebarPort.
 
bool getEligibleForSelection ()
 Returns a boolean indicating whether this port has been deemed eligible for selection based on its proximity to the cursor.
 
void setEligibleForConnection (bool eligible)
 Sets the boolean indicating whether this port is eligible for connection to the cable currently being dragged between ports.
 
void extendedHoverEnterEvent (bool cableDragUnderway=false)
 Handle mouse hover start events generated by custom code making use of an extended hover range.
 
void extendedHoverMoveEvent (bool cableDragUnderway=false)
 Handle mouse hover move events generated by custom code making use of an extended hover range.
 
void extendedHoverLeaveEvent ()
 Handle mouse hover leave events generated by custom code making use of an extended hover range.
 
bool canConnectDirectlyTo (VuoRendererPort *toPort)
 Returns a boolean indicating whether there may be a cable attached directly from this port to toPort, taking into account the respective port types (input vs.
 
bool isConnectedTo (VuoRendererPort *toPort)
 Returns a boolean indicating whether there is a cable connecting this port to toPort.
 
bool getInput (void) const
 Returns a boolean indicating whether this port is an input port.
 
bool getOutput (void) const
 Returns a boolean indicating whether this port is an output port.
 
bool getRefreshPort (void) const
 Returns true if this port is a refresh port.
 
bool getDonePort (void) const
 Returns true if this port is a done port.
 
bool getFunctionPort (void) const
 Returns true if this port is a function port.
 
void updateGeometry ()
 Schedules a redraw of this port.
 
QPainterPath getPortPath (qreal inset) const
 Returns a closed path representing the port's circle/triangle.
 
QRectF getPortRect (void) const
 Returns a rectangle encompassing the port's circle.
 
QRectF getPortConstantTextRect (void) const
 Returns a rect enclosing the string representation of the port's constant value.
 
VuoTypegetDataType (void) const
 Returns the data type associated with this port, or NULL if there is no associated data type.
 
bool isConstant (void) const
 Returns true if this port has a constant data value.
 
string getConstantAsString (void) const
 Returns the string representation of this port's constant data value, or an empty string if it has none.
 
VuoRendererPublishedPortgetPublishedPort () const
 Returns a pointer to the VuoRendererPublishedPort associated with this port, or NULL if this port is not currently published.
 
VuoRendererNodegetUnderlyingParentNode (void) const
 Returns a pointer to the node to which this port belongs in the underlying Graphviz (.dot/.vuo) representation of the composition.
 
VuoRendererNodegetRenderedParentNode (void) const
 Returns a pointer to the node currently rendered as this port's parent.
 
VuoRendererPortgetTypecastParentPort () const
 Returns this port's typecast parent port, or NULL if it has none.
 
void setTypecastParentPort (VuoRendererPort *typecastParentPort)
 Sets this port's typecast parent port.
 
bool supportsDisconnectionByDragging (void)
 Returns a boolean indicating whether this port supports cable disconnection by dragging from the port.
 
void resetTimeLastEventFired ()
 Resets the time that the last event was fired to a value that causes the port to be painted as if activity-rendering were disabled.
 
void setFiredEvent ()
 Updates the port's state to indicate that it has just fired an event.
 
void setFadePercentageSinceEventFired (qreal percentage)
 Updates the port's state to indicate that it fired an event at such a time that its fade percentage should now be equal to percentage.
 
vector< QGraphicsItemAnimation * > getAnimations ()
 Returns the 'Show Events'-mode animations associated with this port.
 
void setAnimated (bool animated)
 Sets the boolean indicating whether this port is an animation, and not itself a component of the base composition.
 
- Public Member Functions inherited from VuoBaseDetail< VuoPort >
 VuoBaseDetail (string description, VuoPort *base)
 Creates a VuoNode detail class.
 
VuoPortgetBase (void) const
 Returns the VuoNode detail class instance's base class instance.
 
void setBase (VuoPort *base)
 Sets the VuoNode detail class instance's base class instance.
 

Additional Inherited Members

- Public Types inherited from VuoRendererItem
enum  activityState { notTrackingActivity = -1, activityInProgress = 0 }
 Special composition component activity states.
 
- Static Public Member Functions inherited from VuoRendererItem
static void setDrawBoundingRects (bool drawBoundingRects)
 Specifies whether bounding rects will be shown the next time the QGraphicsScene is rendered.
 
static void drawRect (QPainter *painter, QRectF rect)
 Draws a rect, for debugging.
 
- Static Public Attributes inherited from VuoRendererPort
static const qreal portSpacing = VuoRendererFonts::thickPenWidth*3.0/4.0
 Vertical distance, in pixels at 1:1 zoom, between the center points of two ports.
 
static const qreal portContainerMargin = VuoRendererFonts::thickPenWidth / 6.
 Vertical distance, in pixels at 1:1 zoom, between the outer edge of the first/last port and the node frame rect.
 
static const qreal portInset = 1
 The vertical and horizontal inset used when rendering a port shape within its outer port rect.
 
- Protected Member Functions inherited from VuoRendererPort
void mouseDoubleClickEvent (QGraphicsSceneMouseEvent *event)
 Handle mouse double-click events.
 
void keyPressEvent (QKeyEvent *event)
 Handle key-press events.
 
void paintWithOptions (QPainter *painter, bool sidebarPaintMode)
 Draws an input or output port, with customized options: If sidebarPaintMode is true, paints the port for display within the "Published Port" sidebar.
 
QRectF boundingRectWithOptions (bool sidebarPaintMode) const
 Returns the bounding rectangle of this port, with customized options: If sidebarPaintMode is true, returns the bounding rect of the port for display within the "Published Port" sidebar.
 
QRectF getNameRect (bool sidebarPaintMode=false) const
 Returns the bounding box of the port's label.
 
QPainterPath getPortConstantPath (QRectF innerPortRect, QString text, QPainterPath *outsetPath, bool isTypecast=false) const
 Returns a path representing the frame of a port constant.
 
QRectF getPortConstantTextRectForText (QString text) const
 Returns a rect enclosing the specified text.
 
QPainterPath getFunctionPortGlyph (void) const
 Returns a path representing the glyph for function ports.
 
void paintPortName (QPainter *painter, VuoRendererColors *colors, bool sidebarPaintMode)
 Paints the port's label.
 
- Protected Attributes inherited from VuoRendererPort
bool isRefreshPort
 Is this port a refresh port?
 
bool isDonePort
 Is this port a done port?
 
VuoRendererSignalersignaler
 The Qt signaler used by this port.
 

Constructor & Destructor Documentation

VuoRendererTypecastPort::VuoRendererTypecastPort ( VuoRendererNode uncollapsedTypecastNode,
VuoPort basePort,
VuoRendererSignaler signaler,
bool  isRefreshPort,
QString  sourceType,
QString  destinationType,
VuoRendererPort childPort 
)

Creates a typecast port.

Parameters
uncollapsedTypecastNodeThe original typecast node upon which this typecast port is based.
basePortThe input port to which the typecast node is currently connected.
signalerThe signaler object, for sending Qt change notifications.
isRefreshPortIs the input port to which the typecast node is currently connected a refresh port?
sourceTypeDisplay name for the typecast's source type.
destinationTypeDisplay name for the typecast's destination type.
childPortThe typecast node's input port (corresponding with sourceType).

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