om::sound::filters::FilterParameterCurve Class Reference

A class that represents the scaling curve to use when displaying a SoundFilter parameter. More...

#include <omSoundFilterParameterCurve.h>

Public Types
enum	Enum {   LINEAR = 0, LOGARITHMIC = 1, SQUARE = 2, SQUARE_ROOT = 3,   CUBE = 4, CUBE_ROOT = 5 }
	An enum that specifies the different kinds of scaling curves. More...

Public Member Functions
	FilterParameterCurve ()
	Create a new filter parameter curve object with the LINEAR parameter curve. More...
	FilterParameterCurve (Enum newCurve)
	Create a new filter parameter curve object with the specified units enum value. More...
	operator Enum () const
	Convert this filter parameter curve type to an enum value. More...
UTF8String	toString () const
	Return a string representation of the parameter curve type. More...
	operator UTF8String () const
	Convert this parameter curve type into a string representation. More...

Detailed Description

A class that represents the scaling curve to use when displaying a SoundFilter parameter.

This class allows the user to specify how to display slider values, graphs, etc. Certain types of data are better visualized with a log scale, for instance.

Member Enumeration Documentation

enum om::sound::filters::FilterParameterCurve::Enum

An enum that specifies the different kinds of scaling curves.

Enumerator
LINEAR	The values are spaced evenly in a linear fashion.
LOGARITHMIC	The value are spaced logarithmically along the number line from the minimum to maximum value.
SQUARE	The values are spaced using the function x^2.
SQUARE_ROOT	The values are spaced using the function sqrt(x).
CUBE	The values are spaced using the function x^3.
CUBE_ROOT	The values are spaced using the function x^(1/3).

Constructor & Destructor Documentation

om::sound::filters::FilterParameterCurve::FilterParameterCurve ( )

inline

Create a new filter parameter curve object with the LINEAR parameter curve.

om::sound::filters::FilterParameterCurve::FilterParameterCurve ( Enum  newCurve )

inline

Create a new filter parameter curve object with the specified units enum value.

Member Function Documentation

om::sound::filters::FilterParameterCurve::operator Enum ( ) const

inline

Convert this filter parameter curve type to an enum value.

This operator is provided so that the FilterParameterCurve object can be used directly in a switch statement without the need to explicitly access the underlying enum value.

Returns

the enum representation of this parameter curve type.

UTF8String om::sound::filters::FilterParameterCurve::toString

(

)

const

Return a string representation of the parameter curve type.

om::sound::filters::FilterParameterCurve::operator UTF8String ( ) const

inline

Convert this parameter curve type into a string representation.

---

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

• omSoundFilterParameterCurve.h