Cactus
Extension
ExtensionDescription
A style agnostic framework for creative coding using the SuperCollider audio programming language. At its most basic level it will:
- Create a project file structure with configuration, initialisation and cleanup files.
- Create a buffers folder from which it collects all sound files and make them available through an intuitive interface.
- Allow for defining quickstart templates for different types of projects using a (very) basic templating engine.
- [work in progress] Allow for the creation and access of modules of sound processes.
Class Methods
.new
Create a new instance of Cactus
Arguments:
| projectPath |
A string denoting the path of the project. If the path exists Cactus will load it. If it does not exist it will create the initial structure. NOTE: You can use CactusGUI for ease of access to creating and managing Cactus projects. Start there if you are new to the framework. |
Returns:
A Cactus instance
.at
A convenience global Dictionary. It can be used to store any value but it also stores the instance for every running project under the project name (the project name is the name of its main folder).
Returns:
The contents at 'key'
Instance Methods
.restart
This will re-initialise the project after running 'cleanup.scd'. It will not rerun 'config.scd'.
.clearBuffers
Free all buffers.
.at
A convenience local Dictionary. It can be used to store any value.
.projectName
Get the projectName.
.buf
Get a buffer from the automatically loaded buffers (from the 'buffers' folder of the project).
Arguments:
| name |
The name of the buffer as a symbol. Providing the name of the file returns the buffer. Providing the name of a folder returns a List of the buffers in the folder. |
.bufnums
Like 'buf' but returns bufnums instead of buffers.
.projectPath
Returns the project path.
.openProjectDir
Open the project directory using the OS file browser.
.buffers
Return the Dictionary that contains all the buffers.
.runTemplate
Apply a template to the project. A template provides an easy way to recall common Cactus configurations.
Arguments:
| templateName |
A symbol with the template name. |
| options |
An Event of options to be used by the template. |