NavigationOperator

class cee.NavigationOperator()

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

• config
• invertWalkZoom
• minWalkTargetDistance
• mouseWheelZoomAndWalkBehavior
• name
• ownerView
• rotationAxis
• rotationPoint
• rotationSensitivity

Methods

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

Constructors

cee.NavigationOperator.constructor()

NavigationOperator(name: string?): NavigationOperator

Parameters

name: string = StandardOperator.NAVIGATION

Returns: NavigationOperator

Accessors

cee.NavigationOperator.config()

get config(): OperatorConfig<NavigationType>

The navigation configuration. Specify what should happen on mouse and touch input

Returns: OperatorConfig<NavigationType>

set config(config: OperatorConfig<NavigationType>): void

Parameters

config: OperatorConfig<NavigationType>

Returns: void

cee.NavigationOperator.invertWalkZoom()

get invertWalkZoom(): boolean

Invert the zoom direction of the mouse wheel

Returns: boolean

set invertWalkZoom(invert: boolean): void

Parameters

invert: boolean

Returns: void

cee.NavigationOperator.minWalkTargetDistance()

get minWalkTargetDistance(): number

The minimum walk target minTargetDistance

For walk navigation, this is used to control how much the navigation should slow down when getting close to the rotation point. The walk speed is dynamic so you can interact with large models. Depending on your model size, you might want to adjust this parameter.

The default is undefined (automatic), which will be interpreted as 1/10 of the current view bounding box.

Returns: number

set minWalkTargetDistance(minTargetDistance: number): void

Parameters

minTargetDistance: number

Returns: void

cee.NavigationOperator.mouseWheelZoomAndWalkBehavior()

get mouseWheelZoomAndWalkBehavior(): MouseWheelZoomAndWalkBehavior

Determine mouse wheel zoom and walk behavior

This setting will only have effect if mouse wheel is configured to perform zoom or walk navigation.

Returns: MouseWheelZoomAndWalkBehavior

set mouseWheelZoomAndWalkBehavior(behavior: MouseWheelZoomAndWalkBehavior): void

Parameters

behavior: MouseWheelZoomAndWalkBehavior

Returns: void

cee.NavigationOperator.name()

inherited

get name(): string

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

Returns: string

cee.NavigationOperator.ownerView()

inherited

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

cee.NavigationOperator.rotationAxis()

get rotationAxis(): Vec3Like

An optional user provided axis around which the model should be rotated. Set to null to not constrain rotation to an axis (default).

Returns: Vec3Like

set rotationAxis(axis: Vec3Like): void

Parameters

axis: Vec3Like

Returns: void

cee.NavigationOperator.rotationPoint()

get rotationPoint(): Vec3Like

The current rotation point

Returns: Vec3Like

set rotationPoint(rotationPoint: Vec3Like): void

Parameters

rotationPoint: Vec3Like

Returns: void

cee.NavigationOperator.rotationSensitivity()

get rotationSensitivity(): number

Rotation sensitivity

Sensitivity factor controlling how sensitive the mouse is when doing rotations.

Default 1.0

Returns: number

set rotationSensitivity(sensitivity: number): void

Parameters

sensitivity: number

Returns: void

Methods

cee.NavigationOperator.onAddedToView()

onAddedToView(): void

Returns: void

cee.NavigationOperator.onClick()

optional inherited

onClick(event: MouseEvent): OperatorEventStatus

Parameters

event: MouseEvent

Returns: OperatorEventStatus

cee.NavigationOperator.onDblClick()

optional inherited

onDblClick(event: MouseEvent): OperatorEventStatus

Parameters

event: MouseEvent

Returns: OperatorEventStatus

cee.NavigationOperator.onKeyDown()

optional inherited

onKeyDown(event: KeyboardEvent): OperatorEventStatus

Parameters

event: KeyboardEvent

Returns: OperatorEventStatus

cee.NavigationOperator.onKeyUp()

optional inherited

onKeyUp(event: KeyboardEvent): OperatorEventStatus

Parameters

event: KeyboardEvent

Returns: OperatorEventStatus

cee.NavigationOperator.onMouseDown()

onMouseDown(event: MouseEvent): OperatorEventStatus

Parameters

event: MouseEvent

Returns: OperatorEventStatus

cee.NavigationOperator.onMouseMove()

onMouseMove(event: MouseEvent): OperatorEventStatus

Parameters

event: MouseEvent

Returns: OperatorEventStatus

cee.NavigationOperator.onMouseUp()

onMouseUp(event: MouseEvent): OperatorEventStatus

Parameters

event: MouseEvent

Returns: OperatorEventStatus

cee.NavigationOperator.onPointerDown()

optional inherited

onPointerDown(event: PointerEvent): OperatorEventStatus

Parameters

event: PointerEvent

Returns: OperatorEventStatus

cee.NavigationOperator.onPointerMove()

optional inherited

onPointerMove(event: PointerEvent): OperatorEventStatus

Parameters

event: PointerEvent

Returns: OperatorEventStatus

cee.NavigationOperator.onPointerUp()

optional inherited

onPointerUp(event: PointerEvent): OperatorEventStatus

Parameters

event: PointerEvent

Returns: OperatorEventStatus

cee.NavigationOperator.onRemovedFromView()

optional inherited

onRemovedFromView(): void

Returns: void

cee.NavigationOperator.onTouchEnd()

onTouchEnd(event: TouchEvent): OperatorEventStatus

Parameters

event: TouchEvent

Returns: OperatorEventStatus

cee.NavigationOperator.onTouchMove()

onTouchMove(event: TouchEvent): OperatorEventStatus

Parameters

event: TouchEvent

Returns: OperatorEventStatus

cee.NavigationOperator.onTouchStart()

onTouchStart(event: TouchEvent): OperatorEventStatus

Parameters

event: TouchEvent

Returns: OperatorEventStatus

cee.NavigationOperator.onWheel()

onWheel(event: WheelEvent): OperatorEventStatus

Parameters

event: WheelEvent

Returns: OperatorEventStatus

cee.NavigationOperator.resetRotationPoint()

resetRotationPoint(): boolean

Reset the rotation point to the bounding box center of all models in the owner view. If the operator does not have a valid view bounding box, the rotation point will not be modified and the function will return false.

Returns: boolean