Structures 3D Vision Data Access Functions
This topic lists the available 3D Vision Data Access Functions that get values directly from the available 3D structures.
Note: Each of the following functions references a 3D structure for the first parameter. Index (zero-based) determines which structure is being indexed from the point cloud data; if the index is not specified, the index will default to zero (i.e. the first structure is returned).
| Function | Description |
| GetAngleX(Structure, [index]) | Returns the rotation of the structure on the X-axis. |
| GetAngleY(Structure, [index]) | Returns the rotation of the structure on the Y-axis. |
| GetAngleZ(Structure, [index]) | Returns the rotation of the structure on the Z-axis. |
| GetAxis(Structure, [index]) | Returns the Z-axis line passing the structure's center point as a Line3D structure. |
| GetBoundingBox(Structure) | Returns the bounding box of the structure as a Box3D structure. |
| GetCenter(Structure) | Returns the center point of the structure as a Point3D structure. |
| GetCenterAxisX(Structure) | Returns the X-axis passing through the center point of the structure as a Line3D structure. |
| GetCenterAxisY(Structure) | Returns the Y-axis passing through the center point of the structure as a Line3D structure. |
| GetCenterAxisZ(Structure) | Returns the Z-axis passing through the center point of the structure as a Line3D structure. |
| GetCircle(Structure, [index]) | Returns the specified Circle3D structure. |
| GetEdge(Structure, [index]) | Returns the specified edge as a Line3D structure. |
| GetFace(Structure, [index]) | Returns the face of the specified structure as a Rectangle3D structure. |
| GetHeight(Structure, [index]) | Returns the height of the specified structure as an integer. |
| GetLength(Structure) | Returns the length of the specified structure. |
| GetMidPoint(Structure) | Returns the middle point of the structure as a Point3D structure. |
| GetOffset(Structure) | Returns the configured offset of the structure. |
| GetPerimeter(Structure, [index]) | Returns the perimeter value of the structure. |
| GetPlane(Structure, [index]) | Returns the specified Plane3D structure. |
| GetRadius(Structure, [index]) | Returns the radius of the specified structure (if applicable), as an integer. |
| GetRotation(Structure) | Returns the rotation of the structure (in degrees) about the Z-axis. In case of fixtured structures, the value is relative to the Fixture3D structure's Z-axis. In case of Fixture3D structures and non-fixtured structures, the value is relative to the PointCloud Z-axis. |
| GetSizeX(Structure, [index]) | Returns the size of the structure along the X-axis. |
| GetSizeY(Structure, [index]) | Returns the size of the structure along the Y-axis. |
| GetSizeZ(Structure, [index]) | Returns the size of the structure along the Z-axis. |
| GetSurfaceArea(Structure) | Returns the surface area of the specified structure. |
| GetTilt(Structure) | Returns the tilt angle of the structure (in degrees) on the Z-axis as an integer. In case of fixtured structures, the value is relative to the Fixture3D structure's Z-axis. In case of Fixture3D structures and non-fixtured structures, the value is relative to the PointCloud Z-axis. |
| GetTiltDirection(Structure) | Returns the structure's direction of tilt (in degrees) from the rotated X-axis about the Z-axis as an integer. In case of fixtured structures, the value is relative to the Fixture3D structure's axes. In case of Fixture3D structures and non-fixtured structures, the value is relative to the PointCloud axes. |
| GetVertex(Structure, [index]) | Returns the vertices of the specified structure as a Point3D structure. |
| GetVolume(Structure) | Returns the volume of the specified structure. |
| GetX(Structure, [index1], [index2]) |
Returns the X-axis coordinate of the specified structure's center point. Note: The Index2 parameter is valid only in case of edges (where it specifies an endpoint with the value of 0 or 1).
|
| GetY(Structure, [index1], [index2]) |
Returns the Y-axis coordinate of the specified structure's center point. Note: The Index2 parameter is valid only in case of edges (where it specifies an endpoint with the value of 0 or 1).
|
| GetZ(Structure, [index1], [index2]) |
Returns the Z-axis coordinate of the specified structure's center point. Note: The Index2 parameter is valid only in case of edges (where it specifies an endpoint with the value of 0 or 1).
|