API Docs

Class: MouseArrow

PD. MouseArrow

A mesh for simulating a mouse/pointer arrow during canvas recording.

To illustrate button presses and releases, the mesh also includes a mouse-shaped button indicator which reacts to mouse/pointer events.

     0                                        /
      +_                              _______+_______
      : \__                         _/    |     |    \_
      :    \__                     |      |     |      |
      :       \__                  |      |     |      |
      :          \__               |      |     |      |
      :             \__            |------+-----+------|
      :   2   5 _______'+ 6        |                   |
      :   ,\    \                  |                   |
      : ,'  \    \                 |                   |
      +      \    \                |                   |
      1       \  _.+               |_                 _|
               +'    4               \_______________/
               3

new MouseArrow()

Creates a new arrow indicator for simulating the mouse arrow.

Author:
  • drajmarsh

Extends

  • THREE.Mesh

Members

:boolean

isPointerArrow <readonly>

A flag identifying this object as a pointer arrow.

Type
  • boolean

Methods

buttonDown(button, state)

Displays a button as pressed.

Parameters:
Name Type Description
button PD.MOUSE_BTN

The button to show as pressed.
state boolean

Whether to press (true) or release (false) the button.

isButtonDown( [button], state)

Displays a button as pressed.

Parameters:
Name Type Argument Default Description
button PD.MOUSE_BTN <optional>
 0

The button to check, defaults to any button.
state boolean

Whether to press (true) or release (false) the button.