internal::ParameterValueQueue Class Reference

#include <ParameterValueQueue.h>

Inheritance diagram for internal::ParameterValueQueue:

Collaboration diagram for internal::ParameterValueQueue:

Classes
struct	Point

Public Member Functions
	ParameterValueQueue ()
virtual	~ParameterValueQueue ()
void	initialize (Steinberg::Vst::ParamID id)
bool	isInitialized () const noexcept
void	dispose () noexcept
Steinberg::Vst::ParamID PLUGIN_API	getParameterId () override
Steinberg::int32 PLUGIN_API	getPointCount () override
Steinberg::tresult PLUGIN_API	getPoint (Steinberg::int32 index, Steinberg::int32 &sampleOffset, Steinberg::Vst::ParamValue &value) override
Steinberg::tresult PLUGIN_API	addPoint (Steinberg::int32 sampleOffset, Steinberg::Vst::ParamValue value, Steinberg::int32 &index) override

Private Attributes
bool	mInitialized { false }
Steinberg::Vst::ParamID	mId
std::vector< Point >	mPoints

Detailed Description

IParamValueQueue implementation. Holds automation points sorted in time. Can be initialized with any parameter id, and disposed later to avoid reallocations

Definition at line 23 of file ParameterValueQueue.h.

Constructor & Destructor Documentation

ParameterValueQueue()

internal::ParameterValueQueue::ParameterValueQueue

(

)

Definition at line 22 of file ParameterValueQueue.cpp.

{
   FUNKNOWN_CTOR
}

~ParameterValueQueue()

internal::ParameterValueQueue::~ParameterValueQueue ( )

virtual

Definition at line 27 of file ParameterValueQueue.cpp.

{
   wxASSERT(!mInitialized);
   FUNKNOWN_DTOR;
}

References mInitialized.

Member Function Documentation

addPoint()

Steinberg::tresult internal::ParameterValueQueue::addPoint ( Steinberg::int32  sampleOffset, Steinberg::Vst::ParamValue  value, Steinberg::int32 &  index  )

override

Definition at line 77 of file ParameterValueQueue.cpp.

{
   //store points sorted by time value
 
   wxASSERT(mInitialized);
   
   auto newPoint = Point { sampleOffset, value };
   const auto it =
      std::lower_bound(mPoints.begin(), mPoints.end(), newPoint);
   
   if(it == mPoints.end())
   {
      index = mPoints.size();
      mPoints.push_back(std::move(newPoint));
   }
   else
   {
      if (it->sampleOffset == sampleOffset)
         it->paramValue = value;
      else
         mPoints.insert(it, std::move(newPoint));
      index = std::distance(mPoints.begin(), it);
   }  
 
   return Steinberg::kResultOk;
}

References mInitialized, and mPoints.

dispose()

void internal::ParameterValueQueue::dispose ( )

noexcept

Definition at line 46 of file ParameterValueQueue.cpp.

{
   mInitialized = false;
   mPoints.clear();
}

References mInitialized, and mPoints.

Referenced by internal::ParameterQueuePool::QueueCleanup::operator()().

Here is the caller graph for this function:

getParameterId()

Steinberg::Vst::ParamID internal::ParameterValueQueue::getParameterId ( )

override

Definition at line 52 of file ParameterValueQueue.cpp.

{
   wxASSERT(mInitialized);
   return mId;
}

References mId, and mInitialized.

getPoint()

Steinberg::tresult internal::ParameterValueQueue::getPoint ( Steinberg::int32  index, Steinberg::int32 &  sampleOffset, Steinberg::Vst::ParamValue &  value  )

override

Definition at line 64 of file ParameterValueQueue.cpp.

{
   wxASSERT(mInitialized);
   if(index >= 0 && index < mPoints.size())
   {
      sampleOffset = mPoints[index].sampleOffset;
      value = mPoints[index].paramValue;
      return Steinberg::kResultOk;
   }
   return Steinberg::kInvalidArgument;
}

References mInitialized, and mPoints.

getPointCount()

Steinberg::int32 internal::ParameterValueQueue::getPointCount ( )

override

Definition at line 58 of file ParameterValueQueue.cpp.

{
   wxASSERT(mInitialized);
   return static_cast<int>(mPoints.size());
}

References mInitialized, and mPoints.

initialize()

void internal::ParameterValueQueue::initialize

(

Steinberg::Vst::ParamID

id

)

Definition at line 33 of file ParameterValueQueue.cpp.

{
   wxASSERT(!mInitialized);//misuse
 
   mInitialized = true;
   mId = id;
}

References id, mId, and mInitialized.

isInitialized()

bool internal::ParameterValueQueue::isInitialized ( ) const

noexcept

Definition at line 41 of file ParameterValueQueue.cpp.

{
   return mInitialized;
}

References mInitialized.

Member Data Documentation

mId

Steinberg::Vst::ParamID internal::ParameterValueQueue::mId

private

Definition at line 34 of file ParameterValueQueue.h.

Referenced by getParameterId(), and initialize().

mInitialized

bool internal::ParameterValueQueue::mInitialized { false }

private

Definition at line 33 of file ParameterValueQueue.h.

Referenced by addPoint(), dispose(), getParameterId(), getPoint(), getPointCount(), initialize(), isInitialized(), and ~ParameterValueQueue().

mPoints

std::vector<Point> internal::ParameterValueQueue::mPoints

private

Definition at line 35 of file ParameterValueQueue.h.

Referenced by addPoint(), dispose(), getPoint(), and getPointCount().

---

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

• ParameterValueQueue.h
• ParameterValueQueue.cpp