JUCE v8.0.9
JUCE API
 
Loading...
Searching...
No Matches
juce::WebSliderParameterAttachment Class Reference

An object of this class maintains a connection between a WebSliderRelay and a plug-in parameter. More...

#include <juce_ParameterAttachments.h>

Inheritance diagram for juce::WebSliderParameterAttachment:
Collaboration diagram for juce::WebSliderParameterAttachment:

Public Member Functions

 WebSliderParameterAttachment (RangedAudioParameter &parameterIn, WebSliderRelay &sliderStateIn, UndoManager *undoManager=nullptr)
 Creates a connection between a plug-in parameter and a WebSliderRelay.
 
 ~WebSliderParameterAttachment () override
 Destructor.
 
void sendInitialUpdate ()
 Call this after setting up your slider in the case where you need to do extra setup after constructing this attachment.
 

Private Member Functions

void initialUpdateRequested (WebSliderRelay *) override
 
void setValue (float newValue)
 
void sliderDragEnded (WebSliderRelay *) override
 Called after a drag operation has finished.
 
void sliderDragStarted (WebSliderRelay *) override
 Called when the slider is about to be dragged.
 
void sliderValueChanged (WebSliderRelay *) override
 Called when the slider's value is changed.
 

Private Attributes

ParameterAttachment attachment
 
bool ignoreCallbacks = false
 
RangedAudioParameterparameter
 
WebSliderRelaysliderState
 

Detailed Description

An object of this class maintains a connection between a WebSliderRelay and a plug-in parameter.

During the lifetime of this object it keeps the two things in sync, making it easy to connect a WebSliderRelay to a parameter. When this object is deleted, the connection is broken. Make sure that your parameter and WebSliderRelay are not deleted before this object!

@tags{Audio}

Constructor & Destructor Documentation

◆ WebSliderParameterAttachment()

juce::WebSliderParameterAttachment::WebSliderParameterAttachment ( RangedAudioParameter parameterIn,
WebSliderRelay sliderStateIn,
UndoManager undoManager = nullptr 
)

Creates a connection between a plug-in parameter and a WebSliderRelay.

Parameters
parameterInThe parameter to use
sliderStateInThe WebSliderRelay to use
undoManagerAn optional UndoManager

◆ ~WebSliderParameterAttachment()

juce::WebSliderParameterAttachment::~WebSliderParameterAttachment ( )
override

Destructor.

Member Function Documentation

◆ initialUpdateRequested()

void juce::WebSliderParameterAttachment::initialUpdateRequested ( WebSliderRelay )
inlineoverrideprivatevirtual

◆ sendInitialUpdate()

void juce::WebSliderParameterAttachment::sendInitialUpdate ( )

Call this after setting up your slider in the case where you need to do extra setup after constructing this attachment.

Referenced by initialUpdateRequested().

◆ setValue()

void juce::WebSliderParameterAttachment::setValue ( float  newValue)
private

◆ sliderDragEnded()

void juce::WebSliderParameterAttachment::sliderDragEnded ( WebSliderRelay )
inlineoverrideprivatevirtual

Called after a drag operation has finished.

See also
sliderDragStarted, Slider::stoppedDragging

Reimplemented from juce::SliderListener< WebSliderRelay >.

References attachment, and juce::ParameterAttachment::endGesture().

◆ sliderDragStarted()

void juce::WebSliderParameterAttachment::sliderDragStarted ( WebSliderRelay )
inlineoverrideprivatevirtual

Called when the slider is about to be dragged.

This is called when a drag begins, then it's followed by multiple calls to sliderValueChanged(), and then sliderDragEnded() is called after the user lets go.

See also
sliderDragEnded, Slider::startedDragging

Reimplemented from juce::SliderListener< WebSliderRelay >.

References attachment, and juce::ParameterAttachment::beginGesture().

◆ sliderValueChanged()

void juce::WebSliderParameterAttachment::sliderValueChanged ( WebSliderRelay )
overrideprivatevirtual

Called when the slider's value is changed.

This may be caused by dragging it, or by typing in its text entry box, or by a call to Slider::setValue().

You can find out the new value using Slider::getValue().

See also
Slider::valueChanged

Implements juce::SliderListener< WebSliderRelay >.

Member Data Documentation

◆ attachment

ParameterAttachment juce::WebSliderParameterAttachment::attachment
private

◆ ignoreCallbacks

bool juce::WebSliderParameterAttachment::ignoreCallbacks = false
private

◆ parameter

RangedAudioParameter& juce::WebSliderParameterAttachment::parameter
private

◆ sliderState

WebSliderRelay& juce::WebSliderParameterAttachment::sliderState
private

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