mirror of
https://github.com/sojamo/controlp5
synced 2024-11-26 15:44:55 +01:00
971 lines
55 KiB
HTML
971 lines
55 KiB
HTML
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
||
|
<!-- NewPage -->
|
||
|
<html lang="en">
|
||
|
<head>
|
||
|
<!-- Generated by javadoc (version 1.7.0_51) on Sun Apr 27 21:39:48 SGT 2014 -->
|
||
|
<title>Toggle (Javadocs: controlP5)</title>
|
||
|
<meta name="date" content="2014-04-27">
|
||
|
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
|
||
|
</head>
|
||
|
<body>
|
||
|
<script type="text/javascript"><!--
|
||
|
if (location.href.indexOf('is-external=true') == -1) {
|
||
|
parent.document.title="Toggle (Javadocs: controlP5)";
|
||
|
}
|
||
|
//-->
|
||
|
</script>
|
||
|
<noscript>
|
||
|
<div>JavaScript is disabled on your browser.</div>
|
||
|
</noscript>
|
||
|
<!-- ========= START OF TOP NAVBAR ======= -->
|
||
|
<div class="topNav"><a name="navbar_top">
|
||
|
<!-- -->
|
||
|
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<ul class="navList" title="Navigation">
|
||
|
<li><a href="../controlP5/package-summary.html">Package</a></li>
|
||
|
<li class="navBarCell1Rev">Class</li>
|
||
|
<li><a href="package-tree.html">Tree</a></li>
|
||
|
<li><a href="../index-all.html">Index</a></li>
|
||
|
<li><a href="../help-doc.html">Help</a></li>
|
||
|
</ul>
|
||
|
</div>
|
||
|
<div class="subNav">
|
||
|
<ul class="navList">
|
||
|
<li><a href="../controlP5/TickMark.html" title="class in controlP5"><span class="strong">Prev Class</span></a></li>
|
||
|
<li><a href="../controlP5/Tooltip.html" title="class in controlP5"><span class="strong">Next Class</span></a></li>
|
||
|
</ul>
|
||
|
<ul class="navList">
|
||
|
<li><a href="../index.html?controlP5/Toggle.html" target="_top">Frames</a></li>
|
||
|
<li><a href="Toggle.html" target="_top">No Frames</a></li>
|
||
|
</ul>
|
||
|
<ul class="navList" id="allclasses_navbar_top">
|
||
|
<li><a href="../allclasses-noframe.html">All Classes</a></li>
|
||
|
</ul>
|
||
|
<div>
|
||
|
<script type="text/javascript"><!--
|
||
|
allClassesLink = document.getElementById("allclasses_navbar_top");
|
||
|
if(window==top) {
|
||
|
allClassesLink.style.display = "block";
|
||
|
}
|
||
|
else {
|
||
|
allClassesLink.style.display = "none";
|
||
|
}
|
||
|
//-->
|
||
|
</script>
|
||
|
</div>
|
||
|
<div>
|
||
|
<ul class="subNavList">
|
||
|
<li>Summary: </li>
|
||
|
<li>Nested | </li>
|
||
|
<li><a href="#field_summary">Field</a> | </li>
|
||
|
<li><a href="#constructor_summary">Constr</a> | </li>
|
||
|
<li><a href="#method_summary">Method</a></li>
|
||
|
</ul>
|
||
|
<ul class="subNavList">
|
||
|
<li>Detail: </li>
|
||
|
<li><a href="#field_detail">Field</a> | </li>
|
||
|
<li><a href="#constructor_detail">Constr</a> | </li>
|
||
|
<li><a href="#method_detail">Method</a></li>
|
||
|
</ul>
|
||
|
</div>
|
||
|
<a name="skip-navbar_top">
|
||
|
<!-- -->
|
||
|
</a></div>
|
||
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
||
|
<!-- ======== START OF CLASS DATA ======== -->
|
||
|
<div class="header">
|
||
|
<div class="subTitle">controlP5</div>
|
||
|
<h2 title="Class Toggle" class="title">Class Toggle</h2>
|
||
|
</div>
|
||
|
<div class="contentContainer">
|
||
|
<ul class="inheritance">
|
||
|
<li>java.lang.Object</li>
|
||
|
<li>
|
||
|
<ul class="inheritance">
|
||
|
<li><a href="../controlP5/Controller.html" title="class in controlP5">controlP5.Controller</a><<a href="../controlP5/Toggle.html" title="class in controlP5">Toggle</a>></li>
|
||
|
<li>
|
||
|
<ul class="inheritance">
|
||
|
<li>controlP5.Toggle</li>
|
||
|
</ul>
|
||
|
</li>
|
||
|
</ul>
|
||
|
</li>
|
||
|
</ul>
|
||
|
<div class="description">
|
||
|
<ul class="blockList">
|
||
|
<li class="blockList">
|
||
|
<dl>
|
||
|
<dt>All Implemented Interfaces:</dt>
|
||
|
<dd><a href="../controlP5/CDrawable.html" title="interface in controlP5">CDrawable</a>, <a href="../controlP5/ControllerInterface.html" title="interface in controlP5">ControllerInterface</a><<a href="../controlP5/Toggle.html" title="class in controlP5">Toggle</a>>, <a href="../controlP5/ControlP5Constants.html" title="interface in controlP5">ControlP5Constants</a></dd>
|
||
|
</dl>
|
||
|
<hr>
|
||
|
<br>
|
||
|
<pre>public class <span class="strong">Toggle</span>
|
||
|
extends <a href="../controlP5/Controller.html" title="class in controlP5">Controller</a><<a href="../controlP5/Toggle.html" title="class in controlP5">Toggle</a>></pre>
|
||
|
<div class="block">a toggle can have two states, true and false, where true has the value 1 and false is 0.</div>
|
||
|
<dl><script type="text/javascript">
|
||
|
<!--
|
||
|
document.getElementsByTagName('html')[0].className = 'isjs';function toggle(dt) { var display, dd=dt; do{ dd = dd.nextSibling } while(dd.tagName!='DD'); toOpen =!dd.style.display;dd.style.display = toOpen? 'block':''; dt.getElementsByTagName('span')[0].innerHTML = toOpen? '-':'+' ; }
|
||
|
-->
|
||
|
</script>
|
||
|
<div id="test" class="toggleList"><dl><dt onclick="toggle(this);"><span>+</span>Example</dt><dd><code><pre>
|
||
|
/**
|
||
|
* 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)
|
||
|
|
||
|
|
||
|
*/
|
||
|
|
||
|
|
||
|
</pre></code></dd></dl></div></dl>
|
||
|
</li>
|
||
|
</ul>
|
||
|
</div>
|
||
|
<div class="summary">
|
||
|
<ul class="blockList">
|
||
|
<li class="blockList">
|
||
|
<!-- =========== FIELD SUMMARY =========== -->
|
||
|
<ul class="blockList">
|
||
|
<li class="blockList"><a name="field_summary">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<h3>Field Summary</h3>
|
||
|
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
|
||
|
<caption><span>Fields</span><span class="tabEnd"> </span></caption>
|
||
|
<tr>
|
||
|
<th class="colFirst" scope="col">Modifier and Type</th>
|
||
|
<th class="colLast" scope="col">Field and Description</th>
|
||
|
</tr>
|
||
|
<tr class="altColor">
|
||
|
<td class="colFirst"><code>static int</code></td>
|
||
|
<td class="colLast"><code><strong><a href="../controlP5/Toggle.html#autoHeight">autoHeight</a></strong></code> </td>
|
||
|
</tr>
|
||
|
<tr class="rowColor">
|
||
|
<td class="colFirst"><code>static int</code></td>
|
||
|
<td class="colLast"><code><strong><a href="../controlP5/Toggle.html#autoWidth">autoWidth</a></strong></code> </td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
<ul class="blockList">
|
||
|
<li class="blockList"><a name="fields_inherited_from_class_controlP5.ControlP5Constants">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<h3>Fields inherited from interface controlP5.<a href="../controlP5/ControlP5Constants.html" title="interface in controlP5">ControlP5Constants</a></h3>
|
||
|
<code><a href="../controlP5/ControlP5Constants.html#acceptClassList">acceptClassList</a>, <a href="../controlP5/ControlP5Constants.html#ACTION_BROADCAST">ACTION_BROADCAST</a>, <a href="../controlP5/ControlP5Constants.html#ACTION_CLICK">ACTION_CLICK</a>, <a href="../controlP5/ControlP5Constants.html#ACTION_DRAG">ACTION_DRAG</a>, <a href="../controlP5/ControlP5Constants.html#ACTION_ENTER">ACTION_ENTER</a>, <a href="../controlP5/ControlP5Constants.html#ACTION_EXIT">ACTION_EXIT</a>, <a href="../controlP5/ControlP5Constants.html#ACTION_LEAVE">ACTION_LEAVE</a>, <a href="../controlP5/ControlP5Constants.html#ACTION_MOVE">ACTION_MOVE</a>, <a href="../controlP5/ControlP5Constants.html#ACTION_PRESS">ACTION_PRESS</a>, <a href="../controlP5/ControlP5Constants.html#ACTION_PRESSED">ACTION_PRESSED</a>, <a href="../controlP5/ControlP5Constants.html#ACTION_RELEASE">ACTION_RELEASE</a>, <a href="../controlP5/ControlP5Constants.html#ACTION_RELEASED">ACTION_RELEASED</a>, <a href="../controlP5/ControlP5Constants.html#ACTION_RELEASEDOUTSIDE">ACTION_RELEASEDOUTSIDE</a>, <a href="../controlP5/ControlP5Constants.html#ACTION_WHEEL">ACTION_WHEEL</a>, <a href="../controlP5/ControlP5Constants.html#ACTIVE">ACTIVE</a>, <a href="../controlP5/ControlP5Constants.html#ALL">ALL</a>, <a href="../controlP5/ControlP5Constants.html#ALT">ALT</a>, <a href="../controlP5/ControlP5Constants.html#AQUA">AQUA</a>, <a href="../controlP5/ControlP5Constants.html#ARC">ARC</a>, <a href="../controlP5/ControlP5Constants.html#ARRAY">ARRAY</a>, <a href="../controlP5/ControlP5Constants.html#BACKSPACE">BACKSPACE</a>, <a href="../controlP5/ControlP5Constants.html#BASELINE">BASELINE</a>, <a href="../controlP5/ControlP5Constants.html#BITFONT">BITFONT</a>, <a href="../controlP5/ControlP5Constants.html#BLACK">BLACK</a>, <a href="../controlP5/ControlP5Constants.html#BLUE">BLUE</a>, <a href="../controlP5/ControlP5Constants.html#BOOLEAN">BOOLEAN</a>, <a href="../controlP5/ControlP5Constants.html#BOTTOM">BOTTOM</a>, <a href="../controlP5/ControlP5Constants.html#BOTTOM_OUTSIDE">BOTTOM_OUTSIDE</a>, <a href="../controlP5/ControlP5Constants.html#CAPTIONLABEL">CAPTIONLABEL</a>, <a href="../controlP5/ControlP5Constants.html#CENTER">CENTER</a>, <a href="../controlP5/ControlP5Constants.html#CHECKBOX">CHECKBOX</a>, <a href="../controlP5/ControlP5Constants.html#COMMANDKEY">COMMANDKEY</a>, <a href="../controlP5/ControlP5Constants.html#CONTROL">CONTROL</a>, <a href="../controlP5/ControlP5Constants.html#controlEventClass">controlEventClass</a>, <a href="../controlP5/ControlP5Constants.html#CUSTOM">CUSTOM</a>, <a href="../controlP5/ControlP5Constants.html#DECREASE">DECREASE</a>, <a href="../controlP5/ControlP5Constants.html#DEFAULT">DEFAULT</a>, <a href="../controlP5/ControlP5Constants.html#DELETE">DELETE</a>, <a href="../controlP5/ControlP5Constants.html#DONE">DONE</a>, <a href="../controlP5/ControlP5Constants.html#DOWN">DOWN</a>, <a href="../controlP5/ControlP5Constants.html#DROPDOWN">DROPDOWN</a>, <a href="../controlP5/ControlP5Constants.html#ELLIPSE">ELLIPSE</a>, <a href="../controlP5/ControlP5Constants.html#ENTER">ENTER</a>, <a href="../controlP5/ControlP5Constants.html#ESCAPE">ESCAPE</a>, <a href="../controlP5/ControlP5Constants.html#EVENT">EVENT</a>, <a href="../controlP5/ControlP5Constants.html#eventMethod">eventMethod</a>, <a href="../controlP5/ControlP5Constants.html#FADEIN">FADEIN</a>, <a href="../controlP5/ControlP5Constants.html#FADEOUT">FADEOUT</a>, <a href="../controlP5/ControlP5Constants.html#FIELD">FIELD</a>, <a href="../controlP5/ControlP5Constants.html#FLOAT">FLOAT</a>, <a href="../controlP5/ControlP5Constants.html#FUCHSIA">FUCHSIA</a>, <a href="../controlP5/ControlP5Constants.html#GRAY">GRAY</a>, <a href="../controlP5/ControlP5Constants.html#GREEN">GREEN</a>, <a href="../controlP5/ControlP5Constants.html#grixel">grixel</a>, <a href="../controlP5/ControlP5Constants.html#HALF_PI">HALF_PI</a>, <a href="../controlP5/ControlP5Constants.html#HIDE">HIDE</a>, <a href="../controlP5/ControlP5Constants.html#HIGHLIGHT">HIGHLIGHT</a>, <a href="../controlP5/ControlP5Constants.html#HORIZONTAL">HOR
|
||
|
</ul>
|
||
|
</li>
|
||
|
</ul>
|
||
|
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
||
|
<ul class="blockList">
|
||
|
<li class="blockList"><a name="constructor_summary">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<h3>Constructor Summary</h3>
|
||
|
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
|
||
|
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
|
||
|
<tr>
|
||
|
<th class="colOne" scope="col">Constructor and Description</th>
|
||
|
</tr>
|
||
|
<tr class="altColor">
|
||
|
<td class="colOne"><code><strong><a href="../controlP5/Toggle.html#Toggle(controlP5.ControlP5, java.lang.String)">Toggle</a></strong>(<a href="../controlP5/ControlP5.html" title="class in controlP5">ControlP5</a> theControlP5,
|
||
|
java.lang.String theName)</code>
|
||
|
<div class="block">Convenience constructor to extend Toggle.</div>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr class="rowColor">
|
||
|
<td class="colOne"><code><strong><a href="../controlP5/Toggle.html#Toggle(controlP5.ControlP5, controlP5.Tab, java.lang.String, float, float, float, int, int)">Toggle</a></strong>(<a href="../controlP5/ControlP5.html" title="class in controlP5">ControlP5</a> theControlP5,
|
||
|
<a href="../controlP5/Tab.html" title="class in controlP5">Tab</a> theParent,
|
||
|
java.lang.String theName,
|
||
|
float theValue,
|
||
|
float theX,
|
||
|
float theY,
|
||
|
int theWidth,
|
||
|
int theHeight)</code> </td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</li>
|
||
|
</ul>
|
||
|
<!-- ========== METHOD SUMMARY =========== -->
|
||
|
<ul class="blockList">
|
||
|
<li class="blockList"><a name="method_summary">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<h3>Method Summary</h3>
|
||
|
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
|
||
|
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
|
||
|
<tr>
|
||
|
<th class="colFirst" scope="col">Modifier and Type</th>
|
||
|
<th class="colLast" scope="col">Method and Description</th>
|
||
|
</tr>
|
||
|
<tr class="altColor">
|
||
|
<td class="colFirst"><code>void</code></td>
|
||
|
<td class="colLast"><code><strong><a href="../controlP5/Toggle.html#draw(processing.core.PGraphics)">draw</a></strong>(processing.core.PGraphics theGraphics)</code>
|
||
|
<div class="block">the default draw function for each controller extending superclass Controller.</div>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr class="rowColor">
|
||
|
<td class="colFirst"><code>boolean</code></td>
|
||
|
<td class="colLast"><code><strong><a href="../controlP5/Toggle.html#getState()">getState</a></strong>()</code> </td>
|
||
|
</tr>
|
||
|
<tr class="altColor">
|
||
|
<td class="colFirst"><code>float</code></td>
|
||
|
<td class="colLast"><code><strong><a href="../controlP5/Toggle.html#internalValue()">internalValue</a></strong>()</code> </td>
|
||
|
</tr>
|
||
|
<tr class="rowColor">
|
||
|
<td class="colFirst"><code><a href="../controlP5/Toggle.html" title="class in controlP5">Toggle</a></code></td>
|
||
|
<td class="colLast"><code><strong><a href="../controlP5/Toggle.html#linebreak()">linebreak</a></strong>()</code></td>
|
||
|
</tr>
|
||
|
<tr class="altColor">
|
||
|
<td class="colFirst"><code>void</code></td>
|
||
|
<td class="colLast"><code><strong><a href="../controlP5/Toggle.html#mousePressed()">mousePressed</a></strong>()</code></td>
|
||
|
</tr>
|
||
|
<tr class="rowColor">
|
||
|
<td class="colFirst"><code><a href="../controlP5/Toggle.html" title="class in controlP5">Toggle</a></code></td>
|
||
|
<td class="colLast"><code><strong><a href="../controlP5/Toggle.html#setImages(processing.core.PImage...)">setImages</a></strong>(processing.core.PImage... theImages)</code> </td>
|
||
|
</tr>
|
||
|
<tr class="altColor">
|
||
|
<td class="colFirst"><code>void</code></td>
|
||
|
<td class="colLast"><code><strong><a href="../controlP5/Toggle.html#setInternalValue(float)">setInternalValue</a></strong>(float theInternalValue)</code>
|
||
|
<div class="block">by default a toggle returns 0 (for off) and 1 (for on).</div>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr class="rowColor">
|
||
|
<td class="colFirst"><code><a href="../controlP5/Toggle.html" title="class in controlP5">Toggle</a></code></td>
|
||
|
<td class="colLast"><code><strong><a href="../controlP5/Toggle.html#setMode(int)">setMode</a></strong>(int theMode)</code>
|
||
|
<div class="block">set the visual mode of a Toggle.</div>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr class="altColor">
|
||
|
<td class="colFirst"><code><a href="../controlP5/Toggle.html" title="class in controlP5">Toggle</a></code></td>
|
||
|
<td class="colLast"><code><strong><a href="../controlP5/Toggle.html#setState(boolean)">setState</a></strong>(boolean theFlag)</code>
|
||
|
<div class="block">sets the state of the toggle, this can be true or false.</div>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr class="rowColor">
|
||
|
<td class="colFirst"><code><a href="../controlP5/Toggle.html" title="class in controlP5">Toggle</a></code></td>
|
||
|
<td class="colLast"><code><strong><a href="../controlP5/Toggle.html#setValue(boolean)">setValue</a></strong>(boolean theValue)</code> </td>
|
||
|
</tr>
|
||
|
<tr class="altColor">
|
||
|
<td class="colFirst"><code><a href="../controlP5/Toggle.html" title="class in controlP5">Toggle</a></code></td>
|
||
|
<td class="colLast"><code><strong><a href="../controlP5/Toggle.html#setValue(float)">setValue</a></strong>(float theValue)</code></td>
|
||
|
</tr>
|
||
|
<tr class="rowColor">
|
||
|
<td class="colFirst"><code><a href="../controlP5/Toggle.html" title="class in controlP5">Toggle</a></code></td>
|
||
|
<td class="colLast"><code><strong><a href="../controlP5/Toggle.html#toggle()">toggle</a></strong>()</code>
|
||
|
<div class="block">switch the state of a toggle.</div>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr class="altColor">
|
||
|
<td class="colFirst"><code><a href="../controlP5/Toggle.html" title="class in controlP5">Toggle</a></code></td>
|
||
|
<td class="colLast"><code><strong><a href="../controlP5/Toggle.html#update()">update</a></strong>()</code>
|
||
|
<div class="block">updates the value of the controller without having to set the value explicitly.</div>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr class="rowColor">
|
||
|
<td class="colFirst"><code><a href="../controlP5/Toggle.html" title="class in controlP5">Toggle</a></code></td>
|
||
|
<td class="colLast"><code><strong><a href="../controlP5/Toggle.html#updateDisplayMode(int)">updateDisplayMode</a></strong>(int theState)</code></td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
<ul class="blockList">
|
||
|
<li class="blockList"><a name="methods_inherited_from_class_controlP5.Controller">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<h3>Methods inherited from class controlP5.<a href="../controlP5/Controller.html" title="class in controlP5">Controller</a></h3>
|
||
|
<code><a href="../controlP5/Controller.html#add(controlP5.ControllerInterface)">add</a>, <a href="../controlP5/Controller.html#addCallback(controlP5.CallbackListener)">addCallback</a>, <a href="../controlP5/Controller.html#addListener(controlP5.ControlListener)">addListener</a>, <a href="../controlP5/Controller.html#align(int, int, int, int)">align</a>, <a href="../controlP5/Controller.html#bringToFront()">bringToFront</a>, <a href="../controlP5/Controller.html#bringToFront(controlP5.ControllerInterface)">bringToFront</a>, <a href="../controlP5/Controller.html#changeValue(float)">changeValue</a>, <a href="../controlP5/Controller.html#continuousUpdateEvents()">continuousUpdateEvents</a>, <a href="../controlP5/Controller.html#getAbsolutePosition()">getAbsolutePosition</a>, <a href="../controlP5/Controller.html#getAddress()">getAddress</a>, <a href="../controlP5/Controller.html#getArrayValue()">getArrayValue</a>, <a href="../controlP5/Controller.html#getArrayValue(int)">getArrayValue</a>, <a href="../controlP5/Controller.html#getBehavior()">getBehavior</a>, <a href="../controlP5/Controller.html#getCaptionLabel()">getCaptionLabel</a>, <a href="../controlP5/Controller.html#getColor()">getColor</a>, <a href="../controlP5/Controller.html#getControllerPlugList()">getControllerPlugList</a>, <a href="../controlP5/Controller.html#getControlWindow()">getControlWindow</a>, <a href="../controlP5/Controller.html#getDecimalPrecision()">getDecimalPrecision</a>, <a href="../controlP5/Controller.html#getDefaultValue()">getDefaultValue</a>, <a href="../controlP5/Controller.html#getHeight()">getHeight</a>, <a href="../controlP5/Controller.html#getId()">getId</a>, <a href="../controlP5/Controller.html#getInfo()">getInfo</a>, <a href="../controlP5/Controller.html#getLabel()">getLabel</a>, <a href="../controlP5/Controller.html#getMax()">getMax</a>, <a href="../controlP5/Controller.html#getMin()">getMin</a>, <a href="../controlP5/Controller.html#getName()">getName</a>, <a href="../controlP5/Controller.html#getParent()">getParent</a>, <a href="../controlP5/Controller.html#getPickingColor()">getPickingColor</a>, <a href="../controlP5/Controller.html#getPointer()">getPointer</a>, <a href="../controlP5/Controller.html#getPosition()">getPosition</a>, <a href="../controlP5/Controller.html#getProperty(java.lang.String)">getProperty</a>, <a href="../controlP5/Controller.html#getProperty(java.lang.String, java.lang.String)">getProperty</a>, <a href="../controlP5/Controller.html#getStringValue()">getStringValue</a>, <a href="../controlP5/Controller.html#getTab()">getTab</a>, <a href="../controlP5/Controller.html#getValue()">getValue</a>, <a href="../controlP5/Controller.html#getValueLabel()">getValueLabel</a>, <a href="../controlP5/Controller.html#getView()">getView</a>, <a href="../controlP5/Controller.html#getWidth()">getWidth</a>, <a href="../controlP5/Controller.html#getWindow()">getWindow</a>, <a href="../controlP5/Controller.html#hide()">hide</a>, <a href="../controlP5/Controller.html#init()">init</a>, <a href="../controlP5/Controller.html#isActive()">isActive</a>, <a href="../controlP5/Controller.html#isBroadcast()">isBroadcast</a>, <a href="../controlP5/Controller.html#isInside()">isInside</a>, <a href="../controlP5/Controller.html#isLabelVisible()">isLabelVisible</a>, <a href="../controlP5/Controller.html#isListening()">isListening</a>, <a href="../controlP5/Controller.html#isLock()">isLock</a>, <a href="../controlP5/Controller.html#isMouseOver()">isMouseOver</a>, <a href="../controlP5/Controller.html#isMousePressed()">isMousePressed</a>, <a href="../controlP5/Controller.html#isMoveable()">isMoveable</a>, <a href="../controlP5/Controller.html#isUpdate()">isUpdate</a>, <a href="../controlP5/Controller.html#isUserInteraction()">isUserInteraction</a>, <a href="../controlP5/Controller.html#isVisible()">isVisible</a>, <a href="../controlP5/Controller.html#keyEvent(processing.event.KeyEvent)">keyEvent</a>, <a href="../controlP5/Controller.html#listen(boolean)">listen</a>, <a href="../controlP5/Controller.html#listenerSize()">listenerSize</a>, <a href=
|
||
|
</ul>
|
||
|
<ul class="blockList">
|
||
|
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<h3>Methods inherited from class java.lang.Object</h3>
|
||
|
<code>equals, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
|
||
|
</ul>
|
||
|
<ul class="blockList">
|
||
|
<li class="blockList"><a name="methods_inherited_from_class_controlP5.ControllerInterface">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<h3>Methods inherited from interface controlP5.<a href="../controlP5/ControllerInterface.html" title="interface in controlP5">ControllerInterface</a></h3>
|
||
|
<code><a href="../controlP5/ControllerInterface.html#parent()">parent</a>, <a href="../controlP5/ControllerInterface.html#setColorLabel(int)">setColorLabel</a>, <a href="../controlP5/ControllerInterface.html#setColorValue(int)">setColorValue</a>, <a href="../controlP5/ControllerInterface.html#setLabel(java.lang.String)">setLabel</a></code></li>
|
||
|
</ul>
|
||
|
</li>
|
||
|
</ul>
|
||
|
</li>
|
||
|
</ul>
|
||
|
</div>
|
||
|
<div class="details">
|
||
|
<ul class="blockList">
|
||
|
<li class="blockList">
|
||
|
<!-- ============ FIELD DETAIL =========== -->
|
||
|
<ul class="blockList">
|
||
|
<li class="blockList"><a name="field_detail">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<h3>Field Detail</h3>
|
||
|
<a name="autoHeight">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<ul class="blockList">
|
||
|
<li class="blockList">
|
||
|
<h4>autoHeight</h4>
|
||
|
<pre>public static int autoHeight</pre>
|
||
|
</li>
|
||
|
</ul>
|
||
|
<a name="autoWidth">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<ul class="blockListLast">
|
||
|
<li class="blockList">
|
||
|
<h4>autoWidth</h4>
|
||
|
<pre>public static int autoWidth</pre>
|
||
|
</li>
|
||
|
</ul>
|
||
|
</li>
|
||
|
</ul>
|
||
|
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
||
|
<ul class="blockList">
|
||
|
<li class="blockList"><a name="constructor_detail">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<h3>Constructor Detail</h3>
|
||
|
<a name="Toggle(controlP5.ControlP5, java.lang.String)">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<ul class="blockList">
|
||
|
<li class="blockList">
|
||
|
<h4>Toggle</h4>
|
||
|
<pre>public Toggle(<a href="../controlP5/ControlP5.html" title="class in controlP5">ControlP5</a> theControlP5,
|
||
|
java.lang.String theName)</pre>
|
||
|
<div class="block">Convenience constructor to extend Toggle.</div>
|
||
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>theControlP5</code> - </dd><dd><code>theName</code> - </dd><script type="text/javascript">
|
||
|
<!--
|
||
|
document.getElementsByTagName('html')[0].className = 'isjs';function toggle(dt) { var display, dd=dt; do{ dd = dd.nextSibling } while(dd.tagName!='DD'); toOpen =!dd.style.display;dd.style.display = toOpen? 'block':''; dt.getElementsByTagName('span')[0].innerHTML = toOpen? '-':'+' ; }
|
||
|
-->
|
||
|
</script>
|
||
|
<div id="test" class="toggleList"><dl><dt onclick="toggle(this);"><span>+</span>Example</dt><dd><code><pre>/**
|
||
|
* 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<MyButton>, <MyButton>
|
||
|
// is an indicator for the super class about the type of
|
||
|
// custom controller to be created.
|
||
|
|
||
|
class MyButton extends Controller<MyButton> {
|
||
|
|
||
|
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;
|
||
|
}
|
||
|
}
|
||
|
|
||
|
</pre></code></dd></dl></div></dl>
|
||
|
</li>
|
||
|
</ul>
|
||
|
<a name="Toggle(controlP5.ControlP5, controlP5.Tab, java.lang.String, float, float, float, int, int)">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<ul class="blockListLast">
|
||
|
<li class="blockList">
|
||
|
<h4>Toggle</h4>
|
||
|
<pre>public Toggle(<a href="../controlP5/ControlP5.html" title="class in controlP5">ControlP5</a> theControlP5,
|
||
|
<a href="../controlP5/Tab.html" title="class in controlP5">Tab</a> theParent,
|
||
|
java.lang.String theName,
|
||
|
float theValue,
|
||
|
float theX,
|
||
|
float theY,
|
||
|
int theWidth,
|
||
|
int theHeight)</pre>
|
||
|
</li>
|
||
|
</ul>
|
||
|
</li>
|
||
|
</ul>
|
||
|
<!-- ============ METHOD DETAIL ========== -->
|
||
|
<ul class="blockList">
|
||
|
<li class="blockList"><a name="method_detail">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<h3>Method Detail</h3>
|
||
|
<a name="draw(processing.core.PGraphics)">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<ul class="blockList">
|
||
|
<li class="blockList">
|
||
|
<h4>draw</h4>
|
||
|
<pre>public void draw(processing.core.PGraphics theGraphics)</pre>
|
||
|
<div class="block"><strong>Description copied from class: <code><a href="../controlP5/Controller.html#draw(processing.core.PGraphics)">Controller</a></code></strong></div>
|
||
|
<div class="block">the default draw function for each controller extending superclass Controller. This draw
|
||
|
function will take care of default matrix operations and will call the display function of
|
||
|
the current ControllerView object active for this particular controller.</div>
|
||
|
<dl>
|
||
|
<dt><strong>Specified by:</strong></dt>
|
||
|
<dd><code><a href="../controlP5/CDrawable.html#draw(processing.core.PGraphics)">draw</a></code> in interface <code><a href="../controlP5/CDrawable.html" title="interface in controlP5">CDrawable</a></code></dd>
|
||
|
<dt><strong>Specified by:</strong></dt>
|
||
|
<dd><code><a href="../controlP5/ControllerInterface.html#draw(processing.core.PGraphics)">draw</a></code> in interface <code><a href="../controlP5/ControllerInterface.html" title="interface in controlP5">ControllerInterface</a><<a href="../controlP5/Toggle.html" title="class in controlP5">Toggle</a>></code></dd>
|
||
|
<dt><strong>Overrides:</strong></dt>
|
||
|
<dd><code><a href="../controlP5/Controller.html#draw(processing.core.PGraphics)">draw</a></code> in class <code><a href="../controlP5/Controller.html" title="class in controlP5">Controller</a><<a href="../controlP5/Toggle.html" title="class in controlP5">Toggle</a>></code></dd>
|
||
|
<dt><span class="strong">Parameters:</span></dt><dd><code>theApplet</code> - PApplet</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../controlP5/ControllerView.html" title="interface in controlP5"><code>ControllerView</code></a></dd></dl>
|
||
|
</li>
|
||
|
</ul>
|
||
|
<a name="getState()">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<ul class="blockList">
|
||
|
<li class="blockList">
|
||
|
<h4>getState</h4>
|
||
|
<pre>public boolean getState()</pre>
|
||
|
<dl><dt><span class="strong">Returns:</span></dt><dd></dd></dl>
|
||
|
</li>
|
||
|
</ul>
|
||
|
<a name="internalValue()">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<ul class="blockList">
|
||
|
<li class="blockList">
|
||
|
<h4>internalValue</h4>
|
||
|
<pre>public float internalValue()</pre>
|
||
|
</li>
|
||
|
</ul>
|
||
|
<a name="linebreak()">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<ul class="blockList">
|
||
|
<li class="blockList">
|
||
|
<h4>linebreak</h4>
|
||
|
<pre>public <a href="../controlP5/Toggle.html" title="class in controlP5">Toggle</a> linebreak()</pre>
|
||
|
<dl>
|
||
|
<dt><strong>Overrides:</strong></dt>
|
||
|
<dd><code><a href="../controlP5/Controller.html#linebreak()">linebreak</a></code> in class <code><a href="../controlP5/Controller.html" title="class in controlP5">Controller</a><<a href="../controlP5/Toggle.html" title="class in controlP5">Toggle</a>></code></dd>
|
||
|
<dt><span class="strong">Returns:</span></dt><dd>Controller</dd></dl>
|
||
|
</li>
|
||
|
</ul>
|
||
|
<a name="mousePressed()">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<ul class="blockList">
|
||
|
<li class="blockList">
|
||
|
<h4>mousePressed</h4>
|
||
|
<pre>public void mousePressed()</pre>
|
||
|
</li>
|
||
|
</ul>
|
||
|
<a name="setImages(processing.core.PImage...)">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<ul class="blockList">
|
||
|
<li class="blockList">
|
||
|
<h4>setImages</h4>
|
||
|
<pre>public <a href="../controlP5/Toggle.html" title="class in controlP5">Toggle</a> setImages(processing.core.PImage... theImages)</pre>
|
||
|
<dl>
|
||
|
<dt><strong>Overrides:</strong></dt>
|
||
|
<dd><code><a href="../controlP5/Controller.html#setImages(processing.core.PImage...)">setImages</a></code> in class <code><a href="../controlP5/Controller.html" title="class in controlP5">Controller</a><<a href="../controlP5/Toggle.html" title="class in controlP5">Toggle</a>></code></dd>
|
||
|
</dl>
|
||
|
</li>
|
||
|
</ul>
|
||
|
<a name="setInternalValue(float)">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<ul class="blockList">
|
||
|
<li class="blockList">
|
||
|
<h4>setInternalValue</h4>
|
||
|
<pre>public void setInternalValue(float theInternalValue)</pre>
|
||
|
<div class="block">by default a toggle returns 0 (for off) and 1 (for on). the internal value variable can be
|
||
|
used to store an additional value for a toggle event.</div>
|
||
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>theInternalValue</code> - </dd></dl>
|
||
|
</li>
|
||
|
</ul>
|
||
|
<a name="setMode(int)">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<ul class="blockList">
|
||
|
<li class="blockList">
|
||
|
<h4>setMode</h4>
|
||
|
<pre>public <a href="../controlP5/Toggle.html" title="class in controlP5">Toggle</a> setMode(int theMode)</pre>
|
||
|
<div class="block">set the visual mode of a Toggle. use setMode(ControlP5.DEFAULT) or setMode(ControlP5.SWITCH)</div>
|
||
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>theMode</code> - </dd></dl>
|
||
|
</li>
|
||
|
</ul>
|
||
|
<a name="setState(boolean)">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<ul class="blockList">
|
||
|
<li class="blockList">
|
||
|
<h4>setState</h4>
|
||
|
<pre>public <a href="../controlP5/Toggle.html" title="class in controlP5">Toggle</a> setState(boolean theFlag)</pre>
|
||
|
<div class="block">sets the state of the toggle, this can be true or false.</div>
|
||
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>theFlag</code> - boolean</dd></dl>
|
||
|
</li>
|
||
|
</ul>
|
||
|
<a name="setValue(boolean)">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<ul class="blockList">
|
||
|
<li class="blockList">
|
||
|
<h4>setValue</h4>
|
||
|
<pre>public <a href="../controlP5/Toggle.html" title="class in controlP5">Toggle</a> setValue(boolean theValue)</pre>
|
||
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>theValue</code> - </dd></dl>
|
||
|
</li>
|
||
|
</ul>
|
||
|
<a name="setValue(float)">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<ul class="blockList">
|
||
|
<li class="blockList">
|
||
|
<h4>setValue</h4>
|
||
|
<pre>public <a href="../controlP5/Toggle.html" title="class in controlP5">Toggle</a> setValue(float theValue)</pre>
|
||
|
<dl>
|
||
|
<dt><strong>Specified by:</strong></dt>
|
||
|
<dd><code><a href="../controlP5/ControllerInterface.html#setValue(float)">setValue</a></code> in interface <code><a href="../controlP5/ControllerInterface.html" title="interface in controlP5">ControllerInterface</a><<a href="../controlP5/Toggle.html" title="class in controlP5">Toggle</a>></code></dd>
|
||
|
<dt><strong>Overrides:</strong></dt>
|
||
|
<dd><code><a href="../controlP5/Controller.html#setValue(float)">setValue</a></code> in class <code><a href="../controlP5/Controller.html" title="class in controlP5">Controller</a><<a href="../controlP5/Toggle.html" title="class in controlP5">Toggle</a>></code></dd>
|
||
|
<dt><span class="strong">Parameters:</span></dt><dd><code>theValue</code> - float</dd></dl>
|
||
|
</li>
|
||
|
</ul>
|
||
|
<a name="toggle()">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<ul class="blockList">
|
||
|
<li class="blockList">
|
||
|
<h4>toggle</h4>
|
||
|
<pre>public <a href="../controlP5/Toggle.html" title="class in controlP5">Toggle</a> toggle()</pre>
|
||
|
<div class="block">switch the state of a toggle.</div>
|
||
|
</li>
|
||
|
</ul>
|
||
|
<a name="update()">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<ul class="blockList">
|
||
|
<li class="blockList">
|
||
|
<h4>update</h4>
|
||
|
<pre>public <a href="../controlP5/Toggle.html" title="class in controlP5">Toggle</a> update()</pre>
|
||
|
<div class="block">updates the value of the controller without having to set the value explicitly. update does
|
||
|
not visually update the controller. the updating status can be set with setUpdate(true/false)
|
||
|
and checked with isUpdate().</div>
|
||
|
<dl>
|
||
|
<dt><strong>Specified by:</strong></dt>
|
||
|
<dd><code><a href="../controlP5/ControllerInterface.html#update()">update</a></code> in interface <code><a href="../controlP5/ControllerInterface.html" title="interface in controlP5">ControllerInterface</a><<a href="../controlP5/Toggle.html" title="class in controlP5">Toggle</a>></code></dd>
|
||
|
<dt><strong>Overrides:</strong></dt>
|
||
|
<dd><code><a href="../controlP5/Controller.html#update()">update</a></code> in class <code><a href="../controlP5/Controller.html" title="class in controlP5">Controller</a><<a href="../controlP5/Toggle.html" title="class in controlP5">Toggle</a>></code></dd>
|
||
|
<dt><span class="strong">Returns:</span></dt><dd>Controller</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../controlP5/Controller.html#setUpdate(boolean)"><code>Controller.setUpdate(boolean)</code></a>,
|
||
|
<a href="../controlP5/Controller.html#isUpdate()"><code>Controller.isUpdate()</code></a></dd></dl>
|
||
|
</li>
|
||
|
</ul>
|
||
|
<a name="updateDisplayMode(int)">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<ul class="blockListLast">
|
||
|
<li class="blockList">
|
||
|
<h4>updateDisplayMode</h4>
|
||
|
<pre>public <a href="../controlP5/Toggle.html" title="class in controlP5">Toggle</a> updateDisplayMode(int theState)</pre>
|
||
|
</li>
|
||
|
</ul>
|
||
|
</li>
|
||
|
</ul>
|
||
|
</li>
|
||
|
</ul>
|
||
|
</div>
|
||
|
</div>
|
||
|
<!-- ========= END OF CLASS DATA ========= -->
|
||
|
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
||
|
<div class="bottomNav"><a name="navbar_bottom">
|
||
|
<!-- -->
|
||
|
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<ul class="navList" title="Navigation">
|
||
|
<li><a href="../controlP5/package-summary.html">Package</a></li>
|
||
|
<li class="navBarCell1Rev">Class</li>
|
||
|
<li><a href="package-tree.html">Tree</a></li>
|
||
|
<li><a href="../index-all.html">Index</a></li>
|
||
|
<li><a href="../help-doc.html">Help</a></li>
|
||
|
</ul>
|
||
|
</div>
|
||
|
<div class="subNav">
|
||
|
<ul class="navList">
|
||
|
<li><a href="../controlP5/TickMark.html" title="class in controlP5"><span class="strong">Prev Class</span></a></li>
|
||
|
<li><a href="../controlP5/Tooltip.html" title="class in controlP5"><span class="strong">Next Class</span></a></li>
|
||
|
</ul>
|
||
|
<ul class="navList">
|
||
|
<li><a href="../index.html?controlP5/Toggle.html" target="_top">Frames</a></li>
|
||
|
<li><a href="Toggle.html" target="_top">No Frames</a></li>
|
||
|
</ul>
|
||
|
<ul class="navList" id="allclasses_navbar_bottom">
|
||
|
<li><a href="../allclasses-noframe.html">All Classes</a></li>
|
||
|
</ul>
|
||
|
<div>
|
||
|
<script type="text/javascript"><!--
|
||
|
allClassesLink = document.getElementById("allclasses_navbar_bottom");
|
||
|
if(window==top) {
|
||
|
allClassesLink.style.display = "block";
|
||
|
}
|
||
|
else {
|
||
|
allClassesLink.style.display = "none";
|
||
|
}
|
||
|
//-->
|
||
|
</script>
|
||
|
</div>
|
||
|
<div>
|
||
|
<ul class="subNavList">
|
||
|
<li>Summary: </li>
|
||
|
<li>Nested | </li>
|
||
|
<li><a href="#field_summary">Field</a> | </li>
|
||
|
<li><a href="#constructor_summary">Constr</a> | </li>
|
||
|
<li><a href="#method_summary">Method</a></li>
|
||
|
</ul>
|
||
|
<ul class="subNavList">
|
||
|
<li>Detail: </li>
|
||
|
<li><a href="#field_detail">Field</a> | </li>
|
||
|
<li><a href="#constructor_detail">Constr</a> | </li>
|
||
|
<li><a href="#method_detail">Method</a></li>
|
||
|
</ul>
|
||
|
</div>
|
||
|
<a name="skip-navbar_bottom">
|
||
|
<!-- -->
|
||
|
</a></div>
|
||
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||
|
<p class="legalCopy"><small>processing library controlP5 by Andreas Schlegel. (c) 2006-2014</small></p>
|
||
|
</body>
|
||
|
</html>
|