mirror of
https://github.com/Doodle3D/Doodle3D-Slicer.git
synced 2024-07-01 00:31:21 +02:00
137 lines
3.5 KiB
HTML
Executable File
137 lines
3.5 KiB
HTML
Executable File
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8" />
|
|
<script src="../../list.js"></script>
|
|
<script src="../../page.js"></script>
|
|
<link type="text/css" rel="stylesheet" href="../../page.css" />
|
|
</head>
|
|
<body>
|
|
<h1>[name]</h1>
|
|
|
|
<div class="desc">A geometric line segment represented by a start and end point.</div>
|
|
|
|
|
|
<h2>Constructor</h2>
|
|
|
|
|
|
<h3>[name]([page:Vector3 start], [page:Vector3 end])</h3>
|
|
<div>
|
|
start -- [page:Vector3] Start of the line segment<br />
|
|
end -- [page:Vector3] End of the line segment
|
|
</div>
|
|
<div>
|
|
The start and end vectors default to origin vectors if none are set.
|
|
</div>
|
|
|
|
|
|
<h2>Properties</h2>
|
|
|
|
|
|
|
|
<h3>[property:Vector3 start]</h3>
|
|
|
|
<h3>[property:Vector3 end]</h3>
|
|
|
|
<h2>Methods</h2>
|
|
|
|
|
|
|
|
<h3>[method:Line3 set]([page:Vector3 start], [page:Vector3 end])</h3>
|
|
<div>
|
|
start -- [page:Vector3] <br />
|
|
end -- [page:Vector3]
|
|
</div>
|
|
<div>
|
|
Sets the start and end values by copying the provided vectors.
|
|
</div>
|
|
|
|
<h3>[method:Line3 copy]([page:Line3 line])</h3>
|
|
<div>
|
|
line -- [page:Line3]
|
|
</div>
|
|
<div>
|
|
Copies the passed line's start and end vectors to this line.
|
|
</div>
|
|
|
|
<h3>[method:Line3 clone]()</h3>
|
|
<div>
|
|
Return a new copy of this [page:Line3].
|
|
</div>
|
|
|
|
<h3>[method:Boolean equals]([page:Line3 line])</h3>
|
|
<div>
|
|
line -- [page:Line3]
|
|
</div>
|
|
<div>
|
|
|
|
<h3>[method:Float distance]()</h3>
|
|
<div>
|
|
Returns the length of the line segment.
|
|
</div>
|
|
Returns true if both line's start and end points are equal.
|
|
</div>
|
|
|
|
<h3>[method:Float distanceSq]()</h3>
|
|
<div>
|
|
Returns the line segment's length squared.
|
|
</div>
|
|
|
|
<h3>[method:Line3 applyMatrix4]([page:Matrix4 matrix]) [page:Line3 this]</h3>
|
|
<div>
|
|
matrix -- [page:Matrix4]
|
|
</div>
|
|
<div>
|
|
Apply a matrix transform to the line segment.
|
|
</div>
|
|
|
|
<h3>[method:Vector at]([page:Float t], [page:Vector3 optionalTarget])</h3>
|
|
<div>
|
|
t -- [page:Float] Use values 0-1 to return a result on the line segment. <br />
|
|
optionalTarget -- [page:Vector] Optional target to set the result.
|
|
</div>
|
|
<div>
|
|
Return a vector at a certain position along the line. When t = 0, it returns the start vector, and when t=1 it returns the end vector.
|
|
</div>
|
|
|
|
<h3>[method:Vector3 center]([page:Vector3 optionalTarget])</h3>
|
|
<div>
|
|
optionalTarget -- [page:Vector3] Optional target to set the result.
|
|
</div>
|
|
<div>
|
|
Return the center of the line segment.
|
|
</div>
|
|
|
|
<h3>[method:Vector3 delta]([page:Vector3 optionalTarget])</h3>
|
|
<div>
|
|
optionalTarget -- [page:Vector3] Optional target to set the result.
|
|
</div>
|
|
<div>
|
|
Returns the delta vector of the line segment, or the end vector minus the start vector.
|
|
</div>
|
|
|
|
<h3>[method:Vector3 closestPointToPoint]([page:Vector3 point], [page:Boolean clampToLine], [page:Vector3 optionalTarget])</h3>
|
|
<div>
|
|
point -- [page:Vector3] <br />
|
|
clampToLine -- [page:Boolean] <br />
|
|
optionalTarget -- [page:Vector3] Optional target to set the result.
|
|
</div>
|
|
<div>
|
|
Returns the closets point on the line. If clamp to line is true, then the returned value will be clamped to the line segment.
|
|
</div>
|
|
|
|
<h3>[method:Float closestPointToPointParameter]([page:Vector3 point], [page:Boolean clampToLine])</h3>
|
|
<div>
|
|
point -- [page:Vector3] <br />
|
|
clampToLine -- [page:Boolean]
|
|
</div>
|
|
<div>
|
|
Returns a point parameter based on the closest point as projected on the line segement. If clamp to line is true, then the returned value will be between 0 and 1.
|
|
</div>
|
|
|
|
<h2>Source</h2>
|
|
|
|
[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
|
|
</body>
|
|
</html>
|