# PlotRectangle3D

The PlotRectangle3D function allows you to draw a two-dimensional rectangle by defining its dimensions, offset and rotation.

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

# PlotRectangle3D Inputs

The PlotRectangle3D function has the following syntax:

PlotRectangle3D(PointCloud,Rectangle3D,ExternalRectangle,Name,Color,Transparency,ModelMode,LineDrawingThickness,Show)

Parameter | Description
PointCloud | Reference to a cell containing a point cloud. The default value is $A$0.
Rectangle3D | Specifies the dimensions, offset and angle for the 3D rectangle of the function. Double-click on the Rectangle3D parameter in the property sheet to adjust the rectangle on the acquisition display. Rectangle3D is offset from the PointCloud origin or the external fixture in the following format with the following arguments: {SizeX, SizeY, X, Y, Z, Rotation, Tilt, TiltDirection}
SizeX | The size of the rectangle along the PointCloud X-axis.
SizeY | The size of the rectangle along the PointCloud Y-axis.
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.
Rotation | Specifies the in-plane rotation in degrees around the PointCloud Z-axis of the tool. The value range is -360 to 360. The tool normalizes external references with values outside the allowed range to the allowed range.
Tilt | Specifies the tilt angle in degrees from the PointCloud Z-axis of the tool. The value range is 0 - 180. External references with values outside the allowed range result in an error.
Tilt Direction | Specifies the direction of tilt in degrees from the rotated PointCloud X-axis of the tool, around the PointCloud Z-axis of the tool. The value range is -360 to 360. The tool normalizes external references with values outside the allowed range to the allowed range.
Note: This parameter is only available if you set External Rectangle to 0.
External Rectangle | Specifies a reference to a Rectangle3D structure defined in another cell. The function uses the referenced cell for constructing the 3D structure. Set to 0 (OFF) to use the internal Rectangle3D structure of the function.
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. The default value is Lime Green. Note: If the Model Mode parameter is set to Solid with Wireframe, then the wireframe will be drawn in 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).
Model Mode | Specifies how the plotted rectangle will be drawn in the point cloud: Points: This setting draws only the four corner points of the rectangle. Wireframe: The plotted rectangle will be drawn as a wireframe only, its surface being completely transparent. This is the default setting. Solid: The plotted rectangle will be drawn with its surface being completely solid. Solid with Wireframe: The plotted rectangle will be drawn with a solid surface, 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.

# PlotRectangle3D Outputs

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