Face.html 2.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798
  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. Represents a section bounded by a specific amount of half-edges. The current implmentation assumes that a face always consist of three edges.
  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:Vector3 normal]</h3>
  22. <p>
  23. The normal vector of the face. Default is a [page:Vector3] at (0, 0, 0).
  24. </p>
  25. <h3>[property:Vector3 midpoint]</h3>
  26. <p>
  27. The midpoint or centroid of the face. Default is a [page:Vector3] at (0, 0, 0).
  28. </p>
  29. <h3>[property:Float area]</h3>
  30. <p>
  31. The area of the face. Default is 0.
  32. </p>
  33. <h3>[property:Float constant]</h3>
  34. <p>
  35. Signed distance from face to the origin. Default is 0.
  36. </p>
  37. <h3>[property:VertexNode outside]</h3>
  38. <p>
  39. Reference to a vertex in a vertex list this face can see. Default is null.
  40. </p>
  41. <h3>[property:Integer mark]</h3>
  42. <p>
  43. Marks if a face is visible or deleted. Default is 'Visible'.
  44. </p>
  45. <h3>[property:HalfEdge edge]</h3>
  46. <p>
  47. Reference to the base edge of a face. To retrieve all edges, you can use the 'next' reference of the current edge. Default is null.
  48. </p>
  49. <h2>Methods</h2>
  50. <h3>[method:Face create]( [param:VertexNode a], [param:VertexNode b], [param:VertexNode c] )</h3>
  51. <p>
  52. [page:VertexNode a] - First vertex of the face.<br />
  53. [page:VertexNode b] - Second vertex of the face.<br />
  54. [page:VertexNode c] - Third vertex of the face.<br /><br />
  55. Creates a face.
  56. </p>
  57. <h3>[method:HalfEdge getEdge]( [param:Integer i] )</h3>
  58. <p>
  59. [page:Integer i] - The index of the edge.<br /><br />
  60. Returns an edge by the given index.
  61. </p>
  62. <h3>[method:Face compute] ()</h3>
  63. <p>Computes all properties of the face.</p>
  64. <h3>[method:Float distanceToPoint]( [param:Vector3 point] )</h3>
  65. <p>
  66. [page:Vector3 point] - Any point in 3D space.<br /><br />
  67. Returns the signed distance from a given point to the plane representation of this face.
  68. </p>
  69. <h2>Source</h2>
  70. <p>
  71. [link:https://github.com/mrdoob/three.js/blob/master/examples/jsm/math/ConvexHull.js examples/jsm/math/ConvexHull.js]
  72. </p>
  73. </body>
  74. </html>