BoundedEnvelope Class Reference

#include <Envelope.h>

Inheritance diagram for BoundedEnvelope:

Collaboration diagram for BoundedEnvelope:

Public Member Functions
double	GetRangeLower () const
double	GetRangeUpper () const
void	SetRangeLower (double lower)
void	SetRangeUpper (double upper)
	Envelope (bool exponential, double minValue, double maxValue, double defaultValue)
	Envelope (const Envelope &orig)
	Envelope (const Envelope &orig, double t0, double t1)
Public Member Functions inherited from Envelope
	Envelope (bool exponential, double minValue, double maxValue, double defaultValue)
	Envelope (const Envelope &orig)
	Envelope (const Envelope &orig, double t0, double t1)
virtual	~Envelope ()
bool	IsTrivial () const
bool	ConsistencyCheck ()
double	GetOffset () const
double	GetTrackLen () const
bool	GetExponential () const
void	SetExponential (bool db)
void	Flatten (double value)
double	GetMinValue () const
double	GetMaxValue () const
void	SetRange (double minValue, double maxValue)
double	ClampValue (double value)
bool	HandleXMLTag (const std::string_view &tag, const AttributesList &attrs) override
XMLTagHandler *	HandleXMLChild (const std::string_view &tag) override
void	WriteXML (XMLWriter &xmlFile) const
void	CollapseRegion (double t0, double t1, double sampleDur) noexcept
void	PasteEnvelope (double t0, const Envelope *e, double sampleDur)
void	InsertSpace (double t0, double tlen)
void	SetOffset (double newOffset)
void	SetTrackLen (double trackLen, double sampleDur=0.0)
void	RescaleValues (double minValue, double maxValue)
void	RescaleTimes (double newLength)
void	RescaleTimesBy (double ratio)
double	GetValue (double t, double sampleDur=0) const
	Get envelope value at time t. More...
void	GetValues (double *buffer, int len, double t0, double tstep) const
	Get many envelope points at once. More...
void	Cap (double sampleDur)
double	Average (double t0, double t1) const
double	AverageOfInverse (double t0, double t1) const
double	Integral (double t0, double t1) const
double	IntegralOfInverse (double t0, double t1) const
double	SolveIntegralOfInverse (double t0, double area) const
void	Clear ()
int	InsertOrReplace (double when, double value)
	Add a point at a particular absolute time coordinate. More...
int	Reassign (double when, double value)
	Move a point at when to value. More...
void	Delete (int point)
	DELETE a point by its position in array. More...
void	Insert (int point, const EnvPoint &p) noexcept
	insert a point More...
void	Insert (double when, double value)
size_t	GetNumberOfPoints () const
	Return number of points. More...
const EnvPoint &	operator[] (int index) const
	Accessor for points. More...
double	GetDefaultValue () const
size_t	GetVersion () const
void	GetPoints (double *bufferWhen, double *bufferValue, int bufferLen) const
	Returns the sets of when and value pairs. More...
int	GetDragPoint () const
void	SetDragPoint (int dragPoint)
void	SetDragPointValid (bool valid)
bool	GetDragPointValid () const
void	MoveDragPoint (double newWhen, double value)
void	ClearDragPoint ()
Public Member Functions inherited from XMLTagHandler
	XMLTagHandler ()
virtual	~XMLTagHandler ()
virtual bool	HandleXMLTag (const std::string_view &tag, const AttributesList &attrs)=0
virtual void	HandleXMLEndTag (const std::string_view &WXUNUSED(tag))
virtual void	HandleXMLContent (const std::string_view &WXUNUSED(content))
virtual XMLTagHandler *	HandleXMLChild (const std::string_view &tag)=0
void	ReadXMLEndTag (const char *tag)
void	ReadXMLContent (const char *s, int len)
XMLTagHandler *	ReadXMLChild (const char *tag)

Private Attributes
double	mRangeLower {}
double	mRangeUpper {}

Detailed Description

Definition at line 278 of file Envelope.h.

Member Function Documentation

Envelope() [1/3]

Envelope::Envelope	(	bool	exponential,
		double	minValue,
		double	maxValue,
		double	defaultValue
	)

Definition at line 75 of file Envelope.cpp.

   : mDB(exponential)
   , mMinValue(minValue)
   , mMaxValue(maxValue)
   , mDefaultValue { ClampValue(defaultValue) }
{
}

Envelope() [2/3]

Envelope::Envelope

(

const Envelope &

orig

)

Definition at line 77 of file Envelope.cpp.

   : mDB(orig.mDB)
   , mMinValue(orig.mMinValue)
   , mMaxValue(orig.mMaxValue)
   , mDefaultValue(orig.mDefaultValue)
{
   mOffset = orig.mOffset;
   mTrackLen = orig.mTrackLen;
   CopyRange(orig, 0, orig.GetNumberOfPoints());
}

Envelope() [3/3]

Envelope::Envelope	(	const Envelope &	orig,
		double	t0,
		double	t1
	)

Definition at line 80 of file Envelope.cpp.

   : mDB(orig.mDB)
   , mMinValue(orig.mMinValue)
   , mMaxValue(orig.mMaxValue)
   , mDefaultValue(orig.mDefaultValue)
{
   mOffset = wxMax(t0, orig.mOffset);
   mTrackLen = wxMin(t1, orig.mOffset + orig.mTrackLen) - mOffset;
 
   auto range1 = orig.EqualRange( t0 - orig.mOffset, 0 );
   auto range2 = orig.EqualRange( t1 - orig.mOffset, 0 );
   CopyRange(orig, range1.first, range2.second);
}

References Envelope::Delete(), and Envelope::mDragPoint.

Here is the call graph for this function:

GetRangeLower()

double BoundedEnvelope::GetRangeLower ( ) const

inline

Definition at line 283 of file Envelope.h.

{ return mRangeLower; }

References mRangeLower.

GetRangeUpper()

double BoundedEnvelope::GetRangeUpper ( ) const

inline

Definition at line 284 of file Envelope.h.

{ return mRangeUpper; }

References mRangeUpper.

SetRangeLower()

void BoundedEnvelope::SetRangeLower ( double  lower )

inline

Definition at line 286 of file Envelope.h.

{ mRangeLower = lower; }

References mRangeLower.

SetRangeUpper()

void BoundedEnvelope::SetRangeUpper ( double  upper )

inline

Definition at line 287 of file Envelope.h.

{ mRangeUpper = upper; }

References mRangeUpper.

Member Data Documentation

mRangeLower

double BoundedEnvelope::mRangeLower {}

private

Definition at line 290 of file Envelope.h.

Referenced by GetRangeLower(), and SetRangeLower().

mRangeUpper

double BoundedEnvelope::mRangeUpper {}

private

Definition at line 290 of file Envelope.h.

Referenced by GetRangeUpper(), and SetRangeUpper().

---

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

• Envelope.h