Vapor | SuperCollider 3.13.0 Help

Description

Vapor (http://itunes.apple.com/us/app/vapor./id433370498?mt=8) allows for control via OSC and also sends a number of OSC messages based on touch input. The Vapor class sets up a number of ways for this communication to happen.

Class Methods

.showComputerIP

Posts your computer iP address and the port that sclang is listening on.

.dumpAllOSC

For debugging, when set to 'true' all incoming OSC messages will be dumped to the post window. Call the method again with 'false' to turn off OSC dumping.

.new

creates a new instance of Vapor

Arguments:

ip	the ip of the device running Vapor (can be left empty - see the 'listen' method below)
port	the port to listen on

Instance Methods

.ip

the ip address the SuperCollider sends Vapor messages to.

Arguments:

newIP

an ip string

.listen

listens for the '/vaporPing' message from the Vapor app. If IP is nil, the IP from the OSC message will be saved for you.

Arguments:

action	a Function to evaluate when the message comes in
remove	a boolean that tells the class whether or not to remove this responder when the message comes in.

.addResponders

adds the necessary responders for responding to touches in the Vapor app

.removeResponders

removes all responders listening for OSC from Vapor

.ping

sends a /vaporPing message to Vapor after setting up an OSCresponderNode to listen for the '/pong' reply.

.pic

sends a command for Vapor to take a screen shot and store it in the device's photo roll.

.touch

sends an OSC message to Vapor to create a Vapor touch.

Arguments:

x	a value between 0.0 and 1.0 (0.0 is left, 1.0 is right)
y	a value between 0.0 and 1.0 (0.0 is bottom, 1.0 is top)

.cloud

sends an OSC message to Vapor to create a Vapor cloud.

Arguments:

x	a value between 0.0 and 1.0 (0.0 is left, 1.0 is right)
y	a value between 0.0 and 1.0 (0.0 is bottom, 1.0 is top)

.bomb

sends an OSC message to Vapor to create a Vapor bomb.

Arguments:

x	a value between 0.0 and 1.0 (0.0 is left, 1.0 is right)
y	a value between 0.0 and 1.0 (0.0 is bottom, 1.0 is top)
strength	an optional value (between 1 and 10000) that describes how long it takes for the bomb to fade

.newTouchFunc

a Function to evaluate when a Vapor cloud (double tap) is created. msg, time, addr, recvPort and a touchID are passed into the Function.

.touchMovedFunc

a Function to evaluate when a tracked touch moves. msg, time, addr, recvPort and a touchID are passed into the Function.

.touchEndedFunc

a Function to evaluate when a tracked touch ends. msg, time, addr, recvPort and a touchID are passed into the Function.

.pinchFunc

a Function to evaluate when a pinch gesture is detected. msg, time, addr and recvPort are passed into the Function.

.accelFunc

a Function to evaluate when a accelerometer values are calculated. msg, time, addr and recvPort are passed into the Function.

.cloudFunc

a Function to evaluate when a Vapor cloud (double tap) is created. msg, time, addr and recvPort are passed into the Function.

.rotationFunc

a Function to evaluate when a Vapor detects a rotation gesture. msg, time, addr and recvPort are passed into the Function.

reflectYIn

a boolean value

.reflectCenter

sets the reflectCenter setting in Vapor

Arguments:

reflectCenterIn

a boolean value

Examples

a = Vapor.new(port: 51010);
Vapor.showComputerIP; // the IP and Port info to set in Vapor
a.listen; // from inside the OSC page - press '/vaporPing'

a.addResponders;

Vapor.dumpAllOSC; // to see all incoming OSC
Vapor.dumpAllOSC(false); // turns that off;

// change some settings:

a.gravity_(-1);
a.fade_(0.99);
a.viscosity_(0.99);
a.diffusion_(0.5);
h = 12.0;
// send some touches!
Routine.run({
    inf.do({
        a.touch(1.0.rand, 1.0.rand);
        a.touch(1.0.rand, 1.0.rand);
        a.hue_(h);
        h = h + 1;
        0.02.wait;
    })
})

// set up a SynthDef that takes x and y parameters, and maps them to sound

SynthDef(\test, {arg gate = 1, x, y;
    var env, src;
    env = EnvGen.kr(Env([0, 1, 0], [0.1, 3], \sin, 1), gate, doneAction: 2);
    src = SinOsc.ar(x * 330 + 220, 0, y * 0.5);
    Out.ar(0, src * env);
}).add;

// a dictionary to put our notes into - keyed with the id of the touch 
n = Dictionary.new;

// add functions to respond to new, moved and end of touches
a.newTouchFunc_({arg msg, time, addr, port, touchID;
    [msg, touchID].postln;
    n.add(touchID -> Synth(\test, [\x, msg[1], \y, msg[2]]));
});

a.touchMovedFunc_({arg msg, time, addr, port, touchID;
    [msg, touchID].postln;
    n[touchID].set(\x, msg[1], \y, msg[2]);
});

a.touchEndedFunc_({arg msg, time, addr, port, touchID;
    // sometimes, a touch ends VERY quickly, before the node
    // even starts - wrap in a defer to catch these
    {
        [msg, touchID].postln;
        n[touchID].set(\gate, 0);
        n[touchID] = nil;
    }.defer(s.latency);
});

// stuck notes? (the ones above do have a 3 second decay... but if touches are lost, 
// this may be needed)
a.removeStuckTouches;

// done? remove the responders!
a.removeResponders;

helpfile source: HelpSource/Classes/Vapor.schelp
link::Vapor/Classes/Vapor::

VaporExtension

Description

Class Methods

.showComputerIP

.dumpAllOSC

.new

Arguments:

Instance Methods

.ip

Arguments:

.listen

Arguments:

.addResponders

.removeResponders

.ping

.pic

.touch

Arguments:

.cloud

Arguments:

.bomb

Arguments:

.newTouchFunc

.touchMovedFunc

.touchEndedFunc

.pinchFunc

.accelFunc

.cloudFunc

.rotationFunc

.bombFunc

.viscosity

Arguments:

.hue

Arguments:

.speed

Arguments:

.gravity

Arguments:

.fade

Arguments:

.diffusion

Arguments:

.mode

Arguments:

.colorChange

Arguments:

.reflectX

Arguments:

.reflectY

Arguments:

.reflectCenter

Arguments:

Examples

Vapor
Extension