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

Description

A published input or output port.

Public Member Functions

 VuoRendererPublishedPort (VuoPublishedPort *basePublishedPort)
 Creates a published input or output port.
 
QRectF boundingRect (void) const
 Returns a rectangle containing the rendered published port.
 
void paint (QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget)
 Draws the published port on painter.
 
void setName (string name)
 Sets the published port's name.
 
bool canAccommodateInternalPort (VuoRendererPort *internalPort)
 Returns a boolean indicating whether a new internalPort may be attached to/from this externally visible published port without displacing any currently connected internal data ports.
 
bool isCompatibleAliasWithoutSpecializationForInternalPort (VuoRendererPort *port)
 Returns a boolean indicating whether there may be a cable attached directly between this externally visible published port and the input internalPort, taking into account the respective port types (input vs.
 
bool isCompatibleAliasWithSpecializationForInternalPort (VuoRendererPort *port)
 Returns a boolean indicating whether there may be a cable attached directly between this externally visible published port and the input internalPort, taking into account the respective port types (input vs.
 
bool isCompatibleAliasWithSpecializationForInternalPort (VuoRendererPort *internalPort, VuoRendererPort **portToSpecialize, string &specializedTypeName)
 Returns a boolean indicating whether there may be a cable attached directly between this externally visible published port and the input internalPort, taking into account the respective port types (input vs.
 
bool canBeMergedWith (VuoPublishedPort *otherExternalPort)
 Returns a boolean indicating whether the otherExternalPort may be merged with this one, taking into account the respective port types (input vs.
 
void addConnectedPort (VuoPort *port)
 Adds the specified port to the list of internal ports for which this published port is an alias.
 
void removeConnectedPort (VuoPort *port)
 Removes the specified port from the list of internal ports for which this published port is an alias.
 
QPointF getGlobalPos (void) const
 Returns the location of the published port within the published port sidebar, in global coordinates.
 
void setGlobalPos (QPointF pos)
 Sets the location of the published port within the published port sidebar, in global coordinates.
 
VuoRendererPortgetPortRepresentation ()
 Returns the VuoRendererPort that visually represents this published port.
 
- Public Member Functions inherited from VuoBaseDetail< VuoPublishedPort >
 VuoBaseDetail (string description, VuoPublishedPort *base)
 Creates a VuoPublishedPort detail class.
 
VuoPublishedPortgetBase (void) const
 Returns the VuoPublishedPort detail class instance's base class instance.
 
void setBase (VuoPublishedPort *base)
 Sets the VuoPublishedPort 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. More...
 
- 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.
 
- Protected Member Functions inherited from VuoRendererItem
void drawBoundingRect (QPainter *painter)
 Draws this item's bounding rect, for debugging.
 
bool getRenderActivity ()
 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.
 
QGraphicsItem::CacheMode getCurrentDefaultCacheMode ()
 Returns the current default cache mode for components of this composition.
 
- 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.
 

Constructor & Destructor Documentation

VuoRendererPublishedPort::VuoRendererPublishedPort ( VuoPublishedPort basePublishedPort)

Creates a published input or output port.

Parameters
basePublishedPortThe base for which this renderer detail is to be created.

Member Function Documentation

void VuoRendererPublishedPort::addConnectedPort ( VuoPort port)

Adds the specified port to the list of internal ports for which this published port is an alias.

QRectF VuoRendererPublishedPort::boundingRect ( void  ) const

Returns a rectangle containing the rendered published port.

bool VuoRendererPublishedPort::canAccommodateInternalPort ( VuoRendererPort internalPort)

Returns a boolean indicating whether a new internalPort may be attached to/from this externally visible published port without displacing any currently connected internal data ports.

bool VuoRendererPublishedPort::canBeMergedWith ( VuoPublishedPort otherExternalPort)

Returns a boolean indicating whether the otherExternalPort may be merged with this one, taking into account the respective port types (input vs.

output; event-only vs. event+data; respective data types), without displacing any currently connected internal data ports.

QPointF VuoRendererPublishedPort::getGlobalPos ( void  ) const

Returns the location of the published port within the published port sidebar, in global coordinates.

VuoRendererPort * VuoRendererPublishedPort::getPortRepresentation ( )

Returns the VuoRendererPort that visually represents this published port.

bool VuoRendererPublishedPort::isCompatibleAliasWithoutSpecializationForInternalPort ( VuoRendererPort internalPort)

Returns a boolean indicating whether there may be a cable attached directly between this externally visible published port and the input internalPort, taking into account the respective port types (input vs.

output; event-only vs. event+data; respective data types).

If the connection would require one or both ports to be specialized, returns false. (But see VuoRendererPublishedPort::isCompatibleAliasWithSpecializationForInternalPort(...).)

bool VuoRendererPublishedPort::isCompatibleAliasWithSpecializationForInternalPort ( VuoRendererPort internalPort)

Returns a boolean indicating whether there may be a cable attached directly between this externally visible published port and the input internalPort, taking into account the respective port types (input vs.

output; event-only vs. event+data; respective data types), and the possibility that one port may be specialized in preparation for the connection.

Convenience function for VuoRendererPublishedPort::isCompatibleAliasWithSpecializationForInternalPort(VuoRendererPort *internalPort, VuoRendererPort **portToSpecialize, string &specializedTypeName), for use when only the returned boolean and none of the other output parameter values are needed.

bool VuoRendererPublishedPort::isCompatibleAliasWithSpecializationForInternalPort ( VuoRendererPort internalPort,
VuoRendererPort **  portToSpecialize,
string &  specializedTypeName 
)

Returns a boolean indicating whether there may be a cable attached directly between this externally visible published port and the input internalPort, taking into account the respective port types (input vs.

output; event-only vs. event+data; respective data types), and the possibility that one port may be specialized in preparation for the connection.

void VuoRendererPublishedPort::paint ( QPainter *  painter,
const QStyleOptionGraphicsItem *  option,
QWidget *  widget 
)

Draws the published port on painter.

void VuoRendererPublishedPort::removeConnectedPort ( VuoPort port)

Removes the specified port from the list of internal ports for which this published port is an alias.

void VuoRendererPublishedPort::setGlobalPos ( QPointF  pos)

Sets the location of the published port within the published port sidebar, in global coordinates.

void VuoRendererPublishedPort::setName ( string  name)

Sets the published port's name.


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