A Modulator that calculates its value only at the start of a voice. More...
Inheritance diagram for VoiceStartModulator:
Public Member Functions | |
| virtual Processor * | getChildProcessor (int) override final |
| A VoiceStartModulator has no child processors. More... | |
| virtual float | getVoiceStartValue (int voiceIndex) const noexcept |
| Returns the previously calculated voice start value. More... | |
| virtual void | handleHiseEvent (const HiseEvent &m) override |
| If a note on is received, the voice start value is calculated and stored temporarily until startNote() is called. More... | |
| virtual float | startVoice (int voiceIndex) override |
| When the startNote function is called, a previously calculated value (by the handleMidiMessage function) is stored using the supplied voice index. More... | |
 Public Member Functions inherited from Modulator | |
| Modulator (MainController *m, const String &id, int numVoices) | |
| Creates a new modulator with the given Identifier. More... | |
| virtual void | setColour (Colour c) |
| Sets the colour of the modulator. More... | |
| Public Member Functions inherited from Processor | |
| virtual ProcessorEditorBody * | createEditor (ProcessorEditor *parentEditor)=0 |
| Creates a ProcessorEditor for this Processor and returns the pointer. More... | |
| void | enableConsoleOutput (bool shouldBeEnabled) |
| Enables the Processor to output messages to the Console. More... | |
| virtual float | getAttribute (int parameterIndex) const =0 |
| returns the attribute with the specified index (use a enum in the derived class). More... | |
| virtual float | getDefaultValue (int) const |
| Overwrite this and return the default value. More... | |
| bool | getEditorState (int state) const |
| Restores the state of the Processor's editor. More... | |
| const String & | getId () const |
| Returns the unique id of the Processor instance (!= the Processor name). More... | |
| virtual Identifier | getIdentifierForParameterIndex (int parameterIndex) const |
| This returns a Identifier with the name of the parameter. More... | |
| float | getInputValue () const |
| This can be used to display the Processors input value. More... | |
| int | getLargestBlockSize () const |
| Returns the block size. More... | |
| virtual const String | getName () const |
| Overwrite this and return a pretty name. More... | |
| virtual int | getNumInternalChains () const |
| If your processor uses internal chains, you can return the number here. More... | |
| int | getNumParameters () const |
| This returns the number of (named) parameters. More... | |
| float | getOutputValue () const |
| This can be used to display the Processors output value. More... | |
| double | getSampleRate () const |
| Returns the sample rate. More... | |
| const Path | getSymbol () const |
| Returns the symbol of the Processor. More... | |
| virtual const Identifier | getType () const =0 |
| Overwrite this method to specify the name. More... | |
| int | getVoiceAmount () const noexcept |
| getNumVoices() is occupied by the Synthesiser class, d'oh! | |
| bool | isBypassed () const noexcept |
| Returns true if the processor is bypassed. More... | |
| virtual void | prepareToPlay (double sampleRate_, int samplesPerBlock_) |
| Sets the sample rate and the block size. More... | |
| Processor (MainController *m, const String &id_, int numVoices) | |
| Creates a new Processor with the given Identifier. More... | |
| void | restoreCompleteEditorState (const XmlElement *storedState) |
| Restores the EditorState from a BigInteger that was retrieved using getCompleteEditorState. More... | |
| void | setAttribute (int parameterIndex, float newValue, juce::NotificationType notifyEditor) |
| Changes a Processor parameter. More... | |
| virtual void | setBypassed (bool shouldBeBypassed, NotificationType notifyChangeHandler=dontSendNotification) noexcept |
| This bypasses the processor. More... | |
| void | setEditorState (int state, bool isOn, NotificationType notifyView=sendNotification) |
| Saves the state of the Processor's editor. More... | |
| void | setIsOnAir (bool isBeingProcessedInAudioThread) |
| Call this method after inserting the processor in the signal chain. More... | |
| void | setSymbol (Path newSymbol) |
| Sets a special symbol for the Processor. More... | |
| virtual | ~Processor () |
| Overwrite this if you need custom destruction behaviour. More... | |
| Public Member Functions inherited from SafeChangeBroadcaster | |
| void | addChangeListener (SafeChangeListener *listener) |
| Registers a listener to receive change callbacks from this broadcaster. More... | |
| void | removeAllChangeListeners () |
| Removes all listeners from the list. More... | |
| void | removeChangeListener (SafeChangeListener *listener) |
| Unregisters a listener from the list. More... | |
| void | sendAllocationFreeChangeMessage () |
| This will send a message without allocating a message slot. More... | |
| void | sendChangeMessage (const String &=String()) |
| Causes an asynchronous change message to be sent to all the registered listeners. More... | |
| void | sendSynchronousChangeMessage () |
| Sends a synchronous change message to all the registered listeners. More... | |
| Public Member Functions inherited from ControlledObject | |
| ControlledObject (MainController *m) | |
| Creates a new ControlledObject. More... | |
| const MainController * | getMainController () const noexcept |
| Provides read-only access to the main controller. More... | |
| MainController * | getMainController () noexcept |
| Provides write access to the main controller. More... | |
| Public Member Functions inherited from Modulation | |
| void | applyModulationValue (float calculatedModulationValue, float &destinationValue) const noexcept |
| This applies the previously calculated value to the supplied destination value depending on the modulation mode (adding or multiplying). More... | |
| float | calcIntensityValue (float calculatedModulationValue) const noexcept |
| This applies the intensity to the given value and returns the applied value. More... | |
| float | getDisplayIntensity () const noexcept |
| Returns the actual intensity of the Modulation. More... | |
| float | getIntensity () const noexcept |
| Returns the intensity. More... | |
| Mode | getMode () const noexcept |
| returns the mode the Modulator is operating. More... | |
| void | setIntensity (float newIntensity) noexcept |
| Sets the intensity of the modulation. More... | |
| void | setIntensityFromSlider (float sliderValue) noexcept |
| Use this method to set the intensity from the ModulatorEditorHeader's intensity slider converting linear -12 ... More... | |
Protected Member Functions | |
| virtual float | calculateVoiceStartValue (const HiseEvent &m)=0 |
| Overwrite this method to calculate the voice start value. More... | |
| Protected Member Functions inherited from Processor | |
| void | setInputValue (float newValue, NotificationType notify=sendNotification) |
| Call this from the baseclass whenever you want its editor to display a input value change. More... | |
| virtual void | setInternalAttribute (int parameterIndex, float newValue)=0 |
| Changes a Processor parameter. More... | |
| void | setOutputValue (float newValue) |
| Call this from the baseclass whenever you want its editor to display a value change. More... | |
Additional Inherited Members | |
| Public Types inherited from Processor | |
| enum | InternalChains |
| Overwrite this enum and list all internal chains. More... | |
| enum | SpecialParameters |
| Overwrite this enum and add new parameters. More... | |
| Public Types inherited from Modulation | |
| enum | Mode { GainMode = 0, PitchMode, PanMode } |
| There are two modes that Modulation can work: GainMode and PitchMode. More... | |
Detailed Description
A Modulator that calculates its value only at the start of a voice.
If a midi note on comes in, it calculates a value and temporarily saves the value until startNote() is called. The value is then stored using the supplied voice index and can be retrieved using getVoiceStartValue().
Member Function Documentation
|
protectedpure virtual |
Overwrite this method to calculate the voice start value.
Implemented in GlobalStaticTimeVariantModulator, GlobalVoiceStartModulator, KeyModulator, ArrayModulator, ConstantModulator, and RandomModulator.
|
inlinefinaloverridevirtual |
A VoiceStartModulator has no child processors.
Implements Processor.
|
inlinevirtualnoexcept |
Returns the previously calculated voice start value.
|
inlineoverridevirtual |
If a note on is received, the voice start value is calculated and stored temporarily until startNote() is called.
Implements Modulator.
|
inlineoverridevirtual |
When the startNote function is called, a previously calculated value (by the handleMidiMessage function) is stored using the supplied voice index.
Implements VoiceModulation.