数据交换模块帮助文档

类型列表

接口 IObject

接口 ISubType 继承 IObject

| 属性 | 类型 | 说明 |
| ------ | ---- | ---- |
| subType | string | 具体实现类的类型标识；详细的类型列表请查看DefaultSubTypes。

1. 外部使用者一般不需要关心。

接口 IGeometry 继承 ISubType

接口 IVector2d 继承 IObject

| 属性 | 类型 | 说明 |
| ------ | ---- | ---- |
| x | number | 二维向量的x坐标。 |
| y | number | 二维向量的y坐标。 |



接口 IVector3d 继承 IObject

| 属性 | 类型 | 说明 |
| ------ | ---- | ---- |
| x | number | 三维向量的x坐标。 |
| y | number | 三维向量的y坐标。 |
| z | number | 三维向量的z坐标。 |



接口 ICCS2d 继承 IObject

| 属性 | 类型 | 说明 |
| ------ | ---- | ---- |
| origin | IPoint2d | 坐标系原点。 |
| dx | IVector2d | 坐标系x轴方向。 |
| dy | IVector2d | 坐标系y轴方向。 |



接口 ICCS3d 继承 IObject

| 属性 | 类型 | 说明 |
| ------ | ---- | ---- |
| origin | IPoint3d | 坐标系原点。 |
| dx | IVector3d | 坐标系x轴方向。 |
| dy | IVector3d | 坐标系y轴方向。 |
| dz | IVector3d | 坐标系z轴方向。 |



接口 IMatrix 继承 IObject

| 属性 | 类型 | 说明 |
| ------ | ---- | ---- |
| elements | readonly number[] | 矩阵元素按列向量方式排成一维数组。 |



接口 IUV 继承 IObject

| 属性 | 类型 | 说明 |
| ------ | ---- | ---- |
| u | number | 二维参数域的第一个参数u。 |
| v | number | 二维参数域的第二个参数v。 |



接口 IInterval 继承 IObject

| 属性 | 类型 | 说明 |
| ------ | ---- | ---- |
| start | number | 参数区间的起点。 |
| end | number | 参数区间的终点。 |



接口 ICurve2d 继承 IGeometry

接口 ICurve3d 继承 IGeometry

接口 ITrimmedCurve2d 继承 ICurve2d

| 属性 | 类型 | 说明 |
| ------ | ---- | ---- |
| curve | ICurve2d | 未裁剪的原始曲线。 |
| startParam | number | 获取和设置裁剪曲线的起点参数。 |
| endParam | number | 获取和设置裁剪曲线的终点参数。 |



接口 ITrimmedCurve3d 继承 ICurve3d

| 属性 | 类型 | 说明 |
| ------ | ---- | ---- |
| curve | ICurve3d | 未裁剪的原始曲线。 |
| startParam | number | 起点的参数。 |
| endParam | number | 终点的参数。 |



接口 ICircle2d 继承 ICurve2d

| 属性 | 类型 | 说明 |
| ------ | ---- | ---- |
| origin | IPoint2d | 圆的圆心。 |
| radius | number | 圆的半径。 |



接口 ICircle3d 继承 ICurve3d

| 属性 | 类型 | 说明 |
| ------ | ---- | ---- |
| origin | IPoint3d | 圆的圆心。 |
| radius | number | 圆的半径。 |
| ccs | ICCS3d | 三维圆的局部坐标系（圆心，参数域x轴，参数域y轴，法向） |



接口 ILine2d 继承 ICurve2d

| 属性 | 类型 | 说明 |
| ------ | ---- | ---- |
| origin | IPoint2d | 二维直线的参数原点。 |
| direction | IVector2d | 二维直线的方向（单位向量）。 |



接口 ILine3d 继承 ICurve3d

| 属性 | 类型 | 说明 |
| ------ | ---- | ---- |
| origin | IPoint3d | 三维直线的参数原点。 |
| direction | IVector3d | 三维直线的方向（单位向量）。 |



接口 IRay2d 继承 ICurve2d

| 属性 | 类型 | 说明 |
| ------ | ---- | ---- |
| origin | IPoint2d | 二维射线的原点。 |
| direction | IVector2d | 二维射线的方向（单位向量）。 |



接口 IRay3d 继承 ICurve3d

| 属性 | 类型 | 说明 |
| ------ | ---- | ---- |
| origin | IPoint3d | 三维射线的原点。 |
| direction | IVector3d | 三维射线的方向（单位向量）。 |



接口 IEllipse2d 继承 ICurve2d

| 属性 | 类型 | 说明 |
| ------ | ---- | ---- |
| origin | IPoint2d | 椭圆的圆心。 |
| majorRadius | number | 椭圆长轴半径，也就是x轴方向的半径。 |
| minorRadius | number | 椭圆短轴半径，也就是y轴方向的半径。 |
| ccs | ICCS2d | 二维椭圆的局部坐标系（圆心，参数域x轴，参数域y轴） |



接口 IEllipse3d 继承 ICurve3d

| 属性 | 类型 | 说明 |
| ------ | ---- | ---- |
| origin | IPoint3d | 椭圆的圆心。 |
| majorRadius | number | 椭圆长轴半径，也就是x轴方向的半径。 |
| minorRadius | number | 椭圆短轴半径，也就是y轴方向的半径。 |
| ccs | ICCS3d | 三维椭圆的局部坐标系（圆心，参数域x轴，参数域y轴，法向） |



接口 ILineSegment2d 继承 ITrimmedCurve2d

| 属性 | 类型 | 说明 |
| ------ | ---- | ---- |
| line | ILine2d | 获取或者设置直线段所在的直线。 |
| startParam | number | 获取或者设置直线段的起点参数。 |
| endParam | number | 获取或者设置直线段的终点参数。 |
| startPoint | IPoint2d | 计算直线段的起点。 |
| endPoint | IPoint2d | 计算直线段的终点。 |



接口 ILineSegment3d 继承 ITrimmedCurve3d

| 属性 | 类型 | 说明 |
| ------ | ---- | ---- |
| line | ILine3d | 获取或者设置直线段所在的直线。 |
| startParam | number | 获取或者设置直线段的起点参数。 |
| endParam | number | 获取或者设置直线段的终点参数。 |
| startPoint | IPoint3d | 计算直线段的起点。 |
| endPoint | IPoint3d | 计算直线段的终点。 |



接口 IArc2d 继承 ITrimmedCurve2d

| 属性 | 类型 | 说明 |
| ------ | ---- | ---- |
| circle | ICircle2d | 二维圆弧所在的圆。 |
| startParam | number | 二维圆弧的参数起点（弧度值）。 |
| endParam | number | 二维圆弧的参数终点（弧度值）。 |
| clockSign | number | 圆弧的转向：1 = 逆时针，-1 = 顺时针。 |
| origin | IPoint2d | 圆弧的圆心。 |
| radius | number | 圆弧的半径。 |



接口 IArc3d 继承 ITrimmedCurve3d

| 属性 | 类型 | 说明 |
| ------ | ---- | ---- |
| circle | ICircle3d | 三维圆弧所在的圆。 |
| startParam | number | 三维圆弧的参数起点（弧度值）。 |
| endParam | number | 三维圆弧的参数终点（弧度值）。 |
| origin | IPoint3d | 圆的圆心。 |
| radius | number | 圆的半径。 |



接口 IEllipticArc2d 继承 ITrimmedCurve2d

| 属性 | 类型 | 说明 |
| ------ | ---- | ---- |
| ellipse | IEllipse2d | 椭圆弧所在的椭圆。 |
| startParam | number | 椭圆弧的参数起点（弧度值）。 |
| endParam | number | 椭圆弧的参数终点（弧度值）。 |
| ccs | ICCS2d | 二维椭圆弧所在的椭圆的局部坐标系。 |
| majorRadius | number | 椭圆长轴半径。 |
| minorRadius | number | 椭圆短轴半径。 |
| clockSign | number | 1 = 逆时针，-1 = 顺时针。 |



接口 IEllipticArc3d 继承 ITrimmedCurve3d

| 属性 | 类型 | 说明 |
| ------ | ---- | ---- |
| ellipse | IEllipse3d | 椭圆弧所在的椭圆。 |
| startParam | number | 椭圆弧的参数起点（弧度值）。 |
| endParam | number | 椭圆弧的参数终点（弧度值）。 |
| ccs | ICCS3d | 三维椭圆弧所在的椭圆的局部坐标系。 |
| majorRadius | number | 椭圆长轴半径。 |
| minorRadius | number | 椭圆短轴半径。 |



接口 IBezierCurve2d 继承 ICurve2d

| 属性 | 类型 | 说明 |
| ------ | ---- | ---- |
| controlPoints | IPoint2d[] | 贝塞尔曲线的控制顶点 |
| interval | IInterval | 贝塞尔曲线的参数区间 |



接口 IBezierCurve3d 继承 ICurve3d

| 属性 | 类型 | 说明 |
| ------ | ---- | ---- |
| controlPoints | IPoint3d[] | 贝塞尔曲线的控制顶点 |
| interval | IInterval | 贝塞尔曲线的参数区间 |



接口 INurbsCurve2d 继承 ICurve2d

| 属性 | 类型 | 说明 |
| ------ | ---- | ---- |
| degree | number | nurbs曲线的次数。 |
| knots | number[] | nurbs曲线的节点向量。 |
| controlPoints | IPoint2d[] | nurbs曲线的控制顶点。 |
| weights | number[] | nurbs曲线控制顶点的权重。 |



接口 INurbsCurve3d 继承 ICurve3d

| 属性 | 类型 | 说明 |
| ------ | ---- | ---- |
| degree | number | nurbs曲线的次数。 |
| knots | number[] | nurbs曲线的节点向量。 |
| controlPoints | IPoint3d[] | nurbs曲线的控制顶点。 |
| weights | number[] | nurbs曲线控制顶点的权重。 |



接口 IPolyline2d 继承 ICurve2d

| 属性 | 类型 | 说明 |
| ------ | ---- | ---- |
| points | IPoint2d[] | 构成折线段的有序点列。 |
| tangents | IVector2d[] | 折线段每点处的切向量。 |



接口 IPolyline3d 继承 ICurve3d

| 属性 | 类型 | 说明 |
| ------ | ---- | ---- |
| points | IPoint3d[] | 构成折线段的有序点列。 |
| tangents | IVector3d[] | 折线段每点处的切向量。 |



接口 ICompositeCurve2d 继承 IObject

| 属性 | 类型 | 说明 |
| ------ | ---- | ---- |
| curves | ICurve2d[] | 前后首尾相接的有界曲线列表 |



接口 ICompositeCurve3d 继承 IObject

| 属性 | 类型 | 说明 |
| ------ | ---- | ---- |
| curves | ICurve3d[] | 前后首尾相接的有界曲线列表 |



接口 ICurveLoop2d 继承 IObject

| 属性 | 类型 | 说明 |
| ------ | ---- | ---- |
| curves | ICurve2d[] | 前后首尾相接成环的有界曲线列表。 |



接口 IGeomRegion2d 继承 IObject

| 属性 | 类型 | 说明 |
| ------ | ---- | ---- |
| outerLoop | ICurveLoop2d | 二维区域的外轮廓。 |
| innerLoops | ICurveLoop2d[] | 二维区域内部的空洞。 |



接口 ISurface 继承 IGeometry

接口 ISurfaceWithFrame 继承 ISurface

| 属性 | 类型 | 说明 |
| ------ | ---- | ---- |
| ccs | ICCS3d | 3维曲面的局部标架（表达定位和朝向）。 |



接口 IPlane 继承 ISurfaceWithFrame

| 属性 | 类型 | 说明 |
| ------ | ---- | ---- |
| origin | IPoint3d | 平面的原点。 |
| normal | IVector3d | 平面的法向量。 |
| ccs | ICCS3d | 平面的定位标架。

1. z轴为平面的法向量；
2. x轴和y轴分别为平面坐标系的x轴和y轴。

接口 ICylinder 继承 ISurfaceWithFrame

| 属性 | 类型 | 说明 |
| ------ | ---- | ---- |
| origin | IPoint3d | 圆柱中心轴的原点。 |
| direction | IVector3d | 圆柱中心轴的方向。 |
| radius | number | 圆柱面半径 |
| ccs | ICCS3d | 圆柱面的定位标架。

1. z轴为圆柱的中心轴；z轴正向为参数v正向；
2. x轴朝y轴转动的方向为参数u正向；
3. x轴和圆柱交点对应参数域原点。

接口 ICone 继承 ISurfaceWithFrame

| 属性 | 类型 | 说明 |
| ------ | ---- | ---- |
| origin | IPoint3d | 圆锥中心轴的原点。

1. 注意：不一定是圆锥的顶点。

接口 ITorus 继承 ISurfaceWithFrame

| 属性 | 类型 | 说明 |
| ------ | ---- | ---- |
| origin | IPoint3d | 圆环中心轴的原点；也是圆环的中心点。 |
| direction | IVector3d | 圆环中心轴的方向。 |
| majorRadius | number | 圆环面的大圆半径。 |
| minorRadius | number | 圆环面的小圆半径。 |
| ccs | ICCS3d | 圆环的定位标架。

1. 原点o为圆环中心；
2. z轴为圆环的中心轴；
3. x轴y轴定义在圆环的大圆所在的平面内；
4. x轴和圆环面的交点对应参数域原点；
5. 按z轴和右手法则定义u参数方向，再按u参数方向和右手法则定义小圆上的v参数方向；

接口 IGenericCylinder 继承 ISurfaceWithFrame

| 属性 | 类型 | 说明 |
| ------ | ---- | ---- |
| baseCurve | ICurve2d | 在局部坐标系的xy平面上定义的拉伸面轮廓线。 |
| height | number | 沿局部坐标系的z轴方向的拉伸高度。 |
| ccs | ICCS3d | 广义柱面的定位标架（xy平面上定义轮廓线，z轴方向为拉伸方向）。 |



接口 IRevolvedSurface 继承 ISurface

| 属性 | 类型 | 说明 |
| ------ | ---- | ---- |
| baseCurve | ITrimmedCurve3d | 旋转面的轮廓曲线。 |
| axis | ILine3d | 旋转面的旋转轴。 |
| startAngle | number | 旋转面的起始旋转角度（弧度值）。 |
| endAngle | number | 旋转面的终止旋转角度（弧度值）。 |



接口 INurbsSurface 继承 ISurface

| 属性 | 类型 | 说明 |
| ------ | ---- | ---- |
| udegree | number | nurbs曲面的u向次数。 |
| vdegree | number | nurbs曲面的v向次数。 |
| uknots | number[] | nurbs曲面的u向节点向量。 |
| vknots | number[] | nurbs曲面的v向节点向量。 |
| controlPoints | IPoint3d[][] | nurbs曲面的控制网格。

1. 如果以u向为行，v向为列，那么控制顶点是按列向排列的

接口 ITrimmedSurface 继承 ISurface

| 属性 | 类型 | 说明 |
| ------ | ---- | ---- |
| surface | ISurface | 未裁剪的完整曲面。 |
| sense | boolean | 裁剪曲面和曲面朝向是否一致。 |
| outerLoop | ICurve3d[] | 裁剪曲面的外边界。 |
| innerLoops | ICurve3d[][] | 裁剪曲面的内边界（洞）。 |
| uvOuterLoop | ICurve2d[] | 裁剪曲面的外边界在曲面参数域上对应的参数域曲线。 |
| uvInnerLoops | ICurve2d[][] | 裁剪曲面的内边界在曲面参数域上对应的参数域曲线。 |



接口 IRectTrimmedSurface 继承 ISurface

| 属性 | 类型 | 说明 |
| ------ | ---- | ---- |
| surface | ISurface | 未裁剪的完整曲面。 |
| sense | boolean | 裁剪曲面和曲面朝向是否一致。 |
| uvMin | IUV | 矩形参数域的左下角。 |
| uvMax | IUV | 矩形参数域的右上角。 |



接口 ICurveOnSurface 继承 ICurve3d

| 属性 | 类型 | 说明 |
| ------ | ---- | ---- |
| pCurve | ICurve2d | 曲面参数域上定义的二维曲线（可能是裁剪曲线）。 |
| surface | ISurface | 背景曲面。 |



接口 ICurveOnSurfaces 继承 ICurve3d

| 属性 | 类型 | 说明 |
| ------ | ---- | ---- |
| curve3d | ICurve3d | 贴近一簇曲面片的三维曲线。 |
| pCurves | ICurveOnSurface[] | 三维曲线投影在每个曲面上的形成的参数域二维曲线。 |



接口 IGeometric2dDesign 继承 IBodyBase

| 属性 | 类型 | 说明 |
| ------ | ---- | ---- |
| faces | IDesign2dRegion[] | 2D设计的区域 |
| edges | IDesign2dEdge[] | 模型的所有边。 |
| vertices | IDesign2dVertex[] | 模型的所有顶点。 |



接口 IDesign2dRegion 继承 ITopology

| 属性 | 类型 | 说明 |
| ------ | ---- | ---- |
| edgeLoops | IDesign2dEdge[][] | 面片的边界。

1. 边界是由一系列首尾相接的边构成，它们形成若干个封闭的环；
2. 第一个数组表示面片的外边界环，其他表示内边界环（洞）；
3. 每条边都是用下标表示，也就是父对象IGeometric2dDesign内的edges数组的下标。

接口 IDesign2dEdge 继承 ITopology

| 属性 | 类型 | 说明 |
| ------ | ---- | ---- |
| curve | ICurve2d | 边所依赖的曲线。 |
| sense | boolean | 边的方向（从起点到终点）是否和所依赖的曲线的方向一致。

1. 例如一条直线方向是和X轴正向一样的，但是以这条直线为几何元素的一条边可以是沿X轴负反向的。
2. true表示两者方向一致，false表示不一致。

接口 IDesign2dVertex 继承 ITopology

| 属性 | 类型 | 说明 |
| ------ | ---- | ---- |
| point | IPoint2d | 顶点的坐标位置 |



接口 ITopology 继承 ISubType

| 属性 | 类型 | 说明 |
| ------ | ---- | ---- |
| name | IName | 拓扑对象的持久命名。

1. 命名可以为空，表示这个对象没有名字；
2. 名字的唯一性需要考虑对应的上下文，可能是在某一领域内唯一；
3. 名字种类分为文本型名字和结构化名字两种，具体请参考派生类的说明；
4. 对象是否有持久命名，以及名字的具体构成方式由内部造型引擎和具体需求决定，和拓扑对象的类型没有必然联系。
   1. 比如硬装的墙面和定制衣柜的某个面都是Face类型，但可能一个有命名一个没有命名。

接口 IName 继承 ISubType

| 属性 | 类型 | 说明 |
| ------ | ---- | ---- |
| nameType | NameTypes | 名字表示方式：Text 或者 Struct |



接口 ITextName 继承 IName

| 属性 | 类型 | 说明 |
| ------ | ---- | ---- |
| name | string | 获取对象的名字。 |



接口 IStructuredName 继承 IName

| 属性 | 类型 | 说明 |
| ------ | ---- | ---- |
| entityType | string | 被命名对象的类型，例如V，E，F分别代表顶点，边，面。 |
| progenitors | IName[] | 当前对象的生成源。例如：

1. 两个Face相互裁剪后生成的公共边，它的生成源可以定义为这两个Face。
2. 拉伸一个平面轮廓成为一个实体，那么侧面某个Face的生成源可以定义为轮廓上的一条边。

接口 IBodyBase 继承 ITopology

| 属性 | 类型 | 说明 |
| ------ | ---- | ---- |
| modeltype | ModelTypes | 模型分类（2D平面设计，实体造型模型，或者三角网格模型）。 |
| vertices | any[] | 模型子对象 - 顶点。 |
| faces | any[] | 模型子对象 - 面。 |
| edges | any[] | 模型子对象 - 边。 |



接口 IBody 继承 IBodyBase

| 属性 | 类型 | 说明 |
| ------ | ---- | ---- |
| faces | IFace[] | 造型体的所有面片。 |
| edges | IEdge[] | 造型体的所有边。 |
| vertices | IVertex[] | 造型体的所顶点。 |



接口 IFace 继承 ITopology

| 属性 | 类型 | 说明 |
| ------ | ---- | ---- |
| surface | ISurface | 三维面片所依赖的曲面。

1. 例如一个四边形平面片所依赖的平面，或者一个三角形球面片所依赖的球面。

接口 IEdge 继承 ITopology

| 属性 | 类型 | 说明 |
| ------ | ---- | ---- |
| curve | ICurve3d | 边所依赖的曲线。 |
| sense | boolean | 边的方向（从起点到终点）是否和所依赖的曲线的方向一致。

1. 例如一条直线的方向是和X轴正向一致的，但是以这条直线为几何元素的一条边可以是沿X轴负方向的。
2. true表示两者方向一致，false表示不一致。

接口 IVertex 继承 ITopology

| 属性 | 类型 | 说明 |
| ------ | ---- | ---- |
| point | IPoint3d | 顶点的坐标位置 |



接口 IOutline 继承 ITopology

| 属性 | 类型 | 说明 |
| ------ | ---- | ---- |
| vertices | number[] | 边的两个顶点的下标。 |



接口 IFin 继承 ITopology

| 属性 | 类型 | 说明 |
| ------ | ---- | ---- |
| edge | IEdge | 翼边所引用的边。 |
| sense | boolean | 翼边的方向是否和所引用的边的方向一致。

1. 例如一个四边形的面片，我们沿它的法向的反方向观察这个面片时，它的外环的左侧翼边的方向是从上到下，

接口 ILoop 继承 ITopology

| 属性 | 类型 | 说明 |
| ------ | ---- | ---- |
| fins | IFin[] | 构成环的翼边。 |



接口 IMeshBody 继承 IBodyBase

| 属性 | 类型 | 说明 |
| ------ | ---- | ---- |
| vertices | number[] | 三角网格所有顶点的坐标组成的数组。

1. vertices[3 i]为第 i 个顶点的 x 坐标；
2. vertices[3 i + 1]为第 i 个顶点的 y 坐标；
3. vertices[3 * i + 2]为第 i 个顶点的 z 坐标；

接口 IComponent 继承 ITopology

| 属性 | 类型 | 说明 |
| ------ | ---- | ---- |
| bodies | IBodyBase[] | 组件包含的体。

1. 一个组件可以包含0..n个体（Body，MeshBody，或者2D平面设计）；
2. 但一个体只能被一个组件所有。

接口 IInstance 继承 ITopology

| 属性 | 类型 | 说明 |
| ------ | ---- | ---- |
| component | IComponent | 当前实例所引用的组件。 |
| transform | IMatrix | 当前实例的变换矩阵。

1. 注意：当前实例可能还被上层组件包含，进而可能被更上层的实例引用而再带有变换矩阵；所以要得到

常量 MIX_DATA_EXCHANGE_VERSION

当前交换数据的版本号和历史版本号。
- 第一个为当前版本号，其余为历史版本号；

`ts
const MIX_DATA_EXCHANGE_VERSION: string[] = [
/**
* 当前版本号。
*/
'0.0.1',
/**
* 0.0.0 - 起始占位符
*/
'0.0.0'
];
`



函数 deserialize(json: string)

反序列化接口，把 json 文本解析成实际的数据交换对象进行返回。

- 我们提供了序列化和反序列化接口，外部用户直接使用即可，不需要关心具体的算法原理和 json 数据结构；
- json 数据的层次结构和交换数据的层次结构是基本一致的，只是属性名称进行了别名处理以及共享对象的引用通过下标来表示；
- 目前交换数据不存在历史版本号，所以反序列化流程中没有添加数据升级的过程。
- 注意：
- 反序列化只会返回独立的顶层对象，不会返回任何子对象。
- 一般情况下，传递的顶层对象都是ISubType，可以通过类型标识符来判断具体的子类型；
如果业务组和外部用户在交换一些自定义的数据结构，并且顶层数据是如Point2，Vector3，Matrix等非ISubType类型，
则双方需要另行约定好数据交换的格式，这一部分不在本数据交换包的管理范围内。

`ts
function deserialize(json: string): IObject | IObject[] | undefined;
`



函数 serialize(entities: ISerializable[] | ISerializable)

序列化接口，把数据对象序列化成 json 文本进行返回。
注意：
- 这个接口主要是给内部业务组使用的；外部用户如果需要再次序列化导出的数据，可以直接把数据交换对象
强转成 ISerializable 进行处理即可，它们的实现类实际是继承和实现了 ISerializable 的。
- 子对象无需重复放入序列化列表，系统会自动检测依赖关系进行序列化导出；
如果放入了子对象，序列化流程也不会对其重复保存，但再把json文本反序列化回来时，
数组长度会缩短，因为去除了重复放入的子对象。
- 最终我们把转化好的交换数据列表打包到了一个 MIX 对象中，方便添加版本号等附加信息（目前只有版本号信息）。
- 反序列化接口可以直接接收 MIX 对象的 json 文本，但返回的还是一个交换数据列表，并不包含版本号信息。

`ts
function serialize(entities: ISerializable[] | ISerializable): string;
`



类 MIX

序列化时我们把交换数据列表打包到了一个 MIX 对象中，方便添加版本号等附加信息（目前只有版本号信息）。
反序列化接口可以直接接收 MIX 对象的 json 文本，但返回的还是一个交换数据列表，并不包含版本号信息，
因为反序列化总是会升级成最新数据版本。

`ts
class MIX { ... }
`

$3

- 属性 tp: string

类型标识符。

- 属性 v: string

当前版本号。

- 属性 d: readonly IDynamicObject[]

转化后的交换数据列表。
- 属性名称进行了别名处理、共享对象的引用通过下标来表示。

- constructor(jsonList: readonly IDynamicObject[])

函数 createSerializer(context?: any)

创建一个序列化和反序列化器；可以把MIx对象转成可以直接生成文本的json对象，或者把json对象翻译成MIx对象。
- 外部用户一般不需要使用，直接使用 dialize 和 serialize 接口即可。

`ts
function createSerializer(context?: any): ISerializer;
`



常量 DefaultSubTypes

具体实现类的类型名称汇总；也就是序列化时保存的'tp'字段。

`ts
const DefaultSubTypes = {
//#region --------------- Math2 >> IGeometry ---------------------
// 这部分几何数据类型（IGeometry）的子类别名（subtype）是从Math2当中复刻过来的；
// 使用同样的别名，是为了让IGeometry的json文本可以和Math2通用，提高开发效率。
Line2d_Type: 'L2',
Line3d_Type: 'L',
LineSeg2d_Type: 'LS2',
LineSeg3d_Type: 'LS',
Ray2d_Type: 'RAY2',
Ray3d_Type: 'RAY',
Circle2d_Type: 'CIR2',
Circle3d_Type: 'CIR',
Arc2d_Type: 'ARC2',
Arc3d_Type: 'ARC',
Ellipse2d_Type: 'ELP2',
EllipticalArc2d_Type: 'EARC2',
Ellipse3d_Type: 'ELP',
EllipticalArc3d_Type: 'EARC3',
PolylineCurve2d_Type: 'PLY2',
PolylineCurve3d_Type: 'PLY',
BezierCurve2d_Type: 'BEZ2',
BezierCurve3d_Type: 'BEZ',
NurbsCurve2d_Type: 'NBSC2',
NurbsCurve3d_Type: 'NBSC3',
Plane_Type: 'P',
Cylinder_Type: 'CYL',
Torus_Type: 'TOR',
ExtrudedSurface_Type: 'SLE',
TrimmedSurface_Type: 'GTS',
RectTrimmedSurface_Type: 'RTS',
Cone_Type: 'CON',
NurbsSurface_Type: 'NBSS',
CurveOnSurface_Type: 'COS',
Curve3dOnSurfaces_Type: 'COSS',
RevolvedSurface_Type: 'REVS',
//#endregion

/**
* 一个打包数据块；包含了数据版本号和对象列表。
*/
MIX: 'MIX',

//#region ------------------------ MIxTopo ---------------------
/**
* 文本型名字。
*/
TextName:'TN',
/**
* 结构化名字。
*/
StructuredName:'STN',
/**
* 平面设计中的2维顶点。
*/
Vertex2: 'V2',
/**
* 平面设计中的2维边。
*/
Edge2: 'E2',
/**
* 平面设计中的2维区域。
*/
Face2: 'F2',
/**
* 3维模型的顶点。
*/
Vertex3: 'V3',
/**
* 3维模型的边。
*/
Edge3: 'E3',
/**
* 3维模型的面片。
*/
Face3: 'F3',
/**
* 3维模型面片上的环。
*/
Loop3: 'L3',
/**
* 构成环的翼边。
*/
Fin3: 'FN3',
/**
* 额外标记出来的模型轮廓线。
*/
Outline:'OTL',
/**
* 2维平面设计。
*/
Geometric2dDesign: 'GM2',
/**
* 3维的实体造型模型。
*/
Body: 'GM3',
/**
* 3维的三角网格模型。
*/
MeshBody: 'MM',
/**
* 由若干个模型或者实例组合而成的模型组件。
*/
Component: 'MG',
/**
* 组件的实例。
*/
Instance: 'GI',
/**
* 暂未使用
*/
Material: 'MT',
/**
* 暂未使用
*/
MaterialMetaData: 'MMD',
/**
* 暂未使用
*/
MaterialParameters: 'MP',
/**
* 暂未使用
*/
Style: 'ST',
/**
* 暂未使用
*/
PavingPattern: "PP",
/**
* 暂未使用
*/
UVMapping: 'UVM',
//#endregion
};
`



常量 SubTypeConfig

我们规定，可进行数据交换的纯几何数据类型（Curve, Surface, Point, Vector等）必须是math2当中的类型；
* 公司内部任何第二方如果同时在使用除math2以外的其他几何库，则必须把格式转换成math2类型后才能进行序列化和对外数据交换。

IGeometry的subType是从math2当中复刻过来的；
我们给IGeometry使用同样的别名，从而使得用于数据交换的json文本既可以直接转换成math2对象，也可以直接转换成IGeometry对象。
* 不是所有Math2类型都需要标记子类别名，是因为它们的实例在被其他对象引用的时候都是以最终实现类的类型来声明的，而不是基类或者接口。

在拓扑层面，Brep库的使用率并没有Math2那么高，所以对于拓扑类型，我们不强制必须是Brep库的类型才能做数据交换。
* 在这个库中，我们定义了一套更通用的，更精简的拓扑结构表达形式，我们称之为MIxTopo，它可以支持内部二方的各种自定义拓扑结构；
* 公司内部的二方如果想做对外的拓扑数据交换，那么需要把自己的拓扑结构序列化成MIxTopo的形式，再传递给第三方公司。

考虑到：
1. 第三方公司在调用这个库反序列化后，还可能会把数据修改后再传递回来；
2. 或者由于调查问题的时候，我们需要把MIxTopo结构的json反序列化成内部类型进行Debug；
我们决定在MIxTopo上，也加上一个字段subType，来标记内部具体实现类的类型。
* 但因为可能有多个第二方会接入；或者同一个第二方有多种不同业务含义的同类型拓扑对象，所以不同于Math2的subType，这里可能存在多个subType对应一种通用的MIxTopo类型。
例如可能某二方的背景墙面和吊顶面是不同的实现类，而它们都是一种通用拓扑类型Face。

既然subType和MIxTopo不是一对一的，那么它就只能由第二方自己来定义和维护；
* 我们会要求所有第二方把自己的subType都配置到这个库所包含的某个文件当中，
* 当某个二方需要新增subType时，他必须先来查询这个文件，确认subType是否已经被占用。

此外，
* 对于第三方来说，如果他还需要知道具体的业务含义（例如是先前举例当中的背景墙还是吊顶面），想从properties字段上获取更多信息，
那么就需要对应的内部二方提供一个额外的SDK来解释subType和properties；这部分不属于这个库的范畴。

`ts
const SubTypeConfig: ISubTypeInfo[] = [
...Object.entries(DefaultSubTypes).map(iter => {
return getDefaultInfo(iter[1]);
}),
/**
* 业务方也可以给自己的类型设置subType别名。
* - 假如某工具有两种对象都会被转换成MIxFace3，为了区分它们，可以注册不同的subType；
* - 如果不注册，那么这两种对象被转化后得到的MIxFace3对象的subType就都是默认值 = DefaultSubTypes.F3;
*/
{
subType: 'CustomSubType', // 注册自己的subType别名；不能和 DefaultSubTypes 中现有的别名重复，也不能和其他以注册的别名重复。
description: 'DataExchange-Face',
create: (): ISerializable => {
return new Face('CustomSubType');
}
},
].filter(info => !!info) as ISubTypeInfo[];
``