summaryrefslogtreecommitdiff
path: root/indra/llmath/v4coloru.h
blob: 29128a08a76b760220820e96774e566377229fed (plain)
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
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
/**
 * @file v4coloru.h
 * @brief The LLColor4U class.
 *
 * $LicenseInfo:firstyear=2001&license=viewerlgpl$
 * Second Life Viewer Source Code
 * Copyright (C) 2010, Linden Research, Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation;
 * version 2.1 of the License only.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 *
 * Linden Research, Inc., 945 Battery Street, San Francisco, CA  94111  USA
 * $/LicenseInfo$
 */

#ifndef LL_V4COLORU_H
#define LL_V4COLORU_H

#include "llerror.h"
//#include "vmath.h"
#include "llmath.h"
//#include "v4color.h"

#include "v3color.h"
#include "v4color.h"

//class LLColor3U;
class LLColor4;

//  LLColor4U = | red green blue alpha |

static const U32 LENGTHOFCOLOR4U = 4;


class LLColor4U
{
public:

    U8 mV[LENGTHOFCOLOR4U];

    LLColor4U();                        // Initializes LLColor4U to (0, 0, 0, 1)
    LLColor4U(U8 r, U8 g, U8 b);        // Initializes LLColor4U to (r, g, b, 1)
    LLColor4U(U8 r, U8 g, U8 b, U8 a);      // Initializes LLColor4U to (r. g, b, a)
    LLColor4U(const U8 *vec);           // Initializes LLColor4U to (vec[0]. vec[1], vec[2], 1)
    explicit LLColor4U(const LLSD& sd)
    {
        setValue(sd);
    }

    void setValue(const LLSD& sd)
    {
        mV[0] = sd[0].asInteger();
        mV[1] = sd[1].asInteger();
        mV[2] = sd[2].asInteger();
        mV[3] = sd[3].asInteger();
    }

    LLSD getValue() const
    {
        LLSD ret;
        ret[0] = mV[0];
        ret[1] = mV[1];
        ret[2] = mV[2];
        ret[3] = mV[3];
        return ret;
    }

    const LLColor4U&    setToBlack();                       // zero LLColor4U to (0, 0, 0, 1)
    const LLColor4U&    setToWhite();                       // zero LLColor4U to (0, 0, 0, 1)

    const LLColor4U&    set(U8 r, U8 g, U8 b, U8 a);// Sets LLColor4U to (r, g, b, a)
    const LLColor4U&    set(U8 r, U8 g, U8 b);      // Sets LLColor4U to (r, g, b) (no change in a)
    const LLColor4U&    set(const LLColor4U &vec);  // Sets LLColor4U to vec
    const LLColor4U&    set(const U8 *vec);         // Sets LLColor4U to vec

    const LLColor4U&    setVec(U8 r, U8 g, U8 b, U8 a); // deprecated -- use set()
    const LLColor4U&    setVec(U8 r, U8 g, U8 b);       // deprecated -- use set()
    const LLColor4U&    setVec(const LLColor4U &vec);   // deprecated -- use set()
    const LLColor4U&    setVec(const U8 *vec);          // deprecated -- use set()

    const LLColor4U&    setAlpha(U8 a);

    F32         magVec() const;             // deprecated -- use length()
    F32         magVecSquared() const;      // deprecated -- use lengthSquared()

    F32         length() const;             // Returns magnitude squared of LLColor4U
    F32         lengthSquared() const;      // Returns magnitude squared of LLColor4U

    friend std::ostream&     operator<<(std::ostream& s, const LLColor4U &a);       // Print a
    friend LLColor4U operator+(const LLColor4U &a, const LLColor4U &b); // Return vector a + b
    friend LLColor4U operator-(const LLColor4U &a, const LLColor4U &b); // Return vector a minus b
    friend LLColor4U operator*(const LLColor4U &a, const LLColor4U &b); // Return a * b
    friend bool operator==(const LLColor4U &a, const LLColor4U &b);     // Return a == b
    friend bool operator!=(const LLColor4U &a, const LLColor4U &b);     // Return a != b

    friend const LLColor4U& operator+=(LLColor4U &a, const LLColor4U &b);   // Return vector a + b
    friend const LLColor4U& operator-=(LLColor4U &a, const LLColor4U &b);   // Return vector a minus b
    friend const LLColor4U& operator*=(LLColor4U &a, U8 k);             // Return rgb times scaler k (no alpha change)
    friend const LLColor4U& operator%=(LLColor4U &a, U8 k);             // Return alpha times scaler k (no rgb change)

    LLColor4U addClampMax(const LLColor4U &color);                      // Add and clamp the max

    LLColor4U multAll(const F32 k);                                     // Multiply ALL channels by scalar k

    inline void setVecScaleClamp(const LLColor3 &color);
    inline void setVecScaleClamp(const LLColor4 &color);

    static bool parseColor4U(const std::string& buf, LLColor4U* value);

    // conversion
    operator LLColor4() const
    {
        return LLColor4(*this);
    }

    U32 asRGBA() const;
    void fromRGBA( U32 aVal );

    static LLColor4U white;
    static LLColor4U black;
    static LLColor4U red;
    static LLColor4U green;
    static LLColor4U blue;
};


// Non-member functions
F32     distVec(const LLColor4U &a, const LLColor4U &b);            // Returns distance between a and b
F32     distVec_squared(const LLColor4U &a, const LLColor4U &b);    // Returns distance squared between a and b


inline LLColor4U::LLColor4U()
{
    mV[VRED] = 0;
    mV[VGREEN] = 0;
    mV[VBLUE] = 0;
    mV[VALPHA] = 255;
}

inline LLColor4U::LLColor4U(U8 r, U8 g, U8 b)
{
    mV[VRED] = r;
    mV[VGREEN] = g;
    mV[VBLUE] = b;
    mV[VALPHA] = 255;
}

inline LLColor4U::LLColor4U(U8 r, U8 g, U8 b, U8 a)
{
    mV[VRED] = r;
    mV[VGREEN] = g;
    mV[VBLUE] = b;
    mV[VALPHA] = a;
}

inline LLColor4U::LLColor4U(const U8 *vec)
{
    mV[VRED] = vec[VRED];
    mV[VGREEN] = vec[VGREEN];
    mV[VBLUE] = vec[VBLUE];
    mV[VALPHA] = vec[VALPHA];
}

/*
inline LLColor4U::operator LLColor4()
{
    return(LLColor4((F32)mV[VRED]/255.f,(F32)mV[VGREEN]/255.f,(F32)mV[VBLUE]/255.f,(F32)mV[VALPHA]/255.f));
}
*/

inline const LLColor4U& LLColor4U::setToBlack(void)
{
    mV[VRED] = 0;
    mV[VGREEN] = 0;
    mV[VBLUE] = 0;
    mV[VALPHA] = 255;
    return (*this);
}

inline const LLColor4U& LLColor4U::setToWhite(void)
{
    mV[VRED] = 255;
    mV[VGREEN] = 255;
    mV[VBLUE] = 255;
    mV[VALPHA] = 255;
    return (*this);
}

inline const LLColor4U& LLColor4U::set(const U8 x, const U8 y, const U8 z)
{
    mV[VRED] = x;
    mV[VGREEN] = y;
    mV[VBLUE] = z;

//  no change to alpha!
//  mV[VALPHA] = 255;

    return (*this);
}

inline const LLColor4U& LLColor4U::set(const U8 r, const U8 g, const U8 b, U8 a)
{
    mV[0] = r;
    mV[1] = g;
    mV[2] = b;
    mV[3] = a;
    return (*this);
}

inline const LLColor4U& LLColor4U::set(const LLColor4U &vec)
{
    mV[VRED] = vec.mV[VRED];
    mV[VGREEN] = vec.mV[VGREEN];
    mV[VBLUE] = vec.mV[VBLUE];
    mV[VALPHA] = vec.mV[VALPHA];
    return (*this);
}

inline const LLColor4U& LLColor4U::set(const U8 *vec)
{
    mV[VRED] = vec[VRED];
    mV[VGREEN] = vec[VGREEN];
    mV[VBLUE] = vec[VBLUE];
    mV[VALPHA] = vec[VALPHA];
    return (*this);
}

// deprecated
inline const LLColor4U& LLColor4U::setVec(const U8 x, const U8 y, const U8 z)
{
    mV[VRED] = x;
    mV[VGREEN] = y;
    mV[VBLUE] = z;

//  no change to alpha!
//  mV[VALPHA] = 255;

    return (*this);
}

// deprecated
inline const LLColor4U& LLColor4U::setVec(const U8 r, const U8 g, const U8 b, U8 a)
{
    mV[0] = r;
    mV[1] = g;
    mV[2] = b;
    mV[3] = a;
    return (*this);
}

// deprecated
inline const LLColor4U& LLColor4U::setVec(const LLColor4U &vec)
{
    mV[VRED] = vec.mV[VRED];
    mV[VGREEN] = vec.mV[VGREEN];
    mV[VBLUE] = vec.mV[VBLUE];
    mV[VALPHA] = vec.mV[VALPHA];
    return (*this);
}

// deprecated
inline const LLColor4U& LLColor4U::setVec(const U8 *vec)
{
    mV[VRED] = vec[VRED];
    mV[VGREEN] = vec[VGREEN];
    mV[VBLUE] = vec[VBLUE];
    mV[VALPHA] = vec[VALPHA];
    return (*this);
}

inline const LLColor4U& LLColor4U::setAlpha(U8 a)
{
    mV[VALPHA] = a;
    return (*this);
}

// LLColor4U Magnitude and Normalization Functions

inline F32      LLColor4U::length(void) const
{
    return (F32) sqrt( ((F32)mV[VRED]) * mV[VRED] + ((F32)mV[VGREEN]) * mV[VGREEN] + ((F32)mV[VBLUE]) * mV[VBLUE] );
}

inline F32      LLColor4U::lengthSquared(void) const
{
    return ((F32)mV[VRED]) * mV[VRED] + ((F32)mV[VGREEN]) * mV[VGREEN] + ((F32)mV[VBLUE]) * mV[VBLUE];
}

// deprecated
inline F32      LLColor4U::magVec(void) const
{
    return (F32) sqrt( ((F32)mV[VRED]) * mV[VRED] + ((F32)mV[VGREEN]) * mV[VGREEN] + ((F32)mV[VBLUE]) * mV[VBLUE] );
}

// deprecated
inline F32      LLColor4U::magVecSquared(void) const
{
    return ((F32)mV[VRED]) * mV[VRED] + ((F32)mV[VGREEN]) * mV[VGREEN] + ((F32)mV[VBLUE]) * mV[VBLUE];
}

inline LLColor4U operator+(const LLColor4U &a, const LLColor4U &b)
{
    return LLColor4U(
        a.mV[VRED] + b.mV[VRED],
        a.mV[VGREEN] + b.mV[VGREEN],
        a.mV[VBLUE] + b.mV[VBLUE],
        a.mV[VALPHA] + b.mV[VALPHA]);
}

inline LLColor4U operator-(const LLColor4U &a, const LLColor4U &b)
{
    return LLColor4U(
        a.mV[VRED] - b.mV[VRED],
        a.mV[VGREEN] - b.mV[VGREEN],
        a.mV[VBLUE] - b.mV[VBLUE],
        a.mV[VALPHA] - b.mV[VALPHA]);
}

inline LLColor4U  operator*(const LLColor4U &a, const LLColor4U &b)
{
    return LLColor4U(
        a.mV[VRED] * b.mV[VRED],
        a.mV[VGREEN] * b.mV[VGREEN],
        a.mV[VBLUE] * b.mV[VBLUE],
        a.mV[VALPHA] * b.mV[VALPHA]);
}

inline LLColor4U LLColor4U::addClampMax(const LLColor4U &color)
{
    return LLColor4U(llmin((S32)mV[VRED] + color.mV[VRED], 255),
                    llmin((S32)mV[VGREEN] + color.mV[VGREEN], 255),
                    llmin((S32)mV[VBLUE] + color.mV[VBLUE], 255),
                    llmin((S32)mV[VALPHA] + color.mV[VALPHA], 255));
}

inline LLColor4U LLColor4U::multAll(const F32 k)
{
    // Round to nearest
    return LLColor4U(
        (U8)ll_round(mV[VRED] * k),
        (U8)ll_round(mV[VGREEN] * k),
        (U8)ll_round(mV[VBLUE] * k),
        (U8)ll_round(mV[VALPHA] * k));
}
/*
inline LLColor4U operator*(const LLColor4U &a, U8 k)
{
    // only affects rgb (not a!)
    return LLColor4U(
        a.mV[VRED] * k,
        a.mV[VGREEN] * k,
        a.mV[VBLUE] * k,
        a.mV[VALPHA]);
}

inline LLColor4U operator*(U8 k, const LLColor4U &a)
{
    // only affects rgb (not a!)
    return LLColor4U(
        a.mV[VRED] * k,
        a.mV[VGREEN] * k,
        a.mV[VBLUE] * k,
        a.mV[VALPHA]);
}

inline LLColor4U operator%(U8 k, const LLColor4U &a)
{
    // only affects alpha (not rgb!)
    return LLColor4U(
        a.mV[VRED],
        a.mV[VGREEN],
        a.mV[VBLUE],
        a.mV[VALPHA] * k );
}

inline LLColor4U operator%(const LLColor4U &a, U8 k)
{
    // only affects alpha (not rgb!)
    return LLColor4U(
        a.mV[VRED],
        a.mV[VGREEN],
        a.mV[VBLUE],
        a.mV[VALPHA] * k );
}
*/

inline bool operator==(const LLColor4U &a, const LLColor4U &b)
{
    return (  (a.mV[VRED] == b.mV[VRED])
            &&(a.mV[VGREEN] == b.mV[VGREEN])
            &&(a.mV[VBLUE] == b.mV[VBLUE])
            &&(a.mV[VALPHA] == b.mV[VALPHA]));
}

inline bool operator!=(const LLColor4U &a, const LLColor4U &b)
{
    return (  (a.mV[VRED] != b.mV[VRED])
            ||(a.mV[VGREEN] != b.mV[VGREEN])
            ||(a.mV[VBLUE] != b.mV[VBLUE])
            ||(a.mV[VALPHA] != b.mV[VALPHA]));
}

inline const LLColor4U& operator+=(LLColor4U &a, const LLColor4U &b)
{
    a.mV[VRED] += b.mV[VRED];
    a.mV[VGREEN] += b.mV[VGREEN];
    a.mV[VBLUE] += b.mV[VBLUE];
    a.mV[VALPHA] += b.mV[VALPHA];
    return a;
}

inline const LLColor4U& operator-=(LLColor4U &a, const LLColor4U &b)
{
    a.mV[VRED] -= b.mV[VRED];
    a.mV[VGREEN] -= b.mV[VGREEN];
    a.mV[VBLUE] -= b.mV[VBLUE];
    a.mV[VALPHA] -= b.mV[VALPHA];
    return a;
}

inline const LLColor4U& operator*=(LLColor4U &a, U8 k)
{
    // only affects rgb (not a!)
    a.mV[VRED] *= k;
    a.mV[VGREEN] *= k;
    a.mV[VBLUE] *= k;
    return a;
}

inline const LLColor4U& operator%=(LLColor4U &a, U8 k)
{
    // only affects alpha (not rgb!)
    a.mV[VALPHA] *= k;
    return a;
}

inline F32      distVec(const LLColor4U &a, const LLColor4U &b)
{
    LLColor4U vec = a - b;
    return (vec.length());
}

inline F32      distVec_squared(const LLColor4U &a, const LLColor4U &b)
{
    LLColor4U vec = a - b;
    return (vec.lengthSquared());
}

void LLColor4U::setVecScaleClamp(const LLColor4& color)
{
    F32 color_scale_factor = 255.f;
    F32 max_color = llmax(color.mV[0], color.mV[1], color.mV[2]);
    if (max_color > 1.f)
    {
        color_scale_factor /= max_color;
    }
    const S32 MAX_COLOR = 255;
    S32 r = ll_round(color.mV[0] * color_scale_factor);
    if (r > MAX_COLOR)
    {
        r = MAX_COLOR;
    }
    else if (r < 0)
    {
        r = 0;
    }
    mV[0] = r;

    S32 g = ll_round(color.mV[1] * color_scale_factor);
    if (g > MAX_COLOR)
    {
        g = MAX_COLOR;
    }
    else if (g < 0)
    {
        g = 0;
    }
    mV[1] = g;

    S32 b = ll_round(color.mV[2] * color_scale_factor);
    if (b > MAX_COLOR)
    {
        b = MAX_COLOR;
    }
    else if (b < 0)
    {
        b = 0;
    }
    mV[2] = b;

    // Alpha shouldn't be scaled, just clamped...
    S32 a = ll_round(color.mV[3] * MAX_COLOR);
    if (a > MAX_COLOR)
    {
        a = MAX_COLOR;
    }
    else if (a < 0)
    {
        a = 0;
    }
    mV[3] = a;
}

void LLColor4U::setVecScaleClamp(const LLColor3& color)
{
    F32 color_scale_factor = 255.f;
    F32 max_color = llmax(color.mV[0], color.mV[1], color.mV[2]);
    if (max_color > 1.f)
    {
        color_scale_factor /= max_color;
    }

    const S32 MAX_COLOR = 255;
    S32 r = ll_round(color.mV[0] * color_scale_factor);
    if (r > MAX_COLOR)
    {
        r = MAX_COLOR;
    }
    else
    if (r < 0)
    {
        r = 0;
    }
    mV[0] = r;

    S32 g = ll_round(color.mV[1] * color_scale_factor);
    if (g > MAX_COLOR)
    {
        g = MAX_COLOR;
    }
    else
    if (g < 0)
    {
        g = 0;
    }
    mV[1] = g;

    S32 b = ll_round(color.mV[2] * color_scale_factor);
    if (b > MAX_COLOR)
    {
        b = MAX_COLOR;
    }
    if (b < 0)
    {
        b = 0;
    }
    mV[2] = b;

    mV[3] = 255;
}

inline U32 LLColor4U::asRGBA() const
{
    // Little endian: values are swapped in memory. The original code access the array like a U32, so we need to swap here

    return (mV[3] << 24) | (mV[2] << 16) | (mV[1] << 8) | mV[0];
}

inline void LLColor4U::fromRGBA( U32 aVal )
{
    // Little endian: values are swapped in memory. The original code access the array like a U32, so we need to swap here

    mV[ 0 ] = aVal & 0xFF;
    aVal >>= 8;
    mV[ 1 ] = aVal & 0xFF;
    aVal >>= 8;
    mV[ 2 ] = aVal & 0xFF;
    aVal >>= 8;
    mV[ 3 ] = aVal & 0xFF;
}


#endif