krotos::SampleEngineShallow Class Reference

A structure to hold a "shallow" copy of a SampleEngine structure It contains only the data from a SampleEngine which is required to render the grain visualiser. More...

#include <GrainVisualiser.h>

Public Member Functions
void	shallowCopy (SampleEngine *sampleEngine)
	Make a shallow copy of a sample engine This might have been this class's constructor, but I want to leave the way open to allow copying data to an already created class, to allow for comparison of existing data with incoming (especially background grains), and then skipping the data copy if no change It may well turn out that comparing takes longer than copyinhg though!
std::vector< AudioDescriptor > &	getGrainDescriptionByZ ()
bool	shouldRegenerateDisplayCache ()
bool	analysisResultsAreValid ()
std::vector< Grain > &	getGrainArray ()
AnalysisCoefficients &	getAnalysisCoefficients ()

Public Attributes
std::vector< Grain >	m_grains

Private Attributes
std::vector< AudioDescriptor >	m_grainDescriptionByZ
bool	m_shouldRegenerateDisplayCache {false}
AnalysisCoefficients	m_analysisCoefficients
bool	m_analysisResultsAreValid {false}

Detailed Description

A structure to hold a "shallow" copy of a SampleEngine structure It contains only the data from a SampleEngine which is required to render the grain visualiser.

Member Function Documentation

analysisResultsAreValid()

bool krotos::SampleEngineShallow::analysisResultsAreValid ( )

inline

getAnalysisCoefficients()

AnalysisCoefficients & krotos::SampleEngineShallow::getAnalysisCoefficients ( )

inline

getGrainArray()

std::vector< Grain > & krotos::SampleEngineShallow::getGrainArray ( )

inline

getGrainDescriptionByZ()

std::vector< AudioDescriptor > & krotos::SampleEngineShallow::getGrainDescriptionByZ ( )

inline

shallowCopy()

void krotos::SampleEngineShallow::shallowCopy

(

SampleEngine *

sampleEngine

)

Make a shallow copy of a sample engine This might have been this class's constructor, but I want to leave the way open to allow copying data to an already created class, to allow for comparison of existing data with incoming (especially background grains), and then skipping the data copy if no change It may well turn out that comparing takes longer than copyinhg though!

Parameters

sampleEngine

Pointer to the sample engine we wish to copy from

shouldRegenerateDisplayCache()

bool krotos::SampleEngineShallow::shouldRegenerateDisplayCache ( )

inline

Member Data Documentation

m_analysisCoefficients

AnalysisCoefficients krotos::SampleEngineShallow::m_analysisCoefficients

private

m_analysisResultsAreValid

bool krotos::SampleEngineShallow::m_analysisResultsAreValid {false}

private

m_grainDescriptionByZ

std::vector<AudioDescriptor> krotos::SampleEngineShallow::m_grainDescriptionByZ

private

m_grains

std::vector<Grain> krotos::SampleEngineShallow::m_grains

m_shouldRegenerateDisplayCache

bool krotos::SampleEngineShallow::m_shouldRegenerateDisplayCache {false}

private

---

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

• krotos_gui/components/waveform_viewer/GrainVisualiser.h
• krotos_gui/components/waveform_viewer/GrainVisualiser.cpp