Cesium API - Cartesian2 中文文档

new Cesium.Cartesian2(x, y)

2D笛卡尔点。

Name	Type	Default	Description
`x`	Number	`0.0`	optional X 分量。
`y`	Number	`0.0`	optional Y 分量。

参考：

成员变量

x : Number

Core/Cartesian2.js 26

X 分量。

Default Value: 0.0

y : Number

Core/Cartesian2.js 33

Y 分量。

Default Value: 0.0

staticCesium.Cartesian2.packedLength : Number

Core/Cartesian2.js 98

用于将对象打包到数组中的元素数。

staticconstantCesium.Cartesian2.UNIT_X : Cartesian2

Core/Cartesian2.js 833

一个不可变的Cartesian2实例初始化为（1.0, 0.0）。

staticconstantCesium.Cartesian2.UNIT_Y : Cartesian2

Core/Cartesian2.js 841

一个不可变的Cartesian2实例初始化为（0.0, 1.0）。

staticconstantCesium.Cartesian2.ZERO : Cartesian2

Core/Cartesian2.js 825

一个不可变的Cartesian2实例初始化为（0.0,0.0）。

内置方法

clone(result) → Cartesian2

Core/Cartesian2.js 849

复制这个Cartesian2实例。

Name	Type	Description
`result`	Cartesian2	optional 存储结果的对象。

返回值：

修改后的结果参数，或新的Cartesian2实例（如果没有提供）。

equals(right) → Boolean

Core/Cartesian2.js 859

将此笛卡尔坐标与提供的笛卡尔坐标分量进行比较，如果相等，则返回true，否则返回false。

Name	Type	Description
`right`	Cartesian2	optional 要进行比较的笛卡尔坐标。

返回值：

true 如果相等，否则 false。

equalsEpsilon(right, relativeEpsilon, absoluteEpsilon) → Boolean

Core/Cartesian2.js 871

将此笛卡尔坐标与所提供的笛卡尔坐标分量进行比较，如果通过了绝对或相对公差测试，则返回true，否则返回false。

Name	Type	Default	Description
`right`	Cartesian2		optional 要进行比较的笛卡尔坐标。
`relativeEpsilon`	Number		用于相等性检测的相对epsilon公差。
`absoluteEpsilon`	Number	`relativeEpsilon`	optional 用于相等性测试的绝对epsilon公差。

返回值：

true如果左它们都在规定的epsilon范围内，否则false。

toString() → String

Core/Cartesian2.js 880

以'(x, y)'的格式创建表示该笛卡尔坐标的字符串。

返回值：

以'(x, y)'格式表示所提供的笛卡尔坐标的字符串。

staticCesium.Cartesian2.abs(cartesian, result) → Cartesian2

Core/Cartesian2.js 673

计算所提供的笛卡尔坐标的绝对值。

Name	Type	Description
`cartesian`	Cartesian2	要计算其绝对值的笛卡儿坐标。
`result`	Cartesian2	存储结果的对象。

返回值：

修改后的结果参数。

staticCesium.Cartesian2.add(left, right, result) → Cartesian2

Core/Cartesian2.js 553

计算两个笛卡儿坐标的分量和。

Name	Type	Description
`left`	Cartesian2	第一个笛卡尔坐标。
`right`	Cartesian2	第二个笛卡尔坐标。
`result`	Cartesian2	存储结果的对象。

返回值：

修改后的结果参数。

staticCesium.Cartesian2.angleBetween(left, right) → Number

Core/Cartesian2.js 725

返回所提供的笛卡尔坐标之间的角度(以弧度为单位)。

Name	Type	Description
`left`	Cartesian2	第一个笛卡尔坐标。
`right`	Cartesian2	第二个笛卡尔坐标。

返回值：

两个笛卡尔坐标间的角度。

staticCesium.Cartesian2.clone(cartesian, result) → Cartesian2

Core/Cartesian2.js 61

复制一个Cartesian2实例。

Name	Type	Description
`cartesian`	Cartesian2	要复制的笛卡尔坐标。
`result`	Cartesian2	optional 存储结果的对象。

返回值：

修改后的结果参数或新的Cartesian2实例（如果未提供）。（如果cartesian未定义，则返回undefined。）

staticCesium.Cartesian2.distance(left, right) → Number

Core/Cartesian2.js 390

计算两点之间的距离。

Name	Type	Description
`left`	Cartesian2	第一个点。
`right`	Cartesian2	第二个点。

返回值：

两点之间的距离。

示例：

// Returns 1.0
var d = Cesium.Cartesian2.distance(new Cesium.Cartesian2(1.0, 0.0), new Cesium.Cartesian2(2.0, 0.0));

staticCesium.Cartesian2.distanceSquared(left, right) → Number

Core/Cartesian2.js 422

计算两点之间距离的平方。使用这个函数比较平方距离比使用Cartesian2#distance更有效。

Name	Type	Description
`left`	Cartesian2	要计算距离的第一个点。
`right`	Cartesian2	要计算距离的第二个点。

返回值：

两点之间的距离。

示例：

// 返回 4.0, 而不是 2.0。
var d = Cesium.Cartesian2.distance(new Cesium.Cartesian2(1.0, 0.0), new Cesium.Cartesian2(3.0, 0.0));

staticCesium.Cartesian2.divideByScalar(cartesian, scalar, result) → Cartesian2

Core/Cartesian2.js 629

将提供的笛卡尔分量除以提供的标量。

Name	Type	Description
`cartesian`	Cartesian2	要被除的笛卡尔坐标。
`scalar`	Number	要除以的标量。
`result`	Cartesian2	存储结果的对象。

返回值：

修改后的结果参数。

staticCesium.Cartesian2.divideComponents(left, right, result) → Cartesian2

Core/Cartesian2.js 533

计算两个笛卡儿坐标的分量商。

Name	Type	Description
`left`	Cartesian2	第一个笛卡尔坐标。
`right`	Cartesian2	第二个笛卡尔坐标。
`result`	Cartesian2	存储结果的对象。

返回值：

修改后的结果参数。

staticCesium.Cartesian2.dot(left, right) → Number

Core/Cartesian2.js 480

计算两个笛卡尔的点（标量）乘积。

Name	Type	Description
`left`	Cartesian2	第一个笛卡尔坐标。
`right`	Cartesian2	第二个笛卡尔坐标。

返回值：

点积。

staticCesium.Cartesian2.equals(left, right) → Boolean

Core/Cartesian2.js 775

比较所提供的笛卡尔坐标分量，如果相等，则返回true，否则返回false。

Name	Type	Description
`left`	Cartesian2	optional 第一个笛卡尔坐标。
`right`	Cartesian2	optional 第二个笛卡尔坐标。

返回值：

true如果左边和右边相等，否则false。

staticCesium.Cartesian2.equalsEpsilon(left, right, relativeEpsilon, absoluteEpsilon) → Boolean

Core/Cartesian2.js 811

比较所提供的笛卡尔组件，如果通过了绝对或相对公差测试，则返回true，否则返回false。

Name	Type	Default	Description
`left`	Cartesian2		optional 第一个笛卡尔坐标。
`right`	Cartesian2		optional 第二个笛卡尔坐标。
`relativeEpsilon`	Number		用于相等性测试的相对epsilon公差。
`absoluteEpsilon`	Number	`relativeEpsilon`	optional 用于相等性测试的绝对epsilon公差。

返回值：

true如果left和right都在规定的epsilon范围内，否则false。

staticCesium.Cartesian2.fromArray(array, startingIndex, result) → Cartesian2

Core/Cartesian2.js 243

从数组中的两个连续元素创建Cartesian2。

Name	Type	Default	Description
`array`	Array.<Number>		两个连续元素分别对应x和y分量的数组。
`startingIndex`	Number	`0`	optional 数组中第一个元素的偏移量，它对应于x分量。
`result`	Cartesian2		optional 存储结果的对象。

返回值：

修改后的结果参数，或新的Cartesian2实例（如果没有提供）

示例：

// 使用（1.0,2.0）创建一个Cartesian2
var v = [1.0, 2.0];
var p = Cesium.Cartesian2.fromArray(v);
// 使用（1.0,2.0）在数组中使用偏移量创建Cartesian2
var v2 = [0.0, 0.0, 1.0, 2.0];
var p2 = Cesium.Cartesian2.fromArray(v2, 2);

staticCesium.Cartesian2.fromCartesian3(cartesian, result) → Cartesian2

Core/Cartesian2.js 82

从现有的Cartesian3创建一个Cartesian2实例。这只是利用了Cartesian3的x和y属性而删除了z属性。

Name	Type	Description
`cartesian`	Cartesian3	从中创建Cartesian2实例的Cartesian3实例。
`result`	Cartesian2	optional 存储结果的对象。

返回值：

修改后的结果参数，或新的Cartesian2实例（如果没有提供）

staticCesium.Cartesian2.fromCartesian4(cartesian, result) → Cartesian2

Core/Cartesian2.js 92

从现有的Cartesian4创建一个Cartesian2实例。这只是利用了Cartesian4的x和y属性而删除了z和w属性。

Name	Type	Description
`cartesian`	Cartesian4	从中创建Cartesian2实例的Cartesian4实例。
`result`	Cartesian2	optional 存储结果的对象。

返回值：

修改后的结果参数，或新的Cartesian2实例（如果没有提供）

staticCesium.Cartesian2.fromElements(x, y, result) → Cartesian2

Core/Cartesian2.js 44

根据x和y坐标创建Cartesian2实例。

Name	Type	Description
`x`	Number	x坐标。
`y`	Number	y坐标。
`result`	Cartesian2	optional 存储结果的对象。

返回值：

修改后的结果参数或新的Cartesian2实例（如果未提供）。

staticCesium.Cartesian2.lerp(start, end, t, result) → Cartesian2

Core/Cartesian2.js 703

使用所提供的笛卡尔坐标计算t处的线性插值或外推（extrapolation）。

Name	Type	Description
`start`	Cartesian2	对应于0.0的t值。
`end`	Cartesian2	对应于1.0的t值。
`t`	Number	在t上做插值的点。
`result`	Cartesian2	存储结果的对象。

返回值：

修改后的结果参数。

staticCesium.Cartesian2.magnitude(cartesian) → Number

Core/Cartesian2.js 362

计算笛卡尔坐标的大小(长度)。

Name	Type	Description
`cartesian`	Cartesian2	要计算其大小的笛卡儿坐标实例。

返回值：

大小。

staticCesium.Cartesian2.magnitudeSquared(cartesian) → Number

Core/Cartesian2.js 342

计算所提供的笛卡尔坐标的平方大小。

Name	Type	Description
`cartesian`	Cartesian2	要计算其平方大小的笛卡儿坐标实例。

返回值：

平方大小。

staticCesium.Cartesian2.maximumByComponent(first, second, result) → Cartesian2

Core/Cartesian2.js 318

比较两个笛卡儿坐标，并计算出一个包含所提供的两个笛卡儿坐标的最大分量的笛卡儿坐标。

Name	Type	Description
`first`	Cartesian2	第一个笛卡尔坐标
`second`	Cartesian2	第二个笛卡尔坐标
`result`	Cartesian2	存储结果的对象。

返回值：

包含最大分量的笛卡尔坐标。

staticCesium.Cartesian2.maximumComponent(cartesian) → Number

Core/Cartesian2.js 251

计算所提供的笛卡尔坐标的最大分量的值。

Name	Type	Description
`cartesian`	Cartesian2	使用的笛卡尔坐标。

返回值：

最大分量的值。

staticCesium.Cartesian2.minimumByComponent(first, second, result) → Cartesian2

Core/Cartesian2.js 289

比较两个笛卡儿坐标，并计算出一个包含所提供的两个笛卡儿坐标的最小分量的笛卡儿坐标。

Name	Type	Description
`first`	Cartesian2	第一个笛卡尔坐标
`second`	Cartesian2	第二个笛卡尔坐标
`result`	Cartesian2	存储结果的对象。

返回值：

包含最小分量的笛卡尔坐标。

staticCesium.Cartesian2.minimumComponent(cartesian) → Number

Core/Cartesian2.js 265

计算提供的笛卡尔坐标的最小分量的值。

Name	Type	Description
`cartesian`	Cartesian2	使用的笛卡尔坐标。

返回值：

最小分量的值。

staticCesium.Cartesian2.mostOrthogonalAxis(cartesian, result) → Cartesian2

Core/Cartesian2.js 751

返回与所提供的笛卡尔坐标最正交的轴。

Name	Type	Description
`cartesian`	Cartesian2	要在其上找到最正交轴的笛卡尔坐标。
`result`	Cartesian2	存储结果的对象。

返回值：

最正交的轴。

staticCesium.Cartesian2.multiplyByScalar(cartesian, scalar, result) → Cartesian2

Core/Cartesian2.js 601

将提供的笛卡尔坐标分量乘以提供的标量。

Name	Type	Description
`cartesian`	Cartesian2	要被乘的笛卡尔坐标。
`scalar`	Number	要乘以的标量。
`result`	Cartesian2	存储结果的对象。

返回值：

修改后的结果参数。

staticCesium.Cartesian2.multiplyComponents(left, right, result) → Cartesian2

Core/Cartesian2.js 505

计算两个笛卡儿坐标的分量积。

Name	Type	Description
`left`	Cartesian2	第一个笛卡尔坐标。
`right`	Cartesian2	第二个笛卡尔坐标。
`result`	Cartesian2	存储结果的对象。

返回值：

修改后的结果参数。

staticCesium.Cartesian2.negate(cartesian, result) → Cartesian2

Core/Cartesian2.js 655

对所提供的笛卡尔坐标取反。

Name	Type	Description
`cartesian`	Cartesian2	要取反的笛卡尔坐标。
`result`	Cartesian2	存储结果的对象。

返回值：

修改后的结果参数。

staticCesium.Cartesian2.normalize(cartesian, result) → Cartesian2

Core/Cartesian2.js 446

计算提供的笛卡尔坐标的标准化形式。

Name	Type	Description
`cartesian`	Cartesian2	要标准化的笛卡尔坐标。
`result`	Cartesian2	存储结果的对象。

返回值：

修改后的结果参数。

staticCesium.Cartesian2.pack(value, array, startingIndex) → Array.<Number>

Core/Cartesian2.js 117

将提供的实例存储到提供的数组中。

Name	Type	Default	Description
`value`	Cartesian2		要打包的值。
`array`	Array.<Number>		要打包到的数组。
`startingIndex`	Number	`0`	optional 开始打包元素的数组索引。

返回值：

被打包到的数组。

staticCesium.Cartesian2.packArray(array, result) → Array.<Number>

Core/Cartesian2.js 175

将Cartesian2s数组展平为分量数组。

Name	Type	Description
`array`	Array.<Cartesian2>	要打包的笛卡尔坐标数组。
`result`	Array.<Number>	optional 存储结果的数组。

返回值：

打包后的数组。

staticCesium.Cartesian2.subtract(left, right, result) → Cartesian2

Core/Cartesian2.js 573

计算两个笛卡儿坐标的分量差。

Name	Type	Description
`left`	Cartesian2	第一个笛卡尔坐标。
`right`	Cartesian2	第二个笛卡尔坐标。
`result`	Cartesian2	存储结果的对象。

返回值：

修改后的结果参数。

staticCesium.Cartesian2.unpack(array, startingIndex, result) → Cartesian2

Core/Cartesian2.js 147

从已打包的数组中检索实例。

Name	Type	Default	Description
`array`	Array.<Number>		被打包到的数组。
`startingIndex`	Number	`0`	optional 要解包的元素的起始索引。
`result`	Cartesian2		optional 存储结果的对象。