Color.html 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8" />
  5. <base href="../../../" />
  6. <script src="list.js"></script>
  7. <script src="page.js"></script>
  8. <link type="text/css" rel="stylesheet" href="page.css" />
  9. </head>
  10. <body>
  11. <h1>颜色([name])</h1>
  12. <p class="desc">
  13. 表示一个颜色。
  14. </p>
  15. <h2>示例(Examples)</h2>
  16. 颜色可以用以下任意一种方式初始化。
  17. <code>
  18. //empty constructor - will default white
  19. var color = new THREE.Color();
  20. //Hexadecimal color (recommended)
  21. var color = new THREE.Color( 0xff0000 );
  22. //RGB string
  23. var color = new THREE.Color("rgb(255, 0, 0)");
  24. var color = new THREE.Color("rgb(100%, 0%, 0%)");
  25. //X11 color name - all 140 color names are supported.
  26. //Note the lack of CamelCase in the name
  27. var color = new THREE.Color( 'skyblue' );
  28. //HSL string
  29. var color = new THREE.Color("hsl(0, 100%, 50%)");
  30. //Separate RGB values between 0 and 1
  31. var color = new THREE.Color( 1, 0, 0 );
  32. </code>
  33. <h2>构造器(Constructor)</h2>
  34. <h3>[name]( [param:Color_Hex_or_String r], [param:Float g], [param:Float b] )</h3>
  35. <p>
  36. [page:Color_Hex_or_String r] - (可选参数) 如果参数g和b被定义,则r表示颜色中的红色分量。
  37. 如果未被定义,r可以是一个十六进制 [link:https://en.wikipedia.org/wiki/Web_colors#Hex_triplet hexadecimal triplet] 颜色值或CSS样式的字符串或一个Color实例。<br />
  38. [page:Float g] - (可选参数) 如果被定义,表示颜色中的绿色分量。<br />
  39. [page:Float b] - (可选参数) 如果被定义,表示颜色中的蓝色分量。<br /><br />
  40. 注意使用十六进制 [link:https://en.wikipedia.org/wiki/Web_colors#Hex_triplet hexadecimal triplet] 定义一个颜色在three.js中是标准的方法,而且其余
  41. 文档也将会使用这个方法。<br /><br />
  42. 当所有参数被定义时,r是红色分量,g是绿色分量,b是蓝色分量。<br />
  43. 当只有 [page:Color_Hex_or_String r] 被定义时:<br />
  44. <ul>
  45. <li>它可用一个十六进制 [link:https://en.wikipedia.org/wiki/Web_colors#Hex_triplet hexadecimal triplet] 值表示颜色(推荐)。</li>
  46. <li>它可以是一个另一个颜色实例。</li>
  47. <li>它可以是另外一个CSS样式。例如:
  48. <ul>
  49. <li>'rgb(250, 0,0)'</li>
  50. <li>'rgb(100%,0%,0%)'</li>
  51. <li>'hsl(0, 100%, 50%)'</li>
  52. <li>'#ff0000'</li>
  53. <li>'#f00'</li>
  54. <li>'red'</li>
  55. </ul>
  56. </li>
  57. </ul>
  58. </p>
  59. <h2>属性(Properties)</h2>
  60. <h3>[property:Float r]</h3>
  61. <p>
  62. 红色通道的值在0到1之间。默认值为1。
  63. </p>
  64. <h3>[property:Float g]</h3>
  65. <p>
  66. 绿色通道的值在0到1之间。默认值为1。
  67. </p>
  68. <h3>[property:Float b]</h3>
  69. <p>
  70. 蓝色通道的值在0到1之间。默认值为1。
  71. </p>
  72. <h2>方法(Methods)</h2>
  73. <h3>[method:Color add]( [param:Color color] ) </h3>
  74. <p>将给定颜色的RGB值添加到此颜色的RGB值。</p>
  75. <h3>[method:Color addColors]( [param:Color color1], [param:Color color2] ) </h3>
  76. <p>将此颜色的RGB值设置为 [page:Color color1] 和 [page:Color color2] 的RGB值之和。</p>
  77. <h3>[method:Color addScalar]( [param:Number s] ) </h3>
  78. <p>给现有的RGB值都加上 [page:Number s] 。</p>
  79. <h3>[method:Color clone]() </h3>
  80. <p>返回一个与当前颜色的 [page:.r r], [page:.g g] 和 [page:.b b] 相同的颜色。</p>
  81. <h3>[method:Color copy]( [param:Color color] ) </h3>
  82. <p>
  83. 从 [page:Color color] 中拷贝 [page:.r r], [page:.g g] 和 [page:.b b] 值到当前的颜色。
  84. </p>
  85. <h3>[method:Color convertGammaToLinear]( [param:Float gammaFactor] ) </h3>
  86. <p>
  87. [page:Float gammaFactor] - (可选参数). 默认值 *2.0*.<br /><br />
  88. 通过取颜色 [page:.r r], [page:.g g] and [page:.b b] 的 [page:Float gammaFactor] 次方将颜色从伽马空间转换成线性空间。
  89. </p>
  90. <h3>[method:Color convertLinearToGamma]( [param:Float gammaFactor] ) </h3>
  91. <p>
  92. [page:Float gammaFactor] - (可选参数). 默认值 *2.0*.<br /><br />
  93. 通过取颜色 [page:.r r], [page:.g g] and [page:.b b] 的 1/[page:Float gammaFactor] 次方将颜色从线性空间转换成伽马空间。
  94. </p>
  95. <h3>[method:Color convertLinearToSRGB]() </h3>
  96. <p>
  97. 将此颜色从线性空间转换成sRGB空间。
  98. </p>
  99. <h3>[method:Color convertSRGBToLinear]() </h3>
  100. <p>
  101. 将此颜色从sRGB空间转换成线性空间。
  102. </p>
  103. <h3>[method:Color copyGammaToLinear]( [param:Color color], [param:Float gammaFactor] ) </h3>
  104. <p>
  105. [page:Color color] — 需要拷贝的颜色。<br />
  106. [page:Float gammaFactor] - (可选参数). 默认值为 *2.0*.<br /><br />
  107. 将传入的 [param:Color color] 从伽马空间转换到线性空间然后复制给当前颜色。
  108. </p>
  109. <h3>[method:Color copyLinearToGamma]( [param:Color color], [param:Float gammaFactor] ) </h3>
  110. <p>
  111. [page:Color color] — 需要拷贝的颜色。<br />
  112. [page:Float gammaFactor] - (可选参数). 默认值为 *2.0*.<br /><br />
  113. 将传入的 [param:Color color] 从线性空间转换到伽马空间然后复制给当前颜色。
  114. </p>
  115. <h3>[method:Color copyLinearToSRGB]( [param:Color color]] ) </h3>
  116. <p>
  117. [page:Color color] — 需要拷贝的颜色。<br />
  118. 将传入的 [param:Color color] 拷贝给当前颜色,然后将当前颜色从线性空间转换到sRGB空间。
  119. </p>
  120. <h3>[method:Color copySRGBToLinear]( [param:Color color] ) </h3>
  121. <p>
  122. [page:Color color] — 需要拷贝的颜色。<br />
  123. 将传入的 [param:Color color] 拷贝给当前颜色,然后将当前颜色从sRGB空间转换到线性空间。
  124. </p>
  125. <h3>[method:Boolean equals]( [param:Color color] ) </h3>
  126. <p>将 [param:Color color] 的RGB值与该对象的RGB值进行比较。如果它们都是相同的,返回true,否则返回false。</p>
  127. <h3>[method:Color fromArray]( [param:Array array], [param:Integer offset] ) </h3>
  128. <p>
  129. [page:Array array] - 格式为 [ [page:Float r], [page:Float g], [page:Float b] ] 的数组 [page:Array]。<br />
  130. [page:Integer offset] - 数组中可选偏移量<br /><br />
  131. 从格式为[ [page:Float r], [page:Float g], [page:Float b] ]的数组数据中来创建Color对象。
  132. </p>
  133. <h3>[method:Integer getHex]()</h3>
  134. <p>返回此颜色的十六进制值。</p>
  135. <h3>[method:String getHexString]()</h3>
  136. <p>将此颜色的十六进制值作为字符串返回 (例如, 'FFFFFF')。</p>
  137. <h3>[method:Object getHSL]( [param:Object target] )</h3>
  138. <p>
  139. [page:Object target] — 结果将复制到这个对象中。向对象添加h、s和l键(如果不存在)。<br /><br />
  140. 将此颜色的 [page:.r r], [page:.g g] 和 [page:.b b] 值转换为 [link:https://en.wikipedia.org/wiki/HSL_and_HSV HSL]格式,然后返回一个格式如下的对象:
  141. <code>
  142. { h: 0, s: 0, l: 0 }
  143. </code>
  144. </p>
  145. <h3>[method:String getStyle]()</h3>
  146. <p>以CSS样式字符串的形式返回该颜色的值。例如:“rgb(255,0,0)”。</p>
  147. <h3>[method:Color lerp]( [param:Color color], [param:Float alpha] ) </h3>
  148. <p>
  149. [page:Color color] - 用于收敛的颜色。<br />
  150. [page:Float alpha] - 介于0到1的数字。<br /><br />
  151. 将该颜色的RGB值线性插值到传入参数的RGB值。alpha参数可以被认为是两种颜色之间的比例值,其中0是当前颜色和1.0是第一个参数的颜色。
  152. </p>
  153. <h3>[method:Color lerpHSL]( [param:Color color], [param:Float alpha] ) </h3>
  154. <p>
  155. [page:Color color] - 用于收敛的颜色。<br />
  156. [page:Float alpha] - 介于0到1的数字。<br /><br />
  157. 将该颜色的HSL值线性插值到传递参数的HSL值。它不同于上诉的[page:lerp]。通过不直接从一种颜色插入到另一种颜色,
  158. 而是通过插值这两种颜色之间的所有色相(H)、亮度(L)、饱和度(S)。alpha参数可以被认为是两种颜色之间的比例值,
  159. 其中0是当前颜色和1.0是第一个参数的颜色。
  160. </p>
  161. <h3>[method:Color multiply]( [param:Color color] ) </h3>
  162. <p>将此颜色的RGB值乘以给定的[page: color color]的RGB值。</p>
  163. <h3>[method:Color multiplyScalar]( [param:Number s] ) </h3>
  164. <p>将此颜色的RGB值乘以给定的[page:Number s]的值。</p>
  165. <h3>[method:Color offsetHSL]( [param:Float h], [param:Float s], [param:Float l] ) </h3>
  166. <p>
  167. 将给定的 [page:Float h], [page:Float s], 和 [page:Float l]值加到当前颜色值。
  168. 内部的机制为:先将该颜色的 [page:.r r], [page:.g g] 和 [page:.b b] 值转换为HSL,然后与传入的[page:Float h], [page:Float s], 和 [page:Float l]
  169. 相加,最后再将结果转成RGB值。
  170. </p>
  171. <h3>[method:Color set]( [param:Color_Hex_or_String value] ) </h3>
  172. <p>
  173. [page:Color_Hex_or_String value] - 用于设置该颜色的值。<br /><br />
  174. 有关 [page:Color_Hex_or_String value] 的详细信息,请参阅上面的构造函数。
  175. 根据输入类型,将会委托给 [page:.copy], [page:.setStyle], 或者 [page:.setHex] 函数处理。
  176. </p>
  177. <h3>[method:Color setHex]( [param:Integer hex] ) </h3>
  178. <p>
  179. [page:Integer hex] — [link:https://en.wikipedia.org/wiki/Web_colors#Hex_triplet hexadecimal triplet] 格式。<br /><br />
  180. 采用十六进制值设置此颜色。
  181. </p>
  182. <h3>[method:Color setHSL]( [param:Float h], [param:Float s], [param:Float l] ) </h3>
  183. <p>
  184. [page:Float h] — 色相值处于0到1之间。hue value between 0.0 and 1.0 <br />
  185. [page:Float s] — 饱和度值处于0到1之间。<br />
  186. [page:Float l] — 亮度值处于0到1之间。<br /><br />
  187. 采用HLS值设置此颜色。
  188. </p>
  189. <h3>[method:Color setRGB]( [param:Float r], [param:Float g], [param:Float b] ) </h3>
  190. <p>
  191. [page:Float r] — 红色通道的值在0到1之间。<br />
  192. [page:Float g] — 绿色通道的值在0到1之间。<br />
  193. [page:Float b] — 蓝色通道的值在0到1之间。<br /><br />
  194. 采用RGB值设置此颜色。
  195. </p>
  196. <h3>[method:Color setScalar]( [param:Float scalar] ) </h3>
  197. <p>
  198. [page:Float scalar] — 处于0到1之间的值<br /><br />
  199. 将颜色的RGB值都设为该 [page:Float scalar] 的值。
  200. </p>
  201. <h3>[method:Color setStyle]( [param:String style] ) </h3>
  202. <p>
  203. [page:String style] — 颜色css样式的字符串<br /><br />
  204. 采用ccs样式的字符串设置此颜色。例如,
  205. "rgb(250, 0,0)",
  206. "rgb(100%, 0%, 0%)",
  207. "hsl(0, 100%, 50%)",
  208. "#ff0000",
  209. "#f00", 或者
  210. "red" ( 或者任何 [link:https://en.wikipedia.org/wiki/X11_color_names#Color_name_chart X11 color name]
  211. - 所有140种颜色名称都支持 ).<br />
  212. 半透明颜色例如 "rgba(255, 0, 0, 0.5)" and "hsla(0, 100%, 50%, 0.5)" 也能支持,
  213. 但是alpha通道的值将会被丢弃。<br /><br />
  214. 注意,对于X11颜色名称,多个单词(如暗橙色)变成字符串“darkorange”(全部是小写字母)。
  215. </p>
  216. <h3>[method:Color setColorName]( [param:String style] ) </h3>
  217. <p>
  218. [page:String style] — color name ( from [link:https://en.wikipedia.org/wiki/X11_color_names#Color_name_chart X11 color names] ).<br /><br />
  219. Sets this color from a color name. Faster than [page:.setStyle] method if you don't need the other CSS-style formats.<br/><br/>
  220. For convenience, the list of names is exposed in Color.NAMES as a hash: <code>Color.NAMES.aliceblue // returns 0xF0F8FF</code>
  221. </p>
  222. <h3>[method:Color sub]( [param:Color color] ) </h3>
  223. <p>
  224. 从该颜色的RGB分量中减去传入颜色的RGB分量。如果分量结果是负,则该分量为零。
  225. </p>
  226. <h3>[method:Array toArray]( [param:Array array], [param:Integer offset] ) </h3>
  227. <p>
  228. [page:Array array] - 存储颜色的可选数组 <br />
  229. [page:Integer offset] - 数组的可选偏移量<br /><br />
  230. 返回一个格式为[ r, g, b ] 数组。
  231. </p>
  232. <h2>源码(Source)</h2>
  233. <p>
  234. [link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
  235. </p>
  236. </body>
  237. </html>