MeasurePolygonAreaOperator

class Operators.Measure.MeasurePolygonAreaOperator()

This operator allows you to create a polygon and measure its area. Click to add points to the polygon. 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. 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

_clearMeasurement

MeasurePolygonAreaOperator._clearMeasurement()
Return type:void

_pickExisting

MeasurePolygonAreaOperator._pickExisting(selectPoint)
Arguments:
Return type:

boolean

addMapping

MeasurePolygonAreaOperator.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

MeasurePolygonAreaOperator.clearMapping()

Clears any button and key modifier mappings for the operator.

Return type:void

setAnchor

MeasurePolygonAreaOperator.setAnchor(anchor)
Arguments:
  • anchor (MeasurePolygonAreaAnchor()) – None

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

Return type:void

setMapping

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

Sets the button and key modifier mapping for the operator.

Return type:void