Mouse

Mouse.getPosition()

getPosition(): Mouse.Position;

マウス位置を取得します。

• TypeScript
• JavaScript

const position = Atarabi.mouse.getPosition();
alert(`X: ${position.x}, Y: ${position.y}`);

var position = Atarabi.mouse.getPosition();
alert("X: ".concat(position.x, ", Y: ").concat(position.y));

Added in version 0.3.0.

Mouse.hook()

hook(click: Mouse.Click, fn: Mouse.HookFunc): Uuid;

マウス入力をフックします。 fn が true を返した場合、デフォルトの処理が無視され、 false を返した場合、続いてデフォルトの処理が実行されます。

• TypeScript
• JavaScript

// ダブルミドルクリックをするとコンポをつくる。
const uuid = Atarabi.mouse.hook({ button: 'Middle', count: 2 }, ctx => {
    app.project.items.addComp('Comp', 1000, 1000, 1, 100, 30);
    return true; // trueを返した場合、デフォルトの処理が呼ばれなくなる。
});

// ダブルミドルクリックをするとコンポをつくる。
var uuid = Atarabi.mouse.hook({ button: 'Middle', count: 2 }, function (ctx) {
    app.project.items.addComp('Comp', 1000, 1000, 1, 100, 30);
    return true; // trueを返した場合、デフォルトの処理が呼ばれなくなる。
});

Added in version 0.3.0.

Mouse.unhook()

unhook(uuid: Uuid): void;

マウス入力のフックを解除します。

• TypeScript
• JavaScript

const uuid = Atarabi.mouse.hook({ button: 'Middle', count: 2 }, ctx => {
    alert('C');
    return true;
});

Atarabi.mouse.unhook(uuid);

var uuid = Atarabi.mouse.hook({ button: 'Middle', count: 2 }, function (ctx) {
    alert('C');
    return true;
});
Atarabi.mouse.unhook(uuid);

Added in version 0.3.0.

Mouse.enableHook()

enableHook(enable: boolean): void;

フック機能をオンorオフにします。

• TypeScript
• JavaScript

Atarabi.mouse.enableHook(false);

Atarabi.mouse.enableHook(false);

Added in version 0.3.0.

Mouse.enableHookByUuid()

enableHookByUuid(uuid: Uuid, enable: boolean): void;

個別のフックに対してオンorオフにします。

• TypeScript
• JavaScript

const uuid = Atarabi.mouse.hook({ button: 'Middle', count: 2 }, ctx => {
    alert('D');
    return true;
});

Atarabi.mouse.enableHookByUuid(uuid, false);

var uuid = Atarabi.mouse.hook({ button: 'Middle', count: 2 }, function (ctx) {
    alert('D');
    return true;
});
Atarabi.mouse.enableHookByUuid(uuid, false);

Added in version 0.3.0.

Mouse.sendClick()

sendClick(click: Mouse.Click): void;

マウス入力をします。

• TypeScript
• JavaScript

// ダブル左クリック
Atarabi.mouse.sendClick({ button: 'Left', count: 2 });

 // ダブル左クリック
Atarabi.mouse.sendClick({ button: 'Left', count: 2 });

Added in version 0.3.0.