MeasurePolygonAreaOperator

class Communicator.Operator.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()

_pickExisting()

addMapping()

clearMapping()

setAnchor()

setMapping()


Methods

_clearMeasurement

Communicator.Operator.MeasurePolygonAreaOperator._clearMeasurement()
Return type

void

_pickExisting

Communicator.Operator.MeasurePolygonAreaOperator._pickExisting(selectPoint)
Arguments
  • selectPoint (Communicator.Point2()) –

Return type

boolean

addMapping

Communicator.Operator.MeasurePolygonAreaOperator.addMapping(button, modifier)

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.

Arguments
  • button (Communicator.Button()) –

  • modifier (Communicator.KeyModifiers()) –

Return type

void

clearMapping

Communicator.Operator.MeasurePolygonAreaOperator.clearMapping()

Clears any button and key modifier mappings for the operator.

Return type

void

setAnchor

Communicator.Operator.MeasurePolygonAreaOperator.setAnchor(anchor)

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

Arguments
  • anchor (Communicator.Operator.MeasurePolygonAreaAnchor()) –

Return type

void

setMapping

Communicator.Operator.MeasurePolygonAreaOperator.setMapping(button, modifier)

Sets the button and key modifier mapping for the operator.

Arguments
  • button (Communicator.Button()) –

  • modifier (Communicator.KeyModifiers()) –

Return type

void