VertexList.html 2.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104
  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. A doubly linked list of vertices.
  14. </p>
  15. <h2>Constructor</h2>
  16. <h3>[name]()</h3>
  17. <p>
  18. Creates a new instance of [name].
  19. </p>
  20. <h2>Properties</h2>
  21. <h3>[property:VertexNode head]</h3>
  22. <p>
  23. Reference to the first vertex of the linked list. Default is null.
  24. </p>
  25. <h3>[property:VertexNode tail]</h3>
  26. <p>
  27. Reference to the last vertex of the linked list. Default is null.
  28. </p>
  29. <h2>Methods</h2>
  30. <h3>[method:VertexNode first]()</h3>
  31. <p>Returns the head reference.</p>
  32. <h3>[method:VertexNode last]()</h3>
  33. <p>Returns the tail reference.</p>
  34. <h3>[method:VertexList clear]()</h3>
  35. <p>Clears the linked list.</p>
  36. <h3>[method:VertexList insertBefore]( [param:Vertex target], [param:Vertex vertex] )</h3>
  37. <p>
  38. [page:Vertex target] - The target vertex. It's assumed that this vertex belongs to the linked list.<br />
  39. [page:Vertex vertex] - The vertex to insert.<br /><br />
  40. Inserts a vertex <strong>before</strong> a target vertex.
  41. </p>
  42. <h3>[method:VertexList insertAfter]( [param:Vertex target], [param:Vertex vertex] )</h3>
  43. <p>
  44. [page:Vertex target] - The target vertex. It's assumed that this vertex belongs to the linked list.<br />
  45. [page:Vertex vertex] - The vertex to insert.<br /><br />
  46. Inserts a vertex <strong>after</strong> a target vertex.
  47. </p>
  48. <h3>[method:VertexList append]( [param:Vertex vertex] )</h3>
  49. <p>
  50. [page:Vertex vertex] - The vertex to append.<br /><br />
  51. Appends a vertex to the end of the linked list.
  52. </p>
  53. <h3>[method:VertexList appendChain]( [param:Vertex vertex] )</h3>
  54. <p>
  55. [page:Vertex vertex] - The head vertex of a chain of vertices.<br /><br />
  56. Appends a chain of vertices where the given vertex is the head.
  57. </p>
  58. <h3>[method:VertexList remove]( [param:Vertex vertex] )</h3>
  59. <p>
  60. [page:Vertex vertex] - The vertex to remove.<br /><br />
  61. Removes a vertex from the linked list.
  62. </p>
  63. <h3>[method:VertexList removeSubList]( [param:Vertex a], [param:Vertex b] )</h3>
  64. <p>
  65. [page:Vertex a] - The head of the sublist.<br />
  66. [page:Vertex b] - The tail of the sublist.<br /><br />
  67. Removes a sublist of vertices from the linked list.
  68. </p>
  69. <h3>[method:Boolean isEmpty]()</h3>
  70. <p>Returns true if the linked list is empty.</p>
  71. <h2>Source</h2>
  72. <p>
  73. [link:https://github.com/mrdoob/three.js/blob/master/examples/jsm/math/ConvexHull.js examples/jsm/math/ConvexHull.js]
  74. <p>
  75. </body>
  76. </html>