VertexList.html 2.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8" />
  5. <base href="../../../../" />
  6. <script src="page.js"></script>
  7. <link type="text/css" rel="stylesheet" href="page.css" />
  8. </head>
  9. <body>
  10. <h1>[name]</h1>
  11. <p class="desc">
  12. A doubly linked list of vertices.
  13. </p>
  14. <h2>Import</h2>
  15. <p>
  16. [name] is an add-on, and must be imported explicitly.
  17. See [link:#manual/introduction/Installation Installation / Addons].
  18. </p>
  19. <code>
  20. import { VertexList } from 'three/addons/math/ConvexHull.js';
  21. </code>
  22. <h2>Constructor</h2>
  23. <h3>[name]()</h3>
  24. <p>
  25. Creates a new instance of [name].
  26. </p>
  27. <h2>Properties</h2>
  28. <h3>[property:VertexNode head]</h3>
  29. <p>
  30. Reference to the first vertex of the linked list. Default is null.
  31. </p>
  32. <h3>[property:VertexNode tail]</h3>
  33. <p>
  34. Reference to the last vertex of the linked list. Default is null.
  35. </p>
  36. <h2>Methods</h2>
  37. <h3>[method:VertexNode first]()</h3>
  38. <p>Returns the head reference.</p>
  39. <h3>[method:VertexNode last]()</h3>
  40. <p>Returns the tail reference.</p>
  41. <h3>[method:this clear]()</h3>
  42. <p>Clears the linked list.</p>
  43. <h3>[method:this insertBefore]( [param:Vertex target], [param:Vertex vertex] )</h3>
  44. <p>
  45. [page:Vertex target] - The target vertex. It's assumed that this vertex belongs to the linked list.<br />
  46. [page:Vertex vertex] - The vertex to insert.<br /><br />
  47. Inserts a vertex <strong>before</strong> a target vertex.
  48. </p>
  49. <h3>[method:this insertAfter]( [param:Vertex target], [param:Vertex vertex] )</h3>
  50. <p>
  51. [page:Vertex target] - The target vertex. It's assumed that this vertex belongs to the linked list.<br />
  52. [page:Vertex vertex] - The vertex to insert.<br /><br />
  53. Inserts a vertex <strong>after</strong> a target vertex.
  54. </p>
  55. <h3>[method:this append]( [param:Vertex vertex] )</h3>
  56. <p>
  57. [page:Vertex vertex] - The vertex to append.<br /><br />
  58. Appends a vertex to the end of the linked list.
  59. </p>
  60. <h3>[method:this appendChain]( [param:Vertex vertex] )</h3>
  61. <p>
  62. [page:Vertex vertex] - The head vertex of a chain of vertices.<br /><br />
  63. Appends a chain of vertices where the given vertex is the head.
  64. </p>
  65. <h3>[method:this remove]( [param:Vertex vertex] )</h3>
  66. <p>
  67. [page:Vertex vertex] - The vertex to remove.<br /><br />
  68. Removes a vertex from the linked list.
  69. </p>
  70. <h3>[method:this removeSubList]( [param:Vertex a], [param:Vertex b] )</h3>
  71. <p>
  72. [page:Vertex a] - The head of the sublist.<br />
  73. [page:Vertex b] - The tail of the sublist.<br /><br />
  74. Removes a sublist of vertices from the linked list.
  75. </p>
  76. <h3>[method:Boolean isEmpty]()</h3>
  77. <p>Returns true if the linked list is empty.</p>
  78. <h2>Source</h2>
  79. <p>
  80. [link:https://github.com/mrdoob/three.js/blob/master/examples/jsm/math/ConvexHull.js examples/jsm/math/ConvexHull.js]
  81. <p>
  82. </body>
  83. </html>