MeasurePolygonAreaOperator

class wv.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.

Index

Methods

• _clearMeasurement
• addMapping
• checkMapping
• clearMapping
• isActive
• isDragging
• onTouchEnd
• onTouchMove
• onTouchStart
• setAnchor
• setHandled
• setMapping
• stopInteraction
• _pickExisting

Methods

wv.Operators.Measure.MeasurePolygonAreaOperator._clearMeasurement()

_clearMeasurement(): void

Returns: void

wv.Operators.Measure.MeasurePolygonAreaOperator.addMapping()

inherited

addMapping(button: Button, modifier: KeyModifiers?): void

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.

Parameters

button: Button

modifier: KeyModifiers = KeyModifiers.None

Returns: void

wv.Operators.Measure.MeasurePolygonAreaOperator.checkMapping()

inherited

checkMapping(event: MouseInputEvent): boolean

Checks if the given mouse event matches any of the button and key modifier mappings for the operator. If no mappings are defined, it returns true.

Parameters

event: MouseInputEvent

The mouse event to check against the operator’s mappings.

Returns: boolean

True if the event matches any mapping or if no mappings are defined, false otherwise.

wv.Operators.Measure.MeasurePolygonAreaOperator.clearMapping()

inherited

clearMapping(): void

Clears any button and key modifier mappings for the operator.

Returns: void

wv.Operators.Measure.MeasurePolygonAreaOperator.isActive()

inherited

isActive(): boolean

Checks if the operator is currently active, which is determined by whether the button and key modifier mapping is active or a touch event is active, and that a double click has not occurred and the context menu is not open.

Returns: boolean

True if the operator is active, false otherwise.

wv.Operators.Measure.MeasurePolygonAreaOperator.isDragging()

inherited

isDragging(): boolean

Checks if the operator is currently dragging.

Returns: boolean

True if the operator is dragging, false otherwise.

wv.Operators.Measure.MeasurePolygonAreaOperator.onTouchEnd()

inherited

onTouchEnd(event: TouchInputEvent): void

Base method for handling touch end events. If the touch event corresponds to the primary touch point, it emulates a mouse up event using the touch position and resets the primary touch ID. It also sets the event as handled based on the operator’s setHandled method.

Parameters

event: TouchInputEvent

The touch end event to handle.

Returns: void

wv.Operators.Measure.MeasurePolygonAreaOperator.onTouchMove()

inherited

onTouchMove(event: TouchInputEvent): Promise

Base method for handling touch move events. If the touch event corresponds to the primary touch point, it emulates a mouse move event using the touch position. It awaits the onMouseMove method to allow for asynchronous behavior in child classes.

Parameters

event: TouchInputEvent

The touch move event to handle.

Returns: Promise

wv.Operators.Measure.MeasurePolygonAreaOperator.onTouchStart()

inherited

onTouchStart(event: TouchInputEvent): void

Base method for handling touch start events. It tracks the primary touch point and emulates a mouse down event using the touch position. If there is already an active touch, it ignores additional touch start events.

Parameters

event: TouchInputEvent

The touch start event to handle.

Returns: void

wv.Operators.Measure.MeasurePolygonAreaOperator.setAnchor()

setAnchor(anchor: MeasurePolygonAreaAnchor): void

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

Parameters

anchor: MeasurePolygonAreaAnchor

Returns: void

wv.Operators.Measure.MeasurePolygonAreaOperator.setHandled()

inherited

setHandled(): boolean

Base method for setting the handled state of events. By default, it returns false, but child classes can override this method to provide specific behavior for determining whether events should be marked as handled.

Returns: boolean

True if the event should be marked as handled, false otherwise.

wv.Operators.Measure.MeasurePolygonAreaOperator.setMapping()

inherited

setMapping(button: Button, modifier: KeyModifiers?): void

Sets the button and key modifier mapping for the operator.

Parameters

button: Button

modifier: KeyModifiers = KeyModifiers.None

Returns: void

wv.Operators.Measure.MeasurePolygonAreaOperator.stopInteraction()

inherited

Stops an operator from interacting with the scene.

stopInteraction(): void

Stops the current interaction by triggering the “endInteraction” event on the viewer, and resets the dragging state, drag count, and button modifier active state.

Returns: void

wv.Operators.Measure.MeasurePolygonAreaOperator._pickExisting()

_pickExisting(selectPoint: Point2): boolean

Parameters

selectPoint: Point2

Returns: boolean