# PlotCircle3D

The PlotCircle3D function allows you to draw a Circle3D structure by defining its radius, offset and rotation.

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

Inputs

The PlotCircle3D function has the following syntax:

PlotCircle3D(PointCloud,Circle3D,ExternalCircle,Name,Color,Transparency,ModelMode,LineDrawingThickness,Show)

Parameter | Description
PointCloud | Reference to a cell containing a point cloud. The default value is $A$0.
Circle3D | Specifies the dimensions, offset and angle of the function's 3D circle. It is offset from the PointCloud origin in the following format with the following arguments: {Radius, X, Y, Z, Tilt, TiltDirection}
Radius | The radius of the circle.
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.
Tilt | Specifies the circle's tilt angle (in degrees) from the tool's PointCloud Z-axis. The value range is 0 - 180. External references with values outside the allowed range will result in an error.
Tilt Direction | Specifies the circle's direction of tilt (in degrees) from the tool's rotated PointCloud X-axis, about the tool's PointCloud Z-axis. 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 Circle is set to 0.
External Circle | Specifies a reference to a Circle3D structure defined in another cell to be used with the function. Set to 0 (OFF) to use the function's internal Circle3D 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).
Model Mode | Specifies how the plotted circle will be drawn in the point cloud: Points: This setting draws the center point and the wireframe of the circle with points. The wireframe points are all located an equal distance from their neighboring points. Wireframe: The plotted circle will be drawn as a wireframe only, with a completely transparent surface. This is the default setting. Solid: The plotted circle will be drawn with a solid surface. Solid with Wireframe: The plotted circle will be drawn with a solid surface and 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 Circle3D structure.
Results | When inserted into a cell, a ❒Plot structure is created, containing the settings of the 3D circle drawn in the point cloud when the job is Online.