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

Description

Provides colors for rendered items in a composition.

Public Types

enum  HighlightType { standardHighlight, subtleHighlight, noHighlight }
 Specifies the various levels of highlighting that may be applied to a given component. More...
 
enum  SelectionType { directSelection, indirectSelection, sidebarSelection, noSelection }
 Specifies the various levels of selection coloring that may be applied to a given component. More...
 

Public Member Functions

 VuoRendererColors (VuoNode::TintColor tintColor=VuoNode::TintNone, VuoRendererColors::SelectionType selectionType=VuoRendererColors::noSelection, bool isHovered=false, VuoRendererColors::HighlightType highlightType=VuoRendererColors::noHighlight, qint64 timeOfLastActivity=VuoRendererItem::notTrackingActivity)
 Creates a new color scheme provider, optionally tinted with tintColor.
 
QColor canvasFill (void)
 Returns the color for the background of the composition canvas.
 
QColor nodeFill (void)
 Returns the color for the background of the main section of the node (the background of the area the port labels are drawn on).
 
QColor nodeFrame (void)
 Returns the color for the node's outline and the background of its title bar.
 
QColor nodeTitle (void)
 Returns the color for the node's title text in the node's title bar.
 
QColor nodeClass (void)
 Returns the color for the node's class name text in the node's title bar.
 
QColor constantFill (void)
 Returns the color for the background of constants.
 
QColor constantText (void)
 Returns the color for the text on port constant flags.
 
QColor animatedPortFill (void)
 Returns the color for the background of an animated copy of a port.
 
QColor eventBlockingBarrier (void)
 Returns the color for a port's event wall or door.
 
QColor animatedeventBlockingBarrier (void)
 Returns the color for the event wall or door of the animated copy of a port.
 
QColor actionIndicator (void)
 Returns the color for the port action symbol.
 
QColor publishedPortFill (void)
 Returns the color for the background of ports in the published port sidebars.
 
QColor publishedPortTitle (void)
 Returns the color for the title text of ports in the published port sidebars.
 
QColor publishedProtocolPortTitle (void)
 Returns the color for the title text of protocol ports in the published port sidebars.
 
QColor portFill (void)
 Returns the color for the background of ports in the main section of the node.
 
QColor portTitlebarFill (void)
 Returns the color for the background of ports in the titlebar of the node.
 
QColor portTitle (void)
 Returns the color for the title text of ports in the main section of the node.
 
QColor cableUpper (void)
 Returns the color for the highlight on the upper side of left-to-right cables (and lower side of right-to-left cables).
 
QColor cableMain (void)
 Returns the color for the main cable body.
 
QColor errorMark (void)
 Returns the color for marking nodes and cables involved in build errors.
 

Static Public Member Functions

static VuoRendererColorsgetSharedColors (void)
 Returns a shared, untinted color scheme provider.
 
static void setDark (bool isDark)
 Sets whether all instances return colors appropriate for a dark interface.
 
static bool isDark (void)
 Returns whether the global interface is dark.
 
static qint64 getVirtualNodeExecutionOrigin (void)
 Returns the projected time (in ms since epoch) at which a node must have completed its previous execution in order to have faded to the defaultNodeFrameAndFillAlpha level at the current time.
 
static qint64 getVirtualFiredEventOrigin (void)
 Returns the projected time (in ms since epoch) at which a port must have fired its most recent event in order to have faded to the defaultPortFillAlpha level at the current time.
 
static qint64 getVirtualFiredEventOriginForAnimationFadePercentage (qreal percentage)
 Returns the projected time (in ms since epoch) at which a port must have fired its most recent event in order for its animation to have faded to the percentage provided.
 
static qint64 getVirtualPropagatedEventOrigin (void)
 Returns the projected time (in ms since epoch) at which a cable must have propagated its most recent event in order to have faded to the defaultCableUpperAndMainAlpha level at the current time.
 
static VuoNode::TintColor getActiveProtocolTint (int protocolIndex)
 Returns the tint to be used for the heading of an active protocol, given the index of the protocol within the sidebar.
 

Static Public Attributes

static const int activityAnimationFadeDuration = 950
 Time period, in ms, over which a 'Show Events'-mode animation (e.g., for trigger port firing) fades to its minimum alpha level.
 

Member Enumeration Documentation

Specifies the various levels of highlighting that may be applied to a given component.

Specifies the various levels of selection coloring that may be applied to a given component.

Constructor & Destructor Documentation

VuoRendererColors::VuoRendererColors ( VuoNode::TintColor  tintColor = VuoNode::TintNone,
VuoRendererColors::SelectionType  selectionType = VuoRendererColors::noSelection,
bool  isHovered = false,
VuoRendererColors::HighlightType  highlightType = VuoRendererColors::noHighlight,
qint64  timeOfLastActivity = VuoRendererItem::notTrackingActivity 
)

Creates a new color scheme provider, optionally tinted with tintColor.

If selectionType is anything other than VuoRendererColors::noSelection or VuoRendererColors::sidebarSelection, the colors are also tinted slightly blue and have their opacity increased to indicate selection. If isHovered is true, the colors are also slightly tinted dark blue to indicate potential for selection. If highlightType is anything other than VuoRendererColors::noHighlight, the colors are also tinted with light blue (more easily visible at a distance) to indicate potential for cable connection. If timeOfLastActivity is anything other than VuoRendererItem::notTrackingActivity, the alpha level is modified to reflect the amount of time that has passed since the timeOfLastActivity (e.g., a node execution or event firing), in ms since epoch.

Member Function Documentation

QColor VuoRendererColors::actionIndicator ( void  )

Returns the color for the port action symbol.

QColor VuoRendererColors::animatedeventBlockingBarrier ( void  )

Returns the color for the event wall or door of the animated copy of a port.

QColor VuoRendererColors::animatedPortFill ( void  )

Returns the color for the background of an animated copy of a port.

QColor VuoRendererColors::cableMain ( void  )

Returns the color for the main cable body.

QColor VuoRendererColors::cableUpper ( void  )

Returns the color for the highlight on the upper side of left-to-right cables (and lower side of right-to-left cables).

QColor VuoRendererColors::canvasFill ( void  )

Returns the color for the background of the composition canvas.

Can be overridden by VuoRendererComposition::setBackgroundTransparent.

QColor VuoRendererColors::constantFill ( void  )

Returns the color for the background of constants.

QColor VuoRendererColors::constantText ( void  )

Returns the color for the text on port constant flags.

QColor VuoRendererColors::errorMark ( void  )

Returns the color for marking nodes and cables involved in build errors.

QColor VuoRendererColors::eventBlockingBarrier ( void  )

Returns the color for a port's event wall or door.

VuoNode::TintColor VuoRendererColors::getActiveProtocolTint ( int  protocolIndex)
static

Returns the tint to be used for the heading of an active protocol, given the index of the protocol within the sidebar.

VuoRendererColors * VuoRendererColors::getSharedColors ( void  )
static

Returns a shared, untinted color scheme provider.

Don't free this object.

qint64 VuoRendererColors::getVirtualFiredEventOrigin ( void  )
static

Returns the projected time (in ms since epoch) at which a port must have fired its most recent event in order to have faded to the defaultPortFillAlpha level at the current time.

qint64 VuoRendererColors::getVirtualFiredEventOriginForAnimationFadePercentage ( qreal  percentage)
static

Returns the projected time (in ms since epoch) at which a port must have fired its most recent event in order for its animation to have faded to the percentage provided.

qint64 VuoRendererColors::getVirtualNodeExecutionOrigin ( void  )
static

Returns the projected time (in ms since epoch) at which a node must have completed its previous execution in order to have faded to the defaultNodeFrameAndFillAlpha level at the current time.

qint64 VuoRendererColors::getVirtualPropagatedEventOrigin ( void  )
static

Returns the projected time (in ms since epoch) at which a cable must have propagated its most recent event in order to have faded to the defaultCableUpperAndMainAlpha level at the current time.

bool VuoRendererColors::isDark ( void  )
static

Returns whether the global interface is dark.

QColor VuoRendererColors::nodeClass ( void  )

Returns the color for the node's class name text in the node's title bar.

QColor VuoRendererColors::nodeFill ( void  )

Returns the color for the background of the main section of the node (the background of the area the port labels are drawn on).

Also used for port fill, and the background of collapsed typecast ports.

QColor VuoRendererColors::nodeFrame ( void  )

Returns the color for the node's outline and the background of its title bar.

Also used for collapsed typecast port borders.

QColor VuoRendererColors::nodeTitle ( void  )

Returns the color for the node's title text in the node's title bar.

QColor VuoRendererColors::portFill ( void  )

Returns the color for the background of ports in the main section of the node.

QColor VuoRendererColors::portTitle ( void  )

Returns the color for the title text of ports in the main section of the node.

QColor VuoRendererColors::portTitlebarFill ( void  )

Returns the color for the background of ports in the titlebar of the node.

QColor VuoRendererColors::publishedPortFill ( void  )

Returns the color for the background of ports in the published port sidebars.

QColor VuoRendererColors::publishedPortTitle ( void  )

Returns the color for the title text of ports in the published port sidebars.

QColor VuoRendererColors::publishedProtocolPortTitle ( void  )

Returns the color for the title text of protocol ports in the published port sidebars.

void VuoRendererColors::setDark ( bool  isDark)
static

Sets whether all instances return colors appropriate for a dark interface.

Member Data Documentation

const int VuoRendererColors::activityAnimationFadeDuration = 950
static

Time period, in ms, over which a 'Show Events'-mode animation (e.g., for trigger port firing) fades to its minimum alpha level.


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