IParam::Shape Struct Reference

Base struct for parameter shaping. More...

#include <IPlugParameter.h>

Inheritance diagram for IParam::Shape:

Public Member Functions
virtual Shape *	Clone () const =0
virtual void	Init (const IParam &param)
	Initializes the shape instance. More...
virtual EDisplayType	GetDisplayType () const =0
virtual double	NormalizedToValue (double value, const IParam &param) const =0
	Returns the real value from a normalized input, based on an IParam's settings. More...
virtual double	ValueToNormalized (double value, const IParam &param) const =0
	Returns the normalized value from a real value, based on an IParam's settings. More...

Detailed Description

Base struct for parameter shaping.

Definition at line 75 of file IPlugParameter.h.

Constructor & Destructor Documentation

~Shape()

virtual IParam::Shape::~Shape ( )

inlinevirtual

Definition at line 77 of file IPlugParameter.h.

Member Function Documentation

Clone()

virtual Shape * IParam::Shape::Clone ( ) const

pure virtual

Returns

A new instance of this Shape struct

Implemented in IParam::ShapeLinear, IParam::ShapePowCurve, and IParam::ShapeExp.

Referenced by IParam::InitDouble().

GetDisplayType()

virtual EDisplayType IParam::Shape::GetDisplayType ( ) const

pure virtual

Returns

EDisplayType, used by AudioUnit plugins to determine the mapping of parameters

Implemented in IParam::ShapeLinear, IParam::ShapePowCurve, and IParam::ShapeExp.

Init()

virtual void IParam::Shape::Init ( const IParam &  param )

inlinevirtual

Initializes the shape instance.

Parameters

param

The parent parameter

Reimplemented in IParam::ShapeExp.

Definition at line 84 of file IPlugParameter.h.

NormalizedToValue()

virtual double IParam::Shape::NormalizedToValue ( double  value, const IParam &  param  ) const

pure virtual

Returns the real value from a normalized input, based on an IParam's settings.

Parameters

value	The normalized value as a double to be converted
param	The IParam to do the calculation against

Returns

double The real value

Implemented in IParam::ShapeLinear, IParam::ShapePowCurve, and IParam::ShapeExp.

ValueToNormalized()

virtual double IParam::Shape::ValueToNormalized ( double  value, const IParam &  param  ) const

pure virtual

Returns the normalized value from a real value, based on an IParam's settings.

Parameters

value	The real value as a double to be converted
param	The IParam to do the calculation against

Returns

double The normalized value

Implemented in IParam::ShapeLinear, IParam::ShapePowCurve, and IParam::ShapeExp.

---

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

• IPlugParameter.h