ASPiK SDK
VSTGUI::CAnimKnobEx Class Reference

The CAnimKnobEx object extends the VSTGUI CAnimKnob object with extra functionality.
It is used in the PluginGUI object for creating custom views. More...

#include <customcontrols.h>

Inheritance diagram for VSTGUI::CAnimKnobEx:

Public Member Functions

 CAnimKnobEx (const CRect &size, IControlListener *listener, int32_t tag, int32_t subPixmaps, CCoord heightOfOneImage, CBitmap *background, const CPoint &offset, bool bSwitchKnob=false)
 
virtual void draw (CDrawContext *pContext) override
 
CMouseEventResult onMouseUp (CPoint &where, const CButtonState &buttons) override
 handle mouse up event More...
 
CMouseEventResult onMouseDown (CPoint &where, const CButtonState &buttons) override
 handle mouse down event More...
 
virtual CMouseEventResult onMouseMoved (CPoint &where, const CButtonState &buttons) override
 handle mouse moved event More...
 
bool checkDefaultValue (CButtonState button) override
 
virtual void valueChanged () override
 
void setSwitchMax (float f)
 set max discrete switching value More...
 
bool isSwitchKnob ()
 query if control is in "switch" mode More...
 
void setAAXKnob (bool b)
 sets the AAX flag for this control More...
 
bool isAAXKnob ()
 query if control wants Pro Tools keyboard modifiers More...
 
 CAnimKnobEx (const CRect &size, IControlListener *listener, int32_t tag, int32_t subPixmaps, CCoord heightOfOneImage, CBitmap *background, const CPoint &offset, bool bSwitchKnob=false)
 
virtual void draw (CDrawContext *pContext) override
 
CMouseEventResult onMouseUp (CPoint &where, const CButtonState &buttons) override
 handle mouse up event More...
 
CMouseEventResult onMouseDown (CPoint &where, const CButtonState &buttons) override
 handle mouse down event More...
 
virtual CMouseEventResult onMouseMoved (CPoint &where, const CButtonState &buttons) override
 handle mouse moved event More...
 
bool checkDefaultValue (CButtonState button) override
 
virtual void valueChanged () override
 
void setSwitchMax (float f)
 set max discrete switching value More...
 
bool isSwitchKnob ()
 query if control is in "switch" mode More...
 
void setAAXKnob (bool b)
 sets the AAX flag for this control More...
 
bool isAAXKnob ()
 query if control wants Pro Tools keyboard modifiers More...
 

Protected Attributes

bool switchKnob = false
 
bool aaxKnob = false
 
float maxControlValue = 1.0
 

Detailed Description

The CAnimKnobEx object extends the VSTGUI CAnimKnob object with extra functionality.
It is used in the PluginGUI object for creating custom views.

Author
Will Pirkle http://www.willpirkle.com
Remarks
This object is included in Designing Audio Effects Plugins in C++ 2nd Ed. by Will Pirkle
Version
Revision : 1.0
Date
Date : 2018 / 09 / 7

Member Function Documentation

◆ isAAXKnob() [1/2]

bool VSTGUI::CAnimKnobEx::isAAXKnob ( )
inline

query if control wants Pro Tools keyboard modifiers

Returns
true if in "switch" mode

◆ isAAXKnob() [2/2]

bool VSTGUI::CAnimKnobEx::isAAXKnob ( )
inline

query if control wants Pro Tools keyboard modifiers

Returns
true if in "switch" mode

◆ isSwitchKnob() [1/2]

bool VSTGUI::CAnimKnobEx::isSwitchKnob ( )
inline

query if control is in "switch" mode

Returns
true if in "switch" mode

◆ isSwitchKnob() [2/2]

bool VSTGUI::CAnimKnobEx::isSwitchKnob ( )
inline

query if control is in "switch" mode

Returns
true if in "switch" mode

◆ onMouseDown() [1/2]

CMouseEventResult VSTGUI::CAnimKnobEx::onMouseDown ( CPoint &  where,
const CButtonState &  buttons 
)
override

handle mouse down event

Parameters
where- coordinates of mouse event
buttons- button state during mouse event

◆ onMouseDown() [2/2]

CMouseEventResult VSTGUI::CAnimKnobEx::onMouseDown ( CPoint &  where,
const CButtonState &  buttons 
)
override

handle mouse down event

Parameters
where- coordinates of mouse event
buttons- button state during mouse event

◆ onMouseMoved() [1/2]

virtual CMouseEventResult VSTGUI::CAnimKnobEx::onMouseMoved ( CPoint &  where,
const CButtonState &  buttons 
)
overridevirtual

handle mouse moved event

Parameters
where- coordinates of mouse event
buttons- button state during mouse event

◆ onMouseMoved() [2/2]

CMouseEventResult VSTGUI::CAnimKnobEx::onMouseMoved ( CPoint &  where,
const CButtonState &  buttons 
)
overridevirtual

handle mouse moved event

Parameters
where- coordinates of mouse event
buttons- button state during mouse event

◆ onMouseUp() [1/2]

CMouseEventResult VSTGUI::CAnimKnobEx::onMouseUp ( CPoint &  where,
const CButtonState &  buttons 
)
override

handle mouse up event

Parameters
where- coordinates of mouse event
buttons- button state during mouse event

◆ onMouseUp() [2/2]

CMouseEventResult VSTGUI::CAnimKnobEx::onMouseUp ( CPoint &  where,
const CButtonState &  buttons 
)
override

handle mouse up event

Parameters
where- coordinates of mouse event
buttons- button state during mouse event

◆ setAAXKnob() [1/2]

void VSTGUI::CAnimKnobEx::setAAXKnob ( bool  b)
inline

sets the AAX flag for this control

Parameters
bflag to enable AAX mode

◆ setAAXKnob() [2/2]

void VSTGUI::CAnimKnobEx::setAAXKnob ( bool  b)
inline

sets the AAX flag for this control

Parameters
bflag to enable AAX mode

◆ setSwitchMax() [1/2]

void VSTGUI::CAnimKnobEx::setSwitchMax ( float  f)
inline

set max discrete switching value

Parameters
f- the max value as a float

◆ setSwitchMax() [2/2]

void VSTGUI::CAnimKnobEx::setSwitchMax ( float  f)
inline

set max discrete switching value

Parameters
f- the max value as a float

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