Home Reference Source

import {Mouse} from 'penvas/src/mouse.js'

public class | source

Mouse

Mouse service

Example:

let tile = { x: 10, y: 10, width: 32, height: 32 };
if (mouse.isOver(tile)) {
    tile.backgroundColor = 'red';
}

Constructor Summary

Public Constructor
public	constructor()

Member Summary

Public Members
public	ax: number
public	ay: number
public	scaleX: number
public	scaleY: number
public	x: number
public	y: number

Method Summary

Public Methods
public	getAngle(target: Object): number
public	isClickOn(object: Object): boolean Check if mouse click and is over object
public	isClickOut(object: Object): boolean Check if mouse click and is out of object
public	isOut(object: Object): boolean Check if mouse is out of object
public	isOver(object: Object): boolean Check if mouse is over object

Protected Methods
protected	hasCollision(object: Object): boolean Check if mouse coordinates has collisions with object

Public Constructors

public constructor() source

Public Members

public ax: number source

public ay: number source

public scaleX: number source

public scaleY: number source

public x: number source

public y: number source

Public Methods

public getAngle(target: Object): number source

Params:

Name	Type	Attribute	Description
target	Object
target.x	number
target.y	number
target.width	number

Return:

public isClickOn(object: Object): boolean source

Check if mouse click and is over object

Params:

Name	Type	Attribute	Description
object	Object
object.x	number
object.y	number
object.width	number
object.height	number

Return:

public isClickOut(object: Object): boolean source

Check if mouse click and is out of object

Params:

Name	Type	Attribute	Description
object	Object
object.x	number
object.y	number
object.width	number
object.height	number

Return:

public isOut(object: Object): boolean source

Check if mouse is out of object

Params:

Name	Type	Attribute	Description
object	Object
object.x	number
object.y	number
object.width	number
object.height	number

Return:

public isOver(object: Object): boolean source

Check if mouse is over object

Params:

Name	Type	Attribute	Description
object	Object
object.x	number
object.y	number
object.width	number
object.height	number

Return:

Protected Methods

protected hasCollision(object: Object): boolean source

Check if mouse coordinates has collisions with object

Params:

Name	Type	Attribute	Description
object	Object
object.x	number
object.y	number
object.width	number
object.height	number

Return: