-
Notifications
You must be signed in to change notification settings - Fork 0
/
ToolSettings.js.html
333 lines (290 loc) · 13 KB
/
ToolSettings.js.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Source: ToolSettings.js</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Source: ToolSettings.js</h1>
<section>
<article>
<pre class="prettyprint source linenums"><code>/*
* Copyright 2020 WICKLETS LLC
*
* This file is part of Wick Engine.
*
* Wick Engine is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Wick Engine is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with Wick Engine. If not, see <https://www.gnu.org/licenses/>.
*/
Wick.ToolSettings = class {
static get DEFAULT_SETTINGS () {
return [{
type: 'color',
name: 'fillColor',
default: new Wick.Color('#000000')
}, {
type: 'color',
name: 'strokeColor',
default: new Wick.Color('#000000')
}, {
type: "number",
name: 'strokeWidth',
default: 1,
min: 0,
max: 100,
step: 1,
}, {
type: "number",
name: 'brushSize',
default: 10,
min: 1,
max: 100,
step: 1,
}, {
type: "number",
name: 'eraserSize',
default: 10,
min: 1,
max: 100,
step: 1,
}, {
type: "number",
name: 'cornerRadius',
default: 0,
min: 0,
max: 100,
step: 1,
}, {
type: "number",
name: 'brushStabilizerWeight',
default: 20,
min: 0,
max: 100,
step: 1,
}, {
type: "boolean",
name: 'pressureEnabled',
default: false,
}, {
type: "boolean",
name: 'relativeBrushSize',
default: true,
}, {
type: "number",
name: 'gapFillAmount',
default: 1,
min: 0,
max: 5,
step: 1,
}, {
/**
* The render style of the onion skinned frames.
* "standard": Objects on onion skinned frames are rendered fully
* "outlines": Only the strokes of objects on onion skinned frames are rendered
* "tint": Objects are rendered fully but with a slight tint
*/
type: "choice",
name: 'onionSkinStyle',
default: 'standard',
options: ['standard', 'outlines', 'tint']
}, {
type: "number",
name: 'onionSkinOutlineWidth',
default: 2,
min: 1,
max: 25,
step: .1,
}, {
type: 'color',
name: 'backwardOnionSkinTint',
default: new Wick.Color('rgba(255, 0, 0, .5)'),
}, {
type: 'color',
name: 'forwardOnionSkinTint',
default: new Wick.Color('rgba(0, 0, 255, .5)'),
},{
type: "choice",
name: 'brushMode',
default: 'none',
options: ['none', 'behind', 'inside']
}];
}
/**
* Create a new ToolSettings object.
*/
constructor () {
this._settings = {};
this._onSettingsChangedCallback = () => {};
this.resetAllSettings();
this.loadSettingsFromLocalstorage();
}
/**
* Returns the appropriate key to use to store a tool setting by name.
* @param {String} settingName name of tool setting.
* @returns {String} Key to be used.
*/
getStorageKey (settingName) {
return "WICK.TOOLSETTINGS."+settingName;
}
/**
* Creates the tool settings at the start of the editor. Will open with previously used settings if they exist.
*/
createSetting (args) {
if(!args) console.error('createSetting: args is required');
if(!args.name) console.error('createSetting: args.name is required');
if(args.default === undefined) console.error('createSetting: args.default is required');
let name = args.name;
let type = args.type;
// Create a default setting to start.
this._settings[args.name] = {
type: args.type,
name: args.name,
value: args.default,
default: args.default,
min: args.min,
max: args.max,
step: args.step,
options: args.options,
};
}
/**
* Update a value in the settings.
* @param {string} name - The name of the setting to update.
* @param {string|number|Color} value - The value of the setting to change to.
*/
setSetting (name, value) {
var setting = this._settings[name];
if (!setting) return;
// Check to make sure there's no type mismatch
if((typeof value) !== (typeof setting.value)) {
console.warn('Warning: Wick.ToolSettings: Type mismatch while setting ' + name);
console.warn(value);
return;
}
var min = setting.min;
if(min !== undefined) {
value = Math.max(min, value);
}
var max = setting.max;
if(max !== undefined) {
value = Math.min(max, value);
}
setting.value = value;
this._fireOnSettingsChanged(name, value);
if (setting.type === 'color') {
localforage.setItem(this.getStorageKey(name), value.rgba);
} else {
localforage.setItem(this.getStorageKey(name), value);
}
}
/**
* Retrieve a value in the settings.
* @param {string} name - The name of the setting to retrieve.
*/
getSetting (name) {
var setting = this._settings[name];
if(!setting) {
console.error("ToolSettings.getSetting: invalid setting: " + name);
return
}
return setting.value;
}
/**
* Returns an object with the setting restrictions for a provided setting.
* @param {String} name name of tool setting
* @returns {Object} an object containing the values min, max, step and options where appropriate.
*/
getSettingRestrictions (name) {
var setting = this._settings[name];
if (!setting) console.error("ToolSettings.getSettingRestrictions: invalid setting: " + name);
return {
min: setting.min,
max: setting.max,
step: setting.step,
options: setting.options,
};
}
/**
* Returns an array containing all settings with all information.
* @returns {Object[]} Array of settings objects.
*/
getAllSettings () {
var allSettings = [];
for(var name in this._settings) {
allSettings.push(this._settings[name]);
}
return allSettings;
}
/**
* Receives a call back that will be provided the name and value of the setting that was changed.
*/
onSettingsChanged (callback) {
this._onSettingsChangedCallback = callback;
}
/**
* Reset settings to the deafults.
*/
resetAllSettings () {
Wick.ToolSettings.DEFAULT_SETTINGS.forEach(setting => {
this.createSetting(setting);
});
}
/**
* Load settings from localstorage if they exist.
*/
loadSettingsFromLocalstorage () {
Wick.ToolSettings.DEFAULT_SETTINGS.forEach(setting => {
// Get stored tool setting if it exists.
localforage.getItem(this.getStorageKey(name)).then( (value) => {
if (value) {
this._settings[args.name] = {
type: args.type,
name: args.name,
value: type === 'color' ? new window.Wick.Color(value) : value,
default: args.default,
min: args.min,
max: args.max,
step: args.step,
options: args.options,
};
}
});
});
}
_fireOnSettingsChanged (name, value) {
this._onSettingsChangedCallback(name, value);
}
}
</code></pre>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="BuiltinAssets.html">BuiltinAssets</a></li><li><a href="GlobalAPI.html">GlobalAPI</a></li><li><a href="paper.SelectionGUI.html">SelectionGUI</a></li><li><a href="paper-paper.Selection.html">Selection</a></li><li><a href="SelectionWidget.html">SelectionWidget</a></li><li><a href="Wick.AutoSave.html">AutoSave</a></li><li><a href="Wick.Base.html">Base</a></li><li><a href="Wick.Button.html">Button</a></li><li><a href="Wick.Clip.html">Clip</a></li><li><a href="Wick.Clipboard.html">Clipboard</a></li><li><a href="Wick.FileCache.html">FileCache</a></li><li><a href="Wick.Frame.html">Frame</a></li><li><a href="Wick.GUIElement.Project.html">Project</a></li><li><a href="Wick.GUIElement.Timeline.html">Timeline</a></li><li><a href="Wick.GUIElement-Wick.GUIElement.Breadcrumbs.html">Breadcrumbs</a></li><li><a href="Wick.GUIElement-Wick.GUIElement.Button.html">Button</a></li><li><a href="Wick.History.html">History</a></li><li><a href="Wick.HTMLExport.html">HTMLExport</a></li><li><a href="Wick.HTMLPreview.html">HTMLPreview</a></li><li><a href="Wick.ImageSequence.html">ImageSequence</a></li><li><a href="Wick.Layer.html">Layer</a></li><li><a href="Wick.Path.html">Path</a></li><li><a href="Wick.Project.html">Project</a></li><li><a href="Wick.Selection.html">Selection</a></li><li><a href="Wick.Tickable.html">Tickable</a></li><li><a href="Wick.Timeline.html">Timeline</a></li><li><a href="Wick.Tools-Wick.Tools.Brush.html">Brush</a></li><li><a href="Wick.Tools-Wick.Tools.Cursor.html">Cursor</a></li><li><a href="Wick.Tools-Wick.Tools.Ellipse.html">Ellipse</a></li><li><a href="Wick.Tools-Wick.Tools.Eraser.html">Eraser</a></li><li><a href="Wick.Tools-Wick.Tools.Eyedropper.html">Eyedropper</a></li><li><a href="Wick.Tools-Wick.Tools.FillBucket.html">FillBucket</a></li><li><a href="Wick.Tools-Wick.Tools.Interact.html">Interact</a></li><li><a href="Wick.Tools-Wick.Tools.Line.html">Line</a></li><li><a href="Wick.Tools-Wick.Tools.None.html">None</a></li><li><a href="Wick.Tools-Wick.Tools.Pan.html">Pan</a></li><li><a href="Wick.Tools-Wick.Tools.Pencil.html">Pencil</a></li><li><a href="Wick.Tools-Wick.Tools.Rectangle.html">Rectangle</a></li><li><a href="Wick.Tools-Wick.Tools.Text.html">Text</a></li><li><a href="Wick.Tools-Wick.Tools.Zoom.html">Zoom</a></li><li><a href="Wick.Transformation.html">Transformation</a></li><li><a href="Wick.Tween.html">Tween</a></li><li><a href="Wick.View-Wick.View.Clip.html">Clip</a></li><li><a href="Wick.View-Wick.View.Frame.html">Frame</a></li><li><a href="Wick.View-Wick.View.Path.html">Path</a></li><li><a href="Wick.View-Wick.View.Selection.html">Selection</a></li><li><a href="Wick.WickFile.html">WickFile</a></li><li><a href="Wick.WickObjectFile.html">WickObjectFile</a></li><li><a href="Wick.ZIPExport.html">ZIPExport</a></li><li><a href="WickObjectCache.html">WickObjectCache</a></li><li><a href="Wick-Wick.Asset.html">Asset</a></li><li><a href="Wick-Wick.AudioTrack.html">AudioTrack</a></li><li><a href="Wick-Wick.ClipAsset.html">ClipAsset</a></li><li><a href="Wick-Wick.Color.html">Color</a></li><li><a href="Wick-Wick.FileAsset.html">FileAsset</a></li><li><a href="Wick-Wick.FontAsset.html">FontAsset</a></li><li><a href="Wick-Wick.GIFAsset.html">GIFAsset</a></li><li><a href="Wick-Wick.GUIElement.html">GUIElement</a></li><li><a href="Wick-Wick.ImageAsset.html">ImageAsset</a></li><li><a href="Wick-Wick.SoundAsset.html">SoundAsset</a></li><li><a href="Wick-Wick.SVGAsset.html">SVGAsset</a></li><li><a href="Wick-Wick.Tool.html">Tool</a></li><li><a href="Wick-Wick.ToolSettings.html">ToolSettings</a></li><li><a href="Wick-Wick.View.html">View</a></li></ul><h3>Global</h3><ul><li><a href="global.html#type">type</a></li><li><a href="global.html#Wick">Wick</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.4</a> on Fri Apr 24 2020 15:26:12 GMT-0400 (Eastern Daylight Time)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>