@cearth/tools/doc/api/tools.md

CEarth 的 工具库

<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@cearth/tools](./tools.md)

## tools package

库的摘要信息

## Remarks

库的说明信息

## Enumerations

<table><thead><tr><th>

Enumeration


</th><th>

Description


</th></tr></thead>
<tbody><tr><td>

[CartesianAxis](./tools.cartesianaxis.md)


</td><td>

迪卡尔坐标轴


</td></tr>
<tr><td>

[HeadingPitchRollComponent](./tools.headingpitchrollcomponent.md)


</td><td>

HeadingPitchRoll 的 各个分量


</td></tr>
<tr><td>

[Xyz\_Hpr](./tools.xyz_hpr.md)


</td><td>


</td></tr>
</tbody></table>

## Functions

<table><thead><tr><th>

Function


</th><th>

Description


</th></tr></thead>
<tbody><tr><td>

[applyMatrixReferFrame(target, matrix, referFrame, result)](./tools.applymatrixreferframe.md)


</td><td>

给 target 应用相对于 参考系 referFrame 的矩阵变换 matrix


</td></tr>
<tr><td>

[applyTransformInfoPrimitive(target, transform, options)](./tools.applytransforminfoprimitive.md)


</td><td>

应用变换信息


</td></tr>
<tr><td>

[applyTransformInPrimitive(target, matrix)](./tools.applytransforminprimitive.md)


</td><td>

将变换信息应用在目标身上


</td></tr>
<tr><td>

[computeNormalOfCoplanars(origin, point1, point2)](./tools.computenormalofcoplanars.md)


</td><td>

计算三个点所在的平面的法向量


</td></tr>
<tr><td>

[createPlaneOfCoplanars(origin, point1, point2)](./tools.createplaneofcoplanars.md)


</td><td>

创建经过三个点的平面


</td></tr>
<tr><td>

[flatTransformInfoOptions(options)](./tools.flattransforminfooptions.md)


</td><td>

扁平化选项


</td></tr>
<tr><td>

[getBoundingSphere(target)](./tools.getboundingsphere.md)


</td><td>

获取包围盒


</td></tr>
<tr><td>

[getEntityInfo(entity, fixedFrameTransform, ellipsoid)](./tools.getentityinfo.md)


</td><td>

获取 entity 的变换信息


</td></tr>
<tr><td>

[getLocalTransformInfo(transform, options)](./tools.getlocaltransforminfo.md)


</td><td>

获取全局的变换信息


</td></tr>
<tr><td>

[getMatrix4OfTransformInfo(info, result)](./tools.getmatrix4oftransforminfo.md)


</td><td>


</td></tr>
<tr><td>

[getNeighborPairs(points, relativeEpsilon, absoluteEpsilon)](./tools.getneighborpairs.md)


</td><td>

邻点对生成器


</td></tr>
<tr><td>

[getPosition(target, result)](./tools.getposition.md)


</td><td>

获取位置


</td></tr>
<tr><td>

[getTransform(target)](./tools.gettransform.md)


</td><td>

获取目标的变换信息


</td></tr>
<tr><td>

[getWorldMatrix(transform, options)](./tools.getworldmatrix.md)


</td><td>

获取全局的变换矩阵


</td></tr>
<tr><td>

[getWorldTransformInfo(transform, options)](./tools.getworldtransforminfo.md)


</td><td>

获取全局的变换信息


</td></tr>
<tr><td>

[isMatrixPrimitive(target)](./tools.ismatrixprimitive.md)


</td><td>

MatrixPrimitive 类型守卫


</td></tr>
<tr><td>

[isPositionListPrimitive(target)](./tools.ispositionlistprimitive.md)


</td><td>

PositionListPrimitive 类型守卫


</td></tr>
<tr><td>

[isPositionPrimitive(target)](./tools.ispositionprimitive.md)


</td><td>

PositionPrimitive 类型守卫


</td></tr>
<tr><td>

[isPrimitiveObject(target)](./tools.isprimitiveobject.md)


</td><td>

PrimitiveObject 类型守卫


</td></tr>
<tr><td>

[localQuaternionToWorld(quate, referFrame, result)](./tools.localquaterniontoworld.md)


</td><td>

将局部坐标系下的四元数转为世界坐标系下的四元数


</td></tr>
<tr><td>

[makeMatrixReferFrame(matrix, referFrame, result)](./tools.makematrixreferframe.md)


</td><td>

创建一个相对于指定参考系的变换


</td></tr>
<tr><td>

[matrix4ToHeadingPitchRoll(matrix, result)](./tools.matrix4toheadingpitchroll.md)


</td><td>

矩阵转 HeadingPitchRoll


</td></tr>
<tr><td>

[quaternionToHeadingPitchRoll(quate, referFrame, result)](./tools.quaterniontoheadingpitchroll.md)


</td><td>

四元数转 HeadingPitchRoll


</td></tr>
<tr><td>

[resetTransformInfoPrimitive(target, transform, options)](./tools.resettransforminfoprimitive.md)


</td><td>

重围目标的变换信息


</td></tr>
<tr><td>

[resetTransformInPrimitive(target, matrix)](./tools.resettransforminprimitive.md)


</td><td>

重设变换信息


</td></tr>
<tr><td>

[rotateMatrixReferFrame(axis, angle, referFrame, result)](./tools.rotatematrixreferframe.md)


</td><td>

创建相对于指定参考系下的缩放矩阵


</td></tr>
<tr><td>

[rotationInfoToQuaternion(rotation)](./tools.rotationinfotoquaternion.md)


</td><td>

旋转信息转四元数


</td></tr>
<tr><td>

[scaleBoxGraphics(graphics, localScale)](./tools.scaleboxgraphics.md)


</td><td>

缩放 BoxGraphics


</td></tr>
<tr><td>

[scaleCylinderGraphics(graphics, localScale)](./tools.scalecylindergraphics.md)


</td><td>

缩放 CylinderGraphics


</td></tr>
<tr><td>

[scaleEllipseGraphics(graphics, localScale)](./tools.scaleellipsegraphics.md)


</td><td>

缩放 EllipseGraphics


</td></tr>
<tr><td>

[scaleEllipsoidGraphics(graphics, localScale)](./tools.scaleellipsoidgraphics.md)


</td><td>

缩放 EllipsoidGraphics


</td></tr>
<tr><td>

[scaleMatrixReferFrame(scale, referFrame, result)](./tools.scalematrixreferframe.md)


</td><td>

创建相对于指定参考系下缩放矩阵


</td></tr>
<tr><td>

[scaleModelGraphics(graphics, localScale, reset)](./tools.scalemodelgraphics.md)


</td><td>

缩放 ModelGraphics


</td></tr>
<tr><td>

[scalePlaneGraphics(graphics, localScale)](./tools.scaleplanegraphics.md)


</td><td>

缩放 PlaneGraphics


</td></tr>
<tr><td>

[scalePoints(points, scale, origin)](./tools.scalepoints.md)


</td><td>

缩放一组点


</td></tr>
<tr><td>

[transformCorridorGraphics(graphics, matrix, localScale)](./tools.transformcorridorgraphics.md)


</td><td>

对 CorridorGraphics 应用变换


</td></tr>
<tr><td>

[transformEntity(target, transform)](./tools.transformentity.md)


</td><td>

变换 Entity


</td></tr>
<tr><td>

[transformInfoToMatrix(transform)](./tools.transforminfotomatrix.md)


</td><td>

变换信息的矩阵


</td></tr>
<tr><td>

[transformPolygonGraphics(graphics, matrix, localScale)](./tools.transformpolygongraphics.md)


</td><td>

对 CorridorGraphics 应用变换


</td></tr>
<tr><td>

[transformPolygonHierarchy(hierarchy, matrix)](./tools.transformpolygonhierarchy.md)


</td><td>

对 PolygonHierarchy 应用变换


</td></tr>
<tr><td>

[transformPolylineGraphics(graphics, matrix, localScale)](./tools.transformpolylinegraphics.md)


</td><td>

对 PolylineGraphics 应用变换


</td></tr>
<tr><td>

[transformPolylineVolumeGraphics(graphics, matrix, localScale)](./tools.transformpolylinevolumegraphics.md)


</td><td>

对 PolylineGraphics 应用变换


</td></tr>
<tr><td>

[transformWallGraphics(graphics, matrix, localScale)](./tools.transformwallgraphics.md)


</td><td>

对 PolylineGraphics 应用变换


</td></tr>
<tr><td>

[translationMatrixReferFrame(offset, referFrame, result)](./tools.translationmatrixreferframe.md)


</td><td>

创建相对于指定参考系下的平移矩阵


</td></tr>
<tr><td>

[worldMatrixToLocal(matrix, referFrame, result)](./tools.worldmatrixtolocal.md)


</td><td>

将世界矩阵转为局部矩阵


</td></tr>
<tr><td>

[worldQuaternionToLocal(quate, referFrame, result)](./tools.worldquaterniontolocal.md)


</td><td>

将全局坐标系下的四元数转为局部坐标系下的四元数


</td></tr>
</tbody></table>

## Interfaces

<table><thead><tr><th>

Interface


</th><th>

Description


</th></tr></thead>
<tbody><tr><td>

[MatrixPrimitiveMember](./tools.matrixprimitivemember.md)


</td><td>

MatrixPrimitive 类型的成员接口


</td></tr>
<tr><td>

[PickedInfo](./tools.pickedinfo.md)


</td><td>

在场景拾取的对象信息


</td></tr>
<tr><td>

[PositionListPrimitiveMember](./tools.positionlistprimitivemember.md)


</td><td>

PositionListPrimitive 类型的成员接口


</td></tr>
<tr><td>

[PositionPrimitiveMember](./tools.positionprimitivemember.md)


</td><td>

PositionPrimitive 类型的成员接口


</td></tr>
<tr><td>

[RotationInfo](./tools.rotationinfo.md)


</td><td>

旋转操作信息


</td></tr>
<tr><td>

[TransformInfo](./tools.transforminfo.md)


</td><td>

变换信息


</td></tr>
<tr><td>

[TransformInfoOptions](./tools.transforminfooptions.md)


</td><td>

变换信息选项


</td></tr>
<tr><td>

[VisualizeTransformInfo](./tools.visualizetransforminfo.md)


</td><td>

用于可视化的变换信息


</td></tr>
</tbody></table>

## Namespaces

<table><thead><tr><th>

Namespace


</th><th>

Description


</th></tr></thead>
<tbody><tr><td>

[Xyz\_Hpr](./tools.xyz_hpr.md)


</td><td>


</td></tr>
</tbody></table>

## Type Aliases

<table><thead><tr><th>

Type Alias


</th><th>

Description


</th></tr></thead>
<tbody><tr><td>

[AxisTransformInfo](./tools.axistransforminfo.md)


</td><td>

轴变换信息


</td></tr>
<tr><td>

[CutableElement](./tools.cutableelement.md)


</td><td>

可剖切的元素


</td></tr>
<tr><td>

[Element3D](./tools.element3d.md)


</td><td>

代表 Cesium 中所有可渲染的对象类型


</td></tr>
<tr><td>

[MatrixPrimitive](./tools.matrixprimitive.md)


</td><td>

矩阵图形


</td></tr>
<tr><td>

[PositionListPrimitive](./tools.positionlistprimitive.md)


</td><td>

位置列表图形


</td></tr>
<tr><td>

[PositionPrimitive](./tools.positionprimitive.md)


</td><td>

位置图形


</td></tr>
<tr><td>

[PrimitiveElement](./tools.primitiveelement.md)


</td><td>

代表所有可加入 PrimitiveCollection 中的类型


</td></tr>
<tr><td>

[PrimitiveObject](./tools.primitiveobject.md)


</td><td>

代表所有可加入 PrimitiveCollection 中的 非集合的类型 Globe、Model、Primitive、Billboards、Labels、Points、ViewportQuad


</td></tr>
<tr><td>

[PrimitiveObjectCollection](./tools.primitiveobjectcollection.md)


</td><td>

代表所有可加入 PrimitiveCollection 中的 集合的类型


</td></tr>
<tr><td>

[QuateTransformInfo](./tools.quatetransforminfo.md)


</td><td>

变换信息


</td></tr>
<tr><td>

[TransformEntityOptions](./tools.transformentityoptions.md)


</td><td>


</td></tr>
<tr><td>

[TransformOptions](./tools.transformoptions.md)


</td><td>


</td></tr>
</tbody></table>