# CylinderFromCircle3D

The CylinderFromCircle3D function is used to construct a 3D cylinder from the specified Circle3D structure. It returns the constructed cylinder as a Cylinder3D structure.

## CylinderFromCircle3D Inputs

The CylinderFromCircle3D function has the following syntax:

CylinderFromCircle3D(PointCloud,Circle3D,ExternalCircle,Length,Offset,Show)

See the table for a description of the available parameters.

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.
Length | Specifies the length (or "height") of the 3D cylinder to construct.
Offset | Specifies the signed distance above or below the circle to position the center of the cylinder. The value range is -inf. to inf., and the default value is 0. Having the value set to 0 means that the 3D cylinder will be positioned at the center of the constructed cylinder.
Show | Selects the type of graphics to overlay on the image.
0 = hide all (default) | All graphics are hidden, except when the cell containing the function is highlighted in the spreadsheet.
1 = result graphics only | The result graphics of the function are displayed at all times.
2 = input and result graphics | The region of interest, the input data and the results are displayed at all times.

## CylinderFromCircle3D Outputs

Returns | A Cylinder3D structure containing the parameters of the configured 3D cylinder.
Results | When initially inserted into a cell, the following functions are automatically inserted into the spreadsheet to create a result table.
| Radius | Length | X | Y | Z | Tilt | Tilt Direction
❒Cylinder3D | GetRadius(Cylinder3D) | GetLength(Cylinder3D) | GetX(Cylinder3D) | GetY(Cylinder3D) | GetZ(Cylinder3D) | GetTilt(Cylinder3D) | GetTiltDirection(Cylinder3D)

## CylinderFromCircle3D Vision Data Access Functions

The following Structures 3D Vision Data Access Functions are automatically inserted into the spreadsheet to create the result table:

Function | Description
GetLength(Cylinder3D) | Returns the length (or "height") of the created 3D cylinder.
GetRadius(Cylinder3D) | Returns the radius of the created 3D cylinder.
GetTilt(Cylinder3D) | Returns the tilt angle of the Cylinder3D structure in degrees on the Z-axis.
GetTiltDirection(Cylinder3D) | Returns the tilt direction angle of the specified Cylinder3D structure in degrees. The angle is measured in the X-Y plane of the original reference coordinate system, and specifies the direction for the projection of the tilted Z-axis onto that plane.
GetX(Cylinder3D) | Returns the X-axis coordinate of the center of the 3D cylinder.
GetY(Cylinder3D) | Returns the Y-axis coordinate of the center of the 3D cylinder.
GetZ(Cylinder3D) | Returns the Z-axis coordinate of the center of the 3D cylinder.