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

Implement .add( controller ) & its use for custom Controllers.

Browse Source 
See example of a custom controller in example.html.
This commit is contained in:
AARON WELLES 2019-06-20 22:23:29 -04:00
parent 743a16b398
commit 36e1991c94
2 changed files with 112 additions and 52 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

133
example.html
View File

@ -1,63 +1,112 @@
<!DOCTYPE html> <!DOCTYPE html>
<html> <html>
<head> <head>
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no"> <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no">
</head> </head>
<body> <body>
<script type="text/javascript" src="build/dat.gui.js"></script> <script type="text/javascript" src="build/dat.gui.js"></script>
<script type="text/javascript"> <script type="text/javascript">
var obj = { var obj = {
message: 'Hello World', message: 'Hello World',
displayOutline: false, displayOutline: false,
maxSize: 6.0, maxSize: 6.0,
speed: 5, speed: 5,
height: 10, height: 10,
noiseStrength: 10.2, noiseStrength: 10.2,
growthSpeed: 0.2, growthSpeed: 0.2,
type: 'three', type: 'three',
explode: function () { explode: function() {
alert('Bang!'); alert('Bang!');
}, },
color0: "#ffae23", // CSS string color0: "#ffae23", // CSS string
color1: [ 0, 128, 255 ], // RGB array color1: [0, 128, 255], // RGB array
color2: [ 0, 128, 255, 0.3 ], // RGB with alpha color2: [0, 128, 255, 0.3], // RGB with alpha
color3: { h: 350, s: 0.9, v: 0.3 } // Hue, saturation, value color3: {
}; h: 350,
s: 0.9,
v: 0.3
} // Hue, saturation, value
};
var gui = new dat.gui.GUI(); var gui = new dat.gui.GUI();
gui.remember(obj); gui.remember(obj);
gui.add(obj, 'message'); gui.add(obj, 'message');
gui.add(obj, 'displayOutline'); gui.add(obj, 'displayOutline');
gui.add(obj, 'explode'); gui.add(obj, 'explode');
gui.add(obj, 'maxSize').min(-10).max(10).step(0.25); gui.add(obj, 'maxSize').min(-10).max(10).step(0.25);
gui.add(obj, 'height').step(5); // Increment amount gui.add(obj, 'height').step(5); // Increment amount
// Choose from accepted values // Choose from accepted values
gui.add(obj, 'type', [ 'one', 'two', 'three' ] ); gui.add(obj, 'type', ['one', 'two', 'three']);
// Choose from named values // Choose from named values
gui.add(obj, 'speed', { Stopped: 0, Slow: 0.1, Fast: 5 } ); gui.add(obj, 'speed', {
Stopped: 0,
Slow: 0.1,
Fast: 5
});
var f1 = gui.addFolder('Colors'); var f1 = gui.addFolder('Colors');
f1.addColor(obj, 'color0'); f1.addColor(obj, 'color0');
f1.addColor(obj, 'color1'); f1.addColor(obj, 'color1');
f1.addColor(obj, 'color2'); f1.addColor(obj, 'color2');
f1.addColor(obj, 'color3'); f1.addColor(obj, 'color3');
var f2 = gui.addFolder('Another Folder'); var f2 = gui.addFolder('Another Folder');
f2.add(obj, 'noiseStrength'); f2.add(obj, 'noiseStrength');
var f3 = f2.addFolder('Nested Folder'); var f3 = f2.addFolder('Nested Folder');
f3.add(obj, 'growthSpeed'); f3.add(obj, 'growthSpeed');
</script> // alternative StringController add
gui.add(new dat.controllers.StringController(obj, 'message'));
// a custom controller
class KnobController extends dat.controllers.Controller {
constructor(object, property, a, b) {
super(object, property);
const _this = this;
this.__input = document.createElement('input');
this.__input.setAttribute('type', 'number');
this.__input.style.width = '40%';
this.updateDisplay();
this.domElement.appendChild(this.__input);
var button = document.createElement('input');
button.setAttribute('type', 'button');
button.value = 'Set ' + property;
button.style.width = '50%';
button.onclick = function(e) {
object[property] = a + b;
_this.updateDisplay();
};
this.domElement.appendChild(button);
}
updateDisplay() {
this.__input.value = this.getValue();
}
}
const api = {
color: '#ffffff',
value: 0.5,
};
gui.add(new KnobController(api, 'value', 0.5, 25), {
liClass: 'knobby'
});
</script>
</body> </body>
</html>
</html>

31
src/dat/gui/GUI.js
View File

@ -1131,23 +1131,30 @@ function recallSavedValue(gui, controller) {
} }
function add(gui, object, property, params) { function add(gui, object, property, params) {
if (object[property] === undefined) {
throw new Error(`Object "${object}" has no property "${property}"`);
}
let controller; let controller;
if (object instanceof Controller) {
controller = object;
params = property || { };
} else {
if (object[property] === undefined) {
throw new Error(`Object "${object}" has no property "${property}"`);
}
if (params.color) {
controller = new ColorController(object, property);
} else {
const factoryArgs = [object, property].concat(params.factoryArgs);
controller = ControllerFactory.apply(gui, factoryArgs);
}
if (params.color) {
controller = new ColorController(object, property);
} else {
const factoryArgs = [object, property].concat(params.factoryArgs);
controller = ControllerFactory.apply(gui, factoryArgs);
} }
if (params.before instanceof Controller) { if (params.before instanceof Controller) {
params.before = params.before.__li; params.before = params.before.__li;
} }
recallSavedValue(gui, controller); recallSavedValue(gui, controller);
dom.addClass(controller.domElement, 'c'); dom.addClass(controller.domElement, 'c');
@ -1165,6 +1172,10 @@ function add(gui, object, property, params) {
dom.addClass(li, GUI.CLASS_CONTROLLER_ROW); dom.addClass(li, GUI.CLASS_CONTROLLER_ROW);
if (controller instanceof ColorController) { if (controller instanceof ColorController) {
dom.addClass(li, 'color'); dom.addClass(li, 'color');
} else if ( params.liClass ) {
dom.addClass(li, params.liClass);
} else if ( controller.liClass ) {
dom.addClass(li, controller.liClass);
} else { } else {
dom.addClass(li, typeof controller.getValue()); dom.addClass(li, typeof controller.getValue());
} }