-
-
Notifications
You must be signed in to change notification settings - Fork 3.3k
/
creating_reading.js
549 lines (525 loc) · 15.6 KB
/
creating_reading.js
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
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
/**
* @module Color
* @submodule Creating & Reading
* @for p5
* @requires core
* @requires constants
*/
import p5 from '../core/main';
import * as constants from '../core/constants';
import './p5.Color';
import '../core/friendly_errors/validate_params';
import '../core/friendly_errors/file_errors';
import '../core/friendly_errors/fes_core';
/**
* Extracts the alpha value from a color or pixel array.
*
* @method alpha
* @param {p5.Color|Number[]|String} color <a href="#/p5.Color">p5.Color</a> object, color components,
* or CSS color
* @return {Number} the alpha value
*
* @example
* <div>
* <code>
* noStroke();
* let c = color(0, 126, 255, 102);
* fill(c);
* rect(15, 15, 35, 70);
* let value = alpha(c); // Sets 'value' to 102
* fill(value);
* rect(50, 15, 35, 70);
* describe('Left half of canvas light blue and right half light charcoal grey.');
* </code>
* </div>
*/
p5.prototype.alpha = function(c) {
p5._validateParameters('alpha', arguments);
return this.color(c)._getAlpha();
};
/**
* Extracts the blue value from a color or pixel array.
*
* @method blue
* @param {p5.Color|Number[]|String} color <a href="#/p5.Color">p5.Color</a> object, color components,
* or CSS color
* @return {Number} the blue value
* @example
* <div>
* <code>
* let c = color(175, 100, 220);
* fill(c);
* rect(15, 20, 35, 60); // Draw left rectangle
* let blueValue = blue(c);
* fill(0, 0, blueValue);
* rect(50, 20, 35, 60); // Draw right rectangle
* describe('Left half of canvas light purple and right half a royal blue.');
* </code>
* </div>
*
*/
p5.prototype.blue = function(c) {
p5._validateParameters('blue', arguments);
return this.color(c)._getBlue();
};
/**
* Extracts the HSB brightness value from a color or pixel array.
*
* @method brightness
* @param {p5.Color|Number[]|String} color <a href="#/p5.Color">p5.Color</a> object, color components,
* or CSS color
* @return {Number} the brightness value
*
* @example
* <div>
* <code>
* noStroke();
* colorMode(HSB, 255);
* let c = color(0, 126, 255);
* fill(c);
* rect(15, 20, 35, 60);
* let value = brightness(c); // Sets 'value' to 255
* fill(value);
* rect(50, 20, 35, 60);
* describe(`Left half of canvas salmon pink and the right half with its
* brightness colored white.`);
* </code>
* </div>
*
* <div>
* <code>
* noStroke();
* colorMode(HSB, 255);
* let c = color('hsb(60, 100%, 50%)');
* fill(c);
* rect(15, 20, 35, 60);
* let value = brightness(c); // A 'value' of 50% is 127.5
* fill(value);
* rect(50, 20, 35, 60);
* describe(`Left half of canvas olive colored and the right half with its
* brightness color gray.`);
* </code>
* </div>
*/
p5.prototype.brightness = function(c) {
p5._validateParameters('brightness', arguments);
return this.color(c)._getBrightness();
};
/**
* Creates colors for storing in variables of the color datatype. The
* parameters are interpreted as RGB or HSB values depending on the
* current <a href="#/p5/colorMode">colorMode()</a>. The default mode is RGB values from 0 to 255
* and, therefore, the function call color(255, 204, 0) will return a
* bright yellow color.
*
* Note that if only one value is provided to <a href="#/p5/color">color()</a>, it will be interpreted
* as a grayscale value. Add a second value, and it will be used for alpha
* transparency. When three values are specified, they are interpreted as
* either RGB or HSB values. Adding a fourth value applies alpha
* transparency.
*
* If a single string argument is provided, RGB, RGBA and Hex CSS color
* strings and all named color strings are supported. In this case, an alpha
* number value as a second argument is not supported, the RGBA form should be
* used.
*
* @method color
* @param {Number} gray number specifying value between white and black.
* @param {Number} [alpha] alpha value relative to current color range
* (default is 0-255)
* @return {p5.Color} resulting color
*
* @example
* <div>
* <code>
* let c = color(255, 204, 0);
* fill(c);
* noStroke();
* rect(30, 20, 55, 55);
* describe(`Yellow rect in middle right of canvas,
* with 55 pixel width and height.`);
* </code>
* </div>
*
* <div>
* <code>
* let c = color(255, 204, 0);
* fill(c);
* noStroke();
* ellipse(25, 25, 80, 80); // Draw left circle
* // Using only one value generates a grayscale value.
* c = color(65);
* fill(c);
* ellipse(75, 75, 80, 80);
* describe(`Yellow ellipse in top left of canvas, black ellipse in bottom
* right, both 80×80.`);
* </code>
* </div>
*
* <div>
* <code>
* // You can use named SVG & CSS colors
* let c = color('magenta');
* fill(c);
* noStroke();
* rect(20, 20, 60, 60);
* describe('Bright fuchsia rect in middle of canvas, 60 pixel width and height.');
* </code>
* </div>
*
* <div>
* <code>
* // Example of hex color codes
* noStroke();
* let c = color('#0f0');
* fill(c);
* rect(0, 10, 45, 80);
* c = color('#00ff00');
* fill(c);
* rect(55, 10, 45, 80);
* describe('Two bright green rects on opposite sides of the canvas, both 45×80.');
* </code>
* </div>
*
* <div>
* <code>
* // RGB and RGBA color strings are also supported
* // these all set to the same color (solid blue)
* let c;
* noStroke();
* c = color('rgb(0,0,255)');
* fill(c);
* rect(10, 10, 35, 35); // Draw rectangle
* c = color('rgb(0%, 0%, 100%)');
* fill(c);
* rect(55, 10, 35, 35); // Draw rectangle
* c = color('rgba(0, 0, 255, 1)');
* fill(c);
* rect(10, 55, 35, 35); // Draw rectangle
* c = color('rgba(0%, 0%, 100%, 1)');
* fill(c);
* rect(55, 55, 35, 35); // Draw rectangle
* describe('Four blue rects in each corner of the canvas, each are 35×35.');
* </code>
* </div>
*
* <div>
* <code>
* // HSL color can also be specified by value
* let c = color('hsl(160, 100%, 50%)');
* noStroke();
* fill(c);
* rect(0, 10, 45, 80); // Draw rectangle
* c = color('hsla(160, 100%, 50%, 0.5)');
* fill(c);
* rect(55, 10, 45, 80); // Draw rectangle
* describe(`Bright sea green rect on left and darker rect on right of canvas,
* both 45×80.`);
* </code>
* </div>
*
* <div>
* <code>
* // HSB color can also be specified
* let c = color('hsb(160, 100%, 50%)');
* noStroke();
* fill(c);
* rect(0, 10, 45, 80); // Draw rectangle
* c = color('hsba(160, 100%, 50%, 0.5)');
* fill(c);
* rect(55, 10, 45, 80); // Draw rectangle
* describe(`Dark green rect on left and lighter green rect on right of canvas,
* both 45×80.`);
* </code>
* </div>
*
* <div>
* <code>
* noStroke();
* let c = color(50, 55, 100);
* fill(c);
* rect(0, 10, 45, 80); // Draw left rect
* colorMode(HSB, 100);
* c = color(50, 55, 100);
* fill(c);
* rect(55, 10, 45, 80);
* describe(`Dark blue rect on left and light teal rect on right of canvas,
* both 45×80.`);
* </code>
* </div>
*/
/**
* @method color
* @param {Number} v1 red or hue value relative to
* the current color range
* @param {Number} v2 green or saturation value
* relative to the current color range
* @param {Number} v3 blue or brightness value
* relative to the current color range
* @param {Number} [alpha]
* @return {p5.Color}
*/
/**
* @method color
* @param {String} value a color string
* @return {p5.Color}
*/
/**
* @method color
* @param {Number[]} values an array containing the red,green,blue &
* and alpha components of the color
* @return {p5.Color}
*/
/**
* @method color
* @param {p5.Color} color
* @return {p5.Color}
*/
p5.prototype.color = function() {
p5._validateParameters('color', arguments);
if (arguments[0] instanceof p5.Color) {
return arguments[0]; // Do nothing if argument is already a color object.
}
const args = arguments[0] instanceof Array ? arguments[0] : arguments;
return new p5.Color(this, args);
};
/**
* Extracts the green value from a color or pixel array.
*
* @method green
* @param {p5.Color|Number[]|String} color <a href="#/p5.Color">p5.Color</a> object, color components,
* or CSS color
* @return {Number} the green value
* @example
* <div>
* <code>
* let c = color(20, 75, 200); // Define color 'c'
* fill(c); // Use color variable 'c' as fill color
* rect(15, 20, 35, 60); // Draw left rectangle
*
* let greenValue = green(c); // Get green in 'c'
* print(greenValue); // Print "75.0"
* fill(0, greenValue, 0); // Use 'greenValue' in new fill
* rect(50, 20, 35, 60); // Draw right rectangle
* describe(`blue rect on left and green on right, both with black outlines
* & 35×60.`);
* </code>
* </div>
*/
p5.prototype.green = function(c) {
p5._validateParameters('green', arguments);
return this.color(c)._getGreen();
};
/**
* Extracts the hue value from a color or pixel array.
*
* Hue exists in both HSB and HSL. This function will return the
* HSB-normalized hue when supplied with an HSB color object (or when supplied
* with a pixel array while the color mode is HSB), but will default to the
* HSL-normalized hue otherwise. (The values will only be different if the
* maximum hue setting for each system is different.)
*
* @method hue
* @param {p5.Color|Number[]|String} color <a href="#/p5.Color">p5.Color</a> object, color components,
* or CSS color
* @return {Number} the hue
* @example
* <div>
* <code>
* noStroke();
* colorMode(HSB, 255);
* let c = color(0, 126, 255);
* fill(c);
* rect(15, 20, 35, 60);
* let value = hue(c); // Sets 'value' to "0"
* fill(value);
* rect(50, 20, 35, 60);
* describe('salmon pink rect on left and black on right, both 35×60.');
* </code>
* </div>
*
*/
p5.prototype.hue = function(c) {
p5._validateParameters('hue', arguments);
return this.color(c)._getHue();
};
/**
* Blends two colors to find a third color somewhere between them. The amt
* parameter is the amount to interpolate between the two values where 0.0
* is equal to the first color, 0.1 is very near the first color, 0.5 is halfway
* in between, etc. An amount below 0 will be treated as 0. Likewise, amounts
* above 1 will be capped at 1. This is different from the behavior of <a href="#/p5/lerp">lerp()</a>,
* but necessary because otherwise numbers outside the range will produce
* strange and unexpected colors.
*
* The way that colors are interpolated depends on the current color mode.
*
* @method lerpColor
* @param {p5.Color} c1 interpolate from this color
* @param {p5.Color} c2 interpolate to this color
* @param {Number} amt number between 0 and 1
* @return {p5.Color} interpolated color
*
* @example
* <div>
* <code>
* colorMode(RGB);
* stroke(255);
* background(51);
* let from = color(218, 165, 32);
* let to = color(72, 61, 139);
* colorMode(RGB); // Try changing to HSB.
* let interA = lerpColor(from, to, 0.33);
* let interB = lerpColor(from, to, 0.66);
* fill(from);
* rect(10, 20, 20, 60);
* fill(interA);
* rect(30, 20, 20, 60);
* fill(interB);
* rect(50, 20, 20, 60);
* fill(to);
* rect(70, 20, 20, 60);
* describe(`4 rects one tan, brown, brownish purple, purple, with white
* outlines & 20×60`);
* </code>
* </div>
*/
p5.prototype.lerpColor = function(c1, c2, amt) {
p5._validateParameters('lerpColor', arguments);
const mode = this._colorMode;
const maxes = this._colorMaxes;
let l0, l1, l2, l3;
let fromArray, toArray;
if (mode === constants.RGB) {
fromArray = c1.levels.map(level => level / 255);
toArray = c2.levels.map(level => level / 255);
} else if (mode === constants.HSB) {
c1._getBrightness(); // Cache hsba so it definitely exists.
c2._getBrightness();
fromArray = c1.hsba;
toArray = c2.hsba;
} else if (mode === constants.HSL) {
c1._getLightness(); // Cache hsla so it definitely exists.
c2._getLightness();
fromArray = c1.hsla;
toArray = c2.hsla;
} else {
throw new Error(`${mode}cannot be used for interpolation.`);
}
// Prevent extrapolation.
amt = Math.max(Math.min(amt, 1), 0);
// Define lerp here itself if user isn't using math module.
// Maintains the definition as found in math/calculation.js
if (typeof this.lerp === 'undefined') {
this.lerp = (start, stop, amt) => amt * (stop - start) + start;
}
// Perform interpolation.
l0 = this.lerp(fromArray[0], toArray[0], amt);
l1 = this.lerp(fromArray[1], toArray[1], amt);
l2 = this.lerp(fromArray[2], toArray[2], amt);
l3 = this.lerp(fromArray[3], toArray[3], amt);
// Scale components.
l0 *= maxes[mode][0];
l1 *= maxes[mode][1];
l2 *= maxes[mode][2];
l3 *= maxes[mode][3];
return this.color(l0, l1, l2, l3);
};
/**
* Extracts the HSL lightness value from a color or pixel array.
*
* @method lightness
* @param {p5.Color|Number[]|String} color <a href="#/p5.Color">p5.Color</a> object, color components,
* or CSS color
* @return {Number} the lightness
*
* @example
* <div>
* <code>
* noStroke();
* colorMode(HSL);
* let c = color(156, 100, 50, 1);
* fill(c);
* rect(15, 20, 35, 60);
* let value = lightness(c); // Sets 'value' to 50
* fill(value);
* rect(50, 20, 35, 60);
* describe(`light pastel green rect on left and dark grey rect on right,
* both 35×60.`);
* </code>
* </div>
*/
p5.prototype.lightness = function(c) {
p5._validateParameters('lightness', arguments);
return this.color(c)._getLightness();
};
/**
* Extracts the red value from a color or pixel array.
*
* @method red
* @param {p5.Color|Number[]|String} color <a href="#/p5.Color">p5.Color</a> object, color components,
* or CSS color
* @return {Number} the red value
* @example
* <div>
* <code>
* let c = color(255, 204, 0); // Define color 'c'
* fill(c); // Use color variable 'c' as fill color
* rect(15, 20, 35, 60); // Draw left rectangle
*
* let redValue = red(c); // Get red in 'c'
* print(redValue); // Print "255.0"
* fill(redValue, 0, 0); // Use 'redValue' in new fill
* rect(50, 20, 35, 60); // Draw right rectangle
* describe(`yellow rect on left and red rect on right, both with black
* outlines and 35×60.`);
* </code>
* </div>
*
* <div class="norender">
* <code>
* colorMode(RGB, 255); // Sets the range for red, green, and blue to 255
* let c = color(127, 255, 0);
* colorMode(RGB, 1); // Sets the range for red, green, and blue to 1
* let myColor = red(c);
* print(myColor); // 0.4980392156862745
* describe('grey canvas');
* </code>
* </div>
*/
p5.prototype.red = function(c) {
p5._validateParameters('red', arguments);
return this.color(c)._getRed();
};
/**
* Extracts the saturation value from a color or pixel array.
*
* Saturation is scaled differently in HSB and HSL. This function will return
* the HSB saturation when supplied with an HSB color object (or when supplied
* with a pixel array while the color mode is HSB), but will default to the
* HSL saturation otherwise.
*
* @method saturation
* @param {p5.Color|Number[]|String} color <a href="#/p5.Color">p5.Color</a> object, color components,
* or CSS color
* @return {Number} the saturation value
* @example
* <div>
* <code>
* noStroke();
* colorMode(HSB, 255);
* let c = color(0, 126, 255);
* fill(c);
* rect(15, 20, 35, 60);
* let value = saturation(c); // Sets 'value' to 126
* fill(value);
* rect(50, 20, 35, 60);
* describe('deep pink rect on left and grey rect on right, both 35×60.');
* </code>
* </div>
*/
p5.prototype.saturation = function(c) {
p5._validateParameters('saturation', arguments);
return this.color(c)._getSaturation();
};
export default p5;