Documentation - v19.2.0-dev
    Preparing search index...

    Class ViewportOperatorAbstract

    Abstract base class for viewport operators. This class should be inherited when building a new viewport operator.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    _viewport: Viewport

    The viewport the operator is operating on

    name: string
    needsValidation: boolean = false

    Indicates whether the operator needs to be validated validate to perform its action

    false
    
    stopCameraControlOnDrag: boolean = false

    Methods

    • Returns void

    • Clear the current operator

      Returns void

    • Initialize the current operator

      Returns void

    • Called by the viewport when the user press a key.

      Parameters

      • event: KeyboardEvent

      Returns void

    • Called by the viewport when the user unpress a key.

      Parameters

      • event: KeyboardEvent

      Returns void

    • Called by the viewport when the user clicks. This means a onPointerDown event followed by a onPointerUp event without any drag. By default, opens the context menu on right button.

      Parameters

      • event: PointerEvent

      Returns void

    • Called by the viewport when the user double clicks. This means a onPointerDown event followed by a onPointerUp event without any drag twice.

      Parameters

      • event: PointerEvent

      Returns void

    • Called by the viewport when the user presses the pointer.

      Parameters

      • event: PointerEvent

      Returns void

    • Called by the viewport when the user drags the pointer.

      Parameters

      • event: PointerEvent

      Returns void

    • Called by the viewport when the user moves the pointer.

      Parameters

      • event: PointerEvent

      Returns void

    • Called by the viewport when the user releases the pointer.

      Parameters

      • event: PointerEvent

      Returns void

    • Show the context menu

      Parameters

      Returns void

    • Validates the current action if applicable

      Returns void