# 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 `cee.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 `cee.Viewer` sets the events listeners internally, and then fires the corresponding Operator event handler method when the event is recieved.

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

`NavigationOperator.``constructor`(name)

  Arguments: | name (`string`) – None
  Return type: | NavigationOperator

## Accessors

`NavigationOperator.``config`()

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

  Return type: | OperatorConfig <NavigationType>

`NavigationOperator.``config`(config)

  Arguments: | config (`OperatorConfig`) – None
  Return type: | void

`NavigationOperator.``invertWalkZoom`()

  Invert the zoom direction of the mouse wheel

  Return type: | boolean

`NavigationOperator.``invertWalkZoom`(invert)

  Arguments: | invert (`boolean`) – None
  Return type: | void

`NavigationOperator.``minWalkTargetDistance`()

  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.

  Return type: | number

`NavigationOperator.``minWalkTargetDistance`(minTargetDistance)

  Arguments: | minTargetDistance (`number`) – None
  Return type: | void

`NavigationOperator.``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.

  Return type: | MouseWheelZoomAndWalkBehavior

`NavigationOperator.``mouseWheelZoomAndWalkBehavior`(behavior)

  Arguments: | behavior (`MouseWheelZoomAndWalkBehavior`) – None
  Return type: | void

`NavigationOperator.``name`()

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

  Return type: | string

`NavigationOperator.``ownerView`()

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

  Return type: | View

`NavigationOperator.``rotationAxis`()

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

  Return type: | Vec3Like

`NavigationOperator.``rotationAxis`(axis)

  Arguments: | axis (`Vec3Like`) – None
  Return type: | void

`NavigationOperator.``rotationPoint`()

  The current rotation point

  Return type: | Vec3Like

`NavigationOperator.``rotationPoint`(rotationPoint)

  Arguments: | rotationPoint (`Vec3Like`) – None
  Return type: | void

`NavigationOperator.``rotationSensitivity`()

  Rotation sensitivity

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

  Default 1.0

  Return type: | number

`NavigationOperator.``rotationSensitivity`(sensitivity)

  Arguments: | sensitivity (`number`) – None
  Return type: | void

## Methods

### onAddedToView

`NavigationOperator.``onAddedToView`()

  Return type: | void

### onClick

`NavigationOperator.``onClick`(event)

  Arguments: | event (`MouseEvent`) – None
  Return type: | OperatorEventStatus

### onDblClick

`NavigationOperator.``onDblClick`(event)

  Arguments: | event (`MouseEvent`) – None
  Return type: | OperatorEventStatus

### onKeyDown

`NavigationOperator.``onKeyDown`(event)

  Arguments: | event (`KeyboardEvent`) – None
  Return type: | OperatorEventStatus

### onKeyUp

`NavigationOperator.``onKeyUp`(event)

  Arguments: | event (`KeyboardEvent`) – None
  Return type: | OperatorEventStatus

### onMouseDown

`NavigationOperator.``onMouseDown`(event)

  Arguments: | event (`MouseEvent`) – None
  Return type: | OperatorEventStatus

### onMouseMove

`NavigationOperator.``onMouseMove`(event)

  Arguments: | event (`MouseEvent`) – None
  Return type: | OperatorEventStatus

### onMouseUp

`NavigationOperator.``onMouseUp`(event)

  Arguments: | event (`MouseEvent`) – None
  Return type: | OperatorEventStatus

### onPointerDown

`NavigationOperator.``onPointerDown`(event)

  Arguments: | event (`PointerEvent`) – None
  Return type: | OperatorEventStatus

### onPointerMove

`NavigationOperator.``onPointerMove`(event)

  Arguments: | event (`PointerEvent`) – None
  Return type: | OperatorEventStatus

### onPointerUp

`NavigationOperator.``onPointerUp`(event)

  Arguments: | event (`PointerEvent`) – None
  Return type: | OperatorEventStatus

### onRemovedFromView

`NavigationOperator.``onRemovedFromView`()

  Return type: | void

### onTouchEnd

`NavigationOperator.``onTouchEnd`(event)

  Arguments: | event (`TouchEvent`) – None
  Return type: | OperatorEventStatus

### onTouchMove

`NavigationOperator.``onTouchMove`(event)

  Arguments: | event (`TouchEvent`) – None
  Return type: | OperatorEventStatus

### onTouchStart

`NavigationOperator.``onTouchStart`(event)

  Arguments: | event (`TouchEvent`) – None
  Return type: | OperatorEventStatus

### onWheel

`NavigationOperator.``onWheel`(event)

  Arguments: | event (`WheelEvent`) – None
  Return type: | OperatorEventStatus

### resetRotationPoint

`NavigationOperator.``resetRotationPoint`()

  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.

  Return type: | boolean

Conversation saved
HOOPSY BETA

### Hello! I'm HOOPSY

Your multilingual generative AI assistant for documentation. Ask me anything about HOOPS Envision for Web in your own language, or choose a sample question below to start a conversation:

What is HOOPS Envision for Web?
What are the latest release notes for HOOPS Envision for Web?
How do I start evaluating HOOPS Envision for Web?
How do I write my first sample application?
How can I get assistance?

HOOPSY may store conversations according to OpenAI's policy. Responses may not always be accurate.

HOOPSY is thinking...