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

Scl1add2UG multiplies the first input by a scale factor, and adds it to the second input patchpoint to produce a third. More...

#import <Scl1add2UG.h>

Inheritance diagram for Scl1add2UG:
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) - setOutput:
 Sets the output patchpoint to aPatchPoint.
(id) - setScale:
 Sets the constant scaler.
(id) - idleSelf
 You never send this message.

Static Public Member Functions

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

Detailed Description

Scl1add2UG multiplies the first input by a scale factor, and adds it to the second input patchpoint to produce a third.

Scl1add2UG adds two input signals, the first of which is scaled:

output = (input1 * scaler) + input2

Memory Spaces

Scl1add2UGabc a output b input 1 (scaled input) c input 2 (unscaled input)


Member Function Documentation

- (id) idleSelf

You never send this message.

Returns:
Returns an id. It's invoked by sending the idle message to the object. Sets the output patchpoint to sink, thus ensuring that the object does not produce any output. Note that you must send setOutput: and run again to use the MKUnitGenerator after sending idle.
- (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) 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.
- (id) setScale: (double)  value

Sets the constant scaler.

Effective values are between 0.0 and 1.0 (a negative scaler is the same as its absolute value, but with a 180 degree phase shift).

Parameters:
valueis a double.
Returns:
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: