# PlotLine3D

The PlotLine3D function allows you to draw a Line3D structure by defining the X, Y and Z-axis position of its starting and end points. The function supports drawing arrows and regular lines as well.

It returns a Plot structure containing the settings of the plotted box.

Inputs

The PlotLine3D function has the following syntax:

PlotLine3D(PointCloud,Line3D,ExternalLine,Name,LineDrawingThickness,Color,Transparency,LineDrawingStyle,Show)

Parameter | Description
PointCloud | Reference to a cell containing a point cloud. The default value is $A$0.
Line3D | Specifies the offsets of the 3D line structure to use. It is offset from the PointCloud origin in the following format with the following arguments: {X0, Y0, Z0, X1, Y1, Z1}
X0 | Offset of the 3D line's starting point on the X-axis from the PointCloud origin.
Y0 | Offset of the 3D line's starting point on the Y-axis from the PointCloud origin.
Z0 | Offset of the 3D line's starting point on the Z-axis from the PointCloud origin.
X1 | Offset of the 3D line's ending point on the X-axis from the PointCloud origin.
Y1 | Offset of the 3D line's ending point on the Y-axis from the PointCloud origin.
Z1 | Offset of the 3D line's ending point on the Z-axis from the PointCloud origin.
Note: This parameter is available only if External Line is set to 0.
External Line | Specifies a reference to the Line3D structure defined in another cell to be used by the function. Set to 0 (OFF) to use the function's internal Line3D structure instead.
Name | The label of the plotted structure. The configured string appears next to the structure.
Line Drawing Thickness | Specifies the thickness of the line. The default value is 5.
Color | Specifies the color of the plotted graphic. Default: 0x32CD32, LimeGreen; max: 0xFFFFFF. Configure different colors by providing the hexadecimal color code in the formula bar or selecting a color from the color picker on the tool property sheet.
Transparency | Specifies the transparency of the drawn line. The value range of the property is 0 – 100 (from no transparency to complete transparency), and the default value is 0 (meaning no transparency).
Line Drawing Style | Specifies the type of line that will be drawn: Start Arrow: Draws an arrow, with the arrowhead located at the starting point of the line. End Arrow: Draws an arrow, with the arrowhead located at the end point of the line. Both Arrows: Draws a left-right arrow. Regular: Draws a regular line with no arrowhead.
Show | Selects the display mode.
0 (Unchecked) = Off | The structure will be hidden, except when the cell containing the function is highlighted in the spreadsheet.
1 (Checked) = On (default) | The structure will be displayed at all times.

Outputs

Returns | A Plot structure that allows you to modify the plotted Line3D structure.
Results | When inserted into a cell, a ❒Plot structure is created, containing the settings of the 3D line drawn in the point cloud when the job is Online.