Controller (Javadocs: controlP5)

+Example

/**
 * ControlP5 Basics
 *
 * The following example demonstrates the basic use of controlP5.

 * After initializing controlP5 you can add controllers to controlP5.
 * Here we use three numberboxes, one slider and one textfield.
 * The numberbox with name numberboxC will trigger function numberboxC()
 * in the example below. Whenever controlP5 detects a function in your 
 * sketch that corresponds to the name of a controller, it will forward
 * an event to that function. Any event triggered by a controller 
 * will be forwarded to function controlEvent in your sketch.
 * related examples ControlP5numberbox, ControlP5slider, ControlP5textfield
 * 
 * by Andreas Schlegel, 2011
 * www.sojamo.de/libraries/controlp5
 *
 */


import controlP5.*;

ControlP5 cp5;
public int myColorRect = 200;
public int myColorBackground = 100;

void setup() {
  size(400, 400);
  noStroke();
  
  cp5 = new ControlP5(this);

  // create a slider
  // parameters:
  // name, minValue, maxValue, defaultValue, x, y, width, height
  cp5.addSlider("sliderA", 100, 200, 100, 100, 260, 100, 14);


  // create 3 numberboxes and assign an id for each
  cp5.addNumberbox("numberboxA", myColorRect, 100, 140, 100, 14).setId(1);
  cp5.addNumberbox("numberboxB", myColorBackground, 100, 180, 100, 14).setId(2);
  cp5.addNumberbox("numberboxC", 0, 100, 220, 100, 14).setId(3);


  // create a texfield
  cp5.addTextfield("textA", 100, 290, 100, 20);

  // change individual settings for a controller
  cp5.getController("numberboxA").setMax(255);
  cp5.getController("numberboxA").setMin(0);
}

void draw() {
  background(myColorBackground);
  fill(myColorRect);
  rect(0, 0, width, 100);
}


// events from controller numberboxC are received here
public void numberboxC(int theValue) {
  println("### got an event from numberboxC : "+theValue);
}


// an event from slider sliderA will change the value of textfield textA here
public void sliderA(int theValue) {
  Textfield txt = ((Textfield)cp5.getController("textA"));
  txt.setValue(""+theValue);
}


// for every change (a textfield event confirmed with a return) in textfield textA,
// function textA will be invoked
public void textA(String theValue) {
  println("### got an event from textA : "+theValue);
}


// function controlEvent will be invoked with every value change 
// in any registered controller
public void controlEvent(ControlEvent theEvent) {
  println("got a control event from controller with id "+theEvent.getId());
  switch(theEvent.getId()) {
    case(1): // numberboxA is registered with id 1
    myColorRect = (int)(theEvent.getController().getValue());
    break;
    case(2):  // numberboxB is registered with id 2
    myColorBackground = (int)(theEvent.getController().getValue());
    break;
  }
}

Field Summary
`static int`	`autoHeight`
`static processing.core.PVector`	`autoSpacing`
`static int`	`autoWidth`

Method Summary
`java.lang.Object`	`add(ControllerInterface theElement)`
`java.lang.Object`	`addCallback(CallbackListener theListener)`
`java.lang.Object`	`addListener(ControlListener theListener)`
`java.lang.Object`	`align(int theCaptionX, int theCaptionY, int theValueX, int theValueY)`
`java.lang.Object`	`bringToFront()`
`java.lang.Object`	`bringToFront(ControllerInterface theController)`
`java.lang.Object`	`changeValue(float theValue)` sets the value of the controller without sending the broadcast event.
`processing.core.PVector`	`getAbsolutePosition()`
`java.lang.String`	`getAddress()`
`float[]`	`getArrayValue()` returns the current float array value of a controller.
`float`	`getArrayValue(int theIndex)`
`ControlBehavior`	`getBehavior()`
`Label`	`getCaptionLabel()`
`CColor`	`getColor()`
`java.util.List`	`getControllerPlugList()`
`ControlWindow`	`getControlWindow()`
`int`	`getDecimalPrecision()`
`float`	`getDefaultValue()`
`int`	`getHeight()`
`int`	`getId()` returns the id of a controller, by default the id is -1.
`java.lang.String`	`getLabel()` returns the controller's caption label text.
`float`	`getMax()` returns the minimum value of the controller.
`float`	`getMin()` returns the maximum value of the controller.
`java.lang.String`	`getName()` returns the index name of the controller.
`ControllerInterface`	`getParent()` returns the parent of a controller.
`int`	`getPickingColor()`
`processing.core.PVector`	`getPosition()` get the position of a controller.
`ControllerProperty`	`getProperty(java.lang.String thePropertyName)`
`ControllerProperty`	`getProperty(java.lang.String theSetter, java.lang.String theGetter)`
`java.lang.String`	`getStringValue()`
`Tab`	`getTab()` get the instance of the tab the controller belongs to.
`float`	`getValue()`
`Label`	`getValueLabel()`
`int`	`getWidth()`
`ControlWindow`	`getWindow()` returns the control window of the controller
`java.lang.Object`	`hide()`
`void`	`init()`
`boolean`	`isActive()` checks if a controller is active.
`boolean`	`isBroadcast()` check if broadcasting is enabled or disabled for a controller.
`boolean`	`isInside()` returns true or false and indicates if the mouse is inside the area of a controller.
`boolean`	`isLabelVisible()`
`boolean`	`isListening()` returns true or false for the current listening status.
`boolean`	`isLock()`
`boolean`	`isMouseOver()` check if the mouse is within this particular controller.
`boolean`	`isMousePressed()` returns true or false if the mouse has is pressed.
`boolean`	`isMoveable()` checks if a controller is moveable.
`boolean`	`isUpdate()` enables the update function for a controller.
`boolean`	`isVisible()`
`void`	`keyEvent(java.awt.event.KeyEvent theEvent)`
`java.lang.Object`	`linebreak()`
`java.lang.Object`	`listen(boolean theValue)` enables a controller to listen to changes made to the variable linked to the controller.
`int`	`listenerSize()`
`java.lang.Object`	`lock()` disables the controller to be moved, or changed or controlled by the user.
`java.lang.Object`	`moveTo(ControlGroup theGroup)`
`java.lang.Object`	`moveTo(ControllerGroup theGroup)`
`java.lang.Object`	`moveTo(ControllerGroup theGroup, Tab theTab, ControlWindow theControlWindow)`
`java.lang.Object`	`moveTo(ControlWindow theControlWindow)` moves the controller to the default tab of a control window - other than the main window.
`java.lang.Object`	`moveTo(ControlWindow theControlWindow, java.lang.String theTabName)`
`java.lang.Object`	`moveTo(processing.core.PApplet theApplet)` moves the controller to the default tab inside the main window.
`java.lang.Object`	`moveTo(processing.core.PApplet theApplet, java.lang.String theTabName)` moves the controller to a tab inside the main window.
`java.lang.Object`	`moveTo(java.lang.String theTabName)` moves the controller to another tab.
`java.lang.Object`	`moveTo(Tab theTab)` moves the controller to another tab.
`java.lang.Object`	`plugTo(java.lang.Object theObject)`
`java.lang.Object`	`plugTo(java.lang.Object[] theObjects)` plugs the controller to a list of objects
`java.lang.Object`	`plugTo(java.lang.Object[] theObjects, java.lang.String theName)`
`java.lang.Object`	`plugTo(java.lang.Object theObject, java.lang.String theName)`
`java.lang.Object`	`registerProperty(java.lang.String thePropertyName)`
`java.lang.Object`	`registerProperty(java.lang.String theSetter, java.lang.String theGetter)`
`java.lang.Object`	`registerTooltip(java.lang.String theText)` adds a tooltip to a controller, by default the tooltip is disabled.
`void`	`remove()` removes a controller from controlP5.
`java.lang.Object`	`remove(ControllerInterface theElement)`
`java.lang.Object`	`removeBehavior()`
`java.lang.Object`	`removeCallback()`
`java.lang.Object`	`removeCallback(CallbackListener theListener)`
`java.lang.Object`	`removeListener(ControlListener theListener)`
`java.lang.Object`	`removeProperty(java.lang.String thePropertyName)`
`java.lang.Object`	`removeProperty(java.lang.String theSetter, java.lang.String theGetter)`
`java.lang.Object`	`setAbsolutePosition(processing.core.PVector thePVector)`
`java.lang.Object`	`setAddress(java.lang.String theAddress)`
`java.lang.Object`	`setArrayValue(float[] theArray)`
`java.lang.Object`	`setArrayValue(int theIndex, float theValue)`
`java.lang.Object`	`setBehavior(ControlBehavior theBehavior)` with setBehavior you can add a ControlBehavior to a controller.
`java.lang.Object`	`setBroadcast(boolean theFlag)` Use setBroadcast to enable and disable the broadcasting of changes in a controller's value.
`java.lang.Object`	`setCaptionLabel(java.lang.String theLabel)` sets the content of the caption label of a controller.
`java.lang.Object`	`setColor(CColor theColor)`
`java.lang.Object`	`setColorActive(int theColor)`
`java.lang.Object`	`setColorBackground(int theColor)`
`java.lang.Object`	`setColorCaptionLabel(int theColor)`
`java.lang.Object`	`setColorForeground(int theColor)`
`java.lang.Object`	`setColorValueLabel(int theColor)`
`java.lang.Object`	`setDecimalPrecision(int theValue)` sets the decimal precision of a controller's float value displayed.
`java.lang.Object`	`setDefaultValue(float theValue)` set the default value.
`java.lang.Object`	`setGroup(ControllerGroup theGroup)`
`java.lang.Object`	`setGroup(java.lang.String theName)` sets the group of the controller.
`java.lang.Object`	`setHeight(int theHeight)`
`java.lang.Object`	`setId(int theId)` set the id of a controller.
`processing.core.PImage`	`setImage(processing.core.PImage theImage)`
`processing.core.PImage`	`setImage(processing.core.PImage theImage, int theState)`
`java.lang.Object`	`setImages(processing.core.PImage[] imgs)`
`java.lang.Object`	`setImages(processing.core.PImage theImageDefault, processing.core.PImage theImageOver, processing.core.PImage theImageActive)` by default controllers use simple shapes, to replace these shapes with images, use setImages().
`java.lang.Object`	`setImages(processing.core.PImage theImageDefault, processing.core.PImage theImageOver, processing.core.PImage theImageActive, processing.core.PImage theImageHighlight)`
`java.lang.Object`	`setLabelVisible(boolean theValue)` show or hide the labels of a controller.
`java.lang.Object`	`setLock(boolean theValue)` sets the lock status of the controller
`java.lang.Object`	`setMax(float theValue)` sets the maximum value of the Controller.
`java.lang.Object`	`setMin(float theValue)` sets the minimum value of the Controller.
`java.lang.Object`	`setMouseOver(boolean theFlag)`
`boolean`	`setMousePressed(boolean theStatus)`
`java.lang.Object`	`setMoveable(boolean theValue)` enable or prevent the controller to be moveable.
`java.lang.Object`	`setParent(ControllerInterface theParent)` set the parent of a parent of a controller.
`java.lang.Object`	`setPosition(float theX, float theY)` set the position of a controller.
`java.lang.Object`	`setPosition(processing.core.PVector thePVector)`
`java.lang.Object`	`setSize(int theWidth, int theHeight)`
`java.lang.Object`	`setSize(processing.core.PImage theImage)` auto-updates the size of a controller according to the dimensions of the PImage.
`java.lang.Object`	`setStringValue(java.lang.String theValue)`
`java.lang.Object`	`setTab(ControlWindow theWindow, java.lang.String theName)`
`java.lang.Object`	`setTab(java.lang.String theName)` sets the tab of the controller.
`java.lang.Object`	`setUpdate(boolean theFlag)` disables the update function for a controller.
`abstract java.lang.Object`	`setValue(float theValue)`
`java.lang.Object`	`setValueLabel(java.lang.String theLabel)` set or change the value of the value label of a controller.
`java.lang.Object`	`setView(ControllerView theDisplay)` use setDisplay to customize your controller look.
`void`	`setView(ControllerView theDisplay, int theMode)`
`java.lang.Object`	`setVisible(boolean theFlag)`
`java.lang.Object`	`setWidth(int theWidth)`
`java.lang.Object`	`show()`
`java.lang.Object`	`unlock()` enables the controller to be moved, changed and controlled by the user.
`java.lang.Object`	`unplugFrom(java.lang.Object theObject)` unplugs the Controller for a single object
`java.lang.Object`	`unplugFrom(java.lang.Object[] theObjects)` unplugs the controller from a list of objects
`java.lang.Object`	`unregisterTooltip()`
`java.lang.Object`	`update()` updates the value of the controller without having to set the value explicitly.
`java.lang.Object`	`updateAbsolutePosition()`
`java.lang.Object`	`updateEvents()` updateEvents is used for internal updates of a controller.
`java.lang.Object`	`updateInternalEvents(processing.core.PApplet theApplet)` a method for putting input events like e.g.
`java.lang.Object`	`updateSize()`

controlP5 Class Controller

autoHeight

autoSpacing

autoWidth

add

addCallback

addListener

align

bringToFront

bringToFront

changeValue

getAbsolutePosition

getAddress

getArrayValue

getArrayValue

getBehavior

getCaptionLabel

getColor

getControllerPlugList

getControlWindow

getDecimalPrecision

getDefaultValue

getHeight

getId

getLabel

getMax

getMin

getName

getParent

getPickingColor

getPosition

getProperty

getProperty

getStringValue

getTab

getValue

getValueLabel

getWidth

getWindow

hide

init

isActive

isBroadcast

isInside

isLabelVisible

isListening

isLock

isMouseOver

isMousePressed

isMoveable

isUpdate

isVisible

keyEvent

linebreak

listen

listenerSize

lock

moveTo

moveTo

moveTo

moveTo

moveTo

moveTo

moveTo

moveTo

moveTo

plugTo

plugTo

plugTo

plugTo

registerProperty

registerProperty

registerTooltip

remove

remove

removeBehavior

removeCallback

removeCallback

removeListener

removeProperty

controlP5
Class Controller