MagicOscilloscope Class Reference

This class collects your samples in a circular buffer and allows the GUI to draw it in the style of an oscilloscope. More...

#include <foleys_MagicOscilloscope.h>

Inheritance diagram for MagicOscilloscope:

Public Member Functions
	MagicOscilloscope (int channel=-1)
	Create an oscilloscope adapter to push samples into for later display in the GUI.
void	pushSamples (const juce::AudioBuffer< float > &buffer) override
	Push samples to a buffer to be visualised.
void	createPlotPaths (juce::Path &path, juce::Path &filledPath, juce::Rectangle< float > bounds, MagicPlotComponent &component) override
	This is the callback that creates the frequency plot for drawing.
void	prepareToPlay (double sampleRate, int samplesPerBlockExpected) override
	This method is called by the MagicProcessorState to allow the plot computation to be set up.
Public Member Functions inherited from MagicPlotSource
	MagicPlotSource ()=default
virtual	~MagicPlotSource ()=default
virtual bool	isActive () const
	You can add an active state to your plot to allow to paint in different colours.
virtual void	setActive (bool shouldBeActive)
juce::int64	getLastDataUpdate () const
	Use this information to invalidate your plot drawing.
void	resetLastDataFlag ()
	Call this to invalidate the lastData flag.
virtual juce::TimeSliceClient *	getBackgroundJob ()
	If your plot needs background processing, return here a pointer to your TimeSliceClient, and it will automatically be added to the common background thread.

Detailed Description

This class collects your samples in a circular buffer and allows the GUI to draw it in the style of an oscilloscope.

Constructor & Destructor Documentation

MagicOscilloscope()

MagicOscilloscope

(

int

channel = -1

)

Create an oscilloscope adapter to push samples into for later display in the GUI.

Parameters

channel

lets you select the channel to analyse. -1 means summing all together (the default)

Member Function Documentation

pushSamples()

void pushSamples ( const juce::AudioBuffer< float > & buffer )

overridevirtual

Push samples to a buffer to be visualised.

Implements MagicPlotSource.

References MagicPlotSource::resetLastDataFlag().

createPlotPaths()

void createPlotPaths ( juce::Path & path, juce::Path & filledPath, juce::Rectangle< float > bounds, MagicPlotComponent & component )

overridevirtual

This is the callback that creates the frequency plot for drawing.

Parameters

path	is the path instance that is constructed by the MagicPlotSource
filledPath	is the path instance that is constructed by the MagicPlotSource to be filled
bounds	the bounds of the plot
component	grants access to the plot component, e.g. to find the colours from it

Implements MagicPlotSource.

prepareToPlay()

void prepareToPlay ( double sampleRate, int samplesPerBlockExpected )

overridevirtual

This method is called by the MagicProcessorState to allow the plot computation to be set up.

Implements MagicPlotSource.

---

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

• foleys_MagicOscilloscope.h
• foleys_MagicOscilloscope.cpp