Quickstart

Create the Sketch

import com.victorvalentim.zividomelive.*;
import com.victorvalentim.zividomelive.manager.OutputManager;
import processing.opengl.PGraphicsOpenGL;
// Processing uses these imports to assemble contributed-library dependencies.
import controlP5.*;
import codeanticode.syphon.*;
import spout.*;

zividomelive ziviDome;

void settings() {
  size(1280, 720, P3D);
  pixelDensity(1);
}

void setup() {
  ziviDome = new zividomelive(this);
  ziviDome.setTargetFrameRate(60); // Optional startup configuration.
  ziviDome.setup();
  ziviDome.setScene(new MainScene());
}

void draw() {
  // ziviDomeLive renders automatically through its Processing draw hook.
}

Call setup() once after construction. Do not call ziviDome.draw() from the sketch: the constructor already registered the library's Processing hooks. ControlP5, Syphon, and Spout imports are required in contributed-library examples so Processing assembles their runtime classpath; only the platform-valid local backend is used.

Implement a Scene

class MainScene implements Scene {
  float angle;

  public void setupScene() {
    angle = 0;
  }

  public void update() {
    angle += 0.01f;
  }

  public void sceneRender(PGraphicsOpenGL pg) {
    pg.background(8, 12, 24);
    pg.lights();
    pg.rotateY(angle);
    pg.box(180);
    // The library owns beginDraw() and endDraw().
  }

  public String getName() {
    return "Main";
  }
}

sceneRender() is invoked for every target needed by the current frame. Keep state changes in update() so animation advances once per frame rather than once per cubemap face.

Select a Render Mode

FULL is the default. A sketch that never calls setRenderMode() keeps the 1.4 routing behavior.

ziviDome.setRenderMode(RenderMode.FULL);
ziviDome.setRenderMode(RenderMode.STANDARD);
ziviDome.setRenderMode(RenderMode.DOMEMASTER);
ziviDome.setRenderMode(RenderMode.EQUIRECTANGULAR);
ziviDome.setRenderMode(RenderMode.SKYBOX);

Use setCurrentView() for the preview route in FULL mode:

ziviDome.setCurrentView(zividomelive.ViewType.FISHEYE_DOMEMASTER);

Dedicated modes preserve that configured selection but temporarily force their own effective representation. See Render Modes and the Control Panel for the complete routing matrix.

Receive Events

The library registers Processing keyboard and mouse hooks and forwards events once to the active scene. The internal ControlP5 listener forwards panel events through the same contract.

public void keyEvent(processing.event.KeyEvent event) {
  if (event.getAction() == processing.event.KeyEvent.PRESS) {
    println(event.getKey());
  }
}

public void mouseEvent(processing.event.MouseEvent event) {
  // Handle scene input.
}

public void controlEvent(controlP5.ControlEvent event) {
  // Handle relevant built-in panel events.
}

Do not forward these events again from the main sketch.

Add More Scenes

SceneManager scenes = new SceneManager();
scenes.registerScene(new IntroScene());
scenes.registerScene(new MainScene());
ziviDome.setSceneManager(scenes);

The first registration activates that scene. Left and Right arrow keys switch scenes through the library's global shortcuts.

Route an Output

Outputs are disabled by default:

OutputManager outputs = ziviDome.getOutputManager();
outputs.setNdiView(zividomelive.ViewType.EQUIRECTANGULAR);
outputs.toggleOutput("ndi");

Check state and diagnostics without confusing backend readiness with render demand:

println(outputs.getOutputState(OutputManager.OutputType.NDI));
println(outputs.getOutputFailureReason(OutputManager.OutputType.NDI));

Native output interoperability still requires platform hardware qualification.

Continue with Scene Management, Spherical Calibration, and External Integration.