HalfEdge.html 2.3 KB

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