VuoRendererColors Class Reference

Description

Provides colors for rendered items in a composition.

Definition at line 18 of file VuoRendererColors.hh.

Public Types
enum	HighlightType { standardHighlight , subtleHighlight , ineligibleHighlight , noHighlight }
	Specifies the various levels of highlighting that may be applied to a given component. More...
enum	SelectionType { directSelection , indirectSelection , 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, bool isMissingImplementation=false)
	Creates a new color scheme provider, optionally tinted with tintColor. More...
QColor	canvasFill (void)
	Returns the color for the background of the composition canvas. More...
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). More...
QColor	nodeFrame (void)
	Returns the color for the node's title bar background. More...
QColor	nodeTitle (void)
	Returns the color for the node's title text in the node's title bar. More...
QColor	nodeClass (void)
	Returns the color for the node's class name text in the node's title bar. More...
QColor	constantFill (void)
	Returns the color for the background of constants. More...
QColor	constantText (void)
	Returns the color for the text on port constant flags. More...
QColor	animatedPortFill (void)
	Returns the color for the background of an animated copy of a port. More...
QColor	eventBlockingBarrier (void)
	Returns the color for a port's event wall or door. More...
QColor	animatedeventBlockingBarrier (void)
	Returns the color for the event wall or door of the animated copy of a port. More...
QColor	actionIndicator (void)
	Returns the color for the port action symbol. More...
QColor	publishedPortFill (void)
	Returns the color for the background of ports in the published port sidebars. More...
QColor	publishedPortTitle (void)
	Returns the color for the title text of ports in the published port sidebars. More...
QColor	publishedProtocolPortTitle (void)
	Returns the color for the title text of protocol ports in the published port sidebars. More...
QColor	portFill (void)
	Returns the color for the background of ports in the main section of the node. More...
QColor	portTitlebarFill (void)
	Returns the color for the background of ports in the titlebar of the node. More...
QColor	portTitle (void)
	Returns the color for the title text of ports in the main section of the node. More...
QColor	portIcon (void)
	Returns the color for the triangle on event-only ports. More...
QColor	cableMain (void)
	Returns the color for the main cable body. More...
QColor	errorMark (void)
	Returns the color for marking nodes and cables involved in build errors. More...
QColor	commentFrame (void)
	Returns the color for the outline of a comment. More...
QColor	commentFill (void)
	Returns the color for the background of a comment. More...
QColor	commentText (void)
	Returns the color for the text of a comment. More...
QColor	selection (void)
	Returns the color for the background of user-selected widgets. More...

Static Public Member Functions
static VuoRendererColors *	getSharedColors (void)
	Returns a shared, untinted color scheme provider. More...
static void	setDark (bool isDark)
	Sets whether all instances return colors appropriate for a dark interface. More...
static bool	isDark (void)
	Returns whether the global interface is dark. More...
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. More...
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. More...
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. More...
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. More...
static VuoNode::TintColor	getActiveProtocolTint (int protocolIndex, bool isInput)
	Returns the tint to be used for the heading of an active protocol, given the index of the protocol within the sidebar. More...

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. More...

Member Enumeration Documentation

HighlightType

enum VuoRendererColors::HighlightType

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

Enumerator
standardHighlight	Cable is being dragged, and port is eligible for direct connection.
subtleHighlight	Cable is being dragged, and port is eligible for connection via typecast.
ineligibleHighlight	Cable is being dragged, but port is not eligible for connection.
noHighlight	Cable is not being dragged.

Definition at line 24 of file VuoRendererColors.hh.

SelectionType

enum VuoRendererColors::SelectionType

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

Definition at line 35 of file VuoRendererColors.hh.

Constructor & Destructor Documentation

VuoRendererColors()

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

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

If selectionType is anything other than VuoRendererColors::noSelection, 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.

Definition at line 30 of file VuoRendererColors.cc.

Member Function Documentation

actionIndicator()

QColor VuoRendererColors::actionIndicator

(

void

)

Returns the color for the port action symbol.

Definition at line 219 of file VuoRendererColors.cc.

animatedeventBlockingBarrier()

QColor VuoRendererColors::animatedeventBlockingBarrier

(

void

)

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

Definition at line 208 of file VuoRendererColors.cc.

animatedPortFill()

QColor VuoRendererColors::animatedPortFill

(

void

)

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

Definition at line 181 of file VuoRendererColors.cc.

cableMain()

QColor VuoRendererColors::cableMain

(

void

)

Returns the color for the main cable body.

Definition at line 248 of file VuoRendererColors.cc.

canvasFill()

QColor VuoRendererColors::canvasFill

(

void

)

Returns the color for the background of the composition canvas.

Can be overridden by VuoRendererComposition::setBackgroundTransparent.

Definition at line 80 of file VuoRendererColors.cc.

commentFill()

QColor VuoRendererColors::commentFill

(

void

)

Returns the color for the background of a comment.

Definition at line 281 of file VuoRendererColors.cc.

commentFrame()

QColor VuoRendererColors::commentFrame

(

void

)

Returns the color for the outline of a comment.

Definition at line 264 of file VuoRendererColors.cc.

commentText()

QColor VuoRendererColors::commentText

(

void

)

Returns the color for the text of a comment.

Definition at line 312 of file VuoRendererColors.cc.

constantFill()

QColor VuoRendererColors::constantFill

(

void

)

Returns the color for the background of constants.

Definition at line 165 of file VuoRendererColors.cc.

constantText()

QColor VuoRendererColors::constantText

(

void

)

Returns the color for the text on port constant flags.

Definition at line 173 of file VuoRendererColors.cc.

errorMark()

QColor VuoRendererColors::errorMark

(

void

)

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

Definition at line 256 of file VuoRendererColors.cc.

eventBlockingBarrier()

QColor VuoRendererColors::eventBlockingBarrier

(

void

)

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

Definition at line 200 of file VuoRendererColors.cc.

getActiveProtocolTint()

VuoNode::TintColor VuoRendererColors::getActiveProtocolTint ( int  protocolIndex, bool  isInput  )

static

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

Definition at line 462 of file VuoRendererColors.cc.

getSharedColors()

VuoRendererColors * VuoRendererColors::getSharedColors ( void  )

static

Returns a shared, untinted color scheme provider.

Don't free this object.

Definition at line 52 of file VuoRendererColors.cc.

getVirtualFiredEventOrigin()

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.

Definition at line 413 of file VuoRendererColors.cc.

getVirtualFiredEventOriginForAnimationFadePercentage()

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.

Definition at line 422 of file VuoRendererColors.cc.

getVirtualNodeExecutionOrigin()

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.

Definition at line 403 of file VuoRendererColors.cc.

getVirtualPropagatedEventOrigin()

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.

Definition at line 435 of file VuoRendererColors.cc.

isDark()

bool VuoRendererColors::isDark ( void  )

static

Returns whether the global interface is dark.

Definition at line 71 of file VuoRendererColors.cc.

nodeClass()

QColor VuoRendererColors::nodeClass

(

void

)

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

Definition at line 154 of file VuoRendererColors.cc.

nodeFill()

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.

Definition at line 89 of file VuoRendererColors.cc.

nodeFrame()

QColor VuoRendererColors::nodeFrame

(

void

)

Returns the color for the node's title bar background.

Definition at line 132 of file VuoRendererColors.cc.

nodeTitle()

QColor VuoRendererColors::nodeTitle

(

void

)

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

Definition at line 143 of file VuoRendererColors.cc.

portFill()

QColor VuoRendererColors::portFill

(

void

)

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

Definition at line 97 of file VuoRendererColors.cc.

portIcon()

QColor VuoRendererColors::portIcon

(

void

)

Returns the color for the triangle on event-only ports.

Definition at line 240 of file VuoRendererColors.cc.

portTitle()

QColor VuoRendererColors::portTitle

(

void

)

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

Definition at line 227 of file VuoRendererColors.cc.

portTitlebarFill()

QColor VuoRendererColors::portTitlebarFill

(

void

)

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

Definition at line 192 of file VuoRendererColors.cc.

publishedPortFill()

QColor VuoRendererColors::publishedPortFill

(

void

)

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

Definition at line 105 of file VuoRendererColors.cc.

publishedPortTitle()

QColor VuoRendererColors::publishedPortTitle

(

void

)

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

Definition at line 113 of file VuoRendererColors.cc.

publishedProtocolPortTitle()

QColor VuoRendererColors::publishedProtocolPortTitle

(

void

)

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

Definition at line 124 of file VuoRendererColors.cc.

selection()

QColor VuoRendererColors::selection

(

void

)

Returns the color for the background of user-selected widgets.

(This is for standard GUI widgets. For canvas nodes/cables, use VuoRendererColors::SelectionType instead.)

Definition at line 323 of file VuoRendererColors.cc.

setDark()

void VuoRendererColors::setDark ( bool  isDark )

static

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

Definition at line 63 of file VuoRendererColors.cc.

Member Data Documentation

activityAnimationFadeDuration

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.

Definition at line 93 of file VuoRendererColors.hh.

---

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

• renderer/VuoRendererColors.hh
• renderer/VuoRendererColors.cc