Module: SpriteTextGui

Adds SpriteText settings folder into dat.gui.
Author:
Copyright:
  • 2011 Data Arts Team, Google Creative Lab
License:
  • under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
Source:
See:

Methods

(static) SpriteTextGui(group, optionsopt, guiParamsopt) → {GUI}

Adds SpriteText settings folder into dat.gui.
Parameters:
Name Type Attributes Default Description
group THREE.Group | THREE.Scene | THREE.Sprite THREE.Group or THREE.Scene of the SpriteText and of all child groups of the SpriteText for which these settings will have an effect. Or Sprite returned from new SpriteText(...).
options Options <optional>
 See the options parameter of the MyThree class.
Properties
Name Type Attributes Default Description
dat object <optional>
 use dat-gui JavaScript Controller Library. dat.gui.
Properties
Name Type Attributes Description
dat GUI <optional>
 dat.GUI().
cookie boolean <optional>
 false - do not save to cookie all user settings
cookieName string <optional>
 Name of the cookie.
guiSelectPoint boolean <optional>
 false - do not displays GuiSelectPoint.
getLanguageCode function <optional>
 language code of your browser Your custom getLanguageCode() function. 
returns the "primary language" subtag of the language version of the browser.
Examples: "en" - English language, "ru" Russian.
See the "Syntax" paragraph of RFC 4646 rfc4646 2.1 Syntax for details.
You can import { getLanguageCode } from '../../commonNodeJS/master/lang.js';
guiParams object <optional>
 {} Followed parameters is allowed. Default is no parameters
Properties
Name Type Attributes Description
folder GUI <optional>
 SpriteTextGui folder. See dat.gui for details
parentFolder GUI <optional>
 parent folder, returned by gui.addFolder(name)
optionsSpriteText string <optional>
 See options of SpriteText. Default is group.userData.optionsSpriteText or no options
spriteFolder string <optional>
 sprite folder name. Default is lang.spriteText
settings string <optional>
 See options.settings of ScaleControllers settings
Source:
Returns:
sprite folder
Type
GUI