library-mirrors/dat.gui
1
0
Fork 0
mirror of https://github.com/dataarts/dat.gui.git synced 2024-12-12 04:08:27 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

updated README to reflect our demo and reference the documentation

Browse Source
This commit is contained in:
jonobr1 2011-01-28 17:04:12 -07:00
parent d14512b454
commit 720080bce5
2 changed files with 45 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
README
View File

@ -1,31 +1,42 @@
var controllableObject = # gui-dat
{ **gui-dat** is a lightweight controller library for JavaScript. It allows you to easily manipulate variables and fire functions on the fly.
numberProperty: 20, ## Basic Usage
anotherNumberProperty: 0, <script type="text/javascript" src="demo/demo.js"></script>
textProperty: "a string", <script type="text/javascript">
booleanProperty: false,
functionProperty: function() {
alert("I am a function!");
}
};
window.onload = function() { window.onload = function() {
var fizzyText = new FizzyText("gui-dat");
GUI.start(); GUI.start();
// Creates a number box // Text field
GUI.add(controllableObject, "numberProperty"); GUI.add(fizzyText, "message");
// Creates a slider (min, max) // Sliders with min and max
GUI.add(controllableObject, "anotherNumberProperty", -100, 100); GUI.add(fizzyText, "maxSize", 0.5, 7);
GUI.add(fizzyText, "growthSpeed", 0.01, 1);
GUI.add(fizzyText, "speed", 0.1, 2);
// Creates a text field // Sliders with min, max and increment
GUI.add(controllableObject, "textProperty"); GUI.add(fizzyText, "noiseStrength", 10, 100, 5);
// Creates a checkbox // Boolean checkbox
GUI.add(controllableObject, "booleanProperty"); GUI.add(fizzyText, "displayOutline");
// Creates a button // Fires a function called "explode"
GUI.add(controllableObject, "functionProperty"); GUI.add(fizzyText, "explode").setName("Explode!"); // Specify a custom name.
} };
</script>
+ ui-dat will infer the type of the property you're trying to add (based on its initial value) and create the corresponding control.
+ The properties must be public, i.e. defined by `**this**.prop = value`.
## Monitor variable changes <i>outside</i> of the GUI
Let's say you have a variable that changes by itself from time to time. If you'd like the GUI to reflect those changes, use the listen() method
GUI.add(obj, "propName").listen();
## Fire a function when someone uses a control
GUI.add(obj, "propName").onChange(function(n) {
alert("You changed me to " + n);
});
Initiated by [George Michael Brower]:http://georgemichaelbrower.com/ and [Jono Brandel]:http://jonobr1.com/ of the Data Arts Team, Google Creative Lab.

8
index.html
View File

@ -97,8 +97,8 @@ window.onload = function() {
<li><strong>gui-dat</strong> will infer the type of the property you're trying to add<br/>(based on its initial value) and create the corresponding control.</li> <li><strong>gui-dat</strong> will infer the type of the property you're trying to add<br/>(based on its initial value) and create the corresponding control.</li>
<li>The properties must be public, i.e. defined by <code><strong>this</strong>.prop = value</code>.</li> <li>The properties must be public, i.e. defined by <code><strong>this</strong>.prop = value</code>.</li>
</ul> </ul>
<!--
<hr/> <!-- <hr/>
<h2>Monitor variable changes <em>outside</em> of the GUI</h2> <h2>Monitor variable changes <em>outside</em> of the GUI</h2>
<p>Let's say you have a variable that changes by itself from time to time. If you'd like the GUI to reflect those changes, use the <code>listen()</code> method.</p> <p>Let's say you have a variable that changes by itself from time to time. If you'd like the GUI to reflect those changes, use the <code>listen()</code> method.</p>
<pre class="prettyprint">GUI.add(obj, "propName").listen();</pre> <pre class="prettyprint">GUI.add(obj, "propName").listen();</pre>
@ -106,8 +106,8 @@ window.onload = function() {
<h2>Fire a function when someone uses a control</h2> <h2>Fire a function when someone uses a control</h2>
<pre class="prettyprint">GUI.add(obj, "propName").onChange(function(n) { <pre class="prettyprint">GUI.add(obj, "propName").onChange(function(n) {
alert("You changed me to " + n); alert("You changed me to " + n);
});</pre> });</pre> -->
-->
<footer> <footer>
Initiated by <a href="http://georgemichaelbrower.com/">George Michael Brower</a> and <a href="http://jonobr1.com/">Jono Brandel</a> of the Data Arts Team, Google Creative Lab. Initiated by <a href="http://georgemichaelbrower.com/">George Michael Brower</a> and <a href="http://jonobr1.com/">Jono Brandel</a> of the Data Arts Team, Google Creative Lab.
</footer> </footer>