Threepp.Color¶
Color class
Represents an RGB color. It can also be converted from an array [r, g, b], a dictionary %[r:, g:, b:] or an integer (0xRRGGBB).
Members¶
Constructors¶
Properties¶
Methods¶
- setScalar
- setRGB
- setHSL
- setHex
- copy
- add
- addColors
- addScalar
- sub
- multiply
- multiplyScalar
- lerp
- lerpColors
- lerpHSL
- randomize
- getHex
- getHexString
- getStyle
- equals
Color¶
Constructor
Arguments
| Arguments | Default | Description |
|---|---|---|
r |
1 |
Red component (0.0-1.0), or a hex value (0xRRGGBB). |
g |
1 |
Green component (0.0-1.0). |
b |
1 |
Blue component (0.0-1.0). |
Description
Constructor
r¶
Property \ Access: r/w
Description
Red component (0.0-1.0)
g¶
Property \ Access: r/w
Description
Green component (0.0-1.0)
b¶
Property \ Access: r/w
Description
Blue component (0.0-1.0)
setScalar¶
Method
Arguments
| Arguments | Default | Description |
|---|---|---|
s |
|
Description
Sets all components to the same value
setRGB¶
Method
Arguments
| Arguments | Default | Description |
|---|---|---|
r |
|
|
g |
|
|
b |
|
Description
Sets the RGB values
setHSL¶
Method
Arguments
| Arguments | Default | Description |
|---|---|---|
h |
|
|
s |
|
|
l |
|
Description
Sets the color from HSL values
setHex¶
Method
Arguments
| Arguments | Default | Description |
|---|---|---|
hex |
|
Description
Sets the color from a hexadecimal value
copy¶
Method
Arguments
| Arguments | Default | Description |
|---|---|---|
color |
|
Description
Copies another color
add¶
Method
Arguments
| Arguments | Default | Description |
|---|---|---|
color |
|
Description
Adds a color
addColors¶
Method
Arguments
| Arguments | Default | Description |
|---|---|---|
c1 |
|
|
c2 |
|
Description
Sets this color to the sum of two colors
addScalar¶
Method
Arguments
| Arguments | Default | Description |
|---|---|---|
s |
|
Description
Adds a scalar
sub¶
Method
Arguments
| Arguments | Default | Description |
|---|---|---|
color |
|
Description
Subtracts a color
multiply¶
Method
Arguments
| Arguments | Default | Description |
|---|---|---|
color |
|
Description
Multiplies by a color
multiplyScalar¶
Method
Arguments
| Arguments | Default | Description |
|---|---|---|
s |
|
Description
Multiplies by a scalar
lerp¶
Method
Arguments
| Arguments | Default | Description |
|---|---|---|
color |
|
|
alpha |
|
Description
Linear interpolation
lerpColors¶
Method
Arguments
| Arguments | Default | Description |
|---|---|---|
c1 |
|
|
c2 |
|
|
alpha |
|
Description
Linear interpolation between two colors
lerpHSL¶
Method
Arguments
| Arguments | Default | Description |
|---|---|---|
color |
|
|
alpha |
|
Description
Linear interpolation in HSL space
randomize¶
Method
Description
Generates a random color
getHex¶
Method
Description
Gets the hexadecimal value
getHexString¶
Method
Description
Gets the hexadecimal string
getStyle¶
Method
Description
Gets a CSS-style string
equals¶
Method
Arguments
| Arguments | Default | Description |
|---|---|---|
color |
|
Description
Equality test