A discrete button behaves like a toggle button except that it is on only if the control value (tied to a parameter) is equal to the step value (DiscreteButtonView::getStep() / step property in the xml). More...

#include <DiscreteButtonView.h>

Inherits CustomDiscreteControlView.

Classes
class	Creator

Public Member Functions
	DiscreteButtonView (const CRect &iSize)
void	draw (CDrawContext *iContext) override
int	getFrames () const
	The number of frames the image contains.
BitmapPtr	getImage () const
	The image for the button.
bool	getInverse () const
	Inverses the meaning of "on" and "off" in regards to drawing the view/image.
CColor const &	getOnColor () const
	When no image is provided, back-color is used for the "off" state and on-color for the "on" state (draws a rectangle with this color).
int32	getStep () const
	The value used to check whether the button is "on" or "off" as well as the value to set the parameter to when the button is selected.
bool	isOff () const
bool	isOn () const
int32_t	onKeyDown (VstKeyCode &keyCode) override
int32_t	onKeyUp (VstKeyCode &keyCode) override
CMouseEventResult	onMouseCancel () override
CMouseEventResult	onMouseDown (CPoint &where, const CButtonState &buttons) override
CMouseEventResult	onMouseUp (CPoint &where, const CButtonState &buttons) override
void	registerParameters () override
	Registers the optional parameter using getControlTag() as its id.
void	setFrames (int iFrames)
void	setImage (BitmapPtr iImage)
void	setInverse (bool iInverse)
	Attribute inverse.
void	setOn ()
void	setOnColor (CColor const &iColor)
void	setStep (int32 step)
bool	sizeToFit () override
Public Member Functions inherited from CustomDiscreteControlView
	CustomDiscreteControlView (const CRect &iSize)
int32	getStepCount () const
	The number of steps of the managed discrete parameter as specified by this view.
void	setStepCount (int32 iStepCount)
Public Member Functions inherited from TCustomControlView< int32 >
int32	getControlValue () const
	Returns the value of the managed parameter (properly typed).
void	registerParameters () override
	Registers the optional parameter using getControlTag() as its id.
virtual void	setControlValue (int32 const &iControlValue)
	Sets the value of the managed parameter to the provided value.
	TCustomControlView (const CRect &iSize)
Public Member Functions inherited from CustomControlView
	CustomControlView (const CRect &iSize)
ParamID	getControlTag () const
	Id of the parameter that this view manages.
virtual void	setControlTag (ParamID iTag)
Public Member Functions inherited from CustomView
void	afterApplyAttributes () override
	Handles the lifecycle behavior getting triggered once all the attributes have been set (which usually happens after the XML file (uidesc) has been read/processed, or when you modify attributes in the VSTGUI Editor).
	CustomView (const CRect &iSize)
	CustomView (const CustomView &c)=delete
void	draw (CDrawContext *iContext) override
	The basic draw method which will erase the background with the back color.
virtual void	drawBackColor (CDrawContext *iContext)
	Draws the back color (if not set to transparent).
void	drawStyleChanged ()
	Called when the draw style is changed (simply marks the view dirty).
CColor const &	getBackColor () const
	The back color (background) for the view.
TagID	getCustomViewTag () const
	The tag associated to this custom view.
bool	getEditorMode () const
	A flag whose purpose is to render/log information during development when the flag is set to true.
void	markDirty ()
	Marks this view dirty which will (at the appropriate time in the rendering lifecycle) trigger a call to draw().
void	onParameterChange (ParamID iParamID) override
	Callback when a parameter changes.
void	setBackColor (CColor const &iColor)
void	setCustomViewTag (TagID iTag)
void	setEditorMode (bool iEditorMode)
Public Member Functions inherited from ParamAware
virtual void	initState (GUIState *iGUIState)
	Called during initialization.
void	invokeAll ()
	Invoke all (currently) registered callbacks and onParameterChange() (if registered).
void	onParameterChange (ParamID iParamID) override
	This is the callback that should be implemented to handle parameter changes.
IGUIParam	registerBaseCallback (ParamID iParamID, Parameters::ChangeCallback iChangeCallback, bool iInvokeCallback)
	Registers a callback for the "base" param for the most generic use case.
IGUIParam	registerBaseCallback (ParamID iParamID, Parameters::ChangeCallback1< IGUIParam > iChangeCallback, bool iInvokeCallback)
	Registers a callback for the "base" param for the most generic use case.
IGUIParam	registerBaseParam (ParamID iParamID, bool iSubscribeToChanges=true)
	Registers the "base" param for the most generic use case but as a result is fairly limited and mainly gives access to the string representation of the param.
template<typename T>
GUIJmbParam< T >	registerCallback (GUIJmbParam< T > &iParam, Parameters::ChangeCallback iChangeCallback, bool iInvokeCallback=false)
	Convenient call to register a callback for the Jmb param simply by using the param from the state (accessible in state-aware views via fState->fMyParam).
template<typename T>
GUIJmbParam< T >	registerCallback (GUIJmbParam< T > &iParam, Parameters::ChangeCallback1< GUIJmbParam< T > > iChangeCallback, bool iInvokeCallback=false)
	Convenient call to register a callback for the Jmb param simply by using the param from the state (accessible in state-aware views via fState->fMyParam).
template<typename T>
GUIJmbParam< T >	registerCallback (JmbParam< T > const &iParamDef, Parameters::ChangeCallback iChangeCallback, bool iInvokeCallback=false)
	Convenient call to register a callback for the Jmb param simply by using its description (accessible in state-aware views via fParams->fMyParam).
template<typename T>
GUIJmbParam< T >	registerCallback (JmbParam< T > const &iParamDef, Parameters::ChangeCallback1< GUIJmbParam< T > > iChangeCallback, bool iInvokeCallback=false)
	Convenient call to register a callback for the Jmb param simply by using its description (accessible in state-aware views via fParams->fMyParam).
GUIRawVstParam	registerCallback (RawVstParam const &iParamDef, Parameters::ChangeCallback iChangeCallback, bool iInvokeCallback=false)
	Registers a raw parameter (no conversion).
GUIRawVstParam	registerCallback (RawVstParam const &iParamDef, Parameters::ChangeCallback1< GUIRawVstParam > iChangeCallback, bool iInvokeCallback=false)
	Registers a raw parameter (no conversion).
template<typename T>
GUIVstParam< T >	registerCallback (VstParam< T > const &iParamDef, Parameters::ChangeCallback iChangeCallback, bool iInvokeCallback=false)
	Convenient call to register a callback for the Vst param simply by using its description (accessible in state-aware views via fParams->fMyParam).
template<typename T>
GUIVstParam< T >	registerCallback (VstParam< T > const &iParamDef, Parameters::ChangeCallback1< GUIVstParam< T > > iChangeCallback, bool iInvokeCallback=false)
	Convenient call to register a callback for the Vst param simply by using its description (accessible in state-aware views via fParams->fMyParam).
template<typename T>
GUIJmbParam< T >	registerJmbCallback (ParamID iParamID, Parameters::ChangeCallback iChangeCallback, bool iInvokeCallback=false)
	Registers a callback for the Jmb param by its id and return the wrapper to the param.
template<typename T>
GUIJmbParam< T >	registerJmbCallback (ParamID iParamID, Parameters::ChangeCallback1< GUIJmbParam< T > > iChangeCallback, bool iInvokeCallback=false)
	Registers a callback for the Jmb param by its id and return the wrapper to the param.
template<typename T>
GUIJmbParam< T >	registerJmbParam (ParamID iParamID, bool iSubscribeToChanges=true)
	Registers the Jmb param by its id and return the wrapper to the param.
template<typename T>
GUIOptionalParam< T >	registerOptionalCallback (ParamID iParamID, Parameters::ChangeCallback iChangeCallback, bool iInvokeCallback=false)
	Registers an optional parameter which handles Vst, Jmb or no parameter at all.
template<typename T>
GUIOptionalParam< T >	registerOptionalCallback (ParamID iParamID, Parameters::ChangeCallback1< GUIOptionalParam< T > > iChangeCallback, bool iInvokeCallback=false)
	Registers an optional parameter which handles Vst, Jmb or no parameter at all.
GUIOptionalParam< int32 >	registerOptionalDiscreteCallback (ParamID iParamID, int32 iStepCount, Parameters::ChangeCallback iChangeCallback, bool iInvokeCallback=false)
	Registers an optional discrete parameter which handles Vst, Jmb or no parameter at all.
GUIOptionalParam< int32 >	registerOptionalDiscreteCallback (ParamID iParamID, int32 iStepCount, Parameters::ChangeCallback1< GUIOptionalParam< int32 > > iChangeCallback, bool iInvokeCallback=false)
	Registers an optional discrete parameter which handles Vst, Jmb or no parameter at all.
GUIOptionalParam< int32 >	registerOptionalDiscreteParam (ParamID iParamID, int32 iStepCount, bool iSubscribeToChanges=true)
	Registers an optional discrete parameter which handles Vst, Jmb or no parameter at all.
template<typename T>
GUIOptionalParam< T >	registerOptionalParam (ParamID iParamID, bool iSubscribeToChanges=true)
	Registers an optional parameter which handles Vst, Jmb or no parameter at all.
template<typename T>
GUIJmbParam< T >	registerParam (GUIJmbParam< T > &iParam, bool iSubscribeToChanges=true)
	Convenient call to register a Jmb param simply by using the param from the state (accessible in state-aware views via fState->fMyParam).
template<typename T>
GUIJmbParam< T >	registerParam (JmbParam< T > const &iParamDef, bool iSubscribeToChanges=true)
	Convenient call to register a Jmb param simply by using its description (accessible in state-aware views via fParams->fMyParam).
GUIRawVstParam	registerParam (RawVstParam const &iParamDef, bool iSubscribeToChanges=true)
	Registers a raw parameter (no conversion).
template<typename T>
GUIVstParam< T >	registerParam (VstParam< T > const &iParamDef, bool iSubscribeToChanges=true)
	Convenient call to register a Vst param simply by using its description (accessible in state-aware views via fParams->fMyParam).
GUIRawVstParam	registerRawVstCallback (ParamID iParamID, Parameters::ChangeCallback iChangeCallback, bool iInvokeCallback=false)
	Registers a raw parameter (no conversion) The callback will be invoked when the parameter changes.
GUIRawVstParam	registerRawVstCallback (ParamID iParamID, Parameters::ChangeCallback1< GUIRawVstParam > iChangeCallback, bool iInvokeCallback=false)
	Registers a raw parameter (no conversion) The callback will be invoked when the parameter changes.
GUIRawVstParam	registerRawVstParam (ParamID iParamID, bool iSubscribeToChanges=true)
	Registers a raw parameter (no conversion) onParameterChange() will be called on changes (if iSubscribeToChanges is set to true).
GUIVstParam< bool >	registerVstBooleanParam (ParamID iParamID, bool iSubscribeToChanges=true)
template<typename T>
GUIVstParam< T >	registerVstCallback (ParamID iParamID, Parameters::ChangeCallback iChangeCallback, bool iInvokeCallback=false)
	Register a callback for a Vst parameter simply given its id The callback will be invoked when the parameter changes.
template<typename T>
GUIVstParam< T >	registerVstCallback (ParamID iParamID, Parameters::ChangeCallback1< GUIVstParam< T > > iChangeCallback, bool iInvokeCallback=false)
	Register a callback for a Vst parameter simply given its id The callback will be invoked when the parameter changes.
template<typename T>
GUIVstParam< T >	registerVstParam (ParamID iParamID, bool iSubscribeToChanges=true)
	Register a Vst parameter simply given its id onParameterChange() will be called on changes (if iSubscribeToChanges is set to true).
GUIVstParam< Percent >	registerVstPercentParam (ParamID iParamID, bool iSubscribeToChanges=true)
void	unregisterAll ()
	Unregisters all parameters.
template<typename T>
GUIJmbParam< T >	unregisterParam (GUIJmbParam< T > const &iParam)
	Removes the registration of the provided param (closing the connection/stopping to listen).
GUIRawVstParam	unregisterParam (GUIRawVstParam const &iParam)
	Removes the registration of the provided param (closing the connection/stopping to listen).
template<typename T>
GUIVstParam< T >	unregisterParam (GUIVstParam< T > const &iParam)
	Removes the registration of the provided param (closing the connection/stopping to listen).
bool	unregisterParam (ParamID iParamID)
	Removes the registration of the provided param (closing the connection/stopping to listen).
virtual	~ParamAware ()
Public Member Functions inherited from ICustomViewLifecycle
virtual	~ICustomViewLifecycle ()=default
	Destructor (virtual / requirement for interface).

Protected Attributes
int	fFrames {4}
BitmapSPtr	fImage {nullptr}
bool	fInverse {false}
CColor	fOnColor {kRedCColor}
bool	fPressed {false}
int32	fStep {0}
Protected Attributes inherited from CustomDiscreteControlView
int32	fStepCount {-1}
Protected Attributes inherited from TCustomControlView< int32 >
GUIOptionalParam< int32 >	fControlParameter
Protected Attributes inherited from CustomControlView
ParamID	fControlTag {UNDEFINED_PARAM_ID}
Protected Attributes inherited from CustomView
CColor	fBackColor
ParamID	fTag
Protected Attributes inherited from ParamAware
std::unique_ptr< GUIParamCxMgr >	fParamCxMgr {}

Additional Inherited Members
Public Types inherited from TCustomControlView< int32 >
using	Creator
Protected Member Functions inherited from CustomView
bool	sizeToFit (BitmapPtr iBitmap, int iFrameCount=1)
	Convenient call to size to fit this view to match the bitmap.
void	sizeToFit (CCoord iWidth, CCoord iHeight)
	Convenient call to size to fit this view according to the and height provided.

Detailed Description

A discrete button behaves like a toggle button except that it is on only if the control value (tied to a parameter) is equal to the step value (DiscreteButtonView::getStep() / step property in the xml).

Selecting the button will set the underlying parameter to step. This button can be used to implement a radio group button behavior (only one selected at a time).

This view works for any parameter (both Vst and Jmb) that is (or can be interpreted as) a discrete parameter.

In addition to the attributes exposed by CustomDiscreteControlView, this class exposes the following attributes:

Attribute

Description

frames

The number of frames the image contains.

Should be either 2 or 4 (4 includes the pressed state).

See also: getImage() for details

on-color

When no image is provided, back-color is used for the "off" state and on-color for the "on" state (draws a rectangle with this color).

button-image

The image for the button.

The content of the image depends on the attribute frames (getFrames()) with the following convention:

for 2 frames each is of size image height / 2:

y frame

0 the button in its "off" state

image height / 2 the button in its "on" state

Example:

for 4 frames each is of size image height / 4:

y	frame
0	the button in its "off" state
image height * 1/4	the button in its "off" state depressed
image height * 2/4	the button in its "on" state
image height * 3/4	the button in its "on" state depressed

Example: 4 frames example

inverse

Inverses the meaning of "on" and "off" in regards to drawing the view/image.

step

The value used to check whether the button is "on" or "off" as well as the value to set the parameter to when the button is selected.

See also: CustomDiscreteControlView for details on discrete parameters and the usage of step-count

Constructor & Destructor Documentation

◆ DiscreteButtonView()

DiscreteButtonView ( const CRect & iSize )

inlineexplicit

Member Function Documentation

◆ draw()

void draw ( CDrawContext * iContext )

override

◆ getFrames()

int getFrames ( ) const

inline

The number of frames the image contains.

Should be either 2 or 4 (4 includes the pressed state).

See also: getImage() for details

◆ getImage()

BitmapPtr getImage ( ) const

inline

The image for the button.

The content of the image depends on the attribute frames (getFrames()) with the following convention:

for 2 frames each is of size image height / 2:

y frame

0 the button in its "off" state

image height / 2 the button in its "on" state

Example:

for 4 frames each is of size image height / 4:

y	frame
0	the button in its "off" state
image height * 1/4	the button in its "off" state depressed
image height * 2/4	the button in its "on" state
image height * 3/4	the button in its "on" state depressed

Example: 4 frames example

◆ getInverse()

bool getInverse ( ) const

inline

Inverses the meaning of "on" and "off" in regards to drawing the view/image.

◆ getOnColor()

CColor const & getOnColor ( ) const

inline

When no image is provided, back-color is used for the "off" state and on-color for the "on" state (draws a rectangle with this color).

◆ getStep()

int32 getStep ( ) const

inline

The value used to check whether the button is "on" or "off" as well as the value to set the parameter to when the button is selected.

◆ isOff()

bool isOff ( ) const

inline

◆ isOn()

bool isOn ( ) const

◆ onKeyDown()

int32_t onKeyDown ( VstKeyCode & keyCode )

override

◆ onKeyUp()

int32_t onKeyUp ( VstKeyCode & keyCode )

override

◆ onMouseCancel()

CMouseEventResult onMouseCancel ( )

override

◆ onMouseDown()

CMouseEventResult onMouseDown	(	CPoint &	where,
		const CButtonState &	buttons )

override

◆ onMouseUp()

CMouseEventResult onMouseUp	(	CPoint &	where,
		const CButtonState &	buttons )

override

◆ registerParameters()

void registerParameters ( )

overridevirtual

Registers the optional parameter using getControlTag() as its id.

Reimplemented from CustomDiscreteControlView.

◆ setFrames()

void setFrames ( int iFrames )

◆ setImage()

void setImage ( BitmapPtr iImage )

inline

◆ setInverse()

void setInverse ( bool iInverse )

inline

Attribute inverse.

◆ setOn()

void setOn ( )

◆ setOnColor()

void setOnColor ( CColor const & iColor )

inline

◆ setStep()

void setStep ( int32 step )

◆ sizeToFit()

bool sizeToFit ( )

override

Member Data Documentation

◆ fFrames

int fFrames {4}

protected

◆ fImage

BitmapSPtr fImage {nullptr}

protected

◆ fInverse

bool fInverse {false}

protected

◆ fOnColor

CColor fOnColor {kRedCColor}

protected

◆ fPressed

bool fPressed {false}

protected

◆ fStep

int32 fStep {0}

protected

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

pongasoft/VST/GUI/Views/DiscreteButtonView.h
pongasoft/VST/GUI/Views/DiscreteButtonView.cpp

y	frame
0	the button in its "off" state
image height / 2	the button in its "on" state

Classes

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DiscreteButtonView()

Member Function Documentation

◆ draw()

◆ getFrames()

◆ getImage()

◆ getInverse()

◆ getOnColor()

◆ getStep()

◆ isOff()

◆ isOn()

◆ onKeyDown()

◆ onKeyUp()

◆ onMouseCancel()

◆ onMouseDown()

◆ onMouseUp()

◆ registerParameters()

◆ setFrames()

◆ setImage()

◆ setInverse()

◆ setOn()

◆ setOnColor()

◆ setStep()

◆ sizeToFit()

Member Data Documentation

◆ fFrames

◆ fImage

◆ fInverse

◆ fOnColor

◆ fPressed

◆ fStep