Description
Convert a distance in this calibration's units to another unit.
-
Return Type
-
A Double value.
-
Syntax
-
object.ConvertValueToUnit (dfValue, newUnit)
The ConvertValueToUnit Method syntax has these parts: |
| object | An expression evaluating to an object of type McSpatialCalib. | | dfValue | Required. A Double value. The distance to convert to the specified units. newVal - A built-in unit type (see Unit for a list)
| | newUnit | Required. A mcSpatialUnit enumeration, as described in settings. [out, retval]
|
Settings The settings for newUnit are:
|
 | mcsuPixel | 0 | |
| mcsuOther | 1 | |
| mcsuNanometer | 2 | |
| mcsuMicrometer | 3 | |
| mcsuMillimeter | 4 | |
| mcsuCentimeter | 5 | |
| mcsuMeter | 6 | |
| mcsuKilometer | 7 | |
| mcsuInch | 8 | |
| mcsuFoot | 9 | |
| mcsuYard | 10 | |
| mcsuMile | 11 | |
Remarks
This method can be used to convert a distance measured in this calibration's units to its equivalent in any of the other physical units supported. This conversion cannot take place if the calibration is not currently based on an absolute physical unit from the list given in the Unit property documentation, or is based on the mcsuPixel or mcsuCustom units.
|
ConvertValueToUnit Method
