We all love some drag and drop action – we use it all the time, and in fact have often come to expect it to be a feature in nearly every application we interact with. With that in mind, how can we think about integrating some drop actions into our work in TouchDesigner? Well, today is your lucky day! Here we’re going to look at some of the fundamental ideas that will help you get started with much more complicated drag and drop functions.
Anatomy of a Drop Script
Let’s start by setting up a container to perform some actions based on when we drop a file onto it – this will help us get our bearings, and see how dropping works. First we need to set up our container to work with a drop script. First add a new container to a network, next let’s go to the Drag page of the container, and look at the sub page labeled “On Dropping into this Component.”
We’ll start by first changing the drop down menu here to be “Allow Drop.” Next we’ll need to specify what script to run when something is dropped onto this Component. Let’s plan to call our script dropScript, and we’ll place it inside of our container. This means that we can specify it’s relative path and name as
Now we should have something that looks like this:
Now we’re ready to start working. First let’s navigate inside of our container, then split our work-space left and right, and open up a text port on one side of our work-space. Inside of container1 let’s add a new Text DAT and call it dropScript – just like we had planed earlier.
To get started, let’s first write a simple script so we can see this whole thing in action. In our Text DAT let’s use the simple script:
To this in action, let’s open the viewer for our container and drop a file onto it – we’ll want to keep an eye on our text port as well, because this is where our print command will show up.
Perfect. Here we can see that when we drop something onto our container, low and behold our script runs. This is great, but wouldn’t it be slick if we could instead get the pathway to our file? In fact, we can get this! Let’s change out drop script to this:
print( args )
Now when we drop something on to our container we get a list that should look something like this:
('E:/Dropbox/Camera Uploads/2015-05-26 10.55.18.jpg', '0', '0', '0', '1', 'jpg', '2015-05-26 10.55.18', '/container1')
The first item in this list is what we’re looking for – it’s the pathway to where our dropped file lives on our computer. Let’s change our drop script so we only get that first item in our list.
print( args )
Now when we drop a file onto our container we only get the pathway to the file.
That’s all well and good, but what can we do with that?
Changing a Movie File In TOP
Let’s set up a few other items in our container so we can really see this in action. Let’s add a Movie File In TOP, wire that to a Fit TOP, and finally to a Null TOP.
Set the Fit TOP resolution to match that parent container with following expressions:
Finally, let’s name the null bg, and set the parent to display this as the background TOP.
Now we’re ready to return to our drop script. Let’s change our drop script to set the parameter “file” on the Movie File In TOP to be the path from args. In python that looks something like this:
op('moviefilein1').par.file = args
If you’re following along at home, you might want to consider adding some comments and breaking this up slightly. It may make your code a little more verbose, but when you come back to it later on it will be easier to decode what’s actually going on here. That might end up reading like this:
# identify the movie file in # operator that I want to change movTarget = op('moviefilein1') # make a new variable called newFile # assign the args string to this variable newFile = args # set the file paramater for the target op # to be newFile - this means that when I drop # an image onto this container, that file # will become the background movTarget.par.file = newFile
Commenting isn’t always the most fun part of programming, but when you come back to a project or script it can make it much easier to remember what you were thinking and how you were working.
Now, when we drop a file onto our container, we should see the background file change as well.
Changing a Directory
That’s great, but how can we push this a little farther? Well, we might imagine that we find ourselves in a situation where we’d like to change the target directory for a Folder DAT. While the Choose a Directory example works well, it you might not want the hassle of navigating to your folder – instead you might just want to drop it onto your container. We can use the same principles from above to do just that.
Let’s add a Folder DAT to our network. Now we’ll change our dropScript to be:
folderDAT = op('folder1') folderDAT.par.rootfolder = args
Now we can drag an entire folder onto our container and see the Folder DAT update.
Bada bing! With a few basics under your belt, now you can have fun and and start to play with doing something exciting with drop scripts.
Want to take a look at some examples? You can find them here on GitHub