# LineFromPoints3D

The LineFromPoints3D function is used to construct a line segment from two Point3D structures, serving as the start point and end point of the line, respectively. The constructed line segment is returned as a Line3D structure.

## LineFromPoints3D Inputs

The LineFromPoints3D function has the following syntax:

LineFromPoints3D(PointCloud,Point3D0,ExternalPoint0,Point3D1,ExternalPoint1,Show)

See the table for a description of the available parameters.

Parameter | Description
PointCloud | Reference to a cell containing a point cloud. The default value is $A$0.
Point3D 0 | Specifies the offset of the first 3D point to use for creating the 3D line. It is offset from the PointCloud origin in the following format with the following arguments: {X, Y, Z}
X | Offset on the X-axis from the PointCloud origin.
Y | Offset on the Y-axis from the PointCloud origin.
Z | Offset on the Z-axis from the PointCloud origin.
Note: This parameter is available only if External Point 0 is set to 0.
External Point 0 | Specifies a reference to a Point3D structure defined in another cell to be used by the function. Set to 0 (OFF) to use the function's internal Point3D structure.
Point3D 1 | Specifies the offset of the second 3D point to use for creating the 3D line. It is offset from the PointCloud origin in the following format with the following arguments: {X, Y, Z}
X | Offset on the X-axis from the PointCloud origin..
Y | Offset on the Y-axis from the PointCloud origin
Z | Offset on the Z-axis from the PointCloud origin.
Note: This parameter is available only if External Point 1 is set to 0.
External Point 1 | Specifies a reference to the second Point3D structure defined in another cell to be used for constructing the 3D structure. Set to 0 (OFF) to use the function's internal Point3D structure.
Show | Selects the type of graphics to overlay on the image.
0 = hide all (default) | All graphics are hidden, except when the cell containing the function is highlighted in the spreadsheet.
1 = result graphics only | The result graphics of the function are displayed at all times.
2 = input and result graphics | The region of interest, the input data and the results are displayed at all times.

## LineFromPoints3D Outputs

Returns | A Line3D data structure as the projected 3D line, or #ERR if any of the input parameters are invalid.
Results | When initially inserted into a cell, the following functions are automatically inserted into the spreadsheet to create a result table.
| X0 | Y0 | Z0 | X1 | Y1 | Z1
❒Line3D | GetX(Line3D, 0) | GetY(Line3D, 0) | GetZ(Line3D, 0) | GetX(Line3D, 1) | GetY(Line3D, 1) | GetZ(Line3D, 1)

## LineFromPoints3D Vision Data Access Functions

The following Structures 3D Vision Data Access Functions are automatically inserted into the spreadsheet to create the result table:

Function | Description
GetX(Line3D, index) | Returns the X-axis coordinate of the 3D line point specified with the index. An index value of 0 indicates the first endpoint of the line, while a value of 1 indicates its second endpoint.
GetY(Line3D, index) | Returns the Y-axis coordinate of the 3D line point specified with the index. An index value of 0 indicates the first endpoint of the line, while a value of 1 indicates its second endpoint.
GetZ(Line3D, index) | Returns the Z-axis coordinate of the 3D line point specified with the index. An index value of 0 indicates the first endpoint of the line, while a value of 1 indicates its second endpoint.