Class: Mouse
マウスの制御を行います。
このクラスはnegl内部でインスタンス化され、mouseオブジェクトとして提供されます。
取得方法
import { mouse } from "negl";
// or
window.negl.mouseTable of contents
Properties
Methods
Properties
current
• current: MouseState
アニメーション用のマウス座標が存在する位置を保持します。
[アニメーション用のマウス座標]
mouse オブジェクトではブラウザのデフォルトのマウスカーソルから少し遅れた位置を current に保持しています。これによって、マウスに追従する独自のスタイルを実装することができます。どの程度遅延させるかは config.mouse.speed プロパティで設定します。
delta
• delta: MouseState
ブラウザのマウスカーソル位置にアニメーション用のマウス座標の位置の変化量を保持します。
initial
• initial: MouseState
マウスカーソルの初期値を保持します。
speed
• speed: number = config.mouse.speed
マウスのアニメーション座標をブラウザのデフォルトのカーソル位置にどの程度の速度で追従させるかを数値で保持します。
config.mouse.speed プロパティに設定された値がこのプロパティに設定されます。
target
• target: MouseState
ブラウザのマウスカーソルの存在する位置を保持します。
tick
• tick: number = 0
マウスの位置が更新された回数を保持します。
Methods
getClipPos
▸ getClipPos(): Object
マウス位置をクリップ座標で返します。
Returns
Object
| Name | Type |
|---|---|
x | number |
y | number |
getMapPos
▸ getMapPos(width, height): Object
マウス位置を画面中央を0とした際の任意のスケールの座標で返します。
Parameters
| Name | Type |
|---|---|
width | number |
height | number |
Returns
Object
| Name | Type |
|---|---|
x | number |
y | number |
getUvPos
▸ getUvPos(): Object
マウス位置をUV座標で返します。
Returns
Object
| Name | Type |
|---|---|
x | number |
y | number |
isUpdate
▸ isUpdate(): boolean
マウス座標が前回の位置から変更されている場合は true、それ以外は false を返します。
Returns
boolean
setTarget
▸ setTarget(newTarget): void
newTarget のプロパティを target オブジェクトに上書きします。
Parameters
| Name | Type |
|---|---|
newTarget | Partial<MouseState> |
Returns
void
startTrackMousePos
▸ startTrackMousePos(): void
マウスの座標の更新をスタートする際に使用します。
Returns
void