public class Toggle extends Controller<Toggle>
/**
* ControlP5 Toggle
*
*
* find a list of public methods available for the Toggle Controller
* at the bottom of this sketch.
*
* by Andreas Schlegel, 2011
* www.sojamo.de/libraries/controlp5
*
*/
import controlP5.*;
ControlP5 cp5;
int col = color(255);
boolean toggleValue = false;
void setup() {
size(400,400);
smooth();
cp5 = new ControlP5(this);
// create a toggle
cp5.addToggle("toggleValue")
.setPosition(40,100)
.setSize(50,20)
;
// create a toggle and change the default look to a (on/off) switch look
cp5.addToggle("toggle")
.setPosition(40,250)
.setSize(50,20)
.setValue(true)
.setMode(ControlP5.SWITCH)
;
}
void draw() {
background(0);
pushMatrix();
if(toggleValue==true) {
fill(255,255,220);
} else {
fill(128,128,110);
}
translate(280,100);
ellipse(0,0,100,100);
translate(0,150);
fill(col);
ellipse(0,0,40,40);
popMatrix();
}
void toggle(boolean theFlag) {
if(theFlag==true) {
col = color(255);
} else {
col = color(100);
}
println("a toggle event.");
}
/*
a list of all methods available for the Toggle Controller
use ControlP5.printPublicMethodsFor(Toggle.class);
to print the following list into the console.
You can find further details about class Toggle in the javadoc.
Format:
ClassName : returnType methodName(parameter type)
controlP5.Toggle : Toggle setMode(int)
controlP5.Toggle : Toggle setState(boolean)
controlP5.Toggle : Toggle setValue(boolean)
controlP5.Toggle : Toggle setValue(float)
controlP5.Toggle : Toggle toggle()
controlP5.Toggle : Toggle update()
controlP5.Toggle : boolean getState()
controlP5.Controller : CColor getColor()
controlP5.Controller : ControlBehavior getBehavior()
controlP5.Controller : ControlWindow getControlWindow()
controlP5.Controller : ControlWindow getWindow()
controlP5.Controller : Controller addCallback(CallbackListener)
controlP5.Controller : Controller addListener(ControlListener)
controlP5.Controller : Controller hide()
controlP5.Controller : Controller linebreak()
controlP5.Controller : Controller listen(boolean)
controlP5.Controller : Controller lock()
controlP5.Controller : Controller plugTo(Object)
controlP5.Controller : Controller plugTo(Object, String)
controlP5.Controller : Controller plugTo(Object[])
controlP5.Controller : Controller plugTo(Object[], String)
controlP5.Controller : Controller registerProperty(String)
controlP5.Controller : Controller registerProperty(String, String)
controlP5.Controller : Controller registerTooltip(String)
controlP5.Controller : Controller removeBehavior()
controlP5.Controller : Controller removeCallback()
controlP5.Controller : Controller removeCallback(CallbackListener)
controlP5.Controller : Controller removeListener(ControlListener)
controlP5.Controller : Controller removeProperty(String)
controlP5.Controller : Controller removeProperty(String, String)
controlP5.Controller : Controller setArrayValue(float[])
controlP5.Controller : Controller setArrayValue(int, float)
controlP5.Controller : Controller setBehavior(ControlBehavior)
controlP5.Controller : Controller setBroadcast(boolean)
controlP5.Controller : Controller setCaptionLabel(String)
controlP5.Controller : Controller setColor(CColor)
controlP5.Controller : Controller setColorActive(int)
controlP5.Controller : Controller setColorBackground(int)
controlP5.Controller : Controller setColorCaptionLabel(int)
controlP5.Controller : Controller setColorForeground(int)
controlP5.Controller : Controller setColorValueLabel(int)
controlP5.Controller : Controller setDecimalPrecision(int)
controlP5.Controller : Controller setDefaultValue(float)
controlP5.Controller : Controller setDisplay(ControllerDisplay)
controlP5.Controller : Controller setHeight(int)
controlP5.Controller : Controller setId(int)
controlP5.Controller : Controller setImages(PImage, PImage, PImage)
controlP5.Controller : Controller setImages(PImage, PImage, PImage, PImage)
controlP5.Controller : Controller setLabelVisible(boolean)
controlP5.Controller : Controller setLock(boolean)
controlP5.Controller : Controller setMax(float)
controlP5.Controller : Controller setMin(float)
controlP5.Controller : Controller setMoveable(boolean)
controlP5.Controller : Controller setPosition(PVector)
controlP5.Controller : Controller setPosition(float, float)
controlP5.Controller : Controller setSize(PImage)
controlP5.Controller : Controller setSize(int, int)
controlP5.Controller : Controller setStringValue(String)
controlP5.Controller : Controller setUpdate(boolean)
controlP5.Controller : Controller setValueLabel(String)
controlP5.Controller : Controller setVisible(boolean)
controlP5.Controller : Controller setWidth(int)
controlP5.Controller : Controller show()
controlP5.Controller : Controller unlock()
controlP5.Controller : Controller unplugFrom(Object)
controlP5.Controller : Controller unplugFrom(Object[])
controlP5.Controller : Controller unregisterTooltip()
controlP5.Controller : Controller update()
controlP5.Controller : Controller updateSize()
controlP5.Controller : ControllerProperty getProperty(String)
controlP5.Controller : ControllerProperty getProperty(String, String)
controlP5.Controller : Label getCaptionLabel()
controlP5.Controller : Label getValueLabel()
controlP5.Controller : List getControllerPlugList()
controlP5.Controller : PImage setImage(PImage)
controlP5.Controller : PImage setImage(PImage, int)
controlP5.Controller : PVector getAbsolutePosition()
controlP5.Controller : PVector getPosition()
controlP5.Controller : String getAddress()
controlP5.Controller : String getInfo()
controlP5.Controller : String getLabel()
controlP5.Controller : String getName()
controlP5.Controller : String getStringValue()
controlP5.Controller : String toString()
controlP5.Controller : Tab getTab()
controlP5.Controller : boolean isActive()
controlP5.Controller : boolean isBroadcast()
controlP5.Controller : boolean isInside()
controlP5.Controller : boolean isListening()
controlP5.Controller : boolean isLock()
controlP5.Controller : boolean isMouseOver()
controlP5.Controller : boolean isMousePressed()
controlP5.Controller : boolean isMoveable()
controlP5.Controller : boolean isUpdate()
controlP5.Controller : boolean isVisible()
controlP5.Controller : float getArrayValue(int)
controlP5.Controller : float getDefaultValue()
controlP5.Controller : float getMax()
controlP5.Controller : float getMin()
controlP5.Controller : float getValue()
controlP5.Controller : float[] getArrayValue()
controlP5.Controller : int getHeight()
controlP5.Controller : int getId()
controlP5.Controller : int getWidth()
controlP5.Controller : int listenerSize()
controlP5.Controller : void remove()
controlP5.Controller : void setDisplay(ControllerDisplay, int)
java.lang.Object : String toString()
java.lang.Object : boolean equals(Object)
*/
Modifier and Type | Field and Description |
---|---|
static int |
autoHeight |
static int |
autoWidth |
acceptClassList, ACTION_BROADCAST, ACTION_CLICK, ACTION_DRAG, ACTION_ENTER, ACTION_EXIT, ACTION_LEAVE, ACTION_MOVE, ACTION_PRESS, ACTION_PRESSED, ACTION_RELEASE, ACTION_RELEASED, ACTION_RELEASEDOUTSIDE, ACTION_WHEEL, ACTIVE, ALL, ALT, AQUA, ARC, ARRAY, BACKSPACE, BASELINE, BITFONT, BLACK, BLUE, BOOLEAN, BOTTOM, BOTTOM_OUTSIDE, CAPTIONLABEL, CENTER, CHECKBOX, COMMANDKEY, CONTROL, controlEventClass, CUSTOM, DECREASE, DEFAULT, DELETE, DONE, DOWN, DROPDOWN, ELLIPSE, ENTER, ESCAPE, EVENT, eventMethod, FADEIN, FADEOUT, FIELD, FLOAT, FUCHSIA, GRAY, GREEN, grixel, HALF_PI, HIDE, HIGHLIGHT, HORIZONTAL, IDLE, IMAGE, INACTIVE, INCREASE, INTEGER, INVALID, J2D, KEYCONTROL, LEFT, LEFT_OUTSIDE, LIME, LINE, LIST, LOAD, MAROON, MENU, METHOD, MOVE, MULTI, MULTIPLES, NAVY, OLIVE, ORANGE, OVER, P2D, P3D, PI, PRESSED, PRINT, PURPLE, RED, RELEASE, RESET, RIGHT, RIGHT_OUTSIDE, SAVE, SHIFT, SILVER, SINGLE, SINGLE_COLUMN, SINGLE_ROW, SPRITE, standard56, standard58, STRING, SWITCH, SWITCH_BACK, SWITCH_FORE, synt24, TAB, TEAL, THEME_A, THEME_CP52014, THEME_CP5BLUE, THEME_RED, THEME_RETRO, THEME_WHITE, TOP, TOP_OUTSIDE, TRANSITION_WAIT_FADEIN, TREE, TWO_PI, UP, VALUELABEL, VERBOSE, VERTICAL, WAIT, WHITE, YELLOW
Constructor and Description |
---|
Toggle(ControlP5 theControlP5,
java.lang.String theName)
Convenience constructor to extend Toggle.
|
Toggle(ControlP5 theControlP5,
Tab theParent,
java.lang.String theName,
float theValue,
float theX,
float theY,
int theWidth,
int theHeight) |
Modifier and Type | Method and Description |
---|---|
void |
draw(processing.core.PGraphics theGraphics)
the default draw function for each controller extending superclass Controller.
|
boolean |
getState() |
float |
internalValue() |
Toggle |
linebreak() |
void |
mousePressed() |
Toggle |
setImages(processing.core.PImage... theImages) |
void |
setInternalValue(float theInternalValue)
by default a toggle returns 0 (for off) and 1 (for on).
|
Toggle |
setMode(int theMode)
set the visual mode of a Toggle.
|
Toggle |
setState(boolean theFlag)
sets the state of the toggle, this can be true or false.
|
Toggle |
setValue(boolean theValue) |
Toggle |
setValue(float theValue) |
Toggle |
toggle()
switch the state of a toggle.
|
Toggle |
update()
updates the value of the controller without having to set the value explicitly.
|
Toggle |
updateDisplayMode(int theState) |
add, addCallback, addListener, align, bringToFront, bringToFront, changeValue, continuousUpdateEvents, getAbsolutePosition, getAddress, getArrayValue, getArrayValue, getBehavior, getCaptionLabel, getColor, getControllerPlugList, getControlWindow, getDecimalPrecision, getDefaultValue, getHeight, getId, getInfo, getLabel, getMax, getMin, getName, getParent, getPickingColor, getPointer, getPosition, getProperty, getProperty, getStringValue, getTab, getValue, getValueLabel, getView, getWidth, getWindow, hide, init, isActive, isBroadcast, isInside, isLabelVisible, isListening, isLock, isMouseOver, isMousePressed, isMoveable, isUpdate, isUserInteraction, isVisible, keyEvent, 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, removeProperty, setAbsolutePosition, setAddress, setArrayValue, setArrayValue, setBehavior, setBroadcast, setCaptionLabel, setColor, setColorActive, setColorBackground, setColorCaptionLabel, setColorForeground, setColorValueLabel, setDecimalPrecision, setDefaultValue, setGroup, setGroup, setHeight, setId, setImage, setImage, setImages, setImages, setLabelVisible, setLock, setMax, setMin, setMouseOver, setMousePressed, setMoveable, setParent, setPosition, setPosition, setSize, setSize, setStringValue, setTab, setTab, setUpdate, setUserInteraction, setValueLabel, setValueSelf, setView, setView, setVisible, setWidth, show, toString, unlock, unplugFrom, unplugFrom, unregisterTooltip, updateAbsolutePosition, updateEvents, updateInternalEvents, updateSize
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
parent, setColorLabel, setColorValue, setLabel
public Toggle(ControlP5 theControlP5, java.lang.String theName)
theControlP5
- theName
- /**
* ControlP5 extending Controllers
*
* the following example shows how to extend the Controller class to
* create customizable Controllers. You can either extend the Controller class itself,
* or any class that extends Controller itself like the Slider, Button, DropdownList, etc.
*
* How to:
*
* 1) do a super call to the convenience constructor requiring
* 2 parameter (ControlP5 instance, name)
*
* 2) the Controller class has a set of empty methods that allow you to capture
* inputs from the mouse including
* onEnter(), onLeave(), onPress(), onRelease(), onClick(), onScroll(int), onDrag()
* These you can override and include functionality as needed.
*
* 3) use method getPointer() to return the local (relative)
* xy-coordinates of the controller
*
* 4) after instantiation custom controllers are treated the same
* as default controlP5 controllers.
*
* by Andreas Schlegel, 2012
* www.sojamo.de/libraries/controlp5
*
*/
import controlP5.*;
ControlP5 cp5;
PApplet p;
void setup() {
size(400, 400);
cp5 = new ControlP5(this);
// create 2 groups to show nesting of custom controllers and
//
Group g1 = cp5.addGroup("a").setPosition(0,100).setWidth(180);
Group g2 = cp5.addGroup("b").setPosition(0,10).setWidth(180);
g2.moveTo(g1);
// create 2 custom Controllers from class MyButton
// MyButton extends Controller and inherits all methods accordingly.
new MyButton(cp5, "b1").setPosition(0, 0).setSize(180, 200).moveTo(g2);
new MyButton(cp5, "b2").setPosition(205, 15).setSize(180, 200);
}
void draw() {
background(0);
}
// b1 will be called from Controller b1
public void b1(float theValue) {
println("yay button "+theValue);
}
public void controlEvent(ControlEvent theEvent) {
println("controlEvent : "+theEvent);
}
// Create a custom Controller, please not that
// MyButton extends Controller,
// is an indicator for the super class about the type of
// custom controller to be created.
class MyButton extends Controller {
int current = 0xffff0000;
float a = 128;
float na;
int y;
// use the convenience constructor of super class Controller
// MyButton will automatically registered and move to the
// default controlP5 tab.
MyButton(ControlP5 cp5, String theName) {
super(cp5, theName);
// replace the default view with a custom view.
setView(new ControllerView() {
public void display(PApplet p, Object b) {
// draw button background
na += (a-na) * 0.1;
p.fill(current,na);
p.rect(0, 0, getWidth(), getHeight());
// draw horizontal line which can be moved on the x-axis
// using the scroll wheel.
p.fill(0,255,0);
p.rect(0,y,width,10);
// draw the custom label
p.fill(128);
translate(0,getHeight()+14);
p.text(getName(),0,0);
p.text(getName(),0,0);
}
}
);
}
// override various input methods for mouse input control
void onEnter() {
cursor(HAND);
println("enter");
a = 255;
}
void onScroll(int n) {
println("scrolling");
y -= n;
y = constrain(y,0,getHeight()-10);
}
void onPress() {
println("press");
current = 0xffffff00;
}
void onClick() {
Pointer p1 = getPointer();
println("clicked at "+p1.x()+", "+p1.y());
current = 0xffffff00;
setValue(y);
}
void onRelease() {
println("release");
current = 0xffffffff;
}
void onMove() {
println("moving "+this+" "+_myControlWindow.getMouseOverList());
}
void onDrag() {
current = 0xff0000ff;
Pointer p1 = getPointer();
float dif = dist(p1.px(),p1.py(),p1.x(),p1.y());
println("dragging at "+p1.x()+", "+p1.y()+" "+dif);
}
void onReleaseOutside() {
onLeave();
}
void onLeave() {
println("leave");
cursor(ARROW);
a = 128;
}
}
public void draw(processing.core.PGraphics theGraphics)
Controller
draw
in interface CDrawable
draw
in interface ControllerInterface<Toggle>
draw
in class Controller<Toggle>
theApplet
- PAppletControllerView
public boolean getState()
public float internalValue()
public Toggle linebreak()
linebreak
in class Controller<Toggle>
public void mousePressed()
public Toggle setImages(processing.core.PImage... theImages)
setImages
in class Controller<Toggle>
public void setInternalValue(float theInternalValue)
theInternalValue
- public Toggle setMode(int theMode)
theMode
- public Toggle setState(boolean theFlag)
theFlag
- booleanpublic Toggle setValue(boolean theValue)
theValue
- public Toggle setValue(float theValue)
setValue
in interface ControllerInterface<Toggle>
setValue
in class Controller<Toggle>
theValue
- floatpublic Toggle toggle()
public Toggle update()
update
in interface ControllerInterface<Toggle>
update
in class Controller<Toggle>
Controller.setUpdate(boolean)
,
Controller.isUpdate()
public Toggle updateDisplayMode(int theState)
processing library controlP5 by Andreas Schlegel. (c) 2006-2014