# PlotBox3D

The PlotBox3D function allows you to draw a Box3D structure by defining its dimensions, offset and rotation.

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

Inputs

The PlotBox3D function has the following syntax:

PlotBox3D(PointCloud,Box3D,ExternalBox,Name,Color,Transparency,ShowAxisIndicator,ShowDirectionIndicator,DirectionIndicatorAxis,ModelMode,LineDrawingThickness,Show)

Parameter | Description
PointCloud | Reference to a cell containing a point cloud. The default value is $A$0.
Box3D | Specifies the dimensions, offset and angle for the 3D rectangle of the function. It is offset from the PointCloud origin in the following format with the following arguments: {SizeX, SizeY, X, Y, Z, Rotation, Tilt, TiltDirection}
SizeX | The size of the box along the X-axis of the PointCloud. The value range is 0.001 to inf., and the default value is 100.
SizeY | The size of the box along the Y-axis of the PointCloud. The value range is 0.001 to inf., and the default value is 100.
SizeZ | The size of the box along the Z-axis of the PointCloud. The value range is 0.001 to inf., and the default value is 100.
X | Offset on the X-axis from the PointCloud origin. The value range is -inf. to inf., and the default value is 0.
Y | Offset on the Y-axis from the PointCloud origin. The value range is -inf. to inf., and the default value is 0.
Z | Offset on the Z-axis from the PointCloud origin. The value range is -inf. to inf., and the default value is 0.
Rotation | Specifies the in-plane rotation of the box (in degrees) about the PointCloud Z-axis of the tool. The value range is -360 to 360. External references with values outside the allowed range will be normalized to the allowed range.
Tilt | Specifies the tilt angle of the box (in degrees) from the PointCloud Z-axis of the tool. The value range is 0 - 180. External references with values outside the allowed range will result in an error.
Tilt Direction | Specifies the tilt direction of the box (in degrees) from the rotated PointCloud X-axis of the tool, about the PointCloud Z-axis of the tool. The value range is -360 to 360. External references with values outside the allowed range will be normalized to the allowed range.
Note: This parameter is available only if External Box is set to 0.
External Box | Specifies a reference to a Box3D structure defined in another cell of the spreadsheet to be used for plotting. Set to 0 (OFF) to use the function's internal Box3D structure.
Name | The label of the plotted structure. The configured string appears next to the structure.
Color | Specifies the color of the wireframe or surface, depending on the selected Model Mode. 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. Note: If you set the Model Mode parameter to Solid with Wireframe, then the wireframe will be black regardless of the value of this setting.
Transparency | Specifies the transparency of the drawn structure or its elements, depending on the selected Model Mode. The value range of the property is 0 – 100 (from no transparency to complete transparency), and the default value is 0 (meaning no transparency).
Show Axis Indicator | Shows the axis indicator for the plotted structure. This parameter is disabled by default.
Show Direction Indicator | Shows the direction indicator on the axis selected with the Direction Indicator Axis parameter. This parameter is disabled by default.
Direction Indicator Axis | Specifies which axis to show the direction of with the Direction Indicator. By default, the X-axis direction is indicated.
Model Mode | Specifies how the plotted box will be drawn in the point cloud: Points: Only the corner points of the plotted box will be drawn. Wireframe: The plotted box will be drawn as a wireframe only, its surfaces being completely transparent. This is the default setting. Solid: The plotted box will be drawn with its surfaces being completely solid. Solid with Wireframe: The plotted box will be drawn with solid surfaces, with its wireframe toned in black color.
Line Drawing Thickness | Specifies the thickness of the wireframe lines. This setting is available only if the Model Mode parameter is set to Wireframe or Solid with Wireframe, and its default value is 5 with a range between 1 to 10.
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 Box3D structure.
Results | When inserted into a cell, a ❒Plot structure is created, containing the settings of the 3D box drawn in the point cloud when the job is Online.