ScaleUG Class Reference

ScaleUG multiplies a patchpoint by a value that is specified in its memory argument. More...

#import <ScaleUG.h>

List of all members.

Public Member Functions
(id)	- setInput:
	Sets the input patchpoint to aPatchPoint.
(id)	- setOutput:
	Sets the output patchpoint to aPatchPoint.
(id)	- setScale:
	Sets the constant scale factor.
Static Public Member Functions
(BOOL)	+ shouldOptimize:
	Specifies that all arguments are to be optimized if possible.

---

Detailed Description

ScaleUG multiplies a patchpoint by a value that is specified in its memory argument.

ScaleUG multiplies its input by a constant scaler:

output = input1 * scaler

Memory Spaces

ScaleUGab a output b input

---

Member Function Documentation

- (id) setInput:

(id)

aPatchPoint

Sets the input patchpoint to aPatchPoint.

Parameters:

aPatchPoint

is an id.

Returns:

Returns nil if the argument isn't a patchpoint; otherwise returns self.

- (id) setOutput:

(id)

aPatchPoint

Sets the output patchpoint to aPatchPoint.

Parameters:

aPatchPoint

is an id.

Returns:

Returns nil if the argument isn't a patchpoint; otherwise returns self.

- (id) setScale:

(double)

value

Sets the constant scale factor.

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:

value

is a double.

Returns:

Returns self.

+ (BOOL) shouldOptimize:

(unsigned)

arg

Specifies that all arguments are to be optimized if possible.

Parameters:

arg

is an unsigned.

Returns:

Returns an BOOL.

---

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

• ScaleUG.h