Creates an instance of three gui.
Creates a panel that holds controllers.
new GUI();
new GUI( { container: document.getElementById( 'custom' ) } );
Used to determine if the GUI is closed. Use gui.open() or gui.close() to change this.
Used to determine if the GUI is hidden. Use gui.show() or gui.hide() to change this.
title.
The list of controllers and folders contained by this GUI.
The list of controllers contained by this GUI.
The outermost container element.
The list of folders contained by this GUI.
The GUI containing this folder, or undefined if this is the root GUI.
The top level GUI containing this folder, or this if this is the root GUI.
Used to determine if the GUI is closed. Use gui.open() or gui.close() to change this.
Used to determine if the GUI is hidden. Use gui.show() or gui.hide() to change this.
title.
The list of controllers and folders contained by this GUI.
The list of controllers contained by this GUI.
Custom css of three gui
The outermost container element.
The list of folders contained by this GUI.
The GUI containing this folder, or undefined if this is the root GUI.
The top level GUI containing this folder, or this if this is the root GUI.
Adds a controller to the GUI, inferring controller type using the typeof operator.
gui.add( object, 'property' );
gui.add( object, 'number', 0, 100, 1 );
gui.add( object, 'options', [ 1, 2, 3 ] );
The object the controller will modify.
Name of the property to control.
Minimum value for number controllers, or the set of selectable values for a dropdown.
Maximum value for number controllers.
Step value for number controllers.
add
Adds a color controller to the GUI.
params = {
cssColor: '#ff00ff',
rgbColor: { r: 0, g: 0.2, b: 0.4 },
customRange: [ 0, 127, 255 ],
};
gui.addColor( params, 'cssColor' );
gui.addColor( params, 'rgbColor' );
gui.addColor( params, 'customRange', 255 );
The object the controller will modify.
Name of the property to control.
color
Closes the GUI.
close
Returns an array of controllers contained by this GUI and its descendents.
recursive
Destroys all DOM elements and event listeners associated with this GUI
Hides the GUI.
hide
Recalls values that were saved with gui.save().
load
Pass a function to be called whenever a controller in this GUI changes.
change
Pass a function to be called whenever a controller in this GUI has finished changing.
finish change
Opens a GUI or folder. GUI and folders are open by default.
gui.open(); // open
gui.open( false ); // close
gui.open( gui._closed ); // toggle
open
Resets all controllers to their initial values.
reset
Returns an object mapping controller names to values. The object can be passed to gui.load() to recall these values.
save
Sets style
style
Change the title of this GUI.
title
Adds a controller to the GUI, inferring controller type using the typeof operator.
gui.add( object, 'property' );
gui.add( object, 'number', 0, 100, 1 );
gui.add( object, 'options', [ 1, 2, 3 ] );
The object the controller will modify.
Name of the property to control.
Minimum value for number controllers, or the set of selectable values for a dropdown.
Maximum value for number controllers.
Step value for number controllers.
add
Adds a color controller to the GUI.
params = {
cssColor: '#ff00ff',
rgbColor: { r: 0, g: 0.2, b: 0.4 },
customRange: [ 0, 127, 255 ],
};
gui.addColor( params, 'cssColor' );
gui.addColor( params, 'rgbColor' );
gui.addColor( params, 'customRange', 255 );
The object the controller will modify.
Name of the property to control.
color
Returns an array of controllers contained by this GUI and its descendents.
recursive
Destroys all DOM elements and event listeners associated with this GUI
Pass a function to be called whenever a controller in this GUI changes.
change
Pass a function to be called whenever a controller in this GUI has finished changing.
finish change
Returns an object mapping controller names to values. The object can be passed to gui.load() to recall these values.
save
Generated using TypeDoc
Three gui
See the ngx3js docs page for details.