# PlotCylinder3D

The PlotCylinder3D function Functions are tools that are available in Spreadsheet for processing and analyzing acquisitions or other results. You can add functions to your Spreadsheet job to create tool chains and produce results for specific applications. allows you to draw a 3D cylinder.

It returns a Plot structure containing the settings of the drawn 3D cylinder.

Inputs

The PlotCylinder3D function has the following syntax:

PlotCylinder3D(PointCloud A point cloud is a 3D structure that consists of the data points collected by a 3D vision system during acquisition.,Cylinder3D,ExternalCylinder,Name,Color,Transparency,ModelMode,LineDrawingThickness,Show)

Parameter | Description
PointCloud | Reference to a cell containing a point cloud A point cloud is a 3D structure that consists of the data points collected by a 3D vision system during acquisition.. The default value is $A$0.
Cylinder3D | Specifies the dimensions, offset and angle of the function's 3D cylinder. It is offset from the PointCloud origin in the following format with the following arguments: {Radius, Length, X, Y, Z, Tilt, TiltDirection}
Radius | The radius of the cylinder.
Length | The length (or "height") of the cylinder..
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 cylinder'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 cylinder's direction of tilt (in degrees) from the tool's rotated PointCloud X-axis, about the tool's Fixture3D 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 enabled only if External Cylinder is set to 0.
External Cylinder | Specifies a reference to a Cylinder3D structure defined in another cell of the spreadsheet to be used for plotting the 3D cylinder. Set to 0 (OFF) to use the function's internal Cylinder3D 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 cylinder will be drawn in the point cloud: Points: This setting draws the cylinder's top and bottom surfaces and its center Z-axis by points. Wireframe: The cylinder will be drawn as a wireframe only, its surfaces being completely transparent. This is the default setting. Solid: The region will be drawn with its surfaces being completely solid. Solid with Wireframe: The region 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 Cylinder3D structure.
Results | When inserted into a cell, a ❒Plot structure is created, containing the settings of the 3D cylinder drawn in the point cloud when the job A job is a user-configured program in In-Sight 3D Spreadsheet consisting of functions and designed for specific applications. You can create and edit jobs using the In-Sight 3D Spreadsheet interface, and load them on a vision system for deployment in a live environment. is Online.