References ▼
Calibrates the selected ruler inside the specific cell or sub-cell.
#include "ltwrappr.h"
L_INT LImageViewer::CalibrateCell(nCellIndex, nSubCellIndex, dLength, uUnit, dTargetLength, uTargetUnit, uFlags)
A zero based index of the cell on which the function's effect will be applied.
A zero-based index into the image list attached to the cell specified in nCellIndex. This sub-cell will be calibrated. Pass -1 to apply this effect on all sub-cells. Pass -2 to apply this effect on the selected sub-cell.
Value that represents the old length of the virtual ruler.
Value that specifies the unit of measure for the virtual ruler length. Possible values are:
| Value | Meaning |
|---|---|
| CONTAINER_RULERUNIT_INCHES | [0] Inches. |
| CONTAINER_RULERUNIT_FEET | [1] Feet. |
| CONTAINER_RULERUNIT_MICROMETERS | [2] Micrometers. |
| CONTAINER_RULERUNIT_MILLIMETERS | [3] Millimeters. |
| CONTAINER_RULERUNIT_CENTIMETERS | [4] Centimeters. |
| CONTAINER_RULERUNIT_METERS | [5] Meters. |
Value that represents the length to be assigned to the virtual ruler. The unit of measure for the length is specified by the value of the uTargetUnit parameter.
Value that specifies the unit of measure for the virtual ruler length. Possible values are:
| Value | Meaning |
|---|---|
| CONTAINER_RULERUNIT_INCHES | [0] Inches. |
| CONTAINER_RULERUNIT_FEET | [1] Feet. |
| CONTAINER_RULERUNIT_MICROMETERS | [2] Micrometers. |
| CONTAINER_RULERUNIT_MILLIMETERS | [3] Millimeters. |
| CONTAINER_RULERUNIT_CENTIMETERS | [4] Centimeters. This is the default value. |
| CONTAINER_RULERUNIT_METERS | [5] Meters. |
Flags that indicate the direction to which the calibration is applied. Possible values are:
| Value | Meaning |
|---|---|
| CONTAINER_CALIBRATERULER_BOTH | [0] Calibrate both axes. |
| CONTAINER_CALIBRATERULER_VERTICAL | [1] Calibrate vertical axis only. |
| CONTAINER_CALIBRATERULER_HORIZONTAL | [2] Calibrate horizontal axis only. |
| Value | Meaning |
|---|---|
| SUCCESS | The function was successful. |
| < 1 | An error occurred. Refer to Return Codes. |
This function does not require that the annotation ruler to be present in order to calibrate the cell.
The user is expected to send a length along with the unit of measure, and then send a new length with the new unit of measure for the cell being calibrated.
To obtain the unit of measure of the viewer, call the LImageViewerCell::GetRulerUnit function.
To change the unit of measure unit of the viewer, call the LImageViewerCell::SetRulerUnit function.