SuperCollider CLASSES

AbstractResponderFunc

Abstract superclass of responder func objects
Inherits from: Object
Subclasses: HIDFunc, MIDIFunc, OSCFunc

Description

AbstractResponderFunc is the abstract superclass of responder funcs, which are classes which register one or more functions to respond to a particular type of input. It provides some common functionality such as introspection. Its two main subclasses are OSCFunc, and MIDIFunc. By default responder funcs do not persist beyond Cmd-. (see -permanent below).

Instances will register with a dispatcher (an instance of a subclass of AbstractDispatcher), which will actually dispatch incoming messages to an instance's Function(s).

Class Methods

*allFuncProxies

Get all current instances of this classes concrete subclasses, sorted by type.

Returns:

*allEnabled

As allFuncProxies above, but only return those instances currently listening for input.

Returns:

*allDisabled

As allFuncProxies above, but only return those instances currently not listening for input.

Returns:

Inherited class methods

Instance Methods

-func

Get or set this objects response function.

Returns:

The getter returns a Function or similar object.

-srcID

Get this object's source.

Returns:

The return type will depend on subclass. For OSCFunc this will be a NetAddr, for MIDIFunc a UID. This can can be nil, which indicates that the object will respond to any source.

-enabled

Check if this object is currently responding to incoming messages.

Returns:

-dispatcher

et this object's dispatcher. This is the object which matches incoming messages with responder funcs. Instances can use custom dispatchers to support arbitrary matching schemes.

Returns:

An instance of an appropriate subclass of AbstractDispatcher. (The return type will depend on subclass.)

-permanent

-permanent = bool

Get or set whether this responder func is persists when the user executes Cmd-. If false this will be disabled and removed from the global lists. The default is false.

Arguments:

bool

A Boolean indicating if this object is permanent.

Returns:

The getter returns a Boolean.

-enable

Enable this object to receive incoming messages. This is done automatically at creation time.

-disable

Stop this object from receiving incoming messages.

-add (newFunc)

Add a new function to the list of functions which will be executed when this object receives an incoming message.

Arguments:

newFunc

A Function or similar object to be added.

-remove (removeFunc)

Remove a function from the list of functions which will be executed when this object receives an incoming message.

Arguments:

removeFunc

The Function to be removed.

-gui

Open a subclass specific GUI. (Not yet implemented)

Returns:

The GUI object.

-oneShot

Indicate that this object should execute only once and then free itself.

-fix

A synonym for permanent

-free

Disable this object and remove it from the global lists. This should be done when you are finished using this object.

-clear

Remove all active functions from this object's function list.

Inherited instance methods

Examples

See OSCFunc and MIDIFunc.