HalfEdge.html 2.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485
  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. The basis for a half-edge data structure, also known as doubly connected edge list (DCEL).<br />
  14. </p>
  15. <h2>Constructor</h2>
  16. <h3>[name]( [param:VertexNode vertex], [param:Face face] )</h3>
  17. <p>
  18. [page:VertexNode vertex] - [page:VertexNode] A reference to its destination vertex.<br />
  19. [page:Face face] - [page:Face] A reference to its face.<br /><br />
  20. Creates a new instance of [name].
  21. </p>
  22. <h2>Properties</h2>
  23. <h3>[property:VertexNode vertex]</h3>
  24. <p>
  25. Reference to the destination vertex. The origin vertex can be obtained by querying the destination of its twin, or of the previous half-edge. Default is undefined.
  26. </p>
  27. <h3>[property:HalfEdge prev]</h3>
  28. <p>
  29. Reference to the previous half-edge of the same face. Default is null.
  30. </p>
  31. <h3>[property:HalfEdge next]</h3>
  32. <p>
  33. Reference to the next half-edge of the same face. Default is null.
  34. </p>
  35. <h3>[property:HalfEdge twin]</h3>
  36. <p>
  37. Reference to the twin half-edge to reach the opposite face. Default is null.
  38. </p>
  39. <h3>[property:Face face]</h3>
  40. <p>
  41. Each half-edge bounds a single face and thus has a reference to that face. Default is undefined.
  42. </p>
  43. <h2>Methods</h2>
  44. <h3>[method:VertexNode head]()</h3>
  45. <p>Returns the destintation vertex.</p>
  46. <h3>[method:VertexNode tail]()</h3>
  47. <p>Returns the origin vertex.</p>
  48. <h3>[method:Float length]()</h3>
  49. <p>Returns the [link:https://en.wikipedia.org/wiki/Euclidean_distance Euclidean length]
  50. (straight-line length) of the edge.</p>
  51. <h3>[method:Float lengthSquared]()</h3>
  52. <p>Returns the square of the [link:https://en.wikipedia.org/wiki/Euclidean_distance Euclidean length]
  53. (straight-line length) of the edge.</p>
  54. <h3>[method:HalfEdge setTwin]( [param:HalfEdge edge] )</h3>
  55. <p>
  56. [page:HalfEdge edge] - Any half-edge.<br /><br />
  57. Sets the twin edge of this half-edge. It also ensures that the twin reference of the given half-edge is correctly set.
  58. </p>
  59. <h2>Source</h2>
  60. <p>
  61. [link:https://github.com/mrdoob/three.js/blob/master/examples/jsm/math/ConvexHull.js examples/jsm/math/ConvexHull.js]
  62. </p>
  63. </body>
  64. </html>