Operator

class cee.Operator()

The Operator class is the base class for all operators. A name is required for all operators, and the name is used to identify the operator in the OperatorStack.

Operators contain optional methods that correspond to the different events that may occur in the view. When an operator is set on a View, the operator can interact with its ownerView, but only that view. The Viewer sets the events listeners internally, and then fires the corresponding Operator event handler method when the event is recieved.

Index

Constructors

• constructor

Accessors

• name
• ownerView

Methods

• onAddedToView
• onClick
• onDblClick
• onKeyDown
• onKeyUp
• onMouseDown
• onMouseMove
• onMouseUp
• onPointerDown
• onPointerMove
• onPointerUp
• onRemovedFromView
• onTouchEnd
• onTouchMove
• onTouchStart
• onWheel

Constructors

cee.Operator.constructor()

Operator(name: string): Operator

Parameters

name: string

Returns: Operator

Accessors

cee.Operator.name()

get name(): string

The name of the operator. Built-in operator names can be referenced by the StandardOperator enum.

Returns: string

cee.Operator.ownerView()

get ownerView(): View

Returns the View that this operator is set on. If the operator is not on a view’s OperatorStack, null is returned.

Returns: View

Methods

cee.Operator.onAddedToView()

optional

onAddedToView(): void

Returns: void

cee.Operator.onClick()

optional

onClick(event: MouseEvent): OperatorEventStatus

Parameters

event: MouseEvent

Returns: OperatorEventStatus

cee.Operator.onDblClick()

optional

onDblClick(event: MouseEvent): OperatorEventStatus

Parameters

event: MouseEvent

Returns: OperatorEventStatus

cee.Operator.onKeyDown()

optional

onKeyDown(event: KeyboardEvent): OperatorEventStatus

Parameters

event: KeyboardEvent

Returns: OperatorEventStatus

cee.Operator.onKeyUp()

optional

onKeyUp(event: KeyboardEvent): OperatorEventStatus

Parameters

event: KeyboardEvent

Returns: OperatorEventStatus

cee.Operator.onMouseDown()

optional

onMouseDown(event: MouseEvent): OperatorEventStatus

Parameters

event: MouseEvent

Returns: OperatorEventStatus

cee.Operator.onMouseMove()

optional

onMouseMove(event: MouseEvent): OperatorEventStatus

Parameters

event: MouseEvent

Returns: OperatorEventStatus

cee.Operator.onMouseUp()

optional

onMouseUp(event: MouseEvent): OperatorEventStatus

Parameters

event: MouseEvent

Returns: OperatorEventStatus

cee.Operator.onPointerDown()

optional

onPointerDown(event: PointerEvent): OperatorEventStatus

Parameters

event: PointerEvent

Returns: OperatorEventStatus

cee.Operator.onPointerMove()

optional

onPointerMove(event: PointerEvent): OperatorEventStatus

Parameters

event: PointerEvent

Returns: OperatorEventStatus

cee.Operator.onPointerUp()

optional

onPointerUp(event: PointerEvent): OperatorEventStatus

Parameters

event: PointerEvent

Returns: OperatorEventStatus

cee.Operator.onRemovedFromView()

optional

onRemovedFromView(): void

Returns: void

cee.Operator.onTouchEnd()

optional

onTouchEnd(event: TouchEvent): OperatorEventStatus

Parameters

event: TouchEvent

Returns: OperatorEventStatus

cee.Operator.onTouchMove()

optional

onTouchMove(event: TouchEvent): OperatorEventStatus

Parameters

event: TouchEvent

Returns: OperatorEventStatus

cee.Operator.onTouchStart()

optional

onTouchStart(event: TouchEvent): OperatorEventStatus

Parameters

event: TouchEvent

Returns: OperatorEventStatus

cee.Operator.onWheel()

optional

onWheel(event: WheelEvent): OperatorEventStatus

Parameters

event: WheelEvent

Returns: OperatorEventStatus