mirror of
https://github.com/sojamo/controlp5
synced 2024-12-23 03:33:49 +01:00
447 lines
13 KiB
HTML
447 lines
13 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:47 SGT 2014 -->
|
|
<title>ControlTimer (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="ControlTimer (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/ControlP5Legacy.html" title="class in controlP5"><span class="strong">Prev Class</span></a></li>
|
|
<li><a href="../controlP5/ControlWindow.html" title="class in controlP5"><span class="strong">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../index.html?controlP5/ControlTimer.html" target="_top">Frames</a></li>
|
|
<li><a href="ControlTimer.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>Field | </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>Field | </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 ControlTimer" class="title">Class ControlTimer</h2>
|
|
</div>
|
|
<div class="contentContainer">
|
|
<ul class="inheritance">
|
|
<li>java.lang.Object</li>
|
|
<li>
|
|
<ul class="inheritance">
|
|
<li>controlP5.ControlTimer</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<div class="description">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<hr>
|
|
<br>
|
|
<pre>public class <span class="strong">ControlTimer</span>
|
|
extends java.lang.Object</pre>
|
|
<div class="block">control timer is a timer that can be used for example as a stop watch or a duration timer.</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 Timer
|
|
* by andreas schlegel, 2009
|
|
*/
|
|
|
|
import controlP5.*;
|
|
|
|
ControlP5 cp5;
|
|
ControlTimer c;
|
|
Textlabel t;
|
|
|
|
void setup() {
|
|
size(400,400);
|
|
frameRate(30);
|
|
cp5 = new ControlP5(this);
|
|
c = new ControlTimer();
|
|
t = new Textlabel(cp5,"--",100,100);
|
|
c.setSpeedOfTime(1);
|
|
}
|
|
|
|
|
|
void draw() {
|
|
background(0);
|
|
t.setValue(c.toString());
|
|
t.draw(this);
|
|
t.setPosition(mouseX, mouseY);
|
|
}
|
|
|
|
|
|
void mousePressed() {
|
|
c.reset();
|
|
}
|
|
</pre></code></dd></dl></div></dl>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="summary">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- ======== 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/ControlTimer.html#ControlTimer()">ControlTimer</a></strong>()</code>
|
|
<div class="block">create a new control timer, a timer that counts up in time.</div>
|
|
</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>int</code></td>
|
|
<td class="colLast"><code><strong><a href="../controlP5/ControlTimer.html#day()">day</a></strong>()</code>
|
|
<div class="block">day position of the timer.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<td class="colLast"><code><strong><a href="../controlP5/ControlTimer.html#hour()">hour</a></strong>()</code>
|
|
<div class="block">Hour position of the timer in international format (0-23).</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<td class="colLast"><code><strong><a href="../controlP5/ControlTimer.html#millis()">millis</a></strong>()</code>
|
|
<div class="block">Get the milliseconds of the timer.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<td class="colLast"><code><strong><a href="../controlP5/ControlTimer.html#minute()">minute</a></strong>()</code>
|
|
<div class="block">Minutes position of the timer.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<td class="colLast"><code><strong><a href="../controlP5/ControlTimer.html#reset()">reset</a></strong>()</code>
|
|
<div class="block">reset the timer.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<td class="colLast"><code><strong><a href="../controlP5/ControlTimer.html#second()">second</a></strong>()</code>
|
|
<div class="block">Seconds position of the timer.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<td class="colLast"><code><strong><a href="../controlP5/ControlTimer.html#setSpeedOfTime(float)">setSpeedOfTime</a></strong>(float theSpeed)</code>
|
|
<div class="block">set the speed of time, for slow motion or high speed.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>long</code></td>
|
|
<td class="colLast"><code><strong><a href="../controlP5/ControlTimer.html#time()">time</a></strong>()</code>
|
|
<div class="block">get the time in milliseconds since the timer was started.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>java.lang.String</code></td>
|
|
<td class="colLast"><code><strong><a href="../controlP5/ControlTimer.html#toString()">toString</a></strong>()</code>
|
|
<div class="block">return a string representation of the current status of the timer.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<td class="colLast"><code><strong><a href="../controlP5/ControlTimer.html#update()">update</a></strong>()</code>
|
|
<div class="block">called to update the timer.</div>
|
|
</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">
|
|
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="constructor_detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Constructor Detail</h3>
|
|
<a name="ControlTimer()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>ControlTimer</h4>
|
|
<pre>public ControlTimer()</pre>
|
|
<div class="block">create a new control timer, a timer that counts up in time.</div>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="method_detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Method Detail</h3>
|
|
<a name="day()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>day</h4>
|
|
<pre>public int day()</pre>
|
|
<div class="block">day position of the timer.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="hour()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>hour</h4>
|
|
<pre>public int hour()</pre>
|
|
<div class="block">Hour position of the timer in international format (0-23).</div>
|
|
</li>
|
|
</ul>
|
|
<a name="millis()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>millis</h4>
|
|
<pre>public int millis()</pre>
|
|
<div class="block">Get the milliseconds of the timer.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="minute()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>minute</h4>
|
|
<pre>public int minute()</pre>
|
|
<div class="block">Minutes position of the timer.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="reset()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>reset</h4>
|
|
<pre>public void reset()</pre>
|
|
<div class="block">reset the timer.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="second()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>second</h4>
|
|
<pre>public int second()</pre>
|
|
<div class="block">Seconds position of the timer.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="setSpeedOfTime(float)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setSpeedOfTime</h4>
|
|
<pre>public void setSpeedOfTime(float theSpeed)</pre>
|
|
<div class="block">set the speed of time, for slow motion or high speed.</div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>theSpeed</code> - int</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="time()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>time</h4>
|
|
<pre>public long time()</pre>
|
|
<div class="block">get the time in milliseconds since the timer was started.</div>
|
|
<dl><dt><span class="strong">Returns:</span></dt><dd>long</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="toString()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>toString</h4>
|
|
<pre>public java.lang.String toString()</pre>
|
|
<div class="block">return a string representation of the current status of the timer.</div>
|
|
<dl>
|
|
<dt><strong>Overrides:</strong></dt>
|
|
<dd><code>toString</code> in class <code>java.lang.Object</code></dd>
|
|
<dt><span class="strong">Returns:</span></dt><dd>String</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="update()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>update</h4>
|
|
<pre>public void update()</pre>
|
|
<div class="block">called to update the timer.</div>
|
|
</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/ControlP5Legacy.html" title="class in controlP5"><span class="strong">Prev Class</span></a></li>
|
|
<li><a href="../controlP5/ControlWindow.html" title="class in controlP5"><span class="strong">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../index.html?controlP5/ControlTimer.html" target="_top">Frames</a></li>
|
|
<li><a href="ControlTimer.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>Field | </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>Field | </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>
|