COMPAS 2.1.1__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (468) hide show
  1. compas/__init__.py +274 -0
  2. compas/__main__.py +31 -0
  3. compas/_iotools.py +80 -0
  4. compas/_os.py +746 -0
  5. compas/colors/__init__.py +14 -0
  6. compas/colors/cmcrameri/acton.txt +256 -0
  7. compas/colors/cmcrameri/actonS.txt +100 -0
  8. compas/colors/cmcrameri/bam.txt +256 -0
  9. compas/colors/cmcrameri/bamO.txt +256 -0
  10. compas/colors/cmcrameri/bamako.txt +256 -0
  11. compas/colors/cmcrameri/bamakoS.txt +100 -0
  12. compas/colors/cmcrameri/batlow.txt +256 -0
  13. compas/colors/cmcrameri/batlowK.txt +256 -0
  14. compas/colors/cmcrameri/batlowS.txt +100 -0
  15. compas/colors/cmcrameri/batlowW.txt +256 -0
  16. compas/colors/cmcrameri/berlin.txt +256 -0
  17. compas/colors/cmcrameri/bilbao.txt +256 -0
  18. compas/colors/cmcrameri/bilbaoS.txt +100 -0
  19. compas/colors/cmcrameri/broc.txt +256 -0
  20. compas/colors/cmcrameri/brocO.txt +256 -0
  21. compas/colors/cmcrameri/buda.txt +256 -0
  22. compas/colors/cmcrameri/budaS.txt +100 -0
  23. compas/colors/cmcrameri/bukavu.txt +256 -0
  24. compas/colors/cmcrameri/cork.txt +256 -0
  25. compas/colors/cmcrameri/corkO.txt +256 -0
  26. compas/colors/cmcrameri/davos.txt +256 -0
  27. compas/colors/cmcrameri/davosS.txt +100 -0
  28. compas/colors/cmcrameri/devon.txt +256 -0
  29. compas/colors/cmcrameri/devonS.txt +100 -0
  30. compas/colors/cmcrameri/fes.txt +256 -0
  31. compas/colors/cmcrameri/grayC.txt +256 -0
  32. compas/colors/cmcrameri/grayCS.txt +100 -0
  33. compas/colors/cmcrameri/hawaii.txt +256 -0
  34. compas/colors/cmcrameri/hawaiiS.txt +100 -0
  35. compas/colors/cmcrameri/imola.txt +256 -0
  36. compas/colors/cmcrameri/imolaS.txt +100 -0
  37. compas/colors/cmcrameri/lajolla.txt +256 -0
  38. compas/colors/cmcrameri/lajollaS.txt +100 -0
  39. compas/colors/cmcrameri/lapaz.txt +256 -0
  40. compas/colors/cmcrameri/lapazS.txt +100 -0
  41. compas/colors/cmcrameri/lisbon.txt +256 -0
  42. compas/colors/cmcrameri/nuuk.txt +256 -0
  43. compas/colors/cmcrameri/nuukS.txt +100 -0
  44. compas/colors/cmcrameri/oleron.txt +256 -0
  45. compas/colors/cmcrameri/oslo.txt +256 -0
  46. compas/colors/cmcrameri/osloS.txt +100 -0
  47. compas/colors/cmcrameri/roma.txt +256 -0
  48. compas/colors/cmcrameri/romaO.txt +256 -0
  49. compas/colors/cmcrameri/tofino.txt +256 -0
  50. compas/colors/cmcrameri/tokyo.txt +256 -0
  51. compas/colors/cmcrameri/tokyoS.txt +100 -0
  52. compas/colors/cmcrameri/turku.txt +256 -0
  53. compas/colors/cmcrameri/turkuS.txt +100 -0
  54. compas/colors/cmcrameri/vanimo.txt +256 -0
  55. compas/colors/cmcrameri/vik.txt +256 -0
  56. compas/colors/cmcrameri/vikO.txt +256 -0
  57. compas/colors/color.py +1118 -0
  58. compas/colors/colordict.py +103 -0
  59. compas/colors/colormap.py +306 -0
  60. compas/colors/html_colors.py +149 -0
  61. compas/colors/mpl_colormap.py +1064 -0
  62. compas/data/__init__.py +31 -0
  63. compas/data/coercion.py +71 -0
  64. compas/data/conftest.py +10 -0
  65. compas/data/data.py +342 -0
  66. compas/data/encoders.py +240 -0
  67. compas/data/exceptions.py +2 -0
  68. compas/data/json.py +240 -0
  69. compas/data/samples/boxes.obj +250 -0
  70. compas/data/samples/butt_model.obj +2829 -0
  71. compas/data/samples/cone.stl +0 -0
  72. compas/data/samples/cube.off +16 -0
  73. compas/data/samples/cube_ascii.stl +56114 -0
  74. compas/data/samples/cube_binary.stl +0 -0
  75. compas/data/samples/cube_binary_2.stl +0 -0
  76. compas/data/samples/doosabin.json +1 -0
  77. compas/data/samples/faces.obj +63 -0
  78. compas/data/samples/faces_big.obj +9663 -0
  79. compas/data/samples/faces_reversed.obj +63 -0
  80. compas/data/samples/fink.obj +135 -0
  81. compas/data/samples/grid_irregular.obj +303 -0
  82. compas/data/samples/hypar.obj +148 -0
  83. compas/data/samples/lines.json +1 -0
  84. compas/data/samples/lines.obj +282 -0
  85. compas/data/samples/lines_big.obj +40322 -0
  86. compas/data/samples/lines_bigger.obj +161282 -0
  87. compas/data/samples/lines_noleaves.obj +422 -0
  88. compas/data/samples/mesh.obj +874 -0
  89. compas/data/samples/mesh_100_faces.json +1893 -0
  90. compas/data/samples/mesh_110_faces.json +2081 -0
  91. compas/data/samples/open_edges.obj +424 -0
  92. compas/data/samples/point.json +1 -0
  93. compas/data/samples/quadmesh.obj +183 -0
  94. compas/data/samples/quadmesh_planar.obj +181 -0
  95. compas/data/samples/saddle.obj +314 -0
  96. compas/data/samples/spline.obj +72 -0
  97. compas/data/samples/tubemesh.json +1 -0
  98. compas/data/samples/tubemesh.obj +378 -0
  99. compas/data/samples/tubemesh.off +374 -0
  100. compas/data/samples/tubemesh.ply +551 -0
  101. compas/data/schema.py +137 -0
  102. compas/data/validators.py +243 -0
  103. compas/datastructures/__init__.py +75 -0
  104. compas/datastructures/_mutablemapping.py +148 -0
  105. compas/datastructures/assembly/__init__.py +0 -0
  106. compas/datastructures/assembly/assembly.py +234 -0
  107. compas/datastructures/assembly/exceptions.py +6 -0
  108. compas/datastructures/assembly/part.py +228 -0
  109. compas/datastructures/attributes.py +85 -0
  110. compas/datastructures/cell_network/__init__.py +0 -0
  111. compas/datastructures/cell_network/cell_network.py +4190 -0
  112. compas/datastructures/datastructure.py +309 -0
  113. compas/datastructures/graph/__init__.py +0 -0
  114. compas/datastructures/graph/duality.py +197 -0
  115. compas/datastructures/graph/graph.py +2478 -0
  116. compas/datastructures/graph/operations/__init__.py +0 -0
  117. compas/datastructures/graph/operations/join.py +124 -0
  118. compas/datastructures/graph/operations/split.py +63 -0
  119. compas/datastructures/graph/planarity.py +292 -0
  120. compas/datastructures/graph/smoothing.py +59 -0
  121. compas/datastructures/mesh/__init__.py +0 -0
  122. compas/datastructures/mesh/conway.py +553 -0
  123. compas/datastructures/mesh/duality.py +104 -0
  124. compas/datastructures/mesh/mesh.py +5103 -0
  125. compas/datastructures/mesh/operations/__init__.py +0 -0
  126. compas/datastructures/mesh/operations/collapse.py +350 -0
  127. compas/datastructures/mesh/operations/extrude.py +0 -0
  128. compas/datastructures/mesh/operations/insert.py +120 -0
  129. compas/datastructures/mesh/operations/merge.py +83 -0
  130. compas/datastructures/mesh/operations/split.py +263 -0
  131. compas/datastructures/mesh/operations/substitute.py +37 -0
  132. compas/datastructures/mesh/operations/swap.py +62 -0
  133. compas/datastructures/mesh/operations/weld.py +107 -0
  134. compas/datastructures/mesh/remesh.py +234 -0
  135. compas/datastructures/mesh/slice.py +170 -0
  136. compas/datastructures/mesh/smoothing.py +187 -0
  137. compas/datastructures/mesh/subdivision.py +754 -0
  138. compas/datastructures/tree/__init__.py +0 -0
  139. compas/datastructures/tree/tree.py +504 -0
  140. compas/datastructures/volmesh/__init__.py +0 -0
  141. compas/datastructures/volmesh/volmesh.py +4203 -0
  142. compas/files/__init__.py +27 -0
  143. compas/files/_xml/__init__.py +0 -0
  144. compas/files/_xml/xml_cli.py +213 -0
  145. compas/files/_xml/xml_cpython.py +32 -0
  146. compas/files/_xml/xml_pre_38.py +58 -0
  147. compas/files/_xml/xml_shared.py +40 -0
  148. compas/files/gltf/__init__.py +0 -0
  149. compas/files/gltf/constants.py +59 -0
  150. compas/files/gltf/data_classes.py +657 -0
  151. compas/files/gltf/extensions.py +317 -0
  152. compas/files/gltf/gltf.py +92 -0
  153. compas/files/gltf/gltf_children.py +64 -0
  154. compas/files/gltf/gltf_content.py +615 -0
  155. compas/files/gltf/gltf_exporter.py +465 -0
  156. compas/files/gltf/gltf_mesh.py +273 -0
  157. compas/files/gltf/gltf_node.py +348 -0
  158. compas/files/gltf/gltf_parser.py +115 -0
  159. compas/files/gltf/gltf_reader.py +310 -0
  160. compas/files/gltf/gltf_scene.py +125 -0
  161. compas/files/gltf/helpers.py +59 -0
  162. compas/files/obj.py +680 -0
  163. compas/files/off.py +296 -0
  164. compas/files/ply.py +697 -0
  165. compas/files/stl.py +436 -0
  166. compas/files/xml.py +328 -0
  167. compas/geometry/__init__.py +772 -0
  168. compas/geometry/_core/__init__.py +0 -0
  169. compas/geometry/_core/_algebra.py +2826 -0
  170. compas/geometry/_core/angles.py +408 -0
  171. compas/geometry/_core/centroids.py +573 -0
  172. compas/geometry/_core/distance.py +895 -0
  173. compas/geometry/_core/normals.py +149 -0
  174. compas/geometry/_core/nurbs.py +367 -0
  175. compas/geometry/_core/predicates_2.py +582 -0
  176. compas/geometry/_core/predicates_3.py +1111 -0
  177. compas/geometry/_core/quaternions.py +196 -0
  178. compas/geometry/_core/size.py +204 -0
  179. compas/geometry/_core/tangent.py +56 -0
  180. compas/geometry/_core/transformations.py +1121 -0
  181. compas/geometry/_core/transformations_numpy.py +279 -0
  182. compas/geometry/bbox.py +145 -0
  183. compas/geometry/bbox_numpy.py +306 -0
  184. compas/geometry/bestfit.py +77 -0
  185. compas/geometry/bestfit_numpy.py +259 -0
  186. compas/geometry/booleans.py +297 -0
  187. compas/geometry/booleans_shapely.py +147 -0
  188. compas/geometry/brep/__init__.py +112 -0
  189. compas/geometry/brep/brep.py +1131 -0
  190. compas/geometry/brep/edge.py +302 -0
  191. compas/geometry/brep/errors.py +22 -0
  192. compas/geometry/brep/face.py +329 -0
  193. compas/geometry/brep/loop.py +87 -0
  194. compas/geometry/brep/trim.py +46 -0
  195. compas/geometry/brep/vertex.py +46 -0
  196. compas/geometry/contours.py +32 -0
  197. compas/geometry/curves/__init__.py +0 -0
  198. compas/geometry/curves/arc.py +429 -0
  199. compas/geometry/curves/bezier.py +345 -0
  200. compas/geometry/curves/circle.py +500 -0
  201. compas/geometry/curves/conic.py +16 -0
  202. compas/geometry/curves/curve.py +614 -0
  203. compas/geometry/curves/ellipse.py +408 -0
  204. compas/geometry/curves/hyperbola.py +336 -0
  205. compas/geometry/curves/line.py +431 -0
  206. compas/geometry/curves/nurbs.py +412 -0
  207. compas/geometry/curves/parabola.py +256 -0
  208. compas/geometry/curves/polyline.py +724 -0
  209. compas/geometry/frame.py +769 -0
  210. compas/geometry/geometry.py +296 -0
  211. compas/geometry/hull.py +146 -0
  212. compas/geometry/hull_numpy.py +82 -0
  213. compas/geometry/icp_numpy.py +104 -0
  214. compas/geometry/interpolation_barycentric.py +38 -0
  215. compas/geometry/interpolation_coons.py +102 -0
  216. compas/geometry/interpolation_tweening.py +87 -0
  217. compas/geometry/intersection.py +121 -0
  218. compas/geometry/intersections.py +1105 -0
  219. compas/geometry/kdtree.py +153 -0
  220. compas/geometry/offset.py +208 -0
  221. compas/geometry/pca_numpy.py +87 -0
  222. compas/geometry/plane.py +657 -0
  223. compas/geometry/point.py +664 -0
  224. compas/geometry/pointcloud.py +409 -0
  225. compas/geometry/polygon.py +473 -0
  226. compas/geometry/polyhedron.py +650 -0
  227. compas/geometry/projection.py +155 -0
  228. compas/geometry/quadmesh_planarize.py +30 -0
  229. compas/geometry/quadmesh_planarize_none.py +114 -0
  230. compas/geometry/quaternion.py +544 -0
  231. compas/geometry/reflection.py +102 -0
  232. compas/geometry/rotation.py +354 -0
  233. compas/geometry/scale.py +100 -0
  234. compas/geometry/shapes/__init__.py +0 -0
  235. compas/geometry/shapes/box.py +747 -0
  236. compas/geometry/shapes/capsule.py +472 -0
  237. compas/geometry/shapes/cone.py +309 -0
  238. compas/geometry/shapes/cylinder.py +355 -0
  239. compas/geometry/shapes/shape.py +300 -0
  240. compas/geometry/shapes/sphere.py +362 -0
  241. compas/geometry/shapes/torus.py +294 -0
  242. compas/geometry/shear.py +115 -0
  243. compas/geometry/surfaces/__init__.py +0 -0
  244. compas/geometry/surfaces/conical.py +166 -0
  245. compas/geometry/surfaces/cylindrical.py +251 -0
  246. compas/geometry/surfaces/extrusion.py +0 -0
  247. compas/geometry/surfaces/nurbs.py +380 -0
  248. compas/geometry/surfaces/planar.py +223 -0
  249. compas/geometry/surfaces/revolution.py +0 -0
  250. compas/geometry/surfaces/spherical.py +259 -0
  251. compas/geometry/surfaces/surface.py +689 -0
  252. compas/geometry/surfaces/toroidal.py +198 -0
  253. compas/geometry/transformation.py +554 -0
  254. compas/geometry/translation.py +104 -0
  255. compas/geometry/triangulation_delaunay.py +102 -0
  256. compas/geometry/triangulation_earclip.py +300 -0
  257. compas/geometry/trimesh_curvature.py +113 -0
  258. compas/geometry/trimesh_descent_numpy.py +26 -0
  259. compas/geometry/trimesh_geodistance.py +35 -0
  260. compas/geometry/trimesh_gradient_numpy.py +74 -0
  261. compas/geometry/trimesh_isolines.py +41 -0
  262. compas/geometry/trimesh_matrices.py +31 -0
  263. compas/geometry/trimesh_matrices_numpy.py +191 -0
  264. compas/geometry/trimesh_parametrisation.py +55 -0
  265. compas/geometry/trimesh_pull_points_numpy.py +216 -0
  266. compas/geometry/trimesh_remeshing.py +97 -0
  267. compas/geometry/trimesh_samplepoints_numpy.py +108 -0
  268. compas/geometry/trimesh_slicing.py +28 -0
  269. compas/geometry/trimesh_smoothing_numpy.py +34 -0
  270. compas/geometry/vector.py +889 -0
  271. compas/itertools.py +441 -0
  272. compas/linalg.py +634 -0
  273. compas/matrices.py +314 -0
  274. compas/plugins.py +488 -0
  275. compas/rpc/__init__.py +20 -0
  276. compas/rpc/__main__.py +77 -0
  277. compas/rpc/dispatcher.py +181 -0
  278. compas/rpc/errors.py +11 -0
  279. compas/rpc/proxy.py +437 -0
  280. compas/rpc/server.py +79 -0
  281. compas/rpc/services/__init__.py +0 -0
  282. compas/rpc/services/default.py +87 -0
  283. compas/rpc/services/watcher.py +43 -0
  284. compas/scene/__init__.py +56 -0
  285. compas/scene/assemblyobject.py +3 -0
  286. compas/scene/context.py +154 -0
  287. compas/scene/descriptors/__init__.py +0 -0
  288. compas/scene/descriptors/attribute.py +30 -0
  289. compas/scene/descriptors/color.py +91 -0
  290. compas/scene/descriptors/colordict.py +101 -0
  291. compas/scene/descriptors/protocol.py +12 -0
  292. compas/scene/exceptions.py +7 -0
  293. compas/scene/geometryobject.py +58 -0
  294. compas/scene/graphobject.py +173 -0
  295. compas/scene/meshobject.py +238 -0
  296. compas/scene/scene.py +144 -0
  297. compas/scene/sceneobject.py +253 -0
  298. compas/scene/volmeshobject.py +252 -0
  299. compas/tolerance.py +879 -0
  300. compas/topology/__init__.py +45 -0
  301. compas/topology/combinatorics.py +108 -0
  302. compas/topology/connectivity.py +129 -0
  303. compas/topology/orientation.py +204 -0
  304. compas/topology/traversal.py +567 -0
  305. compas/utilities/__init__.py +25 -0
  306. compas/utilities/azync.py +155 -0
  307. compas/utilities/datetime.py +40 -0
  308. compas/utilities/decorators.py +136 -0
  309. compas/utilities/remote.py +54 -0
  310. compas/utilities/ssh.py +169 -0
  311. compas-2.1.1.dist-info/AUTHORS.md +42 -0
  312. compas-2.1.1.dist-info/LICENSE +21 -0
  313. compas-2.1.1.dist-info/METADATA +132 -0
  314. compas-2.1.1.dist-info/RECORD +468 -0
  315. compas-2.1.1.dist-info/WHEEL +5 -0
  316. compas-2.1.1.dist-info/entry_points.txt +2 -0
  317. compas-2.1.1.dist-info/top_level.txt +4 -0
  318. compas_blender/__init__.py +250 -0
  319. compas_blender/collections.py +130 -0
  320. compas_blender/conversions/__init__.py +48 -0
  321. compas_blender/conversions/breps.py +0 -0
  322. compas_blender/conversions/colors.py +23 -0
  323. compas_blender/conversions/curves.py +125 -0
  324. compas_blender/conversions/geometry.py +161 -0
  325. compas_blender/conversions/meshes.py +148 -0
  326. compas_blender/conversions/surfaces.py +48 -0
  327. compas_blender/conversions/transformations.py +46 -0
  328. compas_blender/data.py +30 -0
  329. compas_blender/geometry/__init__.py +14 -0
  330. compas_blender/geometry/booleans.py +100 -0
  331. compas_blender/install.py +338 -0
  332. compas_blender/objects.py +326 -0
  333. compas_blender/print_python_path.py +18 -0
  334. compas_blender/scene/__init__.py +116 -0
  335. compas_blender/scene/boxobject.py +64 -0
  336. compas_blender/scene/capsuleobject.py +73 -0
  337. compas_blender/scene/circleobject.py +53 -0
  338. compas_blender/scene/coneobject.py +70 -0
  339. compas_blender/scene/curveobject.py +58 -0
  340. compas_blender/scene/cylinderobject.py +70 -0
  341. compas_blender/scene/frameobject.py +105 -0
  342. compas_blender/scene/graphobject.py +257 -0
  343. compas_blender/scene/lineobject.py +60 -0
  344. compas_blender/scene/meshobject.py +508 -0
  345. compas_blender/scene/planeobject.py +81 -0
  346. compas_blender/scene/pointcloudobject.py +67 -0
  347. compas_blender/scene/pointobject.py +71 -0
  348. compas_blender/scene/polygonobject.py +57 -0
  349. compas_blender/scene/polyhedronobject.py +57 -0
  350. compas_blender/scene/polylineobject.py +54 -0
  351. compas_blender/scene/sceneobject.py +249 -0
  352. compas_blender/scene/sphereobject.py +72 -0
  353. compas_blender/scene/surfaceobject.py +54 -0
  354. compas_blender/scene/torusobject.py +73 -0
  355. compas_blender/scene/vectorobject.py +69 -0
  356. compas_blender/scene/volmeshobject.py +475 -0
  357. compas_blender/utilities/__init__.py +38 -0
  358. compas_blender/utilities/drawing.py +768 -0
  359. compas_ghpython/__init__.py +124 -0
  360. compas_ghpython/components/Compas_FromJson/code.py +18 -0
  361. compas_ghpython/components/Compas_Info/code.py +15 -0
  362. compas_ghpython/components/Compas_RpcCall/code.py +31 -0
  363. compas_ghpython/components/Compas_ToJson/code.py +19 -0
  364. compas_ghpython/components/Compas_ToRhinoGeometry/code.py +15 -0
  365. compas_ghpython/components/__init__.py +99 -0
  366. compas_ghpython/install.py +29 -0
  367. compas_ghpython/scene/__init__.py +115 -0
  368. compas_ghpython/scene/boxobject.py +40 -0
  369. compas_ghpython/scene/brepobject.py +40 -0
  370. compas_ghpython/scene/capsuleobject.py +41 -0
  371. compas_ghpython/scene/circleobject.py +40 -0
  372. compas_ghpython/scene/coneobject.py +40 -0
  373. compas_ghpython/scene/curveobject.py +42 -0
  374. compas_ghpython/scene/cylinderobject.py +38 -0
  375. compas_ghpython/scene/ellipseobject.py +40 -0
  376. compas_ghpython/scene/frameobject.py +67 -0
  377. compas_ghpython/scene/graphobject.py +77 -0
  378. compas_ghpython/scene/lineobject.py +39 -0
  379. compas_ghpython/scene/meshobject.py +137 -0
  380. compas_ghpython/scene/planeobject.py +61 -0
  381. compas_ghpython/scene/pointobject.py +38 -0
  382. compas_ghpython/scene/polygonobject.py +48 -0
  383. compas_ghpython/scene/polyhedronobject.py +48 -0
  384. compas_ghpython/scene/polylineobject.py +39 -0
  385. compas_ghpython/scene/sceneobject.py +12 -0
  386. compas_ghpython/scene/sphereobject.py +39 -0
  387. compas_ghpython/scene/surfaceobject.py +42 -0
  388. compas_ghpython/scene/torusobject.py +39 -0
  389. compas_ghpython/scene/vectorobject.py +51 -0
  390. compas_ghpython/scene/volmeshobject.py +154 -0
  391. compas_ghpython/sets.py +83 -0
  392. compas_ghpython/timer.py +36 -0
  393. compas_ghpython/uninstall.py +31 -0
  394. compas_ghpython/utilities/__init__.py +33 -0
  395. compas_ghpython/utilities/drawing.py +457 -0
  396. compas_rhino/__init__.py +607 -0
  397. compas_rhino/conduits/__init__.py +16 -0
  398. compas_rhino/conduits/base.py +121 -0
  399. compas_rhino/conduits/faces.py +91 -0
  400. compas_rhino/conduits/labels.py +102 -0
  401. compas_rhino/conduits/lines.py +109 -0
  402. compas_rhino/conduits/points.py +111 -0
  403. compas_rhino/conversions/__init__.py +168 -0
  404. compas_rhino/conversions/breps.py +122 -0
  405. compas_rhino/conversions/curves.py +453 -0
  406. compas_rhino/conversions/docobjects.py +0 -0
  407. compas_rhino/conversions/exceptions.py +7 -0
  408. compas_rhino/conversions/extrusions.py +80 -0
  409. compas_rhino/conversions/geometry.py +187 -0
  410. compas_rhino/conversions/meshes.py +281 -0
  411. compas_rhino/conversions/shapes.py +291 -0
  412. compas_rhino/conversions/surfaces.py +355 -0
  413. compas_rhino/conversions/transformations.py +45 -0
  414. compas_rhino/geometry/__init__.py +44 -0
  415. compas_rhino/geometry/booleans.py +118 -0
  416. compas_rhino/geometry/brep/__init__.py +40 -0
  417. compas_rhino/geometry/brep/brep.py +554 -0
  418. compas_rhino/geometry/brep/builder.py +184 -0
  419. compas_rhino/geometry/brep/edge.py +202 -0
  420. compas_rhino/geometry/brep/face.py +285 -0
  421. compas_rhino/geometry/brep/loop.py +129 -0
  422. compas_rhino/geometry/brep/trim.py +99 -0
  423. compas_rhino/geometry/brep/vertex.py +76 -0
  424. compas_rhino/geometry/curves/__init__.py +43 -0
  425. compas_rhino/geometry/curves/curve.py +382 -0
  426. compas_rhino/geometry/curves/nurbs.py +298 -0
  427. compas_rhino/geometry/surfaces/__init__.py +50 -0
  428. compas_rhino/geometry/surfaces/nurbs.py +370 -0
  429. compas_rhino/geometry/surfaces/surface.py +407 -0
  430. compas_rhino/geometry/trimesh_curvature.py +344 -0
  431. compas_rhino/geometry/trimesh_slicing.py +65 -0
  432. compas_rhino/install.py +382 -0
  433. compas_rhino/install_plugin.py +169 -0
  434. compas_rhino/install_with_pip.py +20 -0
  435. compas_rhino/layers.py +347 -0
  436. compas_rhino/objects.py +1141 -0
  437. compas_rhino/print_python_path.py +18 -0
  438. compas_rhino/scene/__init__.py +123 -0
  439. compas_rhino/scene/boxobject.py +44 -0
  440. compas_rhino/scene/brepobject.py +41 -0
  441. compas_rhino/scene/capsuleobject.py +45 -0
  442. compas_rhino/scene/circleobject.py +43 -0
  443. compas_rhino/scene/coneobject.py +43 -0
  444. compas_rhino/scene/curveobject.py +43 -0
  445. compas_rhino/scene/cylinderobject.py +43 -0
  446. compas_rhino/scene/ellipseobject.py +44 -0
  447. compas_rhino/scene/frameobject.py +99 -0
  448. compas_rhino/scene/graphobject.py +364 -0
  449. compas_rhino/scene/helpers.py +33 -0
  450. compas_rhino/scene/lineobject.py +43 -0
  451. compas_rhino/scene/meshobject.py +673 -0
  452. compas_rhino/scene/planeobject.py +71 -0
  453. compas_rhino/scene/pointobject.py +43 -0
  454. compas_rhino/scene/polygonobject.py +45 -0
  455. compas_rhino/scene/polyhedronobject.py +45 -0
  456. compas_rhino/scene/polylineobject.py +43 -0
  457. compas_rhino/scene/sceneobject.py +123 -0
  458. compas_rhino/scene/sphereobject.py +43 -0
  459. compas_rhino/scene/surfaceobject.py +42 -0
  460. compas_rhino/scene/torusobject.py +43 -0
  461. compas_rhino/scene/vectorobject.py +49 -0
  462. compas_rhino/scene/volmeshobject.py +518 -0
  463. compas_rhino/ui.py +114 -0
  464. compas_rhino/uninstall.py +243 -0
  465. compas_rhino/uninstall_plugin.py +91 -0
  466. compas_rhino/utilities/__init__.py +37 -0
  467. compas_rhino/utilities/constructors.py +71 -0
  468. compas_rhino/utilities/drawing.py +1081 -0
compas/colors/color.py ADDED
@@ -0,0 +1,1118 @@
1
+ from __future__ import absolute_import
2
+ from __future__ import division
3
+ from __future__ import print_function
4
+
5
+ try:
6
+ basestring # type: ignore
7
+ except NameError:
8
+ basestring = str
9
+
10
+ import colorsys
11
+ import re
12
+
13
+ from compas.colors.html_colors import HTML_TO_RGB255
14
+ from compas.data import Data
15
+
16
+ BASE16 = "0123456789abcdef"
17
+
18
+ try:
19
+ HEX_DEC = {v: int(v, base=16) for v in [x + y for x in BASE16 for y in BASE16]}
20
+ except Exception:
21
+ HEX_DEC = {v: int(v, 16) for v in [x + y for x in BASE16 for y in BASE16]}
22
+
23
+
24
+ class ColorError(Exception):
25
+ """Raise if color input is not a color."""
26
+
27
+
28
+ class Color(Data):
29
+ """Class for working with colors.
30
+
31
+ Parameters
32
+ ----------
33
+ red : float
34
+ The red component in the range ``[0.0, 1.0]``.
35
+ green : float
36
+ The green component in the range of ``[0.0, 1.0]``.
37
+ blue : float
38
+ The blue component in the range of ``[0.0, 1.0]``.
39
+ alpha : float, optional
40
+ Transparency setting.
41
+ If ``alpha = 0.0``, the color is fully transparent.
42
+ If ``alpha = 1.0``, the color is fully opaque.
43
+ name : str, optional
44
+ The name of the color.
45
+
46
+ Attributes
47
+ ----------
48
+ r : float
49
+ Red component of the color in RGB1 color space.
50
+ g : float
51
+ Green component of the color in RGB1 color space.
52
+ b : float
53
+ Blue component of the color in RGB1 color space.
54
+ a : float
55
+ Transparency in RGB1 color space.
56
+ rgb : tuple[float, float, float]
57
+ RGB1 color tuple, with components in the range ``[0.0, 1.0]``.
58
+ rgba : tuple[float, float, float, float]
59
+ RGBA1 color tuple (including alpha), with components in the range ``[0.0, 1.0]``.
60
+ rgb255 : tuple[int, int, int]
61
+ RGB255 color tuple, with components in the range ``[0, 255]``.
62
+ rgba255 : tuple[int, int, int, int]
63
+ RGBA255 color tuple (including alpha), with components in the range ``[0, 255]``.
64
+ hex : str
65
+ Hexadecimal color string.
66
+ hls : tuple[float, float, float]
67
+ Hue, Lightness, Saturation.
68
+ hsv : tuple[float, float, float]
69
+ Hue, Saturation, Value / Brightness.
70
+ lightness : float
71
+ How much white the color appears to contain.
72
+ This is the "Lightness" in HLS.
73
+ Making a color "lighter" is like adding more white.
74
+ brightness : float
75
+ How well-lit the color appears to be.
76
+ This is the "Value" in HSV.
77
+ Making a color "brighter" is like shining a stronger light on it, or illuminating it better.
78
+ yuv : tuple[float, float, float]
79
+ Luma and chroma components, with chroma defined by the blue and red projections.
80
+ luma : float
81
+ The brightness of a yuv signal.
82
+ chroma : tuple[float, float]
83
+ The color of a yuv signal.
84
+ "How different from a grey of the same lightness the color appears to be."
85
+ luminance : float
86
+ The amount of light that passes through, is emitted from, or is reflected from a particular area.
87
+ Here, it expresses the preceived brightness of the color.
88
+ Note that this is not the same as the "Lightness" of HLS or the "Value/Brightness" of HSV.
89
+ saturation : float
90
+ The perceived freedom of whiteness.
91
+ is_light : bool
92
+ If True, the color is considered light.
93
+ contrast : :class:`compas.colors.Color`
94
+ The contrasting color to the current color.
95
+
96
+ Examples
97
+ --------
98
+ By default, this class will create a color with the RGB components in the range ``[0.0, 1.0]``.
99
+
100
+ >>> Color(1, 0, 0)
101
+ Color(1.0, 0.0, 0.0, alpha=1.0)
102
+
103
+ Attempting to create a color with components outside of the range ``[0.0, 1.0]`` will raise a ``ValueError``.
104
+
105
+ >>> Color(255, 0, 0)
106
+ Traceback (most recent call last):
107
+ ...
108
+ ValueError: Components of an RGBA color should be in the range 0-1.
109
+
110
+ To create a color with components in the range ``[0, 255]``, use the :meth:`from_rgb255` constructor.
111
+
112
+ >>> Color.from_rgb255(255, 0, 0)
113
+ Color(1.0, 0.0, 0.0, alpha=1.0)
114
+
115
+ Similarly, other constructors are available to create colors from other color spaces.
116
+
117
+ >>> color = Color.from_hls(0.0, 0.5, 1.0)
118
+ >>> color = Color.from_hsv(0.0, 1.0, 1.0)
119
+ >>> color = Color.from_yiq(0.0, 0.0, 0.0)
120
+ >>> color = Color.from_yuv(0.0, 0.0, 0.0)
121
+
122
+ Or, to construct specific colors, for example, ...
123
+
124
+ >>> color = Color.red()
125
+ >>> color = Color.magenta()
126
+ >>> color = Color.lime()
127
+ >>> color = Color.navy()
128
+ >>> color = Color.olive()
129
+
130
+ Colors can be modified through inversion, saturation/desaturation, and lightening/darkening.
131
+
132
+ >>> color = Color.red()
133
+ >>> color.desaturated(25)
134
+ Color(0.875, 0.125, 0.125, alpha=1.0)
135
+ >>> color.desaturated(50)
136
+ Color(0.75, 0.25, 0.25, alpha=1.0)
137
+ >>> color.desaturated(75)
138
+ Color(0.625, 0.375, 0.375, alpha=1.0)
139
+ >>> color.desaturated(100)
140
+ Color(0.5, 0.5, 0.5, alpha=1.0)
141
+
142
+ See Also
143
+ --------
144
+ :class:`compas.colors.ColorMap`
145
+
146
+ """
147
+
148
+ DATASCHEMA = {
149
+ "type": "object",
150
+ "properties": {
151
+ "red": {"type": "number", "minimum": 0.0, "maximum": 1.0},
152
+ "green": {"type": "number", "minimum": 0.0, "maximum": 1.0},
153
+ "blue": {"type": "number", "minimum": 0.0, "maximum": 1.0},
154
+ "alpha": {"type": "number", "minimum": 0.0, "maximum": 1.0},
155
+ },
156
+ "required": ["red", "green", "blue", "alpha"],
157
+ }
158
+
159
+ @property
160
+ def __data__(self):
161
+ return {"red": self.r, "green": self.g, "blue": self.b, "alpha": self.a}
162
+
163
+ def __init__(self, red, green, blue, alpha=1.0, name=None):
164
+ super(Color, self).__init__(name=name)
165
+ self._r = 1.0
166
+ self._g = 1.0
167
+ self._b = 1.0
168
+ self._a = 1.0
169
+ self.r = red
170
+ self.g = green
171
+ self.b = blue
172
+ self.a = alpha
173
+
174
+ def __repr__(self):
175
+ return "{0}({1}, {2}, {3}, alpha={4})".format(type(self).__name__, self.r, self.g, self.b, self.a)
176
+
177
+ def __getitem__(self, key):
178
+ if key == 0:
179
+ return self.r
180
+ if key == 1:
181
+ return self.g
182
+ if key == 2:
183
+ return self.b
184
+ raise KeyError
185
+
186
+ def __len__(self):
187
+ return 3
188
+
189
+ def __iter__(self):
190
+ return iter(self.rgb)
191
+
192
+ def __eq__(self, other):
193
+ return all(a == b for a, b in zip(self, other))
194
+
195
+ # --------------------------------------------------------------------------
196
+ # Properties
197
+ # --------------------------------------------------------------------------
198
+
199
+ @property
200
+ def r(self):
201
+ return self._r
202
+
203
+ @r.setter
204
+ def r(self, red):
205
+ if red > 1.0 or red < 0.0:
206
+ raise ValueError("Components of an RGBA color should be in the range 0-1.")
207
+ self._r = red
208
+
209
+ @property
210
+ def g(self):
211
+ return self._g
212
+
213
+ @g.setter
214
+ def g(self, green):
215
+ if green > 1.0 or green < 0.0:
216
+ raise ValueError("Components of an RGBA color should be in the range 0-1.")
217
+ self._g = green
218
+
219
+ @property
220
+ def b(self):
221
+ return self._b
222
+
223
+ @b.setter
224
+ def b(self, blue):
225
+ if blue > 1.0 or blue < 0.0:
226
+ raise ValueError("Components of an RGBA color should be in the range 0-1.")
227
+ self._b = blue
228
+
229
+ @property
230
+ def a(self):
231
+ return self._a
232
+
233
+ @a.setter
234
+ def a(self, alpha):
235
+ if alpha > 1.0 or alpha < 0.0:
236
+ raise ValueError("Components of an RGBA color should be in the range 0-1.")
237
+ self._a = alpha
238
+
239
+ @property
240
+ def rgb(self):
241
+ r = self.r
242
+ g = self.g
243
+ b = self.b
244
+ return r, g, b
245
+
246
+ @property
247
+ def rgb255(self):
248
+ r = int(self.r * 255)
249
+ g = int(self.g * 255)
250
+ b = int(self.b * 255)
251
+ return r, g, b
252
+
253
+ @property
254
+ def rgba(self):
255
+ r, g, b = self.rgb
256
+ a = self.a
257
+ return r, g, b, a
258
+
259
+ @property
260
+ def rgba255(self):
261
+ r, g, b = self.rgb255
262
+ a = int(self.a * 255)
263
+ return r, g, b, a
264
+
265
+ @property
266
+ def hex(self):
267
+ return "#{0:02x}{1:02x}{2:02x}".format(*self.rgb255)
268
+
269
+ @property
270
+ def hls(self):
271
+ return colorsys.rgb_to_hls(*self.rgb)
272
+
273
+ @property
274
+ def hsv(self):
275
+ return colorsys.rgb_to_hsv(*self.rgb)
276
+
277
+ @property
278
+ def lightness(self):
279
+ return self.hls[1]
280
+
281
+ @property
282
+ def brightness(self):
283
+ return self.hsv[2]
284
+
285
+ @property
286
+ def is_light(self):
287
+ return self.luminance > 0.179
288
+
289
+ @property
290
+ def yuv(self):
291
+ y = self.luma
292
+ u, v = self.chroma
293
+ return y, u, v
294
+
295
+ @property
296
+ def luma(self):
297
+ return 0.299 * self.r + 0.587 * self.g + 0.114 * self.b
298
+
299
+ @property
300
+ def chroma(self):
301
+ y = self.luma
302
+ u = 0.492 * (self.b - y)
303
+ v = 0.877 * (self.r - y)
304
+ return u, v
305
+
306
+ @property
307
+ def luminance(self):
308
+ return 0.2126 * self.r + 0.7152 * self.g + 0.0722 * self.b
309
+
310
+ @property
311
+ def saturation(self):
312
+ maxval = max(self.r, self.g, self.b)
313
+ minval = min(self.r, self.g, self.b)
314
+ return (maxval - minval) / maxval
315
+
316
+ @property
317
+ def contrast(self):
318
+ return self.darkened(25) if self.is_light else self.lightened(50)
319
+
320
+ # --------------------------------------------------------------------------
321
+ # Constructors
322
+ # --------------------------------------------------------------------------
323
+
324
+ @classmethod
325
+ def from_rgb255(cls, r, g, b): # type: (int, int, int) -> Color
326
+ """Construct a color from RGB255 components.
327
+
328
+ Parameters
329
+ ----------
330
+ r : int & valuerange[0, 255]
331
+ Red component.
332
+ g : int & valuerange[0, 255]
333
+ Green component.
334
+ b : int & valuerange[0, 255]
335
+ Blue component.
336
+
337
+ Returns
338
+ -------
339
+ :class:`compas.colors.Color`
340
+
341
+ """
342
+ return cls(r / 255, g / 255, b / 255)
343
+
344
+ @classmethod
345
+ def from_hls(cls, hue, luminance, saturation): # type: (float, float, float) -> Color
346
+ """Construct a color from Hue, Lightness, and Saturation.
347
+
348
+ Parameters
349
+ ----------
350
+ hue : float
351
+ Hue.
352
+ lightness : float
353
+ Lightness.
354
+ saturation : float
355
+ Saturation.
356
+
357
+ Returns
358
+ -------
359
+ :class:`compas.colors.Color`
360
+
361
+ References
362
+ ----------
363
+ https://en.wikipedia.org/wiki/HSL_and_HSV
364
+
365
+ """
366
+ r, g, b = colorsys.hls_to_rgb(hue, luminance, saturation)
367
+ return cls(r, g, b)
368
+
369
+ @classmethod
370
+ def from_hsv(cls, h, s, v): # type: (float, float, float) -> Color
371
+ """Construct a color from Hue, Saturation, and Value.
372
+
373
+ Parameters
374
+ ----------
375
+ h : float
376
+ Hue.
377
+ s : float
378
+ Saturation.
379
+ v : float
380
+ Value.
381
+
382
+ Returns
383
+ -------
384
+ :class:`compas.colors.Color`
385
+
386
+ References
387
+ ----------
388
+ https://en.wikipedia.org/wiki/HSL_and_HSV
389
+
390
+ """
391
+ r, g, b = colorsys.hsv_to_rgb(h, s, v)
392
+ return cls(r, g, b)
393
+
394
+ @classmethod
395
+ def from_yiq(cls, y, i, q): # type: (float, float, float) -> Color
396
+ """Construct a color from components in the YIQ color space.
397
+
398
+ Parameters
399
+ ----------
400
+ y : float
401
+ Luma.
402
+ i : float
403
+ Orange-blue chroma.
404
+ q : float
405
+ Purple-green chroma.
406
+
407
+ Returns
408
+ -------
409
+ :class:`compas.colors.Color`
410
+
411
+ References
412
+ ----------
413
+ https://en.wikipedia.org/wiki/YIQ
414
+
415
+ """
416
+ r, g, b = colorsys.yiq_to_rgb(y, i, q)
417
+ return cls(r, g, b)
418
+
419
+ @classmethod
420
+ def from_yuv(cls, y, u, v): # type: (float, float, float) -> Color
421
+ """Construct a color from components in the YUV color space.
422
+
423
+ Parameters
424
+ ----------
425
+ y : float
426
+ Luma.
427
+ u : float
428
+ Blue projection chroma.
429
+ v : float
430
+ Red projection chroma.
431
+
432
+ Returns
433
+ -------
434
+ :class:`compas.colors.Color`
435
+
436
+ References
437
+ ----------
438
+ https://en.wikipedia.org/wiki/YUV
439
+
440
+ """
441
+ r = y + 1.140 * v
442
+ g = y - 0.395 * u - 0.581 * v
443
+ b = y + 2.032 * u
444
+ return cls(r, g, b)
445
+
446
+ @classmethod
447
+ def from_number(cls, number): # type: (float) -> Color
448
+ """Construct a color from a single number in the range 0-1.
449
+
450
+ Parameters
451
+ ----------
452
+ number : float
453
+ Number in the range 0-1, representing the color.
454
+
455
+ Returns
456
+ -------
457
+ :class:`compas.colors.Color`
458
+
459
+ """
460
+ if number == 0.0:
461
+ r, g, b = 0, 0, 255
462
+ elif 0.0 < number < 0.25:
463
+ r, g, b = 0, int(255 * (4 * number)), 255
464
+ elif number == 0.25:
465
+ r, g, b = 0, 255, 255
466
+ elif 0.25 < number < 0.5:
467
+ r, g, b = 0, 255, int(255 - 255 * 4 * (number - 0.25))
468
+ elif number == 0.5:
469
+ r, g, b = 0, 255, 0
470
+ elif 0.5 < number < 0.75:
471
+ r, g, b = int(0 + 255 * 4 * (number - 0.5)), 255, 0
472
+ elif number == 0.75:
473
+ r, g, b = 255, 255, 0
474
+ elif 0.75 < number < 1.0:
475
+ (r, g, b) = (255, int(255 - 255 * 4 * (number - 0.75)), 0)
476
+ elif number == 1.0:
477
+ r, g, b = 255, 0, 0
478
+ else:
479
+ r, g, b = 0, 0, 0
480
+ return cls(r / 255.0, g / 255.0, b / 255.0)
481
+
482
+ from_i = from_number
483
+
484
+ @classmethod
485
+ def from_hex(cls, value): # type: (str) -> Color
486
+ """Construct a color from a hexadecimal color value.
487
+
488
+ Parameters
489
+ ----------
490
+ value : str
491
+ The hexadecimal color.
492
+
493
+ Returns
494
+ -------
495
+ :class:`compas.colors.Color`
496
+
497
+ """
498
+ value = value.lstrip("#").lower()
499
+ r = HEX_DEC[value[0:2]]
500
+ g = HEX_DEC[value[2:4]]
501
+ b = HEX_DEC[value[4:6]]
502
+ return cls(r / 255.0, g / 255.0, b / 255.0)
503
+
504
+ @classmethod
505
+ def from_name(cls, name): # type: (str) -> Color
506
+ """Construct a color from a name in the extended color table of HTML/CSS/SVG.
507
+
508
+ Parameters
509
+ ----------
510
+ name : str
511
+ The color name. The name is case-insensitive.
512
+
513
+ Returns
514
+ -------
515
+ :class:`compas.colors.Color`
516
+
517
+ References
518
+ ----------
519
+ https://www.w3.org/TR/css-color-3/#svg-color
520
+
521
+ """
522
+ rgb255 = HTML_TO_RGB255.get(name.lower())
523
+ if rgb255 is None:
524
+ raise ValueError("Color name not found.")
525
+ return cls.from_rgb255(*rgb255)
526
+
527
+ @classmethod
528
+ def from_unknown(cls, unknown):
529
+ """Construct a color from an unknown input.
530
+
531
+ Parameters
532
+ ----------
533
+ unknown : str | tuple[int, int, int] | tuple[float, float, float] | :class:`compas.colors.Color`
534
+ The color input.
535
+
536
+ Returns
537
+ -------
538
+ :class:`compas.colors.Color` | None
539
+
540
+ Raises
541
+ ------
542
+ :class:`ColorError`
543
+
544
+ """
545
+ if not unknown:
546
+ return
547
+
548
+ if isinstance(unknown, cls):
549
+ return unknown
550
+
551
+ if Color._is_rgb255(unknown):
552
+ return cls.from_rgb255(*list(unknown))
553
+
554
+ if Color._is_hex(unknown):
555
+ return cls.from_hex(unknown)
556
+
557
+ if Color._is_rgb1(unknown):
558
+ return cls(*list(unknown))
559
+
560
+ if isinstance(unknown, basestring):
561
+ return cls.from_name(unknown)
562
+
563
+ raise ColorError
564
+
565
+ @staticmethod
566
+ def coerce(color):
567
+ """Coerce a color input into a color.
568
+
569
+ Parameters
570
+ ----------
571
+ color : str | tuple[int, int, int] | tuple[float, float, float] | :class:`compas.colors.Color`
572
+ The color input.
573
+
574
+ Returns
575
+ -------
576
+ :class:`compas.colors.Color` | None
577
+
578
+ Raises
579
+ ------
580
+ ColorError
581
+
582
+ """
583
+ if not color:
584
+ return
585
+ if Color._is_rgb255(color):
586
+ return Color.from_rgb255(*list(color))
587
+ if Color._is_hex(color):
588
+ return Color.from_hex(color)
589
+ if Color._is_rgb1(color):
590
+ return Color(*list(color))
591
+ raise ColorError
592
+
593
+ @staticmethod
594
+ def _is_rgb1(color):
595
+ """Verify that the color is in the RGB 1 color space.
596
+
597
+ Returns
598
+ -------
599
+ bool
600
+
601
+ """
602
+ return color and all(isinstance(c, float) and (c >= 0 and c <= 1) for c in color)
603
+
604
+ @staticmethod
605
+ def _is_rgb255(color):
606
+ """Verify that the color is in the RGB 255 color space.
607
+
608
+ Returns
609
+ -------
610
+ bool
611
+
612
+ """
613
+ return color and all(isinstance(c, int) and (c >= 0 and c <= 255) for c in color)
614
+
615
+ @staticmethod
616
+ def _is_hex(color):
617
+ """Verify that the color is in hexadecimal format.
618
+
619
+ Returns
620
+ -------
621
+ bool
622
+
623
+ """
624
+ if isinstance(color, basestring):
625
+ match = re.search(r"^#(?:[0-9a-fA-F]{3}){1,2}$", color)
626
+ if match:
627
+ return True
628
+ return False
629
+ return False
630
+
631
+ # --------------------------------------------------------------------------
632
+ # Presets
633
+ # --------------------------------------------------------------------------
634
+
635
+ @classmethod
636
+ def white(cls):
637
+ """Construct the color white.
638
+
639
+ Returns
640
+ -------
641
+ :class:`compas.colors.Color`
642
+
643
+ """
644
+ return cls(1.0, 1.0, 1.0)
645
+
646
+ @classmethod
647
+ def black(cls):
648
+ """Construct the color black.
649
+
650
+ Returns
651
+ -------
652
+ :class:`compas.colors.Color`
653
+
654
+ """
655
+ return cls(0.0, 0.0, 0.0)
656
+
657
+ @classmethod
658
+ def grey(cls):
659
+ """Construct the color grey.
660
+
661
+ Returns
662
+ -------
663
+ :class:`compas.colors.Color`
664
+
665
+ """
666
+ return cls(0.5, 0.5, 0.5)
667
+
668
+ @classmethod
669
+ def red(cls):
670
+ """Construct the color red.
671
+
672
+ Returns
673
+ -------
674
+ :class:`compas.colors.Color`
675
+
676
+ """
677
+ return cls(1.0, 0.0, 0.0)
678
+
679
+ @classmethod
680
+ def orange(cls):
681
+ """Construct the color orange.
682
+
683
+ Returns
684
+ -------
685
+ :class:`compas.colors.Color`
686
+
687
+ """
688
+ return cls(1.0, 0.5, 0.0)
689
+
690
+ @classmethod
691
+ def yellow(cls):
692
+ """Construct the color yellow.
693
+
694
+ Returns
695
+ -------
696
+ :class:`compas.colors.Color`
697
+
698
+ """
699
+ return cls(1.0, 1.0, 0.0)
700
+
701
+ @classmethod
702
+ def lime(cls):
703
+ """Construct the color lime (or chartreuse green).
704
+
705
+ Returns
706
+ -------
707
+ :class:`compas.colors.Color`
708
+
709
+ """
710
+ return cls(0.5, 1.0, 0.0)
711
+
712
+ @classmethod
713
+ def green(cls):
714
+ """Construct the color green.
715
+
716
+ Returns
717
+ -------
718
+ :class:`compas.colors.Color`
719
+
720
+ """
721
+ return cls(0.0, 1.0, 0.0)
722
+
723
+ @classmethod
724
+ def mint(cls):
725
+ """Construct the color mint (or spring green).
726
+
727
+ Returns
728
+ -------
729
+ :class:`compas.colors.Color`
730
+
731
+ """
732
+ return cls(0.0, 1.0, 0.5)
733
+
734
+ @classmethod
735
+ def cyan(cls):
736
+ """Construct the color cyan.
737
+
738
+ Returns
739
+ -------
740
+ :class:`compas.colors.Color`
741
+
742
+ """
743
+ return cls(0.0, 1.0, 1.0)
744
+
745
+ @classmethod
746
+ def azure(cls):
747
+ """Construct the color azure.
748
+
749
+ Returns
750
+ -------
751
+ :class:`compas.colors.Color`
752
+
753
+ """
754
+ return cls(0.0, 0.5, 1.0)
755
+
756
+ @classmethod
757
+ def blue(cls):
758
+ """Construct the color blue.
759
+
760
+ Returns
761
+ -------
762
+ :class:`compas.colors.Color`
763
+
764
+ """
765
+ return cls(0.0, 0.0, 1.0)
766
+
767
+ @classmethod
768
+ def violet(cls):
769
+ """Construct the color violet.
770
+
771
+ Returns
772
+ -------
773
+ :class:`compas.colors.Color`
774
+
775
+ """
776
+ return cls(0.5, 0.0, 1.0)
777
+
778
+ @classmethod
779
+ def magenta(cls):
780
+ """Construct the color magenta.
781
+
782
+ Returns
783
+ -------
784
+ :class:`compas.colors.Color`
785
+
786
+ """
787
+ return cls(1.0, 0.0, 1.0)
788
+
789
+ @classmethod
790
+ def pink(cls):
791
+ """Construct the color pink.
792
+
793
+ Returns
794
+ -------
795
+ :class:`compas.colors.Color`
796
+
797
+ """
798
+ return cls(1.0, 0.0, 0.5)
799
+
800
+ # --------------------------------------------------------------------------
801
+ # Other presets
802
+ # --------------------------------------------------------------------------
803
+
804
+ @classmethod
805
+ def maroon(cls):
806
+ """Construct the color maroon.
807
+ Returns
808
+ -------
809
+ :class:`compas.colors.Color`
810
+
811
+ """
812
+ return cls(0.5, 0.0, 0.0)
813
+
814
+ @classmethod
815
+ def brown(cls):
816
+ """Construct the color brown.
817
+
818
+ Returns
819
+ -------
820
+ :class:`compas.colors.Color`
821
+
822
+ """
823
+ return cls(0.5, 0.25, 0.0)
824
+
825
+ @classmethod
826
+ def olive(cls):
827
+ """Construct the color olive.
828
+
829
+ Returns
830
+ -------
831
+ :class:`compas.colors.Color`
832
+
833
+ """
834
+ return cls(0.5, 0.5, 0.0)
835
+
836
+ @classmethod
837
+ def teal(cls):
838
+ """Construct the color teal.
839
+
840
+ Returns
841
+ -------
842
+ :class:`compas.colors.Color`
843
+
844
+ """
845
+ return cls(0.0, 0.5, 0.5)
846
+
847
+ @classmethod
848
+ def navy(cls):
849
+ """Construct the color navy.
850
+
851
+ Returns
852
+ -------
853
+ :class:`compas.colors.Color`
854
+
855
+ """
856
+ return cls(0.0, 0.0, 0.5)
857
+
858
+ @classmethod
859
+ def purple(cls):
860
+ """Construct the color purple.
861
+
862
+ Returns
863
+ -------
864
+ :class:`compas.colors.Color`
865
+
866
+ """
867
+ return cls(0.5, 0.0, 0.5)
868
+
869
+ @classmethod
870
+ def silver(cls):
871
+ """Construct the color silver.
872
+
873
+ Returns
874
+ -------
875
+ :class:`compas.colors.Color`
876
+
877
+ """
878
+ return cls(0.75, 0.75, 0.75)
879
+
880
+ # ochre
881
+ # beige
882
+ # bordeaux
883
+ # hotpink
884
+ # steel
885
+ # midnight
886
+ # salmon
887
+
888
+ # --------------------------------------------------------------------------
889
+ # Methods
890
+ # --------------------------------------------------------------------------
891
+
892
+ def lighten(self, factor=10):
893
+ """Lighten the color.
894
+
895
+ Parameters
896
+ ----------
897
+ factor : float, optional
898
+ Percentage of lightness increase.
899
+
900
+ Returns
901
+ -------
902
+ None
903
+
904
+ Raises
905
+ ------
906
+ ValueError
907
+ If the percentage of lightness increase is not in the range 0-100.
908
+
909
+ """
910
+ if factor > 100 or factor < 0:
911
+ raise ValueError("Percentage of increased lightness should be in the range 0-100.")
912
+
913
+ factor = 1.0 + factor / 100
914
+
915
+ hue, luminance, saturation = self.hls
916
+ r, g, b = colorsys.hls_to_rgb(hue, min(1.0, luminance * factor), saturation)
917
+ self.r = r
918
+ self.g = g
919
+ self.b = b
920
+
921
+ def lightened(self, factor=10):
922
+ """Return a lightened copy of the color.
923
+
924
+ Parameters
925
+ ----------
926
+ factor : float, optional
927
+ Percentage of lightness increase.
928
+
929
+ Returns
930
+ -------
931
+ :class:`compas.colors.Color`
932
+
933
+ Raises
934
+ ------
935
+ ValueError
936
+ If the percentage of lightness increase is not in the range 0-100.
937
+
938
+ """
939
+ color = self.copy()
940
+ color.lighten(factor=factor)
941
+ return color
942
+
943
+ def darken(self, factor=10):
944
+ """Darken the color.
945
+
946
+ Parameters
947
+ ----------
948
+ factor : float, optional
949
+ Percentage of lightness reduction.
950
+
951
+ Returns
952
+ -------
953
+ None
954
+
955
+ Raises
956
+ ------
957
+ ValueError
958
+ If the percentage of lightness reduction is not in the range 0-100.
959
+
960
+ """
961
+ if factor > 100 or factor < 0:
962
+ raise ValueError("Percentage of reduced lightness should be in the range 0-100.")
963
+
964
+ factor = 1.0 - factor / 100
965
+
966
+ hue, luminance, saturation = self.hls
967
+ r, g, b = colorsys.hls_to_rgb(hue, max(0.0, luminance * factor), saturation)
968
+ self.r = r
969
+ self.g = g
970
+ self.b = b
971
+
972
+ def darkened(self, factor=10):
973
+ """Return a darkened copy of the color.
974
+
975
+ Parameters
976
+ ----------
977
+ factor : float, optional
978
+ Percentage of lightness reduction.
979
+
980
+ Returns
981
+ -------
982
+ :class:`compas.colors.Color`
983
+
984
+ Raises
985
+ ------
986
+ ValueError
987
+ If the percentage of lightness reduction is not in the range 0-100.
988
+
989
+ """
990
+ color = self.copy()
991
+ color.darken(factor=factor)
992
+ return color
993
+
994
+ def invert(self):
995
+ """Invert the current color wrt to the RGB color circle.
996
+
997
+ Returns
998
+ -------
999
+ None
1000
+
1001
+ """
1002
+ self.r = 1.0 - self.r
1003
+ self.g = 1.0 - self.g
1004
+ self.b = 1.0 - self.b
1005
+
1006
+ def inverted(self):
1007
+ """Return an inverted copy of the color.
1008
+
1009
+ Returns
1010
+ -------
1011
+ :class:`compas.colors.Color`
1012
+
1013
+ """
1014
+ color = self.copy()
1015
+ color.invert()
1016
+ return color
1017
+
1018
+ def saturate(self, factor=10):
1019
+ """Saturate the color by a given percentage.
1020
+
1021
+ Parameters
1022
+ ----------
1023
+ factor : float, optional
1024
+ Percentage of saturation increase.
1025
+
1026
+ Returns
1027
+ -------
1028
+ None
1029
+
1030
+ Raises
1031
+ ------
1032
+ ValueError
1033
+ If the percentage of saturation is not in the range 0-100.
1034
+
1035
+ """
1036
+ if factor > 100 or factor < 0:
1037
+ raise ValueError("Percentage of saturation should be in the range 0-100.")
1038
+
1039
+ factor = 1.0 + factor / 100
1040
+
1041
+ hue, luminance, saturation = self.hls
1042
+ r, g, b = colorsys.hls_to_rgb(hue, luminance, min(1.0, saturation * factor))
1043
+ self.r = r
1044
+ self.g = g
1045
+ self.b = b
1046
+
1047
+ def saturated(self, factor=10):
1048
+ """Return a saturated copy of the color.
1049
+
1050
+ Parameters
1051
+ ----------
1052
+ factor : float, optional
1053
+ Percentage of saturation increase.
1054
+
1055
+ Returns
1056
+ -------
1057
+ :class:`compas.colors.Color`
1058
+
1059
+ Raises
1060
+ ------
1061
+ ValueError
1062
+ If the percentage of desaturation is not in the range 0-100.
1063
+
1064
+ """
1065
+ color = self.copy()
1066
+ color.saturate(factor=factor)
1067
+ return color
1068
+
1069
+ def desaturate(self, factor=10):
1070
+ """Desaturate the color by a given percentage.
1071
+
1072
+ Parameters
1073
+ ----------
1074
+ factor : float, optional
1075
+ Percentage of saturation reduction.
1076
+
1077
+ Returns
1078
+ -------
1079
+ None
1080
+
1081
+ Raises
1082
+ ------
1083
+ ValueError
1084
+ If the percentage of desaturation is not in the range 0-100.
1085
+
1086
+ """
1087
+ if factor > 100 or factor < 0:
1088
+ raise ValueError("Percentage of desaturation should be in the range 0-100.")
1089
+
1090
+ factor = 1.0 - factor / 100
1091
+
1092
+ hue, luminance, saturation = self.hls
1093
+ r, g, b = colorsys.hls_to_rgb(hue, luminance, max(0.0, saturation * factor))
1094
+ self.r = r
1095
+ self.g = g
1096
+ self.b = b
1097
+
1098
+ def desaturated(self, factor=10):
1099
+ """Return a desaturated copy of the color.
1100
+
1101
+ Parameters
1102
+ ----------
1103
+ factor : float, optional
1104
+ Percentage of saturation reduction.
1105
+
1106
+ Returns
1107
+ -------
1108
+ :class:`compas.colors.Color`
1109
+
1110
+ Raises
1111
+ ------
1112
+ ValueError
1113
+ If the percentage of desaturation is not in the range 0-100.
1114
+
1115
+ """
1116
+ color = self.copy()
1117
+ color.desaturate(factor=factor)
1118
+ return color