translate_measuretranslate_measureTranslateMeasuretranslate_measureTranslateMeasureTranslateMeasure (Operator)

Name

translate_measuretranslate_measureTranslateMeasuretranslate_measureTranslateMeasureTranslateMeasure — Translate a measure object.

Signature

translate_measure( : : MeasureHandle, Row, Column : )

Description

translate_measuretranslate_measureTranslateMeasuretranslate_measureTranslateMeasureTranslateMeasure translates the reference point of the measure object given by MeasureHandleMeasureHandleMeasureHandleMeasureHandleMeasureHandlemeasureHandle to the point (RowRowRowRowRowrow,ColumnColumnColumnColumnColumncolumn). If the measure object and the translated measure object lie completely within the image, the measure object is shifted to the new reference point in an efficient manner. Otherwise, the measure object is generated anew with gen_measure_rectangle2gen_measure_rectangle2GenMeasureRectangle2gen_measure_rectangle2GenMeasureRectangle2GenMeasureRectangle2 or gen_measure_arcgen_measure_arcGenMeasureArcgen_measure_arcGenMeasureArcGenMeasureArc using the parameters that were specified when the measure object was created and the new reference point.

A measure object 'MeasureHandle'"MeasureHandle""MeasureHandle""MeasureHandle""MeasureHandle""MeasureHandle" cannot be shared between two or more user's threads. Different measure objects can be used independently and safely in different threads.

Parallelization

Multithreading type: reentrant (runs in parallel with non-exclusive operators).
Multithreading scope: global (may be called from any thread).
Processed without parallelization.

Parameters

MeasureHandleMeasureHandleMeasureHandleMeasureHandleMeasureHandlemeasureHandle (input_control) measure_id → (integer)

Measure object handle.

RowRowRowRowRowrow (input_control) point.y → (real / integer)

Row coordinate of the new reference point.

Default value: 50.0

Suggested values: 10.0, 20.0, 50.0, 100.0, 200.0, 300.0, 400.0, 500.0

Typical range of values: 0.0 ≤ Row Row Row Row Row row ≤ 511.0 (lin)

Minimum increment: 1.0

Recommended increment: 10.0

ColumnColumnColumnColumnColumncolumn (input_control) point.x → (real / integer)

Column coordinate of the new reference point.

Default value: 100.0

Suggested values: 10.0, 20.0, 50.0, 100.0, 200.0, 300.0, 400.0, 500.0

Typical range of values: 0.0 ≤ Column Column Column Column Column column ≤ 511.0 (lin)

Minimum increment: 1.0

Recommended increment: 10.0

Result

If the parameter values are correct the operator translate_measuretranslate_measureTranslateMeasuretranslate_measureTranslateMeasureTranslateMeasure returns the value 2 (H_MSG_TRUE). Otherwise an exception is raised.