CuttingPlaneOperator

class Communicator.Operator.CuttingPlaneOperator()

Constructors

• constructor()

Methods

• addMapping()

• clearMapping()

• onMouseDown()

• onMouseMove()

• onMouseUp()

• setHandled()

• setMapping()

---

Constructors

CuttingPlaneOperator.constructor(viewer, cuttingManager)

Arguments

• viewer (WebViewer()) –

• cuttingManager (CuttingManager()) –

Return type

CuttingPlaneOperator()

Methods

addMapping

CuttingPlaneOperator.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 (Button) –

• modifier (KeyModifiers) – optional

Return type

void

clearMapping

CuttingPlaneOperator.clearMapping()

Clears any button and key modifier mappings for the operator.

Return type

void

onMouseDown

CuttingPlaneOperator.onMouseDown(event)

Arguments

• event (MouseInputEvent()) –

Return type

Promise <void>

onMouseMove

CuttingPlaneOperator.onMouseMove(event)

Arguments

• event (MouseInputEvent()) –

Return type

Promise <void>

onMouseUp

CuttingPlaneOperator.onMouseUp(event)

Arguments

• event (MouseInputEvent()) –

Return type

Promise <void>

setHandled

CuttingPlaneOperator.setHandled()

Return type

boolean

setMapping

CuttingPlaneOperator.setMapping(button[, modifier])

Sets the button and key modifier mapping for the operator.

Arguments

• button (Button) –

• modifier (KeyModifiers) – optional

Return type

void