iPlug 2: IVStyle Struct Reference

A struct encapsulating a set of properties used to configure IVControls. More...

#include <IGraphicsStructs.h>

Public Member Functions
	IVStyle (bool showLabel=DEFAULT_SHOW_LABEL, bool showValue=DEFAULT_SHOW_VALUE, const IVColorSpec &colors={DEFAULT_BGCOLOR, DEFAULT_FGCOLOR, DEFAULT_PRCOLOR, DEFAULT_FRCOLOR, DEFAULT_HLCOLOR, DEFAULT_SHCOLOR, DEFAULT_X1COLOR, DEFAULT_X2COLOR, DEFAULT_X3COLOR}, const IText &labelText=DEFAULT_LABEL_TEXT, const IText &valueText=DEFAULT_VALUE_TEXT, bool hideCursor=DEFAULT_HIDE_CURSOR, bool drawFrame=DEFAULT_DRAW_FRAME, bool drawShadows=DEFAULT_DRAW_SHADOWS, bool emboss=DEFAULT_EMBOSS, float roundness=DEFAULT_ROUNDNESS, float frameThickness=DEFAULT_FRAME_THICKNESS, float shadowOffset=DEFAULT_SHADOW_OFFSET, float widgetFrac=DEFAULT_WIDGET_FRAC, float angle=DEFAULT_WIDGET_ANGLE, EOrientation labelOrientation=DEFAULT_LABEL_ORIENTATION)
	Create a new IVStyle to configure common styling for IVControls. More...

	IVStyle (const std::initializer_list< IColor > &colors)
	Create a new IVStyle based on a list of colors, and defaults for the other elements. More...

IVStyle	WithShowLabel (bool show=true) const

IVStyle	WithShowValue (bool show=true) const

IVStyle	WithLabelText (const IText &text) const

IVStyle	WithValueText (const IText &text) const

IVStyle	WithHideCursor (bool hide=true) const

IVStyle	WithColor (EVColor idx, IColor color) const

IVStyle	WithColors (const IVColorSpec &spec) const

IVStyle	WithRoundness (float v) const

IVStyle	WithFrameThickness (float v) const

IVStyle	WithShadowOffset (float v) const

IVStyle	WithDrawShadows (bool v=true) const

IVStyle	WithDrawFrame (bool v=true) const

IVStyle	WithWidgetFrac (float v) const

IVStyle	WithAngle (float v) const

IVStyle	WithEmboss (bool v=true) const

IVStyle	WithLabelOrientation (EOrientation v) const

Public Attributes
bool	hideCursor = DEFAULT_HIDE_CURSOR

bool	showLabel = DEFAULT_SHOW_LABEL

bool	showValue = DEFAULT_SHOW_VALUE

bool	drawFrame = DEFAULT_DRAW_FRAME

bool	drawShadows = DEFAULT_DRAW_SHADOWS

bool	emboss = DEFAULT_EMBOSS

float	roundness = DEFAULT_ROUNDNESS

float	frameThickness = DEFAULT_FRAME_THICKNESS

float	shadowOffset = DEFAULT_SHADOW_OFFSET

float	widgetFrac = DEFAULT_WIDGET_FRAC

float	angle = DEFAULT_WIDGET_ANGLE

IVColorSpec	colorSpec = DEFAULT_COLOR_SPEC

IText	labelText = DEFAULT_LABEL_TEXT

IText	valueText = DEFAULT_VALUE_TEXT

EOrientation	labelOrientation = DEFAULT_LABEL_ORIENTATION

A struct encapsulating a set of properties used to configure IVControls.

Definition at line 2484 of file IGraphicsStructs.h.

IVStyle::IVStyle	(	bool	showLabel = `DEFAULT_SHOW_LABEL`,
		bool	showValue = `DEFAULT_SHOW_VALUE`,
		const IVColorSpec &	colors = `{DEFAULT_BGCOLOR, DEFAULT_FGCOLOR, DEFAULT_PRCOLOR, DEFAULT_FRCOLOR, DEFAULT_HLCOLOR, DEFAULT_SHCOLOR, DEFAULT_X1COLOR, DEFAULT_X2COLOR, DEFAULT_X3COLOR}`,
		const IText &	labelText = `DEFAULT_LABEL_TEXT`,
		const IText &	valueText = `DEFAULT_VALUE_TEXT`,
		bool	hideCursor = `DEFAULT_HIDE_CURSOR`,
		bool	drawFrame = `DEFAULT_DRAW_FRAME`,
		bool	drawShadows = `DEFAULT_DRAW_SHADOWS`,
		bool	emboss = `DEFAULT_EMBOSS`,
		float	roundness = `DEFAULT_ROUNDNESS`,
		float	frameThickness = `DEFAULT_FRAME_THICKNESS`,
		float	shadowOffset = `DEFAULT_SHADOW_OFFSET`,
		float	widgetFrac = `DEFAULT_WIDGET_FRAC`,
		float	angle = `DEFAULT_WIDGET_ANGLE`,
		EOrientation	labelOrientation = `DEFAULT_LABEL_ORIENTATION`
	)

inline

Create a new IVStyle to configure common styling for IVControls.

Parameters

showLabel	Show the label
showValue	Show the value
colors	An IVColorSpec for the style
labelText	The IText for the label text style
valueText	The IText for the value text style
hideCursor	Should the cursor be hidden e.g. when dragging the control
drawFrame	Should the frame be drawn around the bounds of the control or around the handle, where relevant
drawShadows	Should there be a shadow beneath the control handle
emboss	Should the handle of the control be embossed
roundness	The roundness factor for the control's elements
frameThickness	The thickness of the controls frame elements
shadowOffset	The distance of the shadow from the foreground
widgetFrac	The fraction of the widget area (control area - label/value if shown) that the widget occupies
angle	The rotation angle in degrees of e.g. the handle/pointer on an IVSlider

Definition at line 2517 of file IGraphicsStructs.h.

◆ IVStyle() [2/2]

IVStyle::IVStyle

(

const std::initializer_list< IColor > &

colors

)

inline

Create a new IVStyle based on a list of colors, and defaults for the other elements.

Parameters

Definition at line 2551 of file IGraphicsStructs.h.

◆ WithAngle()

IVStyle IVStyle::WithAngle

(

float

)

const

inline

◆ WithColor()

IVStyle IVStyle::WithColor	(	EVColor	idx,
		IColor	color
	)		const

inline

◆ WithColors()

◆ WithDrawFrame()

IVStyle IVStyle::WithDrawFrame ( bool v = true ) const

inline

◆ WithDrawShadows()

IVStyle IVStyle::WithDrawShadows ( bool v = true ) const

inline

◆ WithEmboss()

IVStyle IVStyle::WithEmboss ( bool v = true ) const

inline

◆ WithFrameThickness()

IVStyle IVStyle::WithFrameThickness

(

float

)

const

inline

◆ WithHideCursor()

IVStyle IVStyle::WithHideCursor ( bool hide = true ) const

inline

◆ WithLabelOrientation()

IVStyle IVStyle::WithLabelOrientation

(

EOrientation

)

const

inline

◆ WithLabelText()

IVStyle IVStyle::WithLabelText

(

const IText &

text

)

const

inline

◆ WithRoundness()

IVStyle IVStyle::WithRoundness

(

float

)

const

inline

◆ WithShadowOffset()

IVStyle IVStyle::WithShadowOffset

(

float

)

const

inline

◆ WithShowLabel()

IVStyle IVStyle::WithShowLabel ( bool show = true ) const

inline

◆ WithShowValue()

IVStyle IVStyle::WithShowValue ( bool show = true ) const

inline

◆ WithValueText()

IVStyle IVStyle::WithValueText

(

const IText &

text

)

const

inline

◆ WithWidgetFrac()

IVStyle IVStyle::WithWidgetFrac

(

float

)

const

inline

◆ angle

float IVStyle::angle = DEFAULT_WIDGET_ANGLE

◆ colorSpec

◆ drawFrame

bool IVStyle::drawFrame = DEFAULT_DRAW_FRAME

◆ drawShadows

bool IVStyle::drawShadows = DEFAULT_DRAW_SHADOWS

◆ emboss

bool IVStyle::emboss = DEFAULT_EMBOSS

◆ frameThickness

float IVStyle::frameThickness = DEFAULT_FRAME_THICKNESS

◆ hideCursor

bool IVStyle::hideCursor = DEFAULT_HIDE_CURSOR

◆ labelOrientation

EOrientation IVStyle::labelOrientation = DEFAULT_LABEL_ORIENTATION

◆ labelText

IText IVStyle::labelText = DEFAULT_LABEL_TEXT

◆ roundness

float IVStyle::roundness = DEFAULT_ROUNDNESS

◆ shadowOffset

float IVStyle::shadowOffset = DEFAULT_SHADOW_OFFSET

◆ showLabel

bool IVStyle::showLabel = DEFAULT_SHOW_LABEL

◆ showValue

bool IVStyle::showValue = DEFAULT_SHOW_VALUE

◆ valueText

IText IVStyle::valueText = DEFAULT_VALUE_TEXT

◆ widgetFrac

float IVStyle::widgetFrac = DEFAULT_WIDGET_FRAC

The documentation for this struct was generated from the following file:

IGraphicsStructs.h

Public Member Functions

Public Attributes

◆ IVStyle() [2/2]

◆ WithAngle()

◆ WithColor()

◆ WithColors()

◆ WithDrawFrame()

◆ WithDrawShadows()

◆ WithEmboss()

◆ WithFrameThickness()

◆ WithHideCursor()

◆ WithLabelOrientation()

◆ WithLabelText()

◆ WithRoundness()

◆ WithShadowOffset()

◆ WithShowLabel()

◆ WithShowValue()

◆ WithValueText()

◆ WithWidgetFrac()

◆ angle

◆ colorSpec

◆ drawFrame

◆ drawShadows

◆ emboss

◆ frameThickness

◆ hideCursor

◆ labelOrientation

◆ labelText

◆ roundness

◆ shadowOffset

◆ showLabel

◆ showValue

◆ valueText

◆ widgetFrac