|
@@ -3,7 +3,7 @@ Color - Represents a color
|
|
|
|
|
|
.. rubric:: Constructor
|
|
|
|
|
|
-.. class:: Color(hex)
|
|
|
+**class**:: Color(*hex*)
|
|
|
|
|
|
Represents a color
|
|
|
|
|
@@ -11,43 +11,43 @@ Color - Represents a color
|
|
|
|
|
|
.. rubric:: Attributes
|
|
|
|
|
|
-.. attribute:: Color.r
|
|
|
+**attribute**:: Color.r
|
|
|
|
|
|
- Red channel (float between 0 and 1)
|
|
|
+ Red channel (*float* between 0 and 1)
|
|
|
|
|
|
-.. attribute:: Color.g
|
|
|
+**attribute**:: Color.g
|
|
|
|
|
|
- Green channel (float between 0 and 1)
|
|
|
+ Green channel (*float* between 0 and 1)
|
|
|
|
|
|
-.. attribute:: Color.b
|
|
|
+**attribute**:: Color.b
|
|
|
|
|
|
- Blue channel (float between 0 and 1)
|
|
|
+ Blue channel (*float* between 0 and 1)
|
|
|
|
|
|
.. rubric:: Methods
|
|
|
|
|
|
-.. function:: Color.copy(color)
|
|
|
+**function**:: Color.copy(*color*)
|
|
|
|
|
|
Copies the given color into this color
|
|
|
|
|
|
- :param Color color: Color to copy
|
|
|
+ :param THREE.Color color: Color to copy
|
|
|
|
|
|
-.. function:: Color.copyGammaToLinear(color)
|
|
|
+**function**:: Color.copyGammaToLinear(*color*)
|
|
|
|
|
|
Creates a gamma color from a linear color
|
|
|
|
|
|
- :param Color color: Color to copy
|
|
|
+ :param THREE.Color color: Color to copy
|
|
|
:returns: Linear color
|
|
|
- :rtype: Color
|
|
|
+ :rtype: THREE.Color
|
|
|
|
|
|
-.. function:: Color.copyLinearToGamma(color)
|
|
|
+**function**:: Color.copyLinearToGamma(*color*)
|
|
|
|
|
|
Creates a linear color from a gamma color
|
|
|
|
|
|
- :param Color color: Color to copy
|
|
|
+ :param THREE.Color color: Color to copy
|
|
|
:returns: Gamma color
|
|
|
- :rtype: Color
|
|
|
+ :rtype: THREE.Color
|
|
|
|
|
|
-.. function:: Color.setRGB(r, g, b)
|
|
|
+**function**:: Color.setRGB(*r*, *g*, *b*)
|
|
|
|
|
|
Sets the RGB value of this color
|
|
|
|
|
@@ -55,7 +55,7 @@ Color - Represents a color
|
|
|
:param float g: Green channel value (between 0 and 1)
|
|
|
:param float b: Blue channel value (between 0 and 1)
|
|
|
|
|
|
-.. function:: Color.setHSV(h, s, v)
|
|
|
+**function**:: Color.setHSV(*h*, *s*, *v*)
|
|
|
|
|
|
Sets the HSV value of this color. Based on MochiKit implementation by
|
|
|
Bob Ippolito.
|
|
@@ -64,20 +64,20 @@ Color - Represents a color
|
|
|
:param float s: Saturation channel (between 0 and 1)
|
|
|
:param float v: Value channel (between 0 and 1)
|
|
|
|
|
|
-.. function:: Color.setHex(hex)
|
|
|
+**function**:: Color.setHex(*hex*)
|
|
|
|
|
|
Sets the value of this color from a hex value
|
|
|
|
|
|
:param integer hex: Value of the color in hex
|
|
|
|
|
|
-.. function:: Color.getHex()
|
|
|
+**function**:: Color.getHex()
|
|
|
|
|
|
Gets the value of this color in hex
|
|
|
|
|
|
:returns: The color value in hex
|
|
|
:rtype: integer
|
|
|
|
|
|
-.. function:: Color.getContextStyle()
|
|
|
+**function**:: Color.getContextStyle()
|
|
|
|
|
|
Returns the value of this color in CSS context style.
|
|
|
|
|
@@ -86,15 +86,15 @@ Color - Represents a color
|
|
|
:returns: A CSS-formatted color value
|
|
|
:rtype: string
|
|
|
|
|
|
-.. function:: Color.clone()
|
|
|
+**function**:: Color.clone()
|
|
|
|
|
|
Clones this color
|
|
|
|
|
|
:returns: New instance identical to this color
|
|
|
:rtype: Color
|
|
|
|
|
|
-.. rubric:: Example
|
|
|
-
|
|
|
+.. rubric:: Example
|
|
|
+
|
|
|
::
|
|
|
|
|
|
var colors = [];
|