Class Mouse

Hierarchy

Vector2
- Mouse

Constructors

constructor

new Mouse(x?: number, y?: number): Mouse
Parameters
- Optionalx: number
- Optionaly: number
Returns Mouse
Inherited from Vector2.constructor
- Defined in node_modules/@types/three/src/math/Vector2.d.ts:15

Properties

height

height: number

`Readonly`isVector2

isVector2: true

`Protected`lastClickTime

lastClickTime: number = 0

`Protected`pageX

pageX: number = ...

`Protected`pageY

pageY: number = ...

width

width: number

x

x: number

Default

y

y: number

Default

Methods

[iterator]

"[iterator]"(): Iterator<number>
Iterating through a Vector2 instance will yield its components (x, y) in the corresponding order.

Returns Iterator<number>
Inherited from Vector2.[iterator]
- Defined in node_modules/@types/three/src/math/Vector2.d.ts:320

add

add(v: Vector2Like): this
Adds v to this vector.
Parameters
- v: Vector2Like
Returns this
Inherited from Vector2.add
- Defined in node_modules/@types/three/src/math/Vector2.d.ts:73

addScalar

addScalar(s: number): this
Adds the scalar value s to this vector's x and y values.
Parameters
- s: number
Returns this
Inherited from Vector2.addScalar
- Defined in node_modules/@types/three/src/math/Vector2.d.ts:78

addScaledVector

addScaledVector(v: Vector2Like, s: number): this
Adds the multiple of v and s to this vector.
Parameters
- v: Vector2Like
- s: number
Returns this
Inherited from Vector2.addScaledVector
- Defined in node_modules/@types/three/src/math/Vector2.d.ts:88

addVectors

addVectors(a: Vector2Like, b: Vector2Like): this
Sets this vector to a + b.
Parameters
- a: Vector2Like
- b: Vector2Like
Returns this
Inherited from Vector2.addVectors
- Defined in node_modules/@types/three/src/math/Vector2.d.ts:83

angle

angle(): number
computes the angle in radians with respect to the positive x-axis

Returns number
Inherited from Vector2.angle
- Defined in node_modules/@types/three/src/math/Vector2.d.ts:225

angleTo

angleTo(v: Vector2): number
Returns the angle between this vector and vector Vector2 | v in radians.
Parameters
- v: Vector2
Returns number
Inherited from Vector2.angleTo
- Defined in node_modules/@types/three/src/math/Vector2.d.ts:230

applyMatrix3

applyMatrix3(m: Matrix3): this
Multiplies this vector (with an implicit 1 as the 3rd component) by m.
Parameters
- m: Matrix3
Returns this
Inherited from Vector2.applyMatrix3
- Defined in node_modules/@types/three/src/math/Vector2.d.ts:129

ceil

ceil(): this
The x and y components of the vector are rounded up to the nearest integer value.

Returns this
Inherited from Vector2.ceil
- Defined in node_modules/@types/three/src/math/Vector2.d.ts:173

clamp

clamp(min: Vector2Like, max: Vector2Like): this
If this vector's x or y value is greater than the max vector's x or y value, it is replaced by the corresponding value. If this vector's x or y value is less than the min vector's x or y value, it is replaced by the corresponding value.
Parameters
- min: Vector2Like
  the minimum x and y values.
- max: Vector2Like
  the maximum x and y values in the desired range.
Returns this
Inherited from Vector2.clamp
- Defined in node_modules/@types/three/src/math/Vector2.d.ts:147

clampLength

clampLength(min: number, max: number): this
If this vector's length is greater than the max value, it is replaced by the max value. If this vector's length is less than the min value, it is replaced by the min value.
Parameters
- min: number
  the minimum value the length will be clamped to.
- max: number
  the maximum value the length will be clamped to.
Returns this
Inherited from Vector2.clampLength
- Defined in node_modules/@types/three/src/math/Vector2.d.ts:163

`Protected`clampNumber

clampNumber(n: number): number
Parameters
- n: number
Returns number
- Defined in src/core/mouse.ts:69

clampScalar

clampScalar(min: number, max: number): this
If this vector's x or y values are greater than the max value, they are replaced by the max value. If this vector's x or y values are less than the min value, they are replaced by the min value.
Parameters
- min: number
  the minimum value the components will be clamped to.
- max: number
  the maximum value the components will be clamped to.
Returns this
Inherited from Vector2.clampScalar
- Defined in node_modules/@types/three/src/math/Vector2.d.ts:155

clampX

clampX(x: number, multiply: number): number
Parameters
- x: number
- multiply: number
Returns number
- Defined in src/core/mouse.ts:57

clampY

clampY(y: number, multiply: number): number
Parameters
- y: number
- multiply: number
Returns number
- Defined in src/core/mouse.ts:61

clone

clone(): this
Returns a new Vector2 instance with the same x and y values.

Returns this
Inherited from Vector2.clone
- Defined in node_modules/@types/three/src/math/Vector2.d.ts:63

copy

copy(v: Vector2Like): this
Copies value of v to this vector.
Parameters
- v: Vector2Like
Returns this
Inherited from Vector2.copy
- Defined in node_modules/@types/three/src/math/Vector2.d.ts:68

cross

cross(v: Vector2Like): number
Computes cross product of this vector and v.
Parameters
- v: Vector2Like
Returns number
Inherited from Vector2.cross
- Defined in node_modules/@types/three/src/math/Vector2.d.ts:198

distanceTo

distanceTo(v: Vector2Like): number
Computes distance of this vector to v.
Parameters
- v: Vector2Like
Returns number
Inherited from Vector2.distanceTo
- Defined in node_modules/@types/three/src/math/Vector2.d.ts:235

distanceToSquared

distanceToSquared(v: Vector2Like): number
Computes squared distance of this vector to v.
Parameters
- v: Vector2Like
Returns number
Inherited from Vector2.distanceToSquared
- Defined in node_modules/@types/three/src/math/Vector2.d.ts:240

divide

divide(v: Vector2Like): this
Divides this vector by v.
Parameters
- v: Vector2Like
Returns this
Inherited from Vector2.divide
- Defined in node_modules/@types/three/src/math/Vector2.d.ts:118

divideScalar

divideScalar(s: number): this
Divides this vector by scalar s. Set vector to ( 0, 0 ) if s == 0.
Parameters
- s: number
Returns this
Inherited from Vector2.divideScalar
- Defined in node_modules/@types/three/src/math/Vector2.d.ts:124

dot

dot(v: Vector2Like): number
Computes dot product of this vector and v.
Parameters
- v: Vector2Like
Returns number
Inherited from Vector2.dot
- Defined in node_modules/@types/three/src/math/Vector2.d.ts:193

equals

equals(v: Vector2Like): boolean
Checks for strict equality of this vector and v.
Parameters
- v: Vector2Like
Returns boolean
Inherited from Vector2.equals
- Defined in node_modules/@types/three/src/math/Vector2.d.ts:272

floor

floor(): this
The components of the vector are rounded down to the nearest integer value.

Returns this
Inherited from Vector2.floor
- Defined in node_modules/@types/three/src/math/Vector2.d.ts:168

fromArray

fromArray(array: number[] | ArrayLike<number>, offset?: number): this
Sets this vector's x and y value from the provided array or array-like.
Parameters
- array: number[] | ArrayLike<number>
  the source array or array-like.
- Optionaloffset: number
  (optional) offset into the array. Default is 0.
Returns this
Inherited from Vector2.fromArray
- Defined in node_modules/@types/three/src/math/Vector2.d.ts:279

fromBufferAttribute

fromBufferAttribute(attribute: BufferAttribute, index: number): this
Sets this vector's x and y values from the attribute.
Parameters
- attribute: BufferAttribute
  the source attribute.
- index: number
  index in the attribute.
Returns this
Inherited from Vector2.fromBufferAttribute
- Defined in node_modules/@types/three/src/math/Vector2.d.ts:303

getCenterY

getCenterY(): number
Returns number
- Defined in src/core/mouse.ts:49

getComponent

getComponent(index: number): number
Gets a component of this vector.
Parameters
- index: number
Returns number
Inherited from Vector2.getComponent
- Defined in node_modules/@types/three/src/math/Vector2.d.ts:58

getMultiply

getMultiply(): number
Returns number
- Defined in src/core/mouse.ts:53

length

length(): number
Computes length of this vector.

Returns number
Inherited from Vector2.length
- Defined in node_modules/@types/three/src/math/Vector2.d.ts:208

lengthSq

lengthSq(): number
Computes squared length of this vector.

Returns number
Inherited from Vector2.lengthSq
- Defined in node_modules/@types/three/src/math/Vector2.d.ts:203

lerp

lerp(v: Vector2Like, alpha: number): this
Linearly interpolates between this vector and v, where alpha is the distance along the line - alpha = 0 will be this vector, and alpha = 1 will be v.
Parameters
- v: Vector2Like
  vector to interpolate towards.
- alpha: number
  interpolation factor in the closed interval [0, 1].
Returns this
Inherited from Vector2.lerp
- Defined in node_modules/@types/three/src/math/Vector2.d.ts:259

lerpVectors

lerpVectors(v1: Vector2Like, v2: Vector2Like, alpha: number): this
Sets this vector to be the vector linearly interpolated between v1 and v2 where alpha is the distance along the line connecting the two vectors - alpha = 0 will be v1, and alpha = 1 will be v2.
Parameters
- v1: Vector2Like
  the starting vector.
- v2: Vector2Like
  vector to interpolate towards.
- alpha: number
  interpolation factor in the closed interval [0, 1].
Returns this
Inherited from Vector2.lerpVectors
- Defined in node_modules/@types/three/src/math/Vector2.d.ts:267

manhattanDistanceTo

manhattanDistanceTo(v: Vector2Like): number
Computes the Manhattan length (distance) from this vector to the given vector v

see Taxicab Geometry
Parameters
- v: Vector2Like
Returns number
Inherited from Vector2.manhattanDistanceTo
- Defined in node_modules/@types/three/src/math/Vector2.d.ts:247

manhattanLength

manhattanLength(): number
Computes the Manhattan length of this vector.

see Taxicab Geometry

Returns number
Inherited from Vector2.manhattanLength
- Defined in node_modules/@types/three/src/math/Vector2.d.ts:215

max

max(v: Vector2Like): this
If this vector's x or y value is less than v's x or y value, replace that value with the corresponding max value.
Parameters
- v: Vector2Like
Returns this
Inherited from Vector2.max
- Defined in node_modules/@types/three/src/math/Vector2.d.ts:139

min

min(v: Vector2Like): this
If this vector's x or y value is greater than v's x or y value, replace that value with the corresponding min value.
Parameters
- v: Vector2Like
Returns this
Inherited from Vector2.min
- Defined in node_modules/@types/three/src/math/Vector2.d.ts:134

multiply

multiply(v: Vector2Like): this
Multiplies this vector by v.
Parameters
- v: Vector2Like
Returns this
Inherited from Vector2.multiply
- Defined in node_modules/@types/three/src/math/Vector2.d.ts:108

multiplyScalar

multiplyScalar(scalar: number): this
Multiplies this vector by scalar s.
Parameters
- scalar: number
Returns this
Inherited from Vector2.multiplyScalar
- Defined in node_modules/@types/three/src/math/Vector2.d.ts:113

negate

negate(): this
Inverts this vector.

Returns this
Inherited from Vector2.negate
- Defined in node_modules/@types/three/src/math/Vector2.d.ts:188

normalize

normalize(): this
Normalizes this vector.

Returns this
Inherited from Vector2.normalize
- Defined in node_modules/@types/three/src/math/Vector2.d.ts:220

onPointerDown

onPointerDown(event: PointerEvent): void
Parameters
- event: PointerEvent
Returns void
- Defined in src/core/mouse.ts:9

onPointerMove

onPointerMove(event: MouseEvent | TouchEvent): void
Parameters
- event: MouseEvent | TouchEvent
Returns void
- Defined in src/core/mouse.ts:34

onPointerUp

onPointerUp(event: PointerEvent | TouchEvent): void
Parameters
- event: PointerEvent | TouchEvent
Returns void
- Defined in src/core/mouse.ts:25

preventEvent

preventEvent(event: Event): void
Parameters
- event: Event
Returns void
- Defined in src/core/mouse.ts:65

random

random(): this
Sets this vector's x and y from Math.random

Returns this
Inherited from Vector2.random
- Defined in node_modules/@types/three/src/math/Vector2.d.ts:315

rotateAround

rotateAround(center: Vector2Like, angle: number): this
Rotates the vector around center by angle radians.
Parameters
- center: Vector2Like
  the point around which to rotate.
- angle: number
  the angle to rotate, in radians.
Returns this
Inherited from Vector2.rotateAround
- Defined in node_modules/@types/three/src/math/Vector2.d.ts:310

round

round(): this
The components of the vector are rounded to the nearest integer value.

Returns this
Inherited from Vector2.round
- Defined in node_modules/@types/three/src/math/Vector2.d.ts:178

roundToZero

roundToZero(): this
The components of the vector are rounded towards zero (up if negative, down if positive) to an integer value.

Returns this
Inherited from Vector2.roundToZero
- Defined in node_modules/@types/three/src/math/Vector2.d.ts:183

set

set(x: number, y: number): this
Sets value of this vector.
Parameters
- x: number
- y: number
Returns this
Inherited from Vector2.set
- Defined in node_modules/@types/three/src/math/Vector2.d.ts:33

setComponent

setComponent(index: number, value: number): this
Sets a component of this vector.
Parameters
- index: number
- value: number
Returns this
Inherited from Vector2.setComponent
- Defined in node_modules/@types/three/src/math/Vector2.d.ts:53

setLength

setLength(length: number): this
Normalizes this vector and multiplies it by l.
Parameters
- length: number
Returns this
Inherited from Vector2.setLength
- Defined in node_modules/@types/three/src/math/Vector2.d.ts:252

setScalar

setScalar(scalar: number): this
Sets the x and y values of this vector both equal to scalar.
Parameters
- scalar: number
Returns this
Inherited from Vector2.setScalar
- Defined in node_modules/@types/three/src/math/Vector2.d.ts:38

setX

setX(x: number): this
Sets X component of this vector.
Parameters
- x: number
Returns this
Inherited from Vector2.setX
- Defined in node_modules/@types/three/src/math/Vector2.d.ts:43

setY

setY(y: number): this
Sets Y component of this vector.
Parameters
- y: number
Returns this
Inherited from Vector2.setY
- Defined in node_modules/@types/three/src/math/Vector2.d.ts:48

sub

sub(v: Vector2Like): this
Subtracts v from this vector.
Parameters
- v: Vector2Like
Returns this
Inherited from Vector2.sub
- Defined in node_modules/@types/three/src/math/Vector2.d.ts:93

subScalar

subScalar(s: number): this
Subtracts s from this vector's x and y components.
Parameters
- s: number
Returns this
Inherited from Vector2.subScalar
- Defined in node_modules/@types/three/src/math/Vector2.d.ts:98

subVectors

subVectors(a: Vector2Like, b: Vector2Like): this
Sets this vector to a - b.
Parameters
- a: Vector2Like
- b: Vector2Like
Returns this
Inherited from Vector2.subVectors
- Defined in node_modules/@types/three/src/math/Vector2.d.ts:103

toArray

toArray(array?: number[], offset?: number): number[]
Returns an array [x, y], or copies x and y into the provided array.
Parameters
- Optionalarray: number[]
  (optional) array to store the vector to. If this is not provided, a new array will be created.
- Optionaloffset: number
  (optional) optional offset into the array.
Returns number[]
The created or provided array.
Inherited from Vector2.toArray
- Defined in node_modules/@types/three/src/math/Vector2.d.ts:287
toArray(array?: Vector2Tuple, offset?: 0): Vector2Tuple
Returns an array [x, y], or copies x and y into the provided array.
Parameters
- Optionalarray: Vector2Tuple
  (optional) array to store the vector to. If this is not provided, a new array will be created.
- Optionaloffset: 0
  (optional) optional offset into the array.
Returns Vector2Tuple
The created or provided array.
Inherited from Vector2.toArray
- Defined in node_modules/@types/three/src/math/Vector2.d.ts:288
toArray(array: ArrayLike<number>, offset?: number): ArrayLike<number>
Copies x and y into the provided array-like.
Parameters
- array: ArrayLike<number>
  array-like to store the vector to.
- Optionaloffset: number
  (optional) optional offset into the array.
Returns ArrayLike<number>
The provided array-like.
Inherited from Vector2.toArray
- Defined in node_modules/@types/three/src/math/Vector2.d.ts:296

updateMouseXY

updateMouseXY(): void
Returns void
- Defined in src/core/mouse.ts:43

Class Mouse

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Mouse

Properties

height

ReadonlyisVector2

ProtectedlastClickTime

ProtectedpageX

ProtectedpageY

width

x

Default

y

Default

Methods

[iterator]

Returns Iterator<number>

add

Parameters

Returns this

addScalar

Parameters

Returns this

addScaledVector

Parameters

Returns this

addVectors

Parameters

Returns this

angle

Returns number

angleTo

Parameters

Returns number

applyMatrix3

Parameters

Returns this

ceil

Returns this

clamp

Parameters

Returns this

clampLength

Parameters

Returns this

ProtectedclampNumber

Parameters

Returns number

clampScalar

Parameters

Returns this

clampX

Parameters

Returns number

clampY

Parameters

Returns number

clone

Returns this

copy

Parameters

Returns this

cross

Parameters

Returns number

distanceTo

Parameters

Returns number

distanceToSquared

Parameters

Returns number

divide

Parameters

`Readonly`isVector2

`Protected`lastClickTime

`Protected`pageX

`Protected`pageY

`Protected`clampNumber