| AAX SDK 2.6.1 Avid Audio Extensions Development Kit

- Welcome
- Manual
- Classes
- Files
- Lists
- Support

- Class List
- Class Index
- Class Hierarchy
- Class Members

Loading...
Searching...
No Matches
List of all members | Public Member Functions
AAX_CStateTaperDelegate< T > Class Template Reference

`#include <AAX_CStateTaperDelegate.h>`

Inheritance diagram for AAX_CStateTaperDelegate< T >:
[legend]
Collaboration diagram for AAX_CStateTaperDelegate< T >:
[legend]

## Description

template<typename T>
class AAX_CStateTaperDelegate< T >

A linear taper conforming to AAX_ITaperDelegate.

This taper spaces a parameter's real values evenly between its minimum and maximum, with a linear mapping between the parameter's real and normalized values. It is essentially a version of AAX_CLinearTaperDelegate without that class' additional RealPrecision templatization.

## Public Member Functions
| AAX_CStateTaperDelegate (T minValue=0, T maxValue=1)
| Constructs a State Taper with specified minimum and maximum values.
AAX_CStateTaperDelegate< T > * | Clone () const AAX_OVERRIDE
| Constructs and returns a copy of the taper delegate.
T | GetMinimumValue () const AAX_OVERRIDE
| Returns the taper's minimum real value.
T | GetMaximumValue () const AAX_OVERRIDE
| Returns the taper's maximum real value.
T | ConstrainRealValue (T value) const AAX_OVERRIDE
| Applies a contraint to the value and returns the constrained value.
T | NormalizedToReal (double normalizedValue) const AAX_OVERRIDE
| Converts a normalized value to a real value.
double | RealToNormalized (T realValue) const AAX_OVERRIDE
| Normalizes a real parameter value.
virtual AAX_ITaperDelegate * | Clone () const =0
| Constructs and returns a copy of the taper delegate.
virtual T | GetMaximumValue () const =0
| Returns the taper's maximum real value.
virtual T | GetMinimumValue () const =0
| Returns the taper's minimum real value.
virtual T | ConstrainRealValue (T value) const =0
| Applies a contraint to the value and returns the constrained value.
virtual T | NormalizedToReal (double normalizedValue) const =0
| Converts a normalized value to a real value.
virtual double | RealToNormalized (T realValue) const =0
| Normalizes a real parameter value.
Public Member Functions inherited from AAX_ITaperDelegateBase
virtual | ~AAX_ITaperDelegateBase ()
| Virtual destructor.

## Constructor & Destructor Documentation

## ◆ AAX_CStateTaperDelegate()

template<typename T >

AAX_CStateTaperDelegate< T >::AAX_CStateTaperDelegate | ( | T | minValue = `0`,
|  | T | maxValue = `1`
| ) |  |

Constructs a State Taper with specified minimum and maximum values.

Note
  The parameter's default value should lie within the min to max range.

Parameters

  [in] | minValue |
  [in] | maxValue |

## Member Function Documentation

## ◆ Clone()

template<typename T >

AAX_CStateTaperDelegate< T > * AAX_CStateTaperDelegate< T >::Clone | ( |  | ) | const
| virtual

Constructs and returns a copy of the taper delegate.

In general, this method's implementation can use a simple copy constructor:

template <typename T>
AAX_CSubclassTaperDelegate<T>* AAX_CSubclassTaperDelegate<T>::Clone() const
{
return new AAX_CSubclassTaperDelegate(*this);
}

Implements AAX_ITaperDelegate< T >.

## ◆ GetMinimumValue()

template<typename T >

T AAX_CStateTaperDelegate< T >::GetMinimumValue | ( |  | ) | const
| inline virtual

Returns the taper's minimum real value.

Implements AAX_ITaperDelegate< T >.

## ◆ GetMaximumValue()

template<typename T >

T AAX_CStateTaperDelegate< T >::GetMaximumValue | ( |  | ) | const
| inline virtual

Returns the taper's maximum real value.

Implements AAX_ITaperDelegate< T >.

## ◆ ConstrainRealValue()

template<typename T >

T AAX_CStateTaperDelegate< T >::ConstrainRealValue | ( | T | value | ) | const
| virtual

Applies a contraint to the value and returns the constrained value.

This method is useful if the taper requires a contraint beyond simple minimum and maximum real value limits.

Note
  This is the function that should actually enforces the constraints in NormalizeToReal() and RealToNormalized().

Parameters

  [in] | value | The unconstrained value

Implements AAX_ITaperDelegate< T >.

## ◆ NormalizedToReal()

template<typename T >

T AAX_CStateTaperDelegate< T >::NormalizedToReal | ( | double | normalizedValue | ) | const
| virtual

Converts a normalized value to a real value.

This is where the actual taper algorithm is implemented.

This function should perform the exact inverse of RealToNormalized(), to within the roundoff precision of the individual taper implementation.

Parameters

  [in] | normalizedValue | The normalized value that will be converted

Implements AAX_ITaperDelegate< T >.

## ◆ RealToNormalized()

template<typename T >

double AAX_CStateTaperDelegate< T >::RealToNormalized | ( | T | realValue | ) | const
| virtual

Normalizes a real parameter value.

This is where the actual taper algorithm is implemented.

This function should perform the exact inverse of NormalizedToReal(), to within the roundoff precision of the individual taper implementation.

Parameters

  [in] | realValue | The real parameter value that will be normalized

Implements AAX_ITaperDelegate< T >.

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

- AAX_CStateTaperDelegate.h