Plane3D

The Plane3D function allows you to create a fixtured 3D plane in the point cloud.

It returns a Plane3D structure containing the settings of the fixtured 3D plane.

Plane3D Inputs

The Plane3D function has the following syntax:

Plane3D(PointCloud,Fixture3D,ExternalFixture,Plane3D,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 around the PointCloud Z-axis. 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 after rotation. 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 Fixture to 0.
External Fixture

Specifies a reference to a Fixture3D structure defined in another cell. The function uses the referenced cell as the fixture of the function. Set to 0 (OFF) to use the internal fixture of the function instead.

Plane3D

Specifies the offset and the angle of the plane to use. It is offset from the Fixture3D origin in the following format with the following arguments:

{X, Y, Z, 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.
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 plane'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.
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.

Plane3D Outputs

Returns

A Plane3D data structure containing the constructed 3D plane, or #ERR if any of the input parameters are invalid.

Results

When initially inserted into a cell, the following functions are automatically inserted into the spreadsheet to create a result table.

  X Y Z Tilt Tilt Direction
❒Plane3D GetX(Plane3D) GetY(Plane3D) GetZ(Plane3D) GetTilt(Plane3D) GetTiltDirection(Plane3D)

Plane3D 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
GetX(Plane3D) Returns the X-axis coordinate of the 3D plane's center point.
GetY(Plane3D) Returns the Y-axis coordinate of the 3D plane's center point.
GetZ(Plane3D) Returns the Z-axis coordinate of the 3D plane's center point.
GetTiltDirection(Plane3D) Returns the tilt direction angle of the specified Plane3D 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.
GetTilt(Plane3D) Returns the tilt angle of the Plane3D structure in degrees on the Z-axis.