MusicKit  0.0.0
Public Member Functions | Static Public Member Functions
InterpUG Class Reference

InterpUG does linear interpolation between two patchpoints, based on the value of a third patchpoint. More...

#import <InterpUG.h>

Inheritance diagram for InterpUG:
MKUnitGenerator

List of all members.

Public Member Functions

(id) - setInput1:
 Sets the input 1 patchpoint to aPatchPoint.
(id) - setInput2:
 Sets the input 2 patchpoint to aPatchPoint.
(id) - setInterpInput:
 Sets the interp input patchpoint to aPatchPoint.
(id) - setOutput:
 Sets the output patchpoint to aPatchPoint.

Static Public Member Functions

(BOOL) + shouldOptimize:
 Specifies that all arguments are to be optimized if possible.

Detailed Description

InterpUG does linear interpolation between two patchpoints, based on the value of a third patchpoint.

InterpUG provides dynamic linear interpolation between two input signals, where the interpolation is controlled by a third input signal:

output = input1 + ((input2 - input1) * input3)

When the value of input3 is 0.0, the output of InterpUG is exactly the signal found at input1. When input3 is 1.0, the output is exactly input2. An AsympUG is often used to produce the control signal.

Memory Spaces

InterpUGabcd a output b input1 c input2 d input3 (interpolation control)


Member Function Documentation

- (id) setInput1: (id)  aPatchPoint

Sets the input 1 patchpoint to aPatchPoint.

Parameters:
aPatchPointis an id.
Returns:
Returns an id. Returns nil if the argument isn't a patchpoint; otherwise returns self.
- (id) setInput2: (id)  aPatchPoint

Sets the input 2 patchpoint to aPatchPoint.

Parameters:
aPatchPointis an id.
Returns:
Returns an id. Returns nil if the argument isn't a patchpoint; otherwise returns self.
- (id) setInterpInput: (id)  aPatchPoint

Sets the interp input patchpoint to aPatchPoint.

Parameters:
aPatchPointis an id.
Returns:
Returns an id. The signal from this input controls the interpolation between the other two input signals. Returns nil if the argument isn't a patchpoint; otherwise returns self.
- (id) setOutput: (id)  aPatchPoint

Sets the output patchpoint to aPatchPoint.

Parameters:
aPatchPointis an id.
Returns:
Returns an id. Returns nil if the argument isn't a patchpoint; otherwise returns self.
+ (BOOL) shouldOptimize: (unsigned)  arg

Specifies that all arguments are to be optimized if possible.

Parameters:
argis an unsigned.
Returns:
Returns an BOOL.

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