GetHit Method
Description
Returns a PointData object with the values of the sample hit.
Syntax
| Visual Basic |
|---|
Public Function GetHit( _ ByVal index As Long, _ ByVal DataType As FHITDATA_TYPES, _ ByVal MeasOrTheo As FDATA_DATASET, _ ByVal CoordSystem As FDATA_COORDSYS, _ ByVal Alignment As String, _ ByVal Workplane As ENUM_PLANE_TYPE _ ) As PointData |
Parameters
- index
- The index number of the desired sample hit object to retrieve.
- DataType
Optional Long value. If no value is supplied, the default value is FHITDATA_CENTROID.Value Description FHITDATA_BALLCENTER FHITDATA_CENTROID FHITDATA_VECTOR - MeasOrTheo
Optional Long value. If no value is supplied, the default value is FDATA_MEAS.Value Description FDATA_ALL FDATA_MEAS FDATA_TARG FDATA_THEO - CoordSystem
Optional Long value that denotes the coordinate system in which to report. An empty value of "" will use the current alignment.Value Description FDATA_CAD FDATA_MACHINE FDATA_PART FDATA_PARTMM3 FDATA_POLAR - Alignment
- Optional String that denotes what alignment to use. You can pass the empty string to denote the current alignment.
If no value is supplied, the default value is an empty string which causes the current alignment to be used.
- Workplane
Optional parameter with the ENUM_PLANE_TYPE enumeration for the PARTMM3 and POLAR coordinate system to denote the workplane to be used.Value Description PLANE_BACK PLANE_BOTTOM PLANE_FRONT PLANE_LEFT PLANE_RIGHT PLANE_TOP
Return Type
PointData object.
Remarks
Use this function to obtain hit information from individual objects. This command works with objects that the hits are supplied by the user and with objects in which the hits are generated by the object itself.
See Also