MeasurePolylineDistanceOperator

class Operators.Measure.MeasurePolylineDistanceOperator()

This operator allows you to create a polyline and measure its distance. Click to add points to the polyline. A cursor will show where the point will be placed. The operator will perform vertex snapping by default. Holding down the alt key will disable this feature. To complete a measurement, double click when placing a point to create an open line measurement, or single click on the first point to create a closed loop. When there is no active measurement being created, click on a text box to drag and reposition it relative to its anchor point. If a measurement is currently being created, pressing the Escape key will discard it, otherwise the last created measurement will be discarded.

Methods

Methods

_clearMeasurement

MeasurePolylineDistanceOperator._clearMeasurement()
Return type:void

_pickExisting

MeasurePolylineDistanceOperator._pickExisting(selectPoint)
Arguments:
Return type:

boolean

addMapping

MeasurePolylineDistanceOperator.addMapping(button, modifier)
Arguments:
  • button (Button()) – None
  • modifier (KeyModifiers()) – None

Adds a button and key modifier mapping for the operator. If no mapping is provided, all combinations are considered valid. All mappings require a mouse button, but a key modifier is optional.

Return type:void

clearMapping

MeasurePolylineDistanceOperator.clearMapping()

Clears any button and key modifier mappings for the operator.

Return type:void

setAnchor

MeasurePolylineDistanceOperator.setAnchor(anchor)
Arguments:
  • anchor (MeasurePolylineDistanceAnchor()) – None

Sets the anchor type that will be set for markups created by this operator.

Return type:void

setMapping

MeasurePolylineDistanceOperator.setMapping(button, modifier)
Arguments:
  • button (Button()) – None
  • modifier (KeyModifiers()) – None

Sets the button and key modifier mapping for the operator.

Return type:void