ofTutorials - Introduction


This chapter will introduce openFrameworks and prepare you to start your first project.

oF Logo

What is OpenFrameworks?

openFrameworks is an open source C++ toolkit designed to assist the creative process by providing a simple and intuitive framework for experimentation. The toolkit is designed to work as a general purpose glue, and wraps together several commonly used libraries, including:

The code is written to be massively cross-compatible. Right now we support five operating systems (Windows, OSX, Linux, iOS, Android) and four IDEs (XCode, Code::Blocks, and Visual Studio and Eclipse). The API is designed to be minimal and easy to grasp.

Simply put, openFrameworks is a tool that makes it much easier to make things with code. We find it super useful, and we hope you do too.

openFrameworks is actively developed by Zach Lieberman, Theodore Watson, and Arturo Castro, with help from the OF community. openFrameworks is indebted to two significant precursors: the Processing development environment, created by Casey Reas, Ben Fry and the Processing community; and the ACU Toolkit, a privately distributed C++ library developed by Ben Fry and others in the MIT Media Lab’s Aesthetics and Computation Group.

— openframeworks.cc/about

Some of these packages (like OpenGL) will be explored in more depth in other parts of the documentation. Most of them do their thing in the background and you will probably never have to worry about them. Each of these libraries have their own syntax, conventions, and quirks, but the beauty of openFrameworks is that you don’t have to worry about them — oF is a single, consistent interface to the functionality that these other libraries provide.

Q&A

  1. Is it a program?

    OF is not itself a program or an application, but you can use OF to write your own programs and applications.

  2. Is it a programming language?

    OF does not constitute its own programming language, the language you use to write programs with OF is C++.

  3. So it’s a library?

    OF is in fact made up of several software libraries but the specific way it integrates these libraries together is more appropriately called a software framework.

  4. What is a software framework?

    A software framework is a kind of pre-fabricated software infrastructure designed to provide all of the low level functionality needed for an application while allowing a programmer to customize the higher level details of what that application should do. One way that using a framework differs from using a library is that the flow of control is inverted. A library can be directly controlled by your code to perform a set of general tasks. In a framework your code responds to events controlled by the framework and uses the framework as an interface to access the functionality of other libraries.

Sounds complicated?

In fact many other multimedia authoring environments work this way even if they do so less transparently.

Consider this loose analogy: You are writing and directing your own film and have decided to work with a film production company. The production company reserves the location, provides all of the infrastructure, finds the camera crew, lighting director, sound engineer and other important staff. It makes sure everyone is on the set on time and doing their job when they should, including you. Your job is to define what happens on the set once everyone is ready. OpenFrameworks is like a film production company for your program. It takes care of the administrative and logistical details and allows you to concentrate on your creative vision.


1. C++ is a programming language

We learned in the last section that openFrameworks is not a programming language, but rather a software framework for creating C++ programs. But what is C++?

Note

This documentation aims to guide you through openFrameworks, during which you will become comfortable with the C++ language. But it is beyond its scope to delve too deeply into a bottom-up introduction to C++, so if that is what you are after, you’ll have better luck with the sites listed in the Additional Resources appendix.

C++ is an extension of the C language, which was developed in 1979 at Bell Labs. They are both general purpose computing languages that can be run on virtually any computing platform in the world. The most basic C++ program looks like this:

// my first program in C++

#include <iostream>
using namespace std;

int main()
{
  cout << "Hello World!\n";
  return 0;
}

Tip

You can get a line-by-line breakdown of this program in the cplusplus.com "Structure of a program" tutorial.

After being run through a compiler, this code will create a fully executable program. It is an exceedingly simple command-line program that simply prints "Hello World!" to the console, but a program nonetheless. You can try it yourself by following these steps:

Warning

This process will vary slightly depending on platform. The following instructions are for the Mac OS, and you must have XCode installed to run them.

1.1. Compiling your First C++ program

PlainText
  1. Paste the code above into a text file and save it on your Desktop as hello.cpp.

    1. If you are using TextEdit, make sure you specify that you want to save it as "plain text", not "rich text" or anything else.

  2. Go into /Applications/Utilities and double-click on Terminal.app Terminal.app

  3. Type the following into the Terminal window, pressing enter after each line:

cd Desktop <1>
g++ -o hello hello.cpp <2>
./hello <3>
  1. Navigate ("change directory") to the Desktop

  2. Use the g++ program to compile hello.cpp (the source code file) into a program called "hello"

  3. Execute the "hello" program that you just created

The result should look like this:

Hello World!

Congratulations, you’ve just created (and then run) your first C++ program! You should see something that looks like this on your Desktop:

Your First Program

This might not look like other programs that you are used to — programs with flashy custom icons that launch windows and use graphics and such — but it’s a program nonetheless. In fact, if you dig deep enough, every program on your computer boils down to a something just like the hello program you just created. The rest is just bells and whistles.

Important

I can hear some people panicking right now, but don’t worry! Things get much more exciting when we start playing with oF. This example was only meant to illustrate the low-level basics of C++. Hopefully you will never have to compile a command line program on the command line again.

1.2. What is a compiler? and an IDE?

If you have used a program like Flash or Processing, you are familiar with the process of writing some code and then "pressing play" to see it in action. This is called compilation or compiling, and it’s what we just did in the previous section. If you are familiar with video editing, compiling is somewhat similar to rendering. The idea is that you must translate the code that is "human readable" into a format that your computer can execute. C, C++, Java, Objective-C, Fortran, Lisp, Pascal… these are all compiled languages. As cryptic as they may seem, all of these languages are supposed to be "human readable". They were created specifically to be written, read, and understood by humans. But no matter which language you start with, in the end, it has to be translated into something your computer can understand. Namely, machine code.

Note

Some languages, such as PHP and Python are known as "scripting languages." They still require compiling, but it happens right before the program executes.

The program that does the job of taking your code and translating it into machine code is called the compiler. GCC is one of the most popular compilers. It can compile lots of different languages. GCC is great for compiling, but knowing exactly how to tell the program exactly what you want to do is the subject of much headache and frustration. In the previous section, we compiled a program with the simple command "g++ -o hello hello.cpp", but once you start doing stuff like using existing libraries, optimizing code for particular processors, bundling your application with resources like images, etc., all bets are off. Telling GCC to compile even a moderately complicated openFrameworks project takes hundreds of lines of isoteric syntax and invoking dozens of helper tools. It’s super complex.

So instead, most developers use IDEs (Integrated Development Environments) to organize and create code projects. Most IDEs will include a text editor, a file organizer, a compiler, and lots of GUI interfaces for customizing all of the options and details of the compilation process. Some popular IDEs are: XCode, Visual Studio, CodeBlocks, Eclipse, NetBeans. There are IDEs for every operating system and language. Some IDEs are for one specific language and some support many.

You might be able to get away with calling stuff like Flash, Processing, VVVV, and MaxMSP IDEs — most of the important features are there. The difference is that IDEs are typically blank slates — they don’t come with any specific functionality. The other tools, on the other hand, come with lots of built-in functionality that is usually optimized for a particular purpose. For instance, Flash compiles programs to be run on the web, while Processing is a rapid prototyping tool.

openFrameworks definitely comes with a lot of functionality. The difference with openFrameworks is that it doesn’t come with it’s own IDE. Technically, you can use whatever IDE you want to create an openFrameworks project, but just as interfacing with a compiler can be difficult, the process of setting up a project of any complexity in an IDE can also be complex and tedious. One of the great things about openFrameworks is that it provides starting points for several IDEs on the 3 major platforms. They’ve done the hard work of creating project templates for 3 different IDEs on the 3 major platforms so all you have to do is download and start coding.

To get started working with openFrameworks, you will want to download and install an IDE for your operating system. Guides for installations can be found here:

1.2.1. Windows

1.2.2. Mac

1.2.3. Linux

1.3. What Can I Make with oF?

The following collection of projects is an attempt to illustrate the range of different kinds of projects that have been built using openFrameworks.

1.3.1. Puppet Parade

by Emily Gobeille and Theo Watson

Puppet Parade is an interactive installation by Emily Gobeille and Theo Watson of Design I/O that allows children to use their arms to puppeteer larger than life creatures projected on the wall in front of them. This dual interactive setup allows children to perform alongside the puppets, blurring the line between the ‘audience’ and the puppeteers and creating an endlessly playful dialogue between the children in the space and the children puppeteering the creatures.

— creativeapplications.net

More Information

1.3.2. Interactive Wall at UD

The 36-foot wall at the University of Dayton’s admission center engages prospective students and reveals videos of student life at UD. The wall displays continuously changing patterns of generative graphics, which respond to the presence of people in front of the wall.

The field of cubes is animated with waves of activity, and a viewer’s presence causes them to rotate and unveil POV videos of a student experience. The viewers can explore the videos moving around to reveal different video fragments. When viewers stand together, their silhouettes join to reveal more of the video. When no one is present in the interaction area the installation displays typographic animations overlaid on the dynamically animated graphic patterns.

For more video documentation and details of design and development process see the Case Study.

— flightphase.com

More information

1.3.3. Scramble Suit

by Arturo Castro and Kyle McDonald

One great thing about openFrameworks is that how easy to incorporate C++ code from pretty much any library. To that end, Arturo and Kyle used a Face Tracker library by Jason Saragih to create a face-replacement technique that Kyle named "Scramble Suit" inspired by fictional technology from Philip K. Dick’s 1977 novel, "A Scanner Darkly". It’s effectively a cloak that hides the identity of the wearer by making it impossible to describe or remember them.

1.4. Why openFrameworks?

openFrameworks is not the only creative coding framework out there. So why should you (or shouldn’t you) use openFrameworks?

coming soon…

1.5. Additional oF Resources