The lowest level base class of an IGraphics control. More...

#include <IControl.h>

Inherited by GFXLabelControl, IBitmapControl, IBubbleControl, IButtonControlBase, IColorPickerControl, ICornerResizerControl, IDirBrowseControlBase, IFPSDisplayControl, IGraphicsLiveEdit, IKnobControlBase, ILambdaControl, ILEDControl, IPanelControl, IPopupMenuControl, IShaderControl, ISkLottieControl, ISkParagraphControl, ISliderControlBase, ISVGControl, ISwitchControlBase, ITextControl, ITextEntryControl, IVBakedPresetManagerControl, IVColorSwatchControl, IVDisplayControl, IVGroupControl, IVKeyboardControl, IVNumberBoxControl, IVPanelControl, IVPlotControl, IVScopeControl< MAXNC, MAXBUF >, IVTrackControlBase, IVXYPadControl, IWebViewControl, TestAnimationControl, TestBezierControl, TestColorControl, TestCursorControl, TestDrawContextControl, TestDropShadowControl, TestFlexBoxControl, TestFontControl, TestGLControl, TestImageControl, TestKeyboardControl, TestMPSControl, TestMTControl, TestShadowGradientControl, TestSizeControl, TestSVGControl, and TestTextControl.

Public Member Functions
	IControl (const IRECT &bounds, int paramIdx=kNoParameter, IActionFunction actionFunc=nullptr)
	Constructor. More...

	IControl (const IRECT &bounds, const std::initializer_list< int > &params, IActionFunction actionFunc=nullptr)
	Constructor (range of parameters) More...

	IControl (const IRECT &bounds, IActionFunction actionFunc)
	Constructor (no paramIdx) More...

	IControl (const IControl &)=delete

void	operator= (const IControl &)=delete

virtual	~IControl ()
	Destructor. More...

virtual void	OnMouseDown (float x, float y, const IMouseMod &mod)
	Implement this method to respond to a mouse down event on this control. More...

virtual void	OnMouseUp (float x, float y, const IMouseMod &mod)
	Implement this method to respond to a mouse up event on this control. More...

virtual void	OnMouseDrag (float x, float y, float dX, float dY, const IMouseMod &mod)
	Implement this method to respond to a mouse drag event on this control. More...

virtual void	OnMouseDblClick (float x, float y, const IMouseMod &mod)
	Implement this method to respond to a mouse double click event on this control. More...

virtual void	OnMouseWheel (float x, float y, const IMouseMod &mod, float d)
	Implement this method to respond to a mouse wheel event on this control. More...

virtual bool	OnKeyDown (float x, float y, const IKeyPress &key)
	Implement this method to respond to a key down event on this control. More...

virtual bool	OnKeyUp (float x, float y, const IKeyPress &key)
	Implement this method to respond to a key up event on this control. More...

virtual void	OnMouseOver (float x, float y, const IMouseMod &mod)
	Implement this method to respond to a mouseover event on this control. More...

virtual void	OnMouseOut ()
	Implement this method to respond to a mouseout event on this control. More...

virtual void	OnTouchCancelled (float x, float y, const IMouseMod &mod)
	Implement this method to respond to a touch cancel event on this control. More...

virtual void	OnDrop (const char *str)
	Implement to do something when something was drag 'n dropped onto this control.

virtual void	OnRescale ()
	Implement to do something when graphics is scaled globally (e.g. More...

virtual void	OnResize ()
	Called when IControl is constructed or resized using SetRect(). More...

virtual void	OnInit ()
	Called just prior to when the control is attached, after its delegate and graphics member variable set.

virtual void	OnAttached ()
	Called after the control has been attached, and its delegate and graphics member variable set. More...

virtual void	OnMsgFromDelegate (int msgTag, int dataSize, const void *pData)
	Implement to receive messages sent to the control, see IEditorDelegate:SendControlMsgFromDelegate()

virtual void	OnMidi (const IMidiMsg &msg)
	Implement to receive MIDI messages sent to the control if mWantsMidi == true, see IEditorDelegate:SendMidiMsgFromDelegate()

virtual bool	OnGesture (const IGestureInfo &info)

virtual void	CreateContextMenu (IPopupMenu &contextMenu)
	Called by default when the user right clicks a control. More...

virtual void	OnPopupMenuSelection (IPopupMenu *pSelectedMenu, int valIdx)
	Implement this method to handle popup menu selection after IGraphics::CreatePopupMenu/IControl::PromptUserInput. More...

virtual void	OnTextEntryCompletion (const char *str, int valIdx)
	Implement this method to handle text input after IGraphics::CreateTextEntry/IControl::PromptUserInput. More...

virtual void	OnContextSelection (int itemSelected)
	Implement this to respond to a menu selection from CreateContextMenu();. More...

virtual void	Draw (IGraphics &g)=0
	Draw the control to the graphics context. More...

virtual void	DrawPTHighlight (IGraphics &g)
	Implement this to customise how a colored highlight is drawn on the control in ProTools (AAX format only), when a control is linked to a parameter that is automated. More...

void	PromptUserInput (int valIdx=0)
	Call this method in response to a mouse event to create an edit box so the user can enter a value, or pop up a pop-up menu, if the control is linked to a parameter (mParamIdx > kNoParameter) More...

void	PromptUserInput (const IRECT &bounds, int valIdx=0)
	Create a text entry box so the user can enter a value, or pop up a pop-up menu, if the control is linked to a parameter (mParamIdx > kNoParameter) specifying the bounds. More...

IControl *	SetActionFunction (IActionFunction actionFunc)
	Set an Action Function for this control. More...

IControl *	SetAnimationEndActionFunction (IActionFunction actionFunc)
	Set an Action Function to be called at the end of an animation. More...

void	SetTooltip (const char *str)
	Set a tooltip for the control. More...

const char *	GetTooltip () const

int	GetParamIdx (int valIdx=0) const
	Get the index of a parameter that the control is linked to Normaly controls are either linked to a single parameter or no parameter but some may be linked to multiple parameters. More...

virtual void	SetParamIdx (int paramIdx, int valIdx=0)
	Set the index of a parameter that the control is linked to If you are calling this "manually" to reuse a control for multiple parameters, you probably want to call IEditorDelegate::SendCurrentParamValuesFromDelegate() afterward, to update the control values. More...

int	LinkedToParam (int paramIdx) const
	Check if the control is linked to a particular parameter. More...

int	NVals () const

virtual int	GetValIdxForPos (float x, float y) const
	Check to see which of the control's values relates to this x and y coordinate. More...

const IParam *	GetParam (int valIdx=0) const
	Get a const pointer to the IParam object (owned by the editor delegate class), associated with this control. More...

virtual void	SetValueFromDelegate (double value, int valIdx=0)
	Set the control's value from the delegate This method is called from the class implementing the IEditorDelegate interface in order to update a control's value members and set it to be marked dirty for redraw. More...

virtual void	SetValueFromUserInput (double value, int valIdx=0)
	Set the control's value after user input. More...

virtual void	SetValueToDefault (int valIdx=kNoValIdx)
	Set one or all of the control's values to the default value of the associated parameter. More...

virtual void	SetValue (double value, int valIdx=0)
	Set one of the control's values. More...

double	GetValue (int valIdx=0) const
	Get the control's value. More...

void	SetGroup (const char *groupName)
	Assign the control to a control group. More...

const char *	GetGroup () const
	Get the group that the control belongs to, if any. More...

const IText &	GetText () const
	Get the Text object for the control. More...

virtual void	SetText (const IText &txt)
	Set the Text object typically used to determine font/layout/size etc of the main text in a control. More...

void	SetBlend (const IBlend &blend)
	Set the Blend for this control. More...

IBlend	GetBlend () const
	Get the Blend for this control.

int	GetTextEntryLength () const
	Get the max number of characters that are allowed in text entry. More...

void	SetTextEntryLength (int len)
	Set the max number of characters that are allowed in text entry. More...

const IRECT &	GetRECT () const
	Get the rectangular draw area for this control, within the graphics context. More...

void	SetRECT (const IRECT &bounds)
	Set the rectangular draw area for this control, within the graphics context. More...

const IRECT &	GetTargetRECT () const
	Get the rectangular mouse tracking target area, within the graphics context for this control. More...

void	SetTargetRECT (const IRECT &bounds)
	Set the rectangular mouse tracking target area, within the graphics context for this control. More...

void	SetTargetAndDrawRECTs (const IRECT &bounds)
	Set BOTH the draw rect and the target area, within the graphics context for this control. More...

virtual void	SetPosition (float x, float y)
	Set the position of the control, preserving the width and height. More...

virtual void	SetSize (float w, float h)
	Set the size of the control, preserving the current position. More...

void	SetPTParameterHighlight (bool isHighlighted, int color)
	Used internally by the AAX wrapper view interface to set the control parmeter highlight. More...

bool	GetMouseDblAsSingleClick () const
	Get double click as single click By default, mouse double click has its own handler. More...

virtual void	Hide (bool hide)
	Shows or hides the IControl. More...

bool	IsHidden () const

virtual void	SetDisabled (bool disable)
	Sets disabled mode for the control, the default implementation modifies the mBlend member. More...

bool	IsDisabled () const

void	SetMouseOverWhenDisabled (bool allow)
	Specify whether the control should respond to mouse overs when disabled. More...

void	SetMouseEventsWhenDisabled (bool allow)
	Specify whether the control should respond to other mouse events when disabled. More...

bool	GetMouseOverWhenDisabled () const

bool	GetMouseEventsWhenDisabled () const

bool	GetIgnoreMouse () const

bool	GetPromptShowsParamLabel () const

void	SetPromptShowsParamLabel (bool enable)
	Set if the control should show parameter labels/units e.g. More...

virtual bool	IsHit (float x, float y) const
	Hit test the control. More...

virtual void	SetDirty (bool triggerAction=true, int valIdx=kNoValIdx)
	Mark the control as dirty, i.e. More...

virtual void	SetClean ()

void	Animate ()

virtual bool	IsDirty ()
	Called at each display refresh by the IGraphics draw loop, after IControl::Animate(), to determine if the control is marked as dirty. More...

void	DisablePrompt (bool disable)
	Disable/enable default prompt for user input. More...

virtual void	OnGUIIdle ()
	This is an idle timer tick call on the GUI thread, only active if USE_IDLE_CALLS is defined.

int	GetTag () const
	Get the control's tag. More...

void	SetWantsMidi (bool enable=true)
	Specify whether this control wants to know about MIDI messages sent to the UI. More...

bool	GetWantsMidi () const

void	SetWantsMultiTouch (bool enable=true)
	Specify whether this control supports multiple touches.

bool	GetWantsMultiTouch () const

IControl *	AttachGestureRecognizer (EGestureType type, IGestureFunc func)
	Add a IGestureFunc that should be triggered in response to a certain type of gesture. More...

bool	GetWantsGestures () const

EGestureType	GetLastGesture () const

IGEditorDelegate *	GetDelegate ()
	Gets a pointer to the class implementing the IEditorDelegate interface that handles parameter changes from this IGraphics instance. More...

void	SetDelegate (IGEditorDelegate &dlg)
	Used internally to set the mDelegate (and mGraphics) variables.

IGraphics *	GetUI ()

const IGraphics *	GetUI () const

bool	GetMouseIsOver () const
	This can be used in IControl::Draw() to check if the mouse is over the control, without implementing mouse over methods. More...

virtual void	SnapToMouse (float x, float y, EDirection direction, const IRECT &bounds, int valIdx=-1, double minClip=0., double maxClip=1.)
	Set control value based on x, y position within a rectangle. More...

virtual void	OnEndAnimation ()

void	StartAnimation (int duration)

void	SetAnimation (IAnimationFunction func)
	Set the animation function. More...

void	SetAnimation (IAnimationFunction func, int duration)
	Set the animation function and starts it. More...

IAnimationFunction	GetAnimationFunction ()
	Get the control's animation function, if it exists.

IActionFunction	GetActionFunction ()
	Get the control's action function, if it exists.

double	GetAnimationProgress () const
	Get the progress in a control's animation, in the range 0-1.

Milliseconds	GetAnimationDuration () const
	Get the duration of animations applied to the control.

template<class T >
T *	As ()
	Helper function to dynamic cast an IControl to a subclass.

Protected Member Functions
template<typename T , typename... Args>
void	ForValIdx (int valIdx, T func, Args...args)
	A helper template function to call a method for an individual value, or for all values. More...

void	SetNVals (int nVals)

Protected Attributes
IRECT	mRECT

IRECT	mTargetRECT

WDL_String	mGroup
	Controls can be grouped for hiding and showing panels.

IText	mText

IBlend	mBlend

int	mTextEntryLength = DEFAULT_TEXT_ENTRY_LEN

bool	mDirty = true

bool	mHide = false

bool	mDisabled = false

bool	mDisablePrompt = true

bool	mDblAsSingleClick = false

bool	mMouseOverWhenDisabled = false

bool	mMouseEventsWhenDisabled = false

bool	mIgnoreMouse = false

bool	mWantsMidi = false

bool	mWantsMultiTouch = false

bool	mPromptShowsParamLabel = false

bool	mMouseIsOver = false
	if mGraphics::mHandleMouseOver = true, this will be true when the mouse is over control. More...

WDL_String	mTooltip

IColor	mPTHighlightColor = COLOR_RED

bool	mPTisHighlighted = false

Detailed Description

The lowest level base class of an IGraphics control.

A control is anything on the GUI

Definition at line 42 of file IControl.h.

Constructor & Destructor Documentation

IControl::IControl	(	const IRECT &	bounds,
		int	paramIdx = `kNoParameter`,
		IActionFunction	actionFunc = `nullptr`
	)

Constructor.

Creates an IControl NOTE: An IControl does not know about the delegate or graphics context to which it belongs in the constructor If you need to do something once those things are known, see IControl::OnInit()

Parameters

bounds	The rectangular area that the control occupies
paramIdx	If this is > -1 (kNoParameter) this control will be associated with a plugin parameter
actionFunc	pass in a lambda function to provide custom functionality when the control "action" happens (usually mouse down).

Definition at line 81 of file IControl.cpp.

Referenced by IVPlotControl::AddPlotFunc(), GetAnimationProgress(), IBitmapControl::IBitmapControl(), IButtonControlBase::OnMouseDown(), IVRangeSliderControl::OnMouseDrag(), IKnobControlBase::OnMouseWheel(), IVGroupControl::OnResize(), and PlaceHolder::OnResize().

IControl::IControl	(	const IRECT &	bounds,
		const std::initializer_list< int > &	params,
		IActionFunction	actionFunc = `nullptr`
	)

Constructor (range of parameters)

Creates an IControl which is linked to multiple parameters NOTE: An IControl does not know about the delegate or graphics context to which it belongs in the constructor If you need to do something once those things are known, see IControl::OnInit()

Parameters

bounds	The rectangular area that the control occupies
params	An initializer list of valid integer parameter indexes
actionFunc	pass in a lambda function to provide custom functionality when the control "action" happens (usually mouse down).

Definition at line 89 of file IControl.cpp.

IControl::IControl	(	const IRECT &	bounds,
		IActionFunction	actionFunc
	)

Constructor (no paramIdx)

Creates an IControl which is not linked to a parameter NOTE: An IControl does not know about the delegate or graphics context to which it belongs in the constructor If you need to do something once those things are known, see IControl::OnInit()

Parameters

bounds	The rectangular area that the control occupies
actionFunc	pass in a lambda function to provide custom functionality when the control "action" happens (usually mouse down).

Definition at line 100 of file IControl.cpp.

virtual IControl::~IControl ( )

inlinevirtual

Destructor.

Clean up any resources that your control owns.

Definition at line 79 of file IControl.h.

References OnMouseDown().

Member Function Documentation

IControl * IControl::AttachGestureRecognizer	(	EGestureType	type,
		IGestureFunc	func
	)

Add a IGestureFunc that should be triggered in response to a certain type of gesture.

Parameters

type	The type of gesture to recognize on this control
func	the function to trigger

Definition at line 309 of file IControl.cpp.

References IGraphics::AttachGestureRecognizer(), and GetUI().

Referenced by IGraphics::AttachGestureRecognizerToRegion(), GetWantsMultiTouch(), and TestGesturesControl::OnInit().

virtual void IControl::CreateContextMenu ( IPopupMenu & contextMenu )

inlinevirtual

Called by default when the user right clicks a control.

If IGRAPHICS_NO_CONTEXT_MENU is enabled as a preprocessor macro right clicking control will mean IControl::CreateContextMenu() and IControl::OnContextSelection() do not function on right clicking control. VST3 provides contextual menu support which is hard wired to right click controls by default. You can add custom items to the menu by implementing IControl::CreateContextMenu() and handle them in IControl::OnContextSelection(). In non-VST 3 hosts right clicking will still create the menu, but it will not feature entries added by the host.

Definition at line 166 of file IControl.h.

References OnPopupMenuSelection().

Referenced by IGraphics::PopupHostContextMenuForParam().

void IControl::DisablePrompt ( bool disable )

inline

Disable/enable default prompt for user input.

Parameters

disable Set true to disable prompt

Definition at line 405 of file IControl.h.

Referenced by IVRadioButtonControl::GetButtonForPoint(), and IVKnobControl::OnInit().

virtual void IControl::Draw ( IGraphics & g )

pure virtual

Draw the control to the graphics context.

Parameters

g	The graphics context to which this control belongs.

Implemented in PlaceHolder, ICaptionControl, IURLControl, ITextControl, ISVGControl, IBitmapControl, ILambdaControl, IPanelControl, IWheelControl, IBTextControl, IBSliderControl, IBKnobRotaterControl, IBKnobControl, IBSwitchControl, IBButtonControl, ISVGSliderControl, ISVGSwitchControl, ISVGButtonControl, ISVGKnobControl, IVColorSwatchControl, IVPanelControl, IVGroupControl, IVPlotControl, IVXYPadControl, IVRangeSliderControl, IVSliderControl, IGraphicsLiveEdit, IVKnobControl, IVKeyboardControl, TestGLControl, IVTabSwitchControl, IVDiskPresetManagerControl, IVLEDMeterControl< MAXNC >, IBubbleControl, IVSlideSwitchControl, TestKeyboardControl, IShaderControl, IVSwitchControl, TestMPSControl, IVMultiSliderControl< MAXNC >, IFPSDisplayControl, IWebViewControl, ISkParagraphControl, IVDisplayControl, IVButtonControl, IPopupMenuControl, IVNumberBoxControl, TestAnimationControl, IVLabelControl, ITextEntryControl, IVScopeControl< MAXNC, MAXBUF >, ISkLottieControl, ILEDControl, TestFlexBoxControl, TestColorControl, TestDirBrowseControl, ICornerResizerControl, IVMeterControl< MAXNC >, IVBakedPresetManagerControl, TestTextSizeControl, IColorPickerControl, TestTextOrientationControl, TestBezierControl, TestFontControl, TestBlendControl, TestGesturesControl, TestArcControl, TestDropShadowControl, TestMTControl, TestSVGControl, TestGradientControl, TestImageControl, TestMultiPathControl, TestSizeControl, TestTextControl, TestCursorControl, TestDrawContextControl, GFXLabelControl, TestLayerControl, TestPolyControl, TestShadowGradientControl, and TestMaskControl.

Referenced by IGraphics::BeginFrame(), and OnContextSelection().

void IControl::DrawPTHighlight ( IGraphics & g )

virtual

Implement this to customise how a colored highlight is drawn on the control in ProTools (AAX format only), when a control is linked to a parameter that is automated.

Parameters

g	The graphics context to which this control belongs.

Definition at line 387 of file IControl.cpp.

References IGraphics::FillCircle(), IRECT::R, and IRECT::T.

Referenced by IGraphics::BeginFrame(), and OnContextSelection().

template<typename T , typename... Args>

void IControl::ForValIdx	(	int	valIdx,
		T	func,
		Args...	args
	)

inlineprotected

A helper template function to call a method for an individual value, or for all values.

Parameters

valIdx	If this is > kNoValIdx execute the function for an individual value. If equal to kNoValIdx call the function for all values
func	A function that takes a single integer argument, the valIdx

Todo:

Parameters

args	Arguments to the function

Definition at line 512 of file IControl.h.

References NVals().

Referenced by SetDirty(), SetValueToDefault(), and SnapToMouse().

IGEditorDelegate* IControl::GetDelegate ( )

inline

Gets a pointer to the class implementing the IEditorDelegate interface that handles parameter changes from this IGraphics instance.

If you need to call other methods on that class, you can use static_cast<PLUG_CLASS_NAME>(GetDelegate();

Returns: The class implementing the IEditorDelegate interface that handles communication to/from from this IGraphics instance.

Definition at line 439 of file IControl.h.

Referenced by IGraphics::AttachBackground(), IGraphics::AttachBubbleControl(), IGraphics::AttachControl(), IGraphics::AttachCornerResizer(), IGraphics::AttachPanelBackground(), IGraphics::AttachPopupMenuControl(), IGraphics::AttachSVGBackground(), IGraphics::AttachTextEntryControl(), IVKeyboardControl::Draw(), IGraphics::EnableLiveEdit(), IWheelControl::IWheelControl(), IVNumberBoxControl::OnMouseDown(), IGraphics::OnMouseDown(), IVNumberBoxControl::OnMouseUp(), IGraphics::OnMouseUp(), IVBakedPresetManagerControl::OnPopupMenuSelection(), IWheelControl::OnPopupMenuSelection(), IGraphics::PopupHostContextMenuForParam(), IGraphics::Resize(), IGraphics::SetControlValueAfterPopupMenu(), SetDirty(), IVTrackControlBase::SetParamsByGroup(), IGraphics::SetQwertyMidiKeyHandlerFunc(), IGraphics::SetScreenScale(), and IGraphics::ShowFPSDisplay().

const char* IControl::GetGroup ( ) const

inline

Get the group that the control belongs to, if any.

Returns: A CString indicating the control group that this control belongs to (may be empty)

Definition at line 278 of file IControl.h.

References mGroup.

Referenced by IGraphics::ForControlInGroup().

bool IControl::GetIgnoreMouse ( ) const

inline

Returns: true if the control ignores mouse events

Definition at line 373 of file IControl.h.

Referenced by IGraphics::ReleaseMouseCapture().

EGestureType IControl::GetLastGesture ( ) const

inline

Returns: the last recognized gesture

Definition at line 434 of file IControl.h.

bool IControl::GetMouseDblAsSingleClick ( ) const

inline

Get double click as single click By default, mouse double click has its own handler.

A control can set mDblAsSingleClick to true which maps double click to single click for this control (and also causes the mouse to be captured by the control on double click).

Returns: /c true if double clicks should be mapped to single clicks

Definition at line 342 of file IControl.h.

References Hide().

Referenced by IGraphics::OnMouseDblClick().

bool IControl::GetMouseEventsWhenDisabled ( ) const

inline

Returns: true if the control responds to other mouse events when disabled

Definition at line 370 of file IControl.h.

Referenced by IGraphics::ReleaseMouseCapture().

bool IControl::GetMouseIsOver ( ) const

inline

This can be used in IControl::Draw() to check if the mouse is over the control, without implementing mouse over methods.

Note that this method is only enabled if IGraphics::EnableMouseOver() is set to true

Returns: if the mouse is over this control.

Definition at line 459 of file IControl.h.

References mMouseIsOver, SnapToMouse(), and StartAnimation().

Referenced by ICornerResizerControl::Draw(), and ICaptionControl::Draw().

bool IControl::GetMouseOverWhenDisabled ( ) const

inline

Returns: true if the control responds to mouse overs when disabled

Definition at line 367 of file IControl.h.

Referenced by IGraphics::ReleaseMouseCapture().

const IParam * IControl::GetParam ( int valIdx = 0 ) const

Get a const pointer to the IParam object (owned by the editor delegate class), associated with this control.

Returns: const pointer to an IParam or nullptr if the control is not associated with a parameter

Definition at line 120 of file IControl.cpp.

References IEditorDelegate::GetParam(), and GetParamIdx().

Referenced by ICaptionControl::Draw(), GetValIdxForPos(), IVNumberBoxControl::OnInit(), IVSwitchControl::OnInit(), IVTabSwitchControl::OnInit(), IVKnobControl::OnInit(), IVSliderControl::OnInit(), ISwitchControlBase::OnInit(), ITextEntryControl::OnKeyDown(), IVNumberBoxControl::OnMouseDown(), ISliderControlBase::OnMouseDown(), IKnobControlBase::OnMouseDrag(), ISliderControlBase::OnMouseDrag(), IVNumberBoxControl::OnMouseUp(), IKnobControlBase::OnMouseWheel(), ISliderControlBase::OnMouseWheel(), OnPopupMenuSelection(), ICaptionControl::OnResize(), PromptUserInput(), IGraphics::PromptUserInput(), IVSwitchControl::SetDirty(), IVKnobControl::SetDirty(), IVSliderControl::SetDirty(), IVTrackControlBase::SetParams(), IVNumberBoxControl::SetStyle(), IVNumberBoxControl::SetValueFromDelegate(), IVNumberBoxControl::SetValueFromUserInput(), SetValueToDefault(), ShowBubbleHorizontalActionFunc(), and ShowBubbleVerticalActionFunc().

int IControl::GetParamIdx ( int valIdx = 0 ) const

Get the index of a parameter that the control is linked to Normaly controls are either linked to a single parameter or no parameter but some may be linked to multiple parameters.

Parameters

valIdx An index to choose which of the controls linked parameters to retrieve. NOTE: since controls usually have only 1 parameter you can omit this argument and use the default index of 0

Returns: Parameter index, or kNoParameter if there is no parameter linked with this control at valIdx

Definition at line 107 of file IControl.cpp.

References NVals().

Referenced by IGraphics::CreateTextEntry(), GetParam(), IGraphics::GetParamIdxForPTAutomation(), GetTooltip(), ISwitchControlBase::OnInit(), IVNumberBoxControl::OnMouseDown(), IGraphics::OnMouseDown(), IVNumberBoxControl::OnMouseUp(), IGraphics::OnMouseUp(), OnPopupMenuSelection(), PromptUserInput(), IGEditorDelegate::SendParameterValueFromDelegate(), SetDirty(), and IGraphics::UpdatePeers().

bool IControl::GetPromptShowsParamLabel ( ) const

inline

Returns: true if the control should show parameter labels/units e.g. "Hz" in text entry prompts

Definition at line 376 of file IControl.h.

Referenced by IGraphics::PromptUserInput().

const IRECT& IControl::GetRECT ( ) const

inline

Get the rectangular draw area for this control, within the graphics context.

Returns: The control's bounds

Definition at line 305 of file IControl.h.

Referenced by IGraphics::BeginFrame(), IVNumberBoxControl::Draw(), IGraphicsLiveEdit::Draw(), IGraphics::IsDirty(), ITextEntryControl::OnKeyDown(), IVNumberBoxControl::OnMouseDblClick(), IGraphicsLiveEdit::OnMouseDown(), IGraphicsLiveEdit::OnMouseDrag(), IGraphicsLiveEdit::OnMouseOver(), IGraphicsLiveEdit::OnMouseUp(), IVNumberBoxControl::OnResize(), IGraphics::ReleaseMouseCapture(), IBubbleControl::SetStrokeColor(), ShowBubbleHorizontalActionFunc(), ShowBubbleVerticalActionFunc(), and IGraphics::StartLayer().

int IControl::GetTag ( ) const

inline

Get the control's tag.

See also: Control Tags

Definition at line 411 of file IControl.h.

References IGraphics::GetControlTag(), and GetUI().

Referenced by IWheelControl::OnPopupMenuSelection(), IGraphics::RemoveControl(), and IGraphics::RemoveControls().

const IRECT& IControl::GetTargetRECT ( ) const

inline

Get the rectangular mouse tracking target area, within the graphics context for this control.

Returns: The control's target bounds within the graphics context

Definition at line 313 of file IControl.h.

Referenced by IGraphicsLiveEdit::OnMouseDown().

const IText& IControl::GetText ( ) const

inline

Get the Text object for the control.

Returns: const IText& The control's mText object, typically used to determine font/layout/size etc of the main text in a control.

Definition at line 282 of file IControl.h.

Referenced by ITextEntryControl::OnKeyDown(), and IGraphics::PromptUserInput().

int IControl::GetTextEntryLength ( ) const

inline

Get the max number of characters that are allowed in text entry.

Returns: int The max number of characters allowed in text entry

Definition at line 297 of file IControl.h.

Referenced by IGraphics::CreateTextEntry().

const char* IControl::GetTooltip ( ) const

inline

Returns: Currently set tooltip text

Definition at line 213 of file IControl.h.

References GetParamIdx(), LinkedToParam(), and SetParamIdx().

IGraphics* IControl::GetUI ( )

inline

Returns: A pointer to the IGraphics context that owns this control

Definition at line 452 of file IControl.h.

const IGraphics* IControl::GetUI ( ) const

inline

Returns: A const pointer to the IGraphics context that owns this control

Definition at line 455 of file IControl.h.

virtual int IControl::GetValIdxForPos	(	float	x,
		float	y
	)		const

inlinevirtual

Check to see which of the control's values relates to this x and y coordinate.

Parameters

x	x coordinate to check
y	x coordinate to check

Returns: An integer specifying which value matches the x, y coordinates, or kNoValIdx if the position is not linked to a value.

Reimplemented in IVTrackControlBase.

Definition at line 239 of file IControl.h.

References GetParam(), GetValue(), SetValue(), SetValueFromDelegate(), SetValueFromUserInput(), and SetValueToDefault().

Referenced by OnMouseDblClick(), IVKnobControl::OnMouseDblClick(), IVSliderControl::OnMouseDblClick(), OnMouseDown(), IGraphics::OnMouseDown(), and IVTrackControlBase::OnMouseOver().

double IControl::GetValue ( int valIdx = 0 ) const

Get the control's value.

Returns: Value of the control, normalized in the range 0-1

Parameters

valIdx The index of the value to set, which should be between 0 and NVals()

Definition at line 151 of file IControl.cpp.

References NVals().

Referenced by TestLayerControl::Draw(), TestPolyControl::Draw(), TestGradientControl::Draw(), TestMultiPathControl::Draw(), TestArcControl::Draw(), TestBlendControl::Draw(), TestTextOrientationControl::Draw(), TestTextSizeControl::Draw(), ILEDControl::Draw(), IVLEDMeterControl< MAXNC >::Draw(), IVRangeSliderControl::Draw(), ISVGKnobControl::Draw(), ISVGButtonControl::Draw(), ISVGSliderControl::Draw(), IBKnobRotaterControl::Draw(), IBSliderControl::Draw(), IWheelControl::Draw(), IVTrackControlBase::DrawBackground(), IVToggleControl::DrawValue(), IVButtonControl::DrawWidget(), IVToggleControl::DrawWidget(), IVKnobControl::DrawWidget(), IVSliderControl::DrawWidget(), IVRangeSliderControl::DrawWidget(), IVXYPadControl::DrawWidget(), GetValIdxForPos(), IWheelControl::IWheelControl(), IVMultiSliderControl< MAXNC >::OnMouseDown(), IBSwitchControl::OnMouseDown(), IKnobControlBase::OnMouseDown(), ISliderControlBase::OnMouseDown(), ISwitchControlBase::OnMouseDown(), ITextToggleControl::OnMouseDown(), IVRangeSliderControl::OnMouseDrag(), IWheelControl::OnMouseUp(), IKnobControlBase::OnMouseWheel(), ISliderControlBase::OnMouseWheel(), ISVGSliderControl::OnResize(), SetDirty(), ITextToggleControl::SetDirty(), SetValueFromDelegate(), SetValueFromUserInput(), IVMultiSliderControl< MAXNC >::SnapToMouse(), and IGraphics::UpdatePeers().

bool IControl::GetWantsGestures ( ) const

inline

Returns: /c true if this control supports multiple gestures

Definition at line 431 of file IControl.h.

Referenced by IGraphics::OnGestureRecognized(), and IGraphics::RespondsToGesture().

bool IControl::GetWantsMidi ( ) const

inline

Returns: /c true if this control wants to know about MIDI messages send to the UI. See OnMIDIMsg()

Definition at line 417 of file IControl.h.

Referenced by IGEditorDelegate::SendMidiMsgFromDelegate().

bool IControl::GetWantsMultiTouch ( ) const

inline

Returns: /c true if this control supports multiple touches

Definition at line 423 of file IControl.h.

References AttachGestureRecognizer().

Referenced by IGraphics::ReleaseMouseCapture().

void IControl::Hide ( bool hide )

virtual

Shows or hides the IControl.

Parameters

hide	Set to `true` to hide the control

Definition at line 237 of file IControl.cpp.

References SetDirty().

Referenced by IPopupMenuControl::CalculateMenuPanels(), GetMouseDblAsSingleClick(), IGraphics::HideControl(), IBubbleControl::IBubbleControl(), and IBubbleControl::SetStrokeColor().

bool IControl::IsDirty ( )

virtual

Called at each display refresh by the IGraphics draw loop, after IControl::Animate(), to determine if the control is marked as dirty.

Returns: true if the control is marked dirty.

Reimplemented in IGraphicsLiveEdit, TestMTControl, and IFPSDisplayControl.

Definition at line 229 of file IControl.cpp.

References GetAnimationFunction().

Referenced by TestMTControl::IsDirty(), IGraphics::IsDirty(), and IsHit().

bool IControl::IsDisabled ( ) const

inline

bool IControl::IsHidden ( ) const

inline

Returns: true if the control is hidden.

Definition at line 349 of file IControl.h.

References SetDisabled().

Referenced by IGraphics::BeginFrame(), IGraphicsLiveEdit::Draw(), IGraphics::ReleaseMouseCapture(), IGraphics::SetControlBounds(), IGraphics::SetControlPosition(), and IGraphics::SetControlSize().

virtual bool IControl::IsHit	(	float	x,
		float	y
	)		const

inlinevirtual

Hit test the control.

Override this method if you want the control to be hit only if a visible part of it is hit, or whatever.

Parameters

x	The X coordinate within the control to test
y	The y coordinate within the control to test

Returns: Return true if the control was hit.

Reimplemented in IVSliderControl, IVKnobControl, IVTabSwitchControl, IVSwitchControl, and IVButtonControl.

Definition at line 385 of file IControl.h.

References IRECT::Contains(), IsDirty(), and SetDirty().

Referenced by IVSwitchControl::OnMouseOut(), IVTabSwitchControl::OnMouseOut(), IVKnobControl::OnMouseOut(), IVSliderControl::OnMouseOut(), and IGraphics::ReleaseMouseCapture().

int IControl::LinkedToParam ( int paramIdx ) const

Check if the control is linked to a particular parameter.

Parameters

paramIdx The paramIdx to test

Returns: the valIdx if linked, or kNoValIdx if not

Definition at line 130 of file IControl.cpp.

References NVals().

Referenced by IGraphics::ForControlWithParam(), and GetTooltip().

int IControl::NVals ( ) const

inline

Returns: The number of values for this control

Definition at line 233 of file IControl.h.

Referenced by IVRangeSliderControl::Draw(), IVTrackControlBase::DrawTrackHandle(), IVRangeSliderControl::DrawWidget(), IVTrackControlBase::DrawWidget(), ForValIdx(), GetParamIdx(), IVTrackControlBase::GetValIdxForPos(), GetValue(), LinkedToParam(), IGraphics::OnMouseDown(), IVRangeSliderControl::OnMouseDrag(), IVRangeSliderControl::OnMouseOver(), IGraphics::OnMouseUp(), IGEditorDelegate::SendParameterValueFromDelegate(), SetDirty(), SetParamIdx(), SetValue(), SetValueToDefault(), and IVMultiSliderControl< MAXNC >::SnapToMouse().

virtual void IControl::OnAttached ( )

inlinevirtual

Called after the control has been attached, and its delegate and graphics member variable set.

Use this method for controls that might need to attach sub controls that should be above their parent in the stack

Reimplemented in IVDiskPresetManagerControl, IVNumberBoxControl, IVBakedPresetManagerControl, and IWebViewControl.

Definition at line 154 of file IControl.h.

Referenced by IGraphics::AttachControl().

virtual void IControl::OnContextSelection ( int itemSelected )

inlinevirtual

Implement this to respond to a menu selection from CreateContextMenu();.

See also: CreateContextMenu()

Definition at line 179 of file IControl.h.

References Draw(), DrawPTHighlight(), and PromptUserInput().

Referenced by As().

bool IControl::OnGesture ( const IGestureInfo & info )

virtual

Returns: true if supports this gesture

Definition at line 318 of file IControl.cpp.

Referenced by IGraphics::OnGestureRecognized(), and OnMidi().

virtual bool IControl::OnKeyDown	(	float	x,
		float	y,
		const IKeyPress &	key
	)

inlinevirtual

Implement this method to respond to a key down event on this control.

Parameters

x	The X coordinate of the mouse at the time of this key down event
y	The Y coordinate of the mouse at the time of this key down event
key	Info about the keypress

Reimplemented in IGraphicsLiveEdit, TestKeyboardControl, and ITextEntryControl.

Definition at line 118 of file IControl.h.

Referenced by IGraphics::OnKeyDown().

virtual bool IControl::OnKeyUp	(	float	x,
		float	y,
		const IKeyPress &	key
	)

inlinevirtual

Implement this method to respond to a key up event on this control.

Parameters

x	The X coordinate of the mouse at the time of this key down event
y	The Y coordinate of the mouse at the time of this key down event
key	Info about the keypress

Definition at line 124 of file IControl.h.

References OnMouseOut(), and OnMouseOver().

Referenced by IGraphics::OnKeyUp().

void IControl::OnMouseDblClick	(	float	x,
		float	y,
		const IMouseMod &	mod
	)

virtual

Implement this method to respond to a mouse double click event on this control.

Parameters

x	The X coordinate of the mouse event
y	The Y coordinate of the mouse event
mod	A struct indicating which modifier keys are held for the event

Reimplemented in PlaceHolder, IVSliderControl, IVKnobControl, IGraphicsLiveEdit, IVNumberBoxControl, ICornerResizerControl, ITextEntryControl, and TestTextControl.

Definition at line 256 of file IControl.cpp.

References GetValIdxForPos(), PromptUserInput(), and SetValueToDefault().

Referenced by IGraphics::OnMouseDblClick(), and OnMouseDrag().

void IControl::OnMouseDown	(	float	x,
		float	y,
		const IMouseMod &	mod
	)

virtual

Implement this method to respond to a mouse down event on this control.

Parameters

x	The X coordinate of the mouse event
y	The Y coordinate of the mouse event
mod	A struct indicating which modifier keys are held for the event

Reimplemented in ICaptionControl, ITextToggleControl, IURLControl, IEditableTextControl, ILambdaControl, ISwitchControlBase, IButtonControlBase, ISliderControlBase, IKnobControlBase, IWheelControl, IBSwitchControl, IVColorSwatchControl, IVXYPadControl, IVRangeSliderControl, IVSliderControl, IVKnobControl, IVMultiSliderControl< MAXNC >, TestMultiPathControl, IVTabSwitchControl, IColorPickerControl, TestKeyboardControl, ISkLottieControl, TestFlexBoxControl, IShaderControl, IVKeyboardControl, IVNumberBoxControl, TestDirBrowseControl, TestMTControl, IPopupMenuControl, TestAnimationControl, TestBezierControl, TestArcControl, TestLayerControl, TestPolyControl, IFPSDisplayControl, TestFontControl, TestSVGControl, IGraphicsLiveEdit, TestTextOrientationControl, ICornerResizerControl, TestTextSizeControl, ITextEntryControl, TestGradientControl, TestImageControl, TestTextControl, and TestCursorControl.

Definition at line 250 of file IControl.cpp.

References GetValIdxForPos(), and PromptUserInput().

Referenced by IPopupMenuControl::OnMouseDown(), IKnobControlBase::OnMouseDown(), ISliderControlBase::OnMouseDown(), IGraphics::OnMouseDown(), IVRangeSliderControl::OnMouseOut(), IBSwitchControl::OnRescale(), and ~IControl().

virtual void IControl::OnMouseDrag	(	float	x,
		float	y,
		float	dX,
		float	dY,
		const IMouseMod &	mod
	)

inlinevirtual

Implement this method to respond to a mouse drag event on this control.

Parameters

x	The X coordinate of the mouse event
y	The Y coordinate of the mouse event
dX	The X delta (difference) since the last event
dY	The Y delta (difference) since the last event
mod	A struct indicating which modifier keys are held for the event

Reimplemented in ILambdaControl, ISliderControlBase, IKnobControlBase, IVXYPadControl, IVRangeSliderControl, IVMultiSliderControl< MAXNC >, IGraphicsLiveEdit, IVKeyboardControl, IShaderControl, IVNumberBoxControl, TestMTControl, TestBezierControl, IPopupMenuControl, TestTextOrientationControl, TestTextSizeControl, and ITextEntryControl.

Definition at line 99 of file IControl.h.

References OnMouseDblClick().

Referenced by IVRangeSliderControl::OnMouseDown(), IVXYPadControl::OnMouseDown(), IGraphics::OnMouseDrag(), and IVRangeSliderControl::OnMouseUp().

void IControl::OnMouseOut ( )

virtual

Implement this method to respond to a mouseout event on this control.

Implementations should call base class, if you wish to use mMouseIsOver.

Reimplemented in IURLControl, IVTrackControlBase, IVColorSwatchControl, IVRangeSliderControl, IVSliderControl, IVKnobControl, IVTabSwitchControl, IVKeyboardControl, IVSwitchControl, ICornerResizerControl, IPopupMenuControl, and TestCursorControl.

Definition at line 273 of file IControl.cpp.

References mMouseIsOver, and SetDirty().

Referenced by OnKeyUp(), TestCursorControl::OnMouseOut(), ICornerResizerControl::OnMouseOut(), IVSwitchControl::OnMouseOut(), IVTabSwitchControl::OnMouseOut(), IVKnobControl::OnMouseOut(), IVSliderControl::OnMouseOut(), IGraphics::OnMouseOut(), and IURLControl::OnMouseOut().

void IControl::OnMouseOver	(	float	x,
		float	y,
		const IMouseMod &	mod
	)

virtual

Implement this method to respond to a mouseover event on this control.

Implementations should call base class, if you wish to use mMouseIsOver.

Parameters

x	The X coordinate of the mouse event
y	The Y coordinate of the mouse event
mod	A struct indicating which modifier keys are held for the event

Reimplemented in IURLControl, IVTrackControlBase, IVColorSwatchControl, IVRangeSliderControl, IVSliderControl, IVKnobControl, IVKeyboardControl, IVTabSwitchControl, IGraphicsLiveEdit, TestBezierControl, IPopupMenuControl, and ICornerResizerControl.

Definition at line 265 of file IControl.cpp.

References mMouseIsOver, and SetDirty().

Referenced by OnKeyUp(), ICornerResizerControl::OnMouseOver(), IVTabSwitchControl::OnMouseOver(), IVKnobControl::OnMouseOver(), IVSliderControl::OnMouseOver(), IGraphics::OnMouseOver(), IURLControl::OnMouseOver(), and IGraphics::OnMouseUp().

virtual void IControl::OnMouseUp	(	float	x,
		float	y,
		const IMouseMod &	mod
	)

inlinevirtual

Implement this method to respond to a mouse up event on this control.

Parameters

x	The X coordinate of the mouse event
y	The Y coordinate of the mouse event
mod	A struct indicating which modifier keys are held for the event

Reimplemented in ILambdaControl, ISwitchControlBase, ISliderControlBase, IKnobControlBase, IWheelControl, IVXYPadControl, IVRangeSliderControl, IVSliderControl, IVKnobControl, TestKeyboardControl, IVKeyboardControl, IShaderControl, IGraphicsLiveEdit, IVNumberBoxControl, TestMTControl, TestBezierControl, TestArcControl, TestPolyControl, TestTextOrientationControl, TestTextSizeControl, and ITextEntryControl.

Definition at line 91 of file IControl.h.

Referenced by IGraphics::OnMouseUp().

virtual void IControl::OnMouseWheel	(	float	x,
		float	y,
		const IMouseMod &	mod,
		float	d
	)

inlinevirtual

Implement this method to respond to a mouse wheel event on this control.

Parameters

x	The X coordinate of the mouse event
y	The Y coordinate of the mouse event
mod	A struct indicating which modifier keys are held for the event
d	The delta value (difference) since the last mouse wheel event

Reimplemented in ISliderControlBase, IKnobControlBase, IWheelControl, IVNumberBoxControl, and IPopupMenuControl.

Definition at line 112 of file IControl.h.

Referenced by IGraphics::OnMouseWheel().

void IControl::OnPopupMenuSelection	(	IPopupMenu *	pSelectedMenu,
		int	valIdx
	)

virtual

Implement this method to handle popup menu selection after IGraphics::CreatePopupMenu/IControl::PromptUserInput.

Parameters

pSelectedMenu	If pSelectedMenu is invalid it means the user didn't select anything
valIdx	An index that indicates which of the controls vals the menu relates to

Reimplemented in IWheelControl, IGraphicsLiveEdit, IVDiskPresetManagerControl, TestFlexBoxControl, TestDirBrowseControl, and IVBakedPresetManagerControl.

Definition at line 281 of file IControl.cpp.

References GetParam(), GetParamIdx(), and SetValueFromUserInput().

Referenced by CreateContextMenu().

virtual void IControl::OnRescale ( )

inlinevirtual

Implement to do something when graphics is scaled globally (e.g.

moves to different DPI screen)

Reimplemented in IBitmapControl, IBTextControl, IBSliderControl, IBKnobControl, IBSwitchControl, IBButtonControl, IWebViewControl, ICornerResizerControl, and TestSizeControl.

Definition at line 145 of file IControl.h.

Referenced by IGraphics::CreatePopupMenu(), SetDelegate(), and IGraphics::SetScreenScale().

virtual void IControl::OnResize ( )

inlinevirtual

Called when IControl is constructed or resized using SetRect().

NOTE: if you call SetDirty() in this method, you should call SetDirty(false) to avoid triggering parameter changes

Reimplemented in PlaceHolder, ICaptionControl, IVTrackControlBase, ISliderControlBase, IBSliderControl, ISVGSliderControl, IVColorSwatchControl, IVPanelControl, IVGroupControl, IVPlotControl, IVXYPadControl, IGraphicsLiveEdit, IVSliderControl, IVKnobControl, IVKeyboardControl, IVTabSwitchControl, IShaderControl, IVSlideSwitchControl, IWebViewControl, IVSwitchControl, IVScopeControl< MAXNC, MAXBUF >, IVButtonControl, TestFlexBoxControl, IVNumberBoxControl, IVDisplayControl, TestGradientControl, TestSizeControl, TestDirBrowseControl, and TestColorControl.

Definition at line 148 of file IControl.h.

Referenced by IVSwitchControl::OnMouseOut(), IVTabSwitchControl::OnMouseOut(), IVKnobControl::OnMouseOut(), IVSliderControl::OnMouseOut(), IBSliderControl::OnRescale(), PlaceHolder::OnTextEntryCompletion(), IGraphics::Resize(), SetDelegate(), IVTrackControlBase::SetParams(), SetRECT(), and SetTargetAndDrawRECTs().

virtual void IControl::OnTextEntryCompletion	(	const char *	str,
		int	valIdx
	)

inlinevirtual

Implement this method to handle text input after IGraphics::CreateTextEntry/IControl::PromptUserInput.

Parameters

str	A CString with the inputted text
valIdx	An index that indicates which of the controls vals the text completion relates to

Reimplemented in PlaceHolder, IEditableTextControl, and IVNumberBoxControl.

Definition at line 176 of file IControl.h.

virtual void IControl::OnTouchCancelled	(	float	x,
		float	y,
		const IMouseMod &	mod
	)

inlinevirtual

Implement this method to respond to a touch cancel event on this control.

Parameters

x	The X coordinate of the mouse event
y	The Y coordinate of the mouse event
mod	A struct indicating which modifier keys are held for the event

Reimplemented in IVKeyboardControl, and TestMTControl.

Definition at line 139 of file IControl.h.

Referenced by IGraphics::OnTouchCancelled().

void IControl::PromptUserInput ( int valIdx = 0 )

Call this method in response to a mouse event to create an edit box so the user can enter a value, or pop up a pop-up menu, if the control is linked to a parameter (mParamIdx > kNoParameter)

Parameters

valIdx An index to choose which of the controls linked parameters to retrieve. NOTE: since controls usually have only 1 parameter you can omit this argument and use the default index of 0

Definition at line 332 of file IControl.cpp.

References GetParam(), GetParamIdx(), GetUI(), IRECT::MH(), IRECT::MW(), IGraphics::PromptUserInput(), and SetDirty().

Referenced by OnContextSelection(), OnMouseDblClick(), IVKnobControl::OnMouseDblClick(), IVSliderControl::OnMouseDblClick(), OnMouseDown(), IVKnobControl::OnMouseDown(), IVSliderControl::OnMouseDown(), and ICaptionControl::OnMouseDown().

void IControl::PromptUserInput	(	const IRECT &	bounds,
		int	valIdx = `0`
	)

Create a text entry box so the user can enter a value, or pop up a pop-up menu, if the control is linked to a parameter (mParamIdx > kNoParameter) specifying the bounds.

Parameters

bounds	The rectangle for the text entry. Pop-up menu's will appear below the rectangle.
valIdx	An index to choose which of the controls linked parameters to retrieve. NOTE: since controls usually have only 1 parameter you can omit this argument and use the default index of 0

Definition at line 355 of file IControl.cpp.

References GetParamIdx(), GetUI(), and IGraphics::PromptUserInput().

IControl* IControl::SetActionFunction ( IActionFunction actionFunc )

inline

Set an Action Function for this control.

Parameters

actionFunc A std::function conforming to IActionFunction

Returns: Ptr to this control, for chaining

Definition at line 201 of file IControl.h.

Referenced by ISkLottieControl::Draw(), IVToggleControl::DrawValue(), IVRadioButtonControl::GetButtonForPoint(), IBubbleControl::IBubbleControl(), IPopupMenuControl::IPopupMenuControl(), IWheelControl::IWheelControl(), and IURLControl::SetText().

void IControl::SetAnimation ( IAnimationFunction func )

inline

Set the animation function.

Parameters

func	A std::function conforming to IAnimationFunction

Definition at line 477 of file IControl.h.

Referenced by DefaultClickActionFunc(), ILEDControl::Draw(), ISkLottieControl::Draw(), ILambdaControl::Draw(), IVToggleControl::DrawValue(), IBubbleControl::IBubbleControl(), IPopupMenuControl::IPopupMenuControl(), TestKeyboardControl::OnKeyDown(), ILambdaControl::OnMouseDown(), IWheelControl::OnMouseUp(), and SplashClickActionFunc().

void IControl::SetAnimation	(	IAnimationFunction	func,
		int	duration
	)

inline

Set the animation function and starts it.

Parameters

func	A std::function conforming to IAnimationFunction
duration	Duration in milliseconds for the animation

Definition at line 482 of file IControl.h.

References StartAnimation().

IControl* IControl::SetAnimationEndActionFunction ( IActionFunction actionFunc )

inline

Set an Action Function to be called at the end of an animation.

Parameters

actionFunc A std::function conforming to IActionFunction

Returns: Ptr to this control, for chaining

Definition at line 206 of file IControl.h.

Referenced by IVToggleControl::DrawValue(), IBubbleControl::IBubbleControl(), IVBakedPresetManagerControl::OnAttached(), IVNumberBoxControl::OnAttached(), and IVDiskPresetManagerControl::OnAttached().

void IControl::SetBlend ( const IBlend & blend )

inline

Set the Blend for this control.

This can be used differently by different controls, or not at all. By default it is used to change the opacity of controls when they are disabled

Definition at line 290 of file IControl.h.

void IControl::SetDirty	(	bool	triggerAction = `true`,
		int	valIdx = `kNoValIdx`
	)

virtual

Mark the control as dirty, i.e.

it should be redrawn on the next display refresh

Parameters

triggerAction If this is true and the control is linked to a parameter notify the class implementing the IEditorDelegate interface that the parameter changed. If this control has an ActionFunction, that can also be triggered. NOTE: it is easy to forget that this method always sets the control dirty, the argument refers to whether a consecutive action should be performed

Reimplemented in ITextToggleControl, IVSliderControl, IVKnobControl, IVSlideSwitchControl, and IVSwitchControl.

Definition at line 196 of file IControl.cpp.

References Clip(), ForValIdx(), GetAnimationFunction(), GetDelegate(), GetParamIdx(), GetUI(), GetValue(), NVals(), IEditorDelegate::SendParameterValueFromUI(), SetValue(), and IGraphics::UpdatePeers().

void IControl::SetDisabled ( bool disable )

virtual

Sets disabled mode for the control, the default implementation modifies the mBlend member.

Parameters

disable true for disabled

Definition at line 243 of file IControl.cpp.

References SetDirty().

Referenced by IGraphics::DisableControl(), and IsHidden().

void IControl::SetGroup ( const char * groupName )

inline

Assign the control to a control group.

See also: Control Groups

Parameters

groupName A CString indicating the control group that this control should belong to

Definition at line 274 of file IControl.h.

References mGroup.

Referenced by IGraphics::AttachControl().

void IControl::SetMouseEventsWhenDisabled ( bool allow )

inline

Specify whether the control should respond to other mouse events when disabled.

Parameters

allow true if it should respond to other mouse events when disabled (false by default)

Definition at line 364 of file IControl.h.

void IControl::SetMouseOverWhenDisabled ( bool allow )

inline

Specify whether the control should respond to mouse overs when disabled.

Parameters

allow true if it should respond to mouse overs when disabled (false by default)

Definition at line 360 of file IControl.h.

void IControl::SetParamIdx	(	int	paramIdx,
		int	valIdx = `0`
	)

virtual

Set the index of a parameter that the control is linked to If you are calling this "manually" to reuse a control for multiple parameters, you probably want to call IEditorDelegate::SendCurrentParamValuesFromDelegate() afterward, to update the control values.

Parameters

paramIdx	Parameter index, or kNoParameter if there is no parameter linked with this control at valIdx
valIdx	An index to choose which of the controls vals to set

Definition at line 113 of file IControl.cpp.

References NVals(), and SetDirty().

Referenced by GetTooltip(), ICaptionControl::ICaptionControl(), IVTrackControlBase::SetParams(), and IURLControl::SetText().

void IControl::SetPosition	(	float	x,
		float	y
	)

virtual

Set the position of the control, preserving the width and height.

This may need to be overriden if you maintain custom positioning data in your control

Parameters

x	the new x coordinate of the top left corner of the control
y	the new y coordinate of the top left corner of the control

Definition at line 289 of file IControl.cpp.

References IRECT::H(), IRECT::L, SetRECT(), SetTargetRECT(), IRECT::T, and IRECT::W().

Referenced by IGraphics::SetControlPosition(), and SetTargetAndDrawRECTs().

void IControl::SetPromptShowsParamLabel ( bool enable )

inline

Set if the control should show parameter labels/units e.g.

"Hz" in text entry prompts

Definition at line 379 of file IControl.h.

void IControl::SetPTParameterHighlight	(	bool	isHighlighted,
		int	color
	)

Used internally by the AAX wrapper view interface to set the control parmeter highlight.

Parameters

isHighlighted	/c true if the control should be highlighted
color	An integer representing one of three colors that ProTools assigns automated controls

Definition at line 363 of file IControl.cpp.

References SetDirty().

Referenced by IGraphics::SetPTParameterHighlight(), and SetTargetAndDrawRECTs().

void IControl::SetRECT ( const IRECT & bounds )

inline

Set the rectangular draw area for this control, within the graphics context.

Parameters

bounds The control's bounds

Definition at line 309 of file IControl.h.

References mMouseIsOver, and OnResize().

Referenced by IPopupMenuControl::CalculateMenuPanels(), IGraphicsLiveEdit::OnMouseUp(), SetPosition(), and IBubbleControl::SetStrokeColor().

void IControl::SetSize	(	float	w,
		float	h
	)

virtual

Set the size of the control, preserving the current position.

This may need to be overriden if you maintain custom positioning data in your control, or if your TargetRECT is not the same as the main RECT.

Parameters

w	the new width of the control
h	the new height of the control

Definition at line 301 of file IControl.cpp.

References IRECT::L, SetTargetAndDrawRECTs(), and IRECT::T.

Referenced by IGraphics::SetControlSize(), and SetTargetAndDrawRECTs().

void IControl::SetTargetAndDrawRECTs ( const IRECT & bounds )

inline

Set BOTH the draw rect and the target area, within the graphics context for this control.

Parameters

bounds The control's new draw and target bounds within the graphics context

Definition at line 321 of file IControl.h.

References mMouseIsOver, OnResize(), SetPosition(), SetPTParameterHighlight(), and SetSize().

Referenced by ITextEntryControl::OnKeyDown(), ICornerResizerControl::OnRescale(), IVNumberBoxControl::OnResize(), IBubbleControl::ResetBounds(), ITextControl::SetBoundsBasedOnStr(), IGraphics::SetControlBounds(), and SetSize().

void IControl::SetTargetRECT ( const IRECT & bounds )

inline

Set the rectangular mouse tracking target area, within the graphics context for this control.

Parameters

bounds The control's new target bounds within the graphics context

Definition at line 317 of file IControl.h.

References mMouseIsOver.

virtual void IControl::SetText ( const IText & txt )

inlinevirtual

Set the Text object typically used to determine font/layout/size etc of the main text in a control.

Parameters

txt	An IText struct with the desired formatting

Reimplemented in IURLControl.

Definition at line 286 of file IControl.h.

Referenced by ITextEntryControl::OnKeyDown(), and IURLControl::OnMouseOut().

void IControl::SetTextEntryLength ( int len )

inline

Set the max number of characters that are allowed in text entry.

Parameters

len	The max number of characters allowed in text entry

Definition at line 301 of file IControl.h.

void IControl::SetTooltip ( const char * str )

inline

Set a tooltip for the control.

Parameters

str	CString tooltip to be displayed

Definition at line 210 of file IControl.h.

void IControl::SetValue	(	double	value,
		int	valIdx = `0`
	)

virtual

Set one of the control's values.

Parameters

value	The normalized 0-1 value
valIdx	The index of the value to set, which should be between 0 and NVals()

Definition at line 145 of file IControl.cpp.

References NVals().

Referenced by ILEDControl::Draw(), IVToggleControl::DrawValue(), GetValIdxForPos(), IWheelControl::IWheelControl(), IVSwitchControl::OnInit(), IWheelControl::OnMidi(), IVTabSwitchControl::OnMouseDown(), IVMultiSliderControl< MAXNC >::OnMouseDown(), IBSwitchControl::OnMouseDown(), IButtonControlBase::OnMouseDown(), ISwitchControlBase::OnMouseDown(), ITextToggleControl::OnMouseDown(), IVXYPadControl::OnMouseDrag(), IKnobControlBase::OnMouseDrag(), ISliderControlBase::OnMouseDrag(), IWheelControl::OnMouseUp(), IKnobControlBase::OnMouseWheel(), ISliderControlBase::OnMouseWheel(), IVMeterControl< MAXNC >::OnMsgFromDelegate(), SetDirty(), IVNumberBoxControl::SetStyle(), SetValueFromDelegate(), SetValueFromUserInput(), SetValueToDefault(), IVMultiSliderControl< MAXNC >::SnapToMouse(), and SnapToMouse().

void IControl::SetValueFromDelegate	(	double	value,
		int	valIdx = `0`
	)

virtual

Set the control's value from the delegate This method is called from the class implementing the IEditorDelegate interface in order to update a control's value members and set it to be marked dirty for redraw.

Parameters

value	Normalised incoming value
valIdx	The index of the value to set, which should be between 0 and NVals()

Reimplemented in IVNumberBoxControl.

Definition at line 157 of file IControl.cpp.

References GetUI(), GetValue(), SetDirty(), and SetValue().

Referenced by GetValIdxForPos(), IGEditorDelegate::SendControlValueFromDelegate(), IGEditorDelegate::SendParameterValueFromDelegate(), and IVNumberBoxControl::SetValueFromDelegate().

void IControl::SetValueFromUserInput	(	double	value,
		int	valIdx = `0`
	)

virtual

Set the control's value after user input.

This method is called after a text entry or popup menu prompt triggered by PromptUserInput(), calling SetDirty(true), which will mean that the new value gets sent back to the delegate

Parameters

value	the normalised value after user input via text entry or pop-up menu
valIdx	An index to choose which of the controls linked parameters to retrieve. NOTE: since controls usually have only 1 parameter you can omit this argument and use the default index of 0

Reimplemented in IVNumberBoxControl.

Definition at line 172 of file IControl.cpp.

References GetValue(), SetDirty(), and SetValue().

Referenced by GetValIdxForPos(), OnPopupMenuSelection(), and IVNumberBoxControl::SetValueFromUserInput().

void IControl::SetValueToDefault ( int valIdx = kNoValIdx )

virtual

Set one or all of the control's values to the default value of the associated parameter.

Parameters

valIdx either an integer > -1 (kNoValIdx) in order to set an individual value to the default value of the associated parameter, or kNoValIdx to default all values This method will call through to SetDirty(true, valIdx), which will mean that the new value gets sent back to the delegate

Definition at line 181 of file IControl.cpp.

References ForValIdx(), IParam::GetDefault(), GetParam(), NVals(), SetDirty(), and SetValue().

Referenced by GetValIdxForPos(), OnMouseDblClick(), IVKnobControl::OnMouseDblClick(), and IVSliderControl::OnMouseDblClick().

void IControl::SetWantsMidi ( bool enable = true )

inline

Specify whether this control wants to know about MIDI messages sent to the UI.

See OnMIDIMsg()

Definition at line 414 of file IControl.h.

Referenced by IWheelControl::IWheelControl().

void IControl::SnapToMouse	(	float	x,
		float	y,
		EDirection	direction,
		const IRECT &	bounds,
		int	valIdx = `-1`,
		double	minClip = `0.`,
		double	maxClip = `1.`
	)

virtual

Set control value based on x, y position within a rectangle.

Commonly used for slider/fader controls.

Parameters

x	The X coordinate for snapping
y	The Y coordinate for snapping
direction	The direction of the control's travel- horizontal or vertical fader
bounds	The area in which the track of e.g. a slider should be snapped
valIdx

Reimplemented in IVMultiSliderControl< MAXNC >.

Definition at line 395 of file IControl.cpp.

References Clip(), IRECT::Constrain(), ForValIdx(), IRECT::H(), IRECT::L, SetDirty(), SetValue(), IRECT::T, and IRECT::W().

Referenced by GetMouseIsOver(), ISliderControlBase::OnMouseDown(), IVRangeSliderControl::OnMouseDrag(), and ISliderControlBase::OnMouseDrag().

void IControl::StartAnimation ( int duration )

Parameters

duration Duration in milliseconds for the animation

Definition at line 423 of file IControl.cpp.

Referenced by ILambdaControl::Draw(), GetMouseIsOver(), TestKeyboardControl::OnKeyDown(), and SetAnimation().