mirror of
https://github.com/sojamo/controlp5
synced 2024-11-22 14:07:55 +01:00
750 lines
26 KiB
HTML
750 lines
26 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:46 SGT 2014 -->
|
|
<title>ControlEvent (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="ControlEvent (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/ControlElement.html" title="annotation in controlP5"><span class="strong">Prev Class</span></a></li>
|
|
<li><a href="../controlP5/ControlFont.html" title="class in controlP5"><span class="strong">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../index.html?controlP5/ControlEvent.html" target="_top">Frames</a></li>
|
|
<li><a href="ControlEvent.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 ControlEvent" class="title">Class ControlEvent</h2>
|
|
</div>
|
|
<div class="contentContainer">
|
|
<ul class="inheritance">
|
|
<li>java.lang.Object</li>
|
|
<li>
|
|
<ul class="inheritance">
|
|
<li>controlP5.ControlEvent</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<div class="description">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<hr>
|
|
<br>
|
|
<pre>public class <span class="strong">ControlEvent</span>
|
|
extends java.lang.Object</pre>
|
|
<div class="block">A controlEvent is sent to a PApplet or a ControlListener whenever a controller value has changed.
|
|
Events can also be sent when a tab is activated, but by default tab events are disabled and have
|
|
to be enabled with <a href="../controlP5/Tab.html" title="class in controlP5"><code>Tab</code></a> Tab.activateEvent(). for detailed information see the tab
|
|
documentation.</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 ControlEvent.
|
|
* every control event is automatically forwarded to the function controlEvent(ControlEvent)
|
|
* inside a sketch if such function is available. For further details about the API of
|
|
* the ControlEvent class, please refer to the documentation.
|
|
*
|
|
*
|
|
* find a list of public methods available for ControlEvent
|
|
* at the bottom of this sketch's source code
|
|
*
|
|
* by Andreas Schlegel, 2012
|
|
* www.sojamo.de/libraries/controlP5
|
|
*
|
|
*/
|
|
|
|
import controlP5.*;
|
|
|
|
ControlP5 cp5;
|
|
|
|
public int myColorRect1 = 200;
|
|
|
|
public int myColorRect2 = 100;
|
|
|
|
|
|
void setup() {
|
|
size(400, 400);
|
|
noStroke();
|
|
|
|
cp5 = new ControlP5(this);
|
|
cp5.addNumberbox("n1")
|
|
.setValue(myColorRect1)
|
|
.setPosition(20, 20)
|
|
.setSize(100, 20)
|
|
.setMin(0)
|
|
.setMax(255)
|
|
.setId(1);
|
|
|
|
cp5.addNumberbox("n2")
|
|
.setValue(myColorRect2)
|
|
.setPosition(20, 60)
|
|
.setSize(100, 20)
|
|
.setMin(0)
|
|
.setMax(255)
|
|
.setId(2);
|
|
|
|
cp5.addTextfield("n3")
|
|
.setPosition(20, 100)
|
|
.setSize(100, 20)
|
|
.setId(3);
|
|
|
|
}
|
|
|
|
void draw() {
|
|
background(ControlP5.MAROON);
|
|
fill(ControlP5.RED, myColorRect1);
|
|
rect(140, 20, 240, 170);
|
|
fill(ControlP5.FUCHSIA, myColorRect2);
|
|
rect(140, 210, 240, 170);
|
|
}
|
|
|
|
|
|
void controlEvent(ControlEvent theEvent) {
|
|
println("got a control event from controller with id "+theEvent.getController().getId());
|
|
|
|
if (theEvent.isFrom(cp5.getController("n1"))) {
|
|
println("this event was triggered by Controller n1");
|
|
}
|
|
|
|
switch(theEvent.getController().getId()) {
|
|
case(1):
|
|
myColorRect1 = (int)(theEvent.getController().getValue());
|
|
break;
|
|
case(2):
|
|
myColorRect2 = (int)(theEvent.getController().getValue());
|
|
break;
|
|
case(3):
|
|
println(theEvent.getController().getStringValue());
|
|
break;
|
|
}
|
|
}
|
|
|
|
|
|
/*
|
|
a list of all methods available for ControlEvent
|
|
use ControlP5.printPublicMethodsFor(ControlEvent.class);
|
|
to print the following list into the console.
|
|
|
|
You can find further details about class ControlEvent in the javadoc.
|
|
|
|
Format:
|
|
ClassName : returnType methodName(parameter type)
|
|
|
|
controlP5.ControlEvent : ControlGroup getGroup()
|
|
controlP5.ControlEvent : Controller getController()
|
|
controlP5.ControlEvent : String getLabel()
|
|
controlP5.ControlEvent : String getName()
|
|
controlP5.ControlEvent : String getStringValue()
|
|
controlP5.ControlEvent : Tab getTab()
|
|
controlP5.ControlEvent : boolean isController()
|
|
controlP5.ControlEvent : boolean isFrom(ControllerInterface)
|
|
controlP5.ControlEvent : boolean isFrom(String)
|
|
controlP5.ControlEvent : boolean isGroup()
|
|
controlP5.ControlEvent : boolean isTab()
|
|
controlP5.ControlEvent : float getValue()
|
|
controlP5.ControlEvent : float[] getArrayValue()
|
|
controlP5.ControlEvent : int getId()
|
|
controlP5.ControlEvent : int getType()
|
|
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/ControlEvent.html#CONTROLLER">CONTROLLER</a></strong></code> </td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<td class="colLast"><code><strong><a href="../controlP5/ControlEvent.html#GROUP">GROUP</a></strong></code> </td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<td class="colLast"><code><strong><a href="../controlP5/ControlEvent.html#TAB">TAB</a></strong></code> </td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<td class="colLast"><code><strong><a href="../controlP5/ControlEvent.html#UNDEFINDED">UNDEFINDED</a></strong></code> </td>
|
|
</tr>
|
|
</table>
|
|
</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/ControlEvent.html#ControlEvent(controlP5.ControllerGroup)">ControlEvent</a></strong>(<a href="../controlP5/ControllerGroup.html" title="class in controlP5">ControllerGroup</a><?> theController)</code> </td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colOne"><code><strong><a href="../controlP5/ControlEvent.html#ControlEvent(controlP5.Tab)">ControlEvent</a></strong>(<a href="../controlP5/Tab.html" title="class in controlP5">Tab</a> theController)</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>float[]</code></td>
|
|
<td class="colLast"><code><strong><a href="../controlP5/ControlEvent.html#getArrayValue()">getArrayValue</a></strong>()</code>
|
|
<div class="block">Returns a float array, applies to e.g.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>float</code></td>
|
|
<td class="colLast"><code><strong><a href="../controlP5/ControlEvent.html#getArrayValue(int)">getArrayValue</a></strong>(int theIndex)</code>
|
|
<div class="block">Returns a float value at a particular index from a controller's array value.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code><a href="../controlP5/Controller.html" title="class in controlP5">Controller</a><?></code></td>
|
|
<td class="colLast"><code><strong><a href="../controlP5/ControlEvent.html#getController()">getController</a></strong>()</code>
|
|
<div class="block">Returns the instance of the controller sending the ControlEvent.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code><a href="../controlP5/ControlGroup.html" title="class in controlP5">ControlGroup</a><?></code></td>
|
|
<td class="colLast"><code><strong><a href="../controlP5/ControlEvent.html#getGroup()">getGroup</a></strong>()</code>
|
|
<div class="block">Returns the group that evoked the ControlEvent</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<td class="colLast"><code><strong><a href="../controlP5/ControlEvent.html#getId()">getId</a></strong>()</code>
|
|
<div class="block">Returns the controller's id, if an id has not been set before the default value -1 will be
|
|
returned.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>java.lang.String</code></td>
|
|
<td class="colLast"><code><strong><a href="../controlP5/ControlEvent.html#getLabel()">getLabel</a></strong>()</code>
|
|
<div class="block">Gets the text of the controller's label that has evoked the event.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>java.lang.String</code></td>
|
|
<td class="colLast"><code><strong><a href="../controlP5/ControlEvent.html#getName()">getName</a></strong>()</code>
|
|
<div class="block">returns the controller's name</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>java.lang.String</code></td>
|
|
<td class="colLast"><code><strong><a href="../controlP5/ControlEvent.html#getStringValue()">getStringValue</a></strong>()</code> </td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code><a href="../controlP5/Tab.html" title="class in controlP5">Tab</a></code></td>
|
|
<td class="colLast"><code><strong><a href="../controlP5/ControlEvent.html#getTab()">getTab</a></strong>()</code>
|
|
<div class="block">Returns the tab that triggered the ControlEvent</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<td class="colLast"><code><strong><a href="../controlP5/ControlEvent.html#getType()">getType</a></strong>()</code> </td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>float</code></td>
|
|
<td class="colLast"><code><strong><a href="../controlP5/ControlEvent.html#getValue()">getValue</a></strong>()</code> </td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<td class="colLast"><code><strong><a href="../controlP5/ControlEvent.html#isAssignableFrom(java.lang.Class)">isAssignableFrom</a></strong>(java.lang.Class<?> c)</code> </td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<td class="colLast"><code><strong><a href="../controlP5/ControlEvent.html#isController()">isController</a></strong>()</code>
|
|
<div class="block">Checks if the ControlEvent was triggered by a controller</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<td class="colLast"><code><strong><a href="../controlP5/ControlEvent.html#isFrom(controlP5.ControllerInterface)">isFrom</a></strong>(<a href="../controlP5/ControllerInterface.html" title="interface in controlP5">ControllerInterface</a><?> theController)</code>
|
|
<div class="block">Checks if the ControlEvent originates from a specific Controller or ControllerGroup.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<td class="colLast"><code><strong><a href="../controlP5/ControlEvent.html#isFrom(java.lang.String)">isFrom</a></strong>(java.lang.String theControllerName)</code>
|
|
<div class="block">checks if the ControlEvent originates from a specific Controller or ControllerGroup
|
|
identifiable by name.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<td class="colLast"><code><strong><a href="../controlP5/ControlEvent.html#isGroup()">isGroup</a></strong>()</code>
|
|
<div class="block">Checks if the ControlEvent was triggered by a ControlGroup</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<td class="colLast"><code><strong><a href="../controlP5/ControlEvent.html#isTab()">isTab</a></strong>()</code>
|
|
<div class="block">Checks if the ControlEvent was triggered by a tab</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>java.lang.String</code></td>
|
|
<td class="colLast"><code><strong><a href="../controlP5/ControlEvent.html#toString()">toString</a></strong>()</code> </td>
|
|
</tr>
|
|
</table>
|
|
<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>
|
|
</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="CONTROLLER">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>CONTROLLER</h4>
|
|
<pre>public static int CONTROLLER</pre>
|
|
</li>
|
|
</ul>
|
|
<a name="GROUP">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>GROUP</h4>
|
|
<pre>public static int GROUP</pre>
|
|
</li>
|
|
</ul>
|
|
<a name="TAB">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>TAB</h4>
|
|
<pre>public static int TAB</pre>
|
|
</li>
|
|
</ul>
|
|
<a name="UNDEFINDED">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>UNDEFINDED</h4>
|
|
<pre>public static int UNDEFINDED</pre>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="constructor_detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Constructor Detail</h3>
|
|
<a name="ControlEvent(controlP5.ControllerGroup)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>ControlEvent</h4>
|
|
<pre>public ControlEvent(<a href="../controlP5/ControllerGroup.html" title="class in controlP5">ControllerGroup</a><?> theController)</pre>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>theController</code> - Controller</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="ControlEvent(controlP5.Tab)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>ControlEvent</h4>
|
|
<pre>public ControlEvent(<a href="../controlP5/Tab.html" title="class in controlP5">Tab</a> theController)</pre>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>theController</code> - Controller</dd></dl>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="method_detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Method Detail</h3>
|
|
<a name="getArrayValue()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getArrayValue</h4>
|
|
<pre>public float[] getArrayValue()</pre>
|
|
<div class="block">Returns a float array, applies to e.g. Range.</div>
|
|
<dl><dt><span class="strong">Returns:</span></dt><dd>float[]</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getArrayValue(int)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getArrayValue</h4>
|
|
<pre>public float getArrayValue(int theIndex)</pre>
|
|
<div class="block">Returns a float value at a particular index from a controller's array value. No error
|
|
checking available here, will throw ArrayIndexOutOfBOundsException in case of unavailable
|
|
index.</div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>theIndex</code> - </dd>
|
|
<dt><span class="strong">Returns:</span></dt><dd></dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getController()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getController</h4>
|
|
<pre>public <a href="../controlP5/Controller.html" title="class in controlP5">Controller</a><?> getController()</pre>
|
|
<div class="block">Returns the instance of the controller sending the ControlEvent.</div>
|
|
<dl><dt><span class="strong">Returns:</span></dt><dd>Controller</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getGroup()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getGroup</h4>
|
|
<pre>public <a href="../controlP5/ControlGroup.html" title="class in controlP5">ControlGroup</a><?> getGroup()</pre>
|
|
<div class="block">Returns the group that evoked the ControlEvent</div>
|
|
<dl><dt><span class="strong">Returns:</span></dt><dd>ControlGroup</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getId()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getId</h4>
|
|
<pre>public int getId()</pre>
|
|
<div class="block">Returns the controller's id, if an id has not been set before the default value -1 will be
|
|
returned.</div>
|
|
<dl><dt><span class="strong">Returns:</span></dt><dd></dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getLabel()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getLabel</h4>
|
|
<pre>public java.lang.String getLabel()</pre>
|
|
<div class="block">Gets the text of the controller's label that has evoked the event.</div>
|
|
<dl><dt><span class="strong">Returns:</span></dt><dd>String</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getName()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getName</h4>
|
|
<pre>public java.lang.String getName()</pre>
|
|
<div class="block">returns the controller's name</div>
|
|
<dl><dt><span class="strong">Returns:</span></dt><dd>String</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getStringValue()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getStringValue</h4>
|
|
<pre>public java.lang.String getStringValue()</pre>
|
|
</li>
|
|
</ul>
|
|
<a name="getTab()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getTab</h4>
|
|
<pre>public <a href="../controlP5/Tab.html" title="class in controlP5">Tab</a> getTab()</pre>
|
|
<div class="block">Returns the tab that triggered the ControlEvent</div>
|
|
<dl><dt><span class="strong">Returns:</span></dt><dd>Tab Tab</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getType()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getType</h4>
|
|
<pre>public int getType()</pre>
|
|
<dl><dt><span class="strong">Returns:</span></dt><dd>int returned is ControlP5.CONTROLLER, or ControlP5.TAB, or ControlP5.GROUP</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getValue()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getValue</h4>
|
|
<pre>public float getValue()</pre>
|
|
</li>
|
|
</ul>
|
|
<a name="isAssignableFrom(java.lang.Class)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>isAssignableFrom</h4>
|
|
<pre>public boolean isAssignableFrom(java.lang.Class<?> c)</pre>
|
|
</li>
|
|
</ul>
|
|
<a name="isController()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>isController</h4>
|
|
<pre>public boolean isController()</pre>
|
|
<div class="block">Checks if the ControlEvent was triggered by a controller</div>
|
|
<dl><dt><span class="strong">Returns:</span></dt><dd>boolean</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../controlP5/Controller.html" title="class in controlP5"><code>Controller</code></a></dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="isFrom(controlP5.ControllerInterface)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>isFrom</h4>
|
|
<pre>public boolean isFrom(<a href="../controlP5/ControllerInterface.html" title="interface in controlP5">ControllerInterface</a><?> theController)</pre>
|
|
<div class="block">Checks if the ControlEvent originates from a specific Controller or ControllerGroup.</div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>theController</code> - </dd>
|
|
<dt><span class="strong">Returns:</span></dt><dd>boolean</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="isFrom(java.lang.String)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>isFrom</h4>
|
|
<pre>public boolean isFrom(java.lang.String theControllerName)</pre>
|
|
<div class="block">checks if the ControlEvent originates from a specific Controller or ControllerGroup
|
|
identifiable by name.</div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>theController</code> - </dd>
|
|
<dt><span class="strong">Returns:</span></dt><dd>boolean</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="isGroup()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>isGroup</h4>
|
|
<pre>public boolean isGroup()</pre>
|
|
<div class="block">Checks if the ControlEvent was triggered by a ControlGroup</div>
|
|
<dl><dt><span class="strong">Returns:</span></dt><dd>boolean</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../controlP5/ControllerGroup.html" title="class in controlP5"><code>ControllerGroup</code></a></dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="isTab()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>isTab</h4>
|
|
<pre>public boolean isTab()</pre>
|
|
<div class="block">Checks if the ControlEvent was triggered by a tab</div>
|
|
<dl><dt><span class="strong">Returns:</span></dt><dd>boolean</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../controlP5/Tab.html" title="class in controlP5"><code>Tab</code></a></dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="toString()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>toString</h4>
|
|
<pre>public java.lang.String toString()</pre>
|
|
<dl>
|
|
<dt><strong>Overrides:</strong></dt>
|
|
<dd><code>toString</code> in class <code>java.lang.Object</code></dd>
|
|
</dl>
|
|
</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/ControlElement.html" title="annotation in controlP5"><span class="strong">Prev Class</span></a></li>
|
|
<li><a href="../controlP5/ControlFont.html" title="class in controlP5"><span class="strong">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../index.html?controlP5/ControlEvent.html" target="_top">Frames</a></li>
|
|
<li><a href="ControlEvent.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>
|