ATK-Sharp  1.0
The ATK library for C#.
Public Member Functions | Protected Member Functions | Properties | List of all members
ATKSharp.Modifiers.BaseModifier Class Reference

The BaseModifier class. Contains the base functionality for modifiers. More...

Inheritance diagram for ATKSharp.Modifiers.BaseModifier:
ATKSharp.Modifiers.IModifier ATKSharp.Modifiers.AllPass ATKSharp.Modifiers.Biquad ATKSharp.Modifiers.Butterworth ATKSharp.Modifiers.Comb ATKSharp.Modifiers.HighPass ATKSharp.Modifiers.LowPass ATKSharp.Modifiers.Reverb ATKSharp.Modifiers.LowPassComb

Public Member Functions

virtual float Modify (float input)
 Abstract class. BaseModifier should not be used in your code unless you are extending ATK More...
 

Protected Member Functions

 BaseModifier ()
 Initializes a new instance of the BaseModifier class. More...
 

Properties

virtual ModifierType ModifierType [get, set]
 Gets or sets the modifier type. More...
 
virtual float Frequency [get, set]
 Gets or sets the modifier frequency. More...
 
virtual float CurrentSample [get, protected set]
 Gets or sets the current sample. More...
 
- Properties inherited from ATKSharp.Modifiers.IModifier
float CurrentSample [get]
 Gets the current sample. More...
 

Detailed Description

The BaseModifier class. Contains the base functionality for modifiers.

Constructor & Destructor Documentation

◆ BaseModifier()

ATKSharp.Modifiers.BaseModifier.BaseModifier ( )
protected

Initializes a new instance of the BaseModifier class.

Member Function Documentation

◆ Modify()

virtual float ATKSharp.Modifiers.BaseModifier.Modify ( float  input)
virtual

Abstract class. BaseModifier should not be used in your code unless you are extending ATK

Parameters
inputThe input.
Returns
The modified input.

Implements ATKSharp.Modifiers.IModifier.

Reimplemented in ATKSharp.Modifiers.Reverb, ATKSharp.Modifiers.Biquad, ATKSharp.Modifiers.Comb, ATKSharp.Modifiers.AllPass, ATKSharp.Modifiers.Butterworth, ATKSharp.Modifiers.LowPassComb, ATKSharp.Modifiers.LowPass, and ATKSharp.Modifiers.HighPass.

Property Documentation

◆ CurrentSample

virtual float ATKSharp.Modifiers.BaseModifier.CurrentSample
getprotected set

Gets or sets the current sample.

◆ Frequency

virtual float ATKSharp.Modifiers.BaseModifier.Frequency
getset

Gets or sets the modifier frequency.

◆ ModifierType

virtual ModifierType ATKSharp.Modifiers.BaseModifier.ModifierType
getset

Gets or sets the modifier type.

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