Summary

Constructor

let pixel = new hmap.basetype.Pixel(100,200);

Methods

clone() → {module:basetype~Pixel}

克隆一个新像素

Returns:

module:basetype~Pixel -

新的像素对象

Example

let newPixel = pixel.clone();

distanceTo(pixel) → {Number}

计算两个像素坐标之间的距离。

Parameters:

Name	Type	Description
pixel	module:basetype~Pixel	像素坐标。

Throws:

当参数不是像素坐标对象时，抛出异常

Returns:

Number -

两个像素之间的距离,像素单位。

Example

let result = pixel1.distanceTo(pixel2);

equals(pixel, tolerance) → {Boolean}

检测两个像素是否相等

Parameters:

Name	Type	Default	Description
pixel	module:basetype~Pixel		待比较的像素
tolerance	Number	0	容差值,单位像素;

Throws:

当第二个参数tolerance小于0时，抛出异常

Returns:

Boolean -

相等返回true;不相等返回false

Example

let result = pixel1.equals(pixel2,4);

getX() → {Number}

获取像素的横坐标

Returns:

Number

Example

let x = pixel.getX();

getY() → {Number}

获取像素的纵坐标

Returns:

Number

Example

let y = pixel.getY();

toString() → {String}

获取像素的字符串表达形式

Returns:

String

Example

let str = pixel.toString();