Cylinder3D

The Cylinder3D function allows you to create a fixtured 3D cylinder in the point cloud.

It returns a Cylinder3D structure containing the settings of the fixtured 3D cylinder.

Cylinder3D Inputs

The Cylinder3D function has the following syntax:

Cylinder3D(PointCloud,Fixture3D,ExternalFixture,Cylinder3D,Show)

Parameter Description

PointCloud

Reference to a cell containing a point cloud. The default value is $A$0.
Fixture3D

Specifies the point cloud coordinate system in which the 3D fixture is defined. It is offset from the PointCloud origin in the following format with the following arguments:

{X, Y, Z, Rotation, Tilt, TiltDirection}

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) about the 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.
Tilt Specifies the tilt angle (in degrees) from the PointCloud Z-axis after rotation. The value range is 0-180. External references with values outside the allowed range will result in an error.
Tilt Direction Specifies the 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 - 360. External references with values outside the allowed range will be normalized to the allowed range.
Note: This parameter is available only if External Fixture is set to 0.
External Fixture

Specifies a reference to a Fixture3D structure defined in another cell to be used as the function's fixture. Set to 0 (OFF) to use the function's internal fixture instead.

Cylinder3D

Specifies the dimensions, offset and angle of the function's 3D cylinder. It is offset from the Fixture3D 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 Fixture3D origin.
Y Offset on the Y-axis from the Fixture3D origin.
Z Offset on the Z-axis from the Fixture3D origin.
Tilt Specifies the cylinder's tilt angle (in degrees) from the tool's Fixture3D 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 Fixture3D 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.
Show

Selects the type of graphics to overlay on the image.

0 = hide all (default)

All graphics will be hidden, except when the cell containing the function is highlighted in the spreadsheet.

2 = input graphics only

The input data will be displayed at all times.

Cylinder3D 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)

Cylinder3D 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
GetRadius(Cylinder3D) Returns the radius of the created 3D cylinder.
GetLength(Cylinder3D) Returns the length (or "height") of the created 3D cylinder.
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.
GetTilt(Cylinder3D) Returns the tilt angle of the 3D cylinder (in degrees) on the Fixture3D Z-axis.
GetTiltDirection(Cylinder3D) Returns the 3D cylinder's direction of tilt (in degrees) from the rotated Fixture3D X-axis about the Fixture3D Z-axis.