Face.html 2.3 KB

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