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 you want to reference from the point cloud data. If you do not specify the index, the index defaults to zero, meaning the function returns the first structure.
| 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 Z-axis in degrees, also known as the in-plane rotation. |
| 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. |
| GetTiltDirection(Structure) | Returns the tilt direction angle of the specified 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. |
| 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).
|