Face.html 2.4 KB

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