How to create Scene

As noted at the end of Structure of RAMDanceToolkit, you can create your own scene. The following EmptyScene sample code shows you how:

.h file

#pragma once

#include "ramMain.h"

class EmptyScene : public ramBaseScene
{

public:
	// The name of your scene. It will be displayed on the GUI.
	string getName() const { return "My scene"; }

    void setupControlPanel();
    void setup();
    void update();
    void draw();

    void drawActor(const ramActor& actor);
    void drawRigid(const ramRigidBody &rigid);
    void onActorSetup(const ramActor &actor);
    void onActorExit(const ramActor &actor);
    void onRigidSetup(const ramRigidBody &rigid);
    void onRigidExit(const ramRigidBody &rigid);
	
private:
    
	// to be registered in GUI 
	float mySlider;

};

.cpp file

#include "EmptyScene.h"

void EmptyScene::setupControlPanel()
{
		// Setup GUI
		// to be called after setup()

	// register a slider for this scene
    ramGetGUI().addSlider("Slider", 0.0, 10.0, &mySlider);
}

void EmptyScene::setup()
{
    
}

void EmptyScene::update()
{
    
}

void EmptyScene::draw()
{
    ofSetColor(255,255,255);
    
    // to use RAMDanceToolkit coordination system
    // use ramBeginCamera() & ramEndCamera() and write codes between them

    ramBeginCamera();
	// you can get slider value using variable 
	// which you registered in setupControlPanel().
    ofDrawBitmapString("Slider value: " + ofToString(mySlider), ofVec3f(0,200,0));
    ramEndCamera();
}

void drawActor(const ramActor& actor)
{
    // To be called for as many number of recieving OSC data
    // of ramActor objects.
    // Each actor is passed as the argument `const ramActor &actor`.
}

void drawRigid(const ramRigidBody &rigid)
{
    // To be called for as many number of recieving OSC data  
    // of ramRigidBod objects.
    // Each actor is passed as the argument `const ramRigidBody &rigid`.
}

void onActorSetup(const ramActor &actor)
{
    // To be called when ramActorManager starts to recieve
    // the OSC data of a new ramActor.  
    // The new actor is passed as the argument `const ramActor &actor`.
}

void onActorExit(const ramActor &actor)
{
    // To be called when `const ramActor &actor` is outdated.  
    // 1.0 sec is set to RAM_OUTDATED_DURATION in ramConstants.h as default.
}

void onRigidSetup(const ramRigidBody &rigid)
{
    // To be called when ramActorManager starts to recieve  
    // OSC data of a new ramRigidBody.
    // The new rigidBody is passed as the argument `const ramRigidBody &rigid`.
}

void onRigidExit(const ramRigidBody &rigid)
{
    // To be called when `const ramRigidBody &rigid` is outdated.  
    // 1.0 sec is set to RAM_OUTDATED_DURATION in ramConstants.h as default.
}

{RAM_ROOT}/examples/example-emptyScene provides a simple example of how to create your own scene.

Defining your scene name

getName() is used both for displaying text and as a key for managing scenes. Make sure that the scene name is not duplicated among the other scenes in your project. (because it is used as a unique key)

string getName() const { return "My new scene"; }

Initializing GUI

You can add GUI parts to the panel by writing some code in setupControlPanel(). ofxUICanvas is used as a scene panel. Please check the ofxUI repo or {RAM_ROOT}/apps/RAMDanceToolkit project for details.

	void setupControlPanel()
	{
		// Setup GUI

		// register a slider for this scene
	    ramGetGUI().addSlider("Slider", 0.0, 10.0, &mySlider);
		
	}

A slider value which is set up in setupControlPanel() can be used as follows:

	// you can get slider value using variable 
	// which you registered in setupControlPanel().
    ofDrawBitmapString("Slider value: " + ofToString(mySlider), ofVec3f(0,200,0));

If you want to set up a listener method, you can set it up as follow:

In the .h file, add this line to add a member method(between {} of class):

    void onPanelChanged(ofxUIEventArgs &e);

In the .cpp file, add this example implementation:

void EmptyScene::onPanelChanged(ofxUIEventArgs &e)
{
    const string name = e.widget->getName();
    if (name == "slider") {
	    // do something...
    }
}

Register this listener method as follows in setupControlPanel(), so you can have a specific method(onPanelChanged(ofxUIEventArgs &e)) which is called when the GUI changes:

    ofAddListener(ramGetGUI().getCurrentUIContext()->newGUIEvent, this, &EmptyScene::onPanelChanged);

Register your scene to SceneManager

You can register your scene to ramSceneManager so you can operate your scene on the GUI. Here we'll explain about how you register your scene. Please check {RAM_ROOT}/examples/example-emptyScene for the details.

First, include a header file of a scene in your testApp.h.

	#include "EmptyScene.h"

Create a scene object of your scene class.

	class testApp : public ramBaseApp
	{
	    public:
	      //omitted
	    EmptyScene myScene;
	}

In your testApp.cpp, register the scene to ramSceneManager after ramInitialize(int port) in setup().

	void testApp::setup()
	{
		ofSetFrameRate(60);
		ofSetVerticalSync(true);
	
		/// ram setup
		// ------------------
		ramInitialize(10000);
	
		ramSceneManager& sceneManager = ramSceneManager::instance();
		sceneManager.addScene(&myScene);
	}

Noq you can see and select your scene on the GUI when you run the app.

You can write your openFrameworks code for scenes, as well as other methods which work with ramBaseApp. These methods are explained in RAM API Reference Core. For more on openFrameworks-specific code, please check the openFrameworks website.

---

This Document by YCAM InterLab, Yoshito Onishi, Satoru Higa, Motoi Shimizu, and Kyle McDonald is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.