mirror of https://github.com/sojamo/controlp5
482 lines
15 KiB
HTML
482 lines
15 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>CP (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="CP (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>Prev Class</li>
|
|
<li><a href="../controlP5/DropdownList.html" title="class in controlP5"><span class="strong">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../index.html?controlP5/CP.html" target="_top">Frames</a></li>
|
|
<li><a href="CP.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 CP" class="title">Class CP</h2>
|
|
</div>
|
|
<div class="contentContainer">
|
|
<ul class="inheritance">
|
|
<li>java.lang.Object</li>
|
|
<li>
|
|
<ul class="inheritance">
|
|
<li>controlP5.CP</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<div class="description">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<hr>
|
|
<br>
|
|
<pre>public class <span class="strong">CP</span>
|
|
extends java.lang.Object</pre>
|
|
</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/CP.html#CP()">CP</a></strong>()</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>static java.lang.String</code></td>
|
|
<td class="colLast"><code><strong><a href="../controlP5/CP.html#arrayToString(java.lang.Object)">arrayToString</a></strong>(java.lang.Object aArray)</code>
|
|
<div class="block">* Convenience method for producing a simple textual representation of an array.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<td class="colLast"><code><strong><a href="../controlP5/CP.html#byteArrayToInt(byte[])">byteArrayToInt</a></strong>(byte[] b)</code> </td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static byte[]</code></td>
|
|
<td class="colLast"><code><strong><a href="../controlP5/CP.html#decodeBase64(java.lang.String)">decodeBase64</a></strong>(java.lang.String base64)</code> </td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static java.lang.String</code></td>
|
|
<td class="colLast"><code><strong><a href="../controlP5/CP.html#encodeBase64(byte[])">encodeBase64</a></strong>(byte[] raw)</code> </td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static java.lang.String</code></td>
|
|
<td class="colLast"><code><strong><a href="../controlP5/CP.html#forHTMLTag(java.lang.String)">forHTMLTag</a></strong>(java.lang.String aTagFragment)</code>
|
|
<div class="block">borrowed from http://www.javapractices.com/Topic96.cjp</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static java.lang.String</code></td>
|
|
<td class="colLast"><code><strong><a href="../controlP5/CP.html#forURL(java.lang.String)">forURL</a></strong>(java.lang.String aURLFragment)</code>
|
|
<div class="block">borrowed from http://www.javapractices.com/Topic96.cjp</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<td class="colLast"><code><strong><a href="../controlP5/CP.html#getBit(int, int)">getBit</a></strong>(int theByte,
|
|
int theIndex)</code> </td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static boolean</code></td>
|
|
<td class="colLast"><code><strong><a href="../controlP5/CP.html#inside(int[], float, float)">inside</a></strong>(int[] theRect,
|
|
float theX,
|
|
float theY)</code> </td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static boolean</code></td>
|
|
<td class="colLast"><code><strong><a href="../controlP5/CP.html#inside(int[], processing.core.PVector)">inside</a></strong>(int[] theRect,
|
|
processing.core.PVector theVector)</code> </td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static byte[]</code></td>
|
|
<td class="colLast"><code><strong><a href="../controlP5/CP.html#intToByteArray(int)">intToByteArray</a></strong>(int a)</code> </td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static java.lang.String</code></td>
|
|
<td class="colLast"><code><strong><a href="../controlP5/CP.html#intToString(int)">intToString</a></strong>(int theInt)</code> </td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<td class="colLast"><code><strong><a href="../controlP5/CP.html#parseHex(java.lang.String)">parseHex</a></strong>(java.lang.String theHex)</code>
|
|
<div class="block">convert a hex number into an int</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static java.lang.String</code></td>
|
|
<td class="colLast"><code><strong><a href="../controlP5/CP.html#replace(java.lang.String, java.lang.String, java.lang.String)">replace</a></strong>(java.lang.String theSourceString,
|
|
java.lang.String theSearchForString,
|
|
java.lang.String theReplaceString)</code> </td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static byte</code></td>
|
|
<td class="colLast"><code><strong><a href="../controlP5/CP.html#setHigh(byte, int)">setHigh</a></strong>(byte theByte,
|
|
int theIndex)</code> </td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static byte</code></td>
|
|
<td class="colLast"><code><strong><a href="../controlP5/CP.html#setLow(byte, int)">setLow</a></strong>(byte theByte,
|
|
int theIndex)</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, toString, 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="CP()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>CP</h4>
|
|
<pre>public CP()</pre>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="method_detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Method Detail</h3>
|
|
<a name="arrayToString(java.lang.Object)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>arrayToString</h4>
|
|
<pre>public static java.lang.String arrayToString(java.lang.Object aArray)</pre>
|
|
<div class="block">* Convenience method for producing a simple textual representation of an array.
|
|
|
|
<P>
|
|
The format of the returned <code>String</code> is the same as
|
|
<code>AbstractCollection.toString</code>:
|
|
<ul>
|
|
<li>non-empty array: [blah, blah]
|
|
<li>empty array: []
|
|
<li>null array: null
|
|
</ul>
|
|
|
|
|
|
<code>aArray</code> is a possibly-null array whose elements are primitives or objects; arrays
|
|
of arrays are also valid, in which case <code>aArray</code> is rendered in a nested,
|
|
recursive fashion.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="byteArrayToInt(byte[])">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>byteArrayToInt</h4>
|
|
<pre>public static int byteArrayToInt(byte[] b)</pre>
|
|
</li>
|
|
</ul>
|
|
<a name="decodeBase64(java.lang.String)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>decodeBase64</h4>
|
|
<pre>public static byte[] decodeBase64(java.lang.String base64)</pre>
|
|
</li>
|
|
</ul>
|
|
<a name="encodeBase64(byte[])">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>encodeBase64</h4>
|
|
<pre>public static java.lang.String encodeBase64(byte[] raw)</pre>
|
|
</li>
|
|
</ul>
|
|
<a name="forHTMLTag(java.lang.String)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>forHTMLTag</h4>
|
|
<pre>public static java.lang.String forHTMLTag(java.lang.String aTagFragment)</pre>
|
|
<div class="block">borrowed from http://www.javapractices.com/Topic96.cjp</div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>aTagFragment</code> - String</dd>
|
|
<dt><span class="strong">Returns:</span></dt><dd>String</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="forURL(java.lang.String)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>forURL</h4>
|
|
<pre>public static java.lang.String forURL(java.lang.String aURLFragment)</pre>
|
|
<div class="block">borrowed from http://www.javapractices.com/Topic96.cjp</div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>aURLFragment</code> - String</dd>
|
|
<dt><span class="strong">Returns:</span></dt><dd>String</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getBit(int, int)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getBit</h4>
|
|
<pre>public static int getBit(int theByte,
|
|
int theIndex)</pre>
|
|
</li>
|
|
</ul>
|
|
<a name="inside(int[], float, float)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>inside</h4>
|
|
<pre>public static boolean inside(int[] theRect,
|
|
float theX,
|
|
float theY)</pre>
|
|
</li>
|
|
</ul>
|
|
<a name="inside(int[], processing.core.PVector)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>inside</h4>
|
|
<pre>public static boolean inside(int[] theRect,
|
|
processing.core.PVector theVector)</pre>
|
|
</li>
|
|
</ul>
|
|
<a name="intToByteArray(int)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>intToByteArray</h4>
|
|
<pre>public static byte[] intToByteArray(int a)</pre>
|
|
</li>
|
|
</ul>
|
|
<a name="intToString(int)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>intToString</h4>
|
|
<pre>public static java.lang.String intToString(int theInt)</pre>
|
|
</li>
|
|
</ul>
|
|
<a name="parseHex(java.lang.String)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>parseHex</h4>
|
|
<pre>public static int parseHex(java.lang.String theHex)</pre>
|
|
<div class="block">convert a hex number into an int</div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>theHex</code> - </dd>
|
|
<dt><span class="strong">Returns:</span></dt><dd></dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="replace(java.lang.String, java.lang.String, java.lang.String)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>replace</h4>
|
|
<pre>public static java.lang.String replace(java.lang.String theSourceString,
|
|
java.lang.String theSearchForString,
|
|
java.lang.String theReplaceString)</pre>
|
|
</li>
|
|
</ul>
|
|
<a name="setHigh(byte, int)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setHigh</h4>
|
|
<pre>public static byte setHigh(byte theByte,
|
|
int theIndex)</pre>
|
|
</li>
|
|
</ul>
|
|
<a name="setLow(byte, int)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>setLow</h4>
|
|
<pre>public static byte setLow(byte theByte,
|
|
int theIndex)</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>Prev Class</li>
|
|
<li><a href="../controlP5/DropdownList.html" title="class in controlP5"><span class="strong">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../index.html?controlP5/CP.html" target="_top">Frames</a></li>
|
|
<li><a href="CP.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>
|