DTS二次开发文档

Class: FiniteElement2

FiniteElement2

FiniteElement2有限元仿真对象，实现对有限元仿真对象的操作
一般通过api.finiteElement2调用其方法

new FiniteElement2()

See:

Extends

Methods

add(data, fn)

根据VTK文件添加一个或多个有限元仿真对象

Parameters:
Name Type Description
data object | array

有限元仿真对象的数据结构，可以是Object类型或者Array类型，对于每一个FiniteElement2对象，支持以下属性：

  • id (string) 有限元仿真对象的唯一标识符ID

  • groupId (string) 可选，Group分组

  • userData (string) 可选，用户自定义数据

  • filePath (string) 必选，包含有限元仿真对象数据的VTK文件路径，取值示例：D:/xxx.vtk

  • location (array) 有限元仿真对象位置坐标：[X,Y,Z]，取值示例，数组元素类型：(number)，取值范围：[任意数值]

  • coordinateType (number) 坐标系类型，取值范围：0为Projection类型，1为WGS84类型，2为火星坐标系(GCJ02)，3为百度坐标系(BD09)，默认值：0

  • rotation (array) 有限元仿真对象旋转角度：[Pitch,Yaw,Roll]，数组元素类型：(number)，取值范围：[任意数值]，默认值：[0,0,0]

  • collision (boolean) 有限元仿真对象创建后是否开启碰撞，默认：true

  • showMesh (boolean) 是否显示有限元仿真模型，默认值：true

  • edge (object) 网格线边框样式对象，包含以下参数：

    type (number) 线框样式，取值范围：[0,1,2]，0：隐藏 1：网格线 2：特征线

    featureAngel (number) 特征性二面角

    color (string) 可选，线框颜色，默认值：[0.1, 0,1, 0.1, 1]，取值示例

  • pointField (object) 设置有限元仿真对象的点属性字段，包含以下参数：

    field (string) 可选，属性字段名称

    component (string) 可选，属性字段对应的分量名称

  • arrow (object) 设置有限元仿真对象的箭头效果，包含以下参数：

    vectorField (string) 使用此属性字段名称对应的值符号化显示箭头

    lengthScale (number) 可选，箭头长度缩放值

    sizeScale (number) 可选，箭头尺寸

    colorField (string) 颜色属性字段名称

    colorComponent (string) 颜色属性字段对应的分量名称

  • colors (object) 有限元仿真对象的自定义调色板对象，包含颜色渐变控制、无效像素颜色和调色板区间数组

    gradient (boolean) 是否渐变

    invalidColor (Color) 无效像素点的默认颜色，默认白色

    colorStops (array) 调色板对象数组，每一个对象包含热力值和对应颜色值，结构示例：[{"value":0, "color":[0,0,1,1]}]，每一个调色板对象支持以下属性：


    color (Color) 值对应的调色板颜色

    value (number) 值
fn function

可选的回调函数，请参考二次开发：异步接口调用方式
Example
对象结构示例：

let fe2 = {
            "id":"fe_2",
            "filePath":"C:/HHKBZ.vtk",
            "location":[2209.658125,22.4936328125,8.699999389648437],
            "rotation":[0,0,0],
            "collision":true,
            "showMesh": true,
            "edge": {
                "type": 1,
                "featureAngel": 30,
                "color": [0.1, 0,1, 0.1, 1]
            },
            "pointField":{
                "field":"U",
                "component": "XY"
            },
            "arrow":{
                "vectorField":"stress",
                "lengthScale": 1000,
                "sizeScale":   1000,
                "colorComponent": "XY"
            },
            "colors":
            {
                "colorStops":[
                    {
                        "value":0,
                        "color":[0.231373,0.298039,0.752941,1]
                    },
                    {
                        "value":0.5,
                        "color":[0.865,0.865,0.865,1]
                    },
                    {
                        "value":1,
                        "color":[0.705882,0.015686,0.14902,1]
                    }
                ]
            }
        };

applyBoxClipFilter(data, fn)

盒子过滤器

Parameters:
Name Type Description
data object | array

有限元仿真对象盒子过滤器的数据结构，可以是Object类型或者Array类型，支持以下属性：

  • id (string) 有限元仿真对象的唯一标识符ID

  • filterId (string) 过滤器ID

  • clipBBox (array) 剖切盒子的范围，格式：[minX,minY,minZ,maxX,maxY,maxZ]，数组元素类型：[任意浮点数]

  • clipRotation (array) 剖切盒子的旋转：[Pitch,Yaw,Roll]，数组元素类型：(number)，取值范围：[任意数值]

  • crinkleClip (boolean) 是否对切面上的网格体进行剖切并只显示剖切区域的一侧，默认值：false 平滑切面效果，设置为true，则显示褶皱效果

  • invertClip (boolean) 是否打开剖切反转，默认值：true
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

applyContourFilter(data, fn)

根据等值线对应的数值添加过滤器并展示过滤后的有限元模型分析结果

Parameters:
Name Type Description
data object | array

有限元仿真对象过滤器的数据结构，可以是Object类型或者Array类型，支持以下属性：

  • id (string) 有限元仿真对象的唯一标识符ID

  • filterId (string) 过滤器ID

  • fieldName (string) 有限元模型对象包含等值线值的属性字段名称，支持点属性字段

  • contourValues (array) 等值线对应的数值数组，数组元素的取值类型: number，取值示例：[100,200,300,500]
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

applyCylinderClipFilter(data, fn)

圆柱过滤器

Parameters:
Name Type Description
data object | array

有限元仿真对象圆柱过滤器的数据结构，可以是Object类型或者Array类型，支持以下属性：

  • id (string) 有限元仿真对象的唯一标识符ID

  • filterId (string) 过滤器ID

  • clipOrigin (array) 圆柱体的柱心坐标：[X,Y,Z]，取值示例，数组元素类型：(number)，取值范围：[任意数值]

  • clipRadius (array) 圆柱体的半径，单位：米，取值范围：[0,任意正数]

  • clipAxis (array) 圆柱体的轴心朝向，即垂直于圆柱底面的法线向量，取值示例：[0,0,1]

  • crinkleClip (boolean) 是否对切面上的网格体进行剖切并只显示剖切区域的一侧，默认值：false 平滑切面效果，设置为true，则显示褶皱效果

  • invertClip (boolean) 是否打开剖切反转，默认值：true
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

applyPlaneClipFilter(data, fn)

切面过滤器

Parameters:
Name Type Description
data object | array

有限元仿真对象切面过滤器的数据结构，可以是Object类型或者Array类型，支持以下属性：

  • id (string) 有限元仿真对象的唯一标识符ID

  • filterId (string) 过滤器ID

  • clipOrigin (array) 切面的原点坐标：[X,Y,Z]，取值示例，数组元素类型：(number)，取值范围：[任意数值]

  • clipNormal (array) 切面的法线向量，取值示例：[1,0,0]

  • crinkleClip (boolean) 是否对切面上的网格体进行剖切并只显示剖切区域的一侧，默认值：false 平滑切面效果，设置为true，则显示褶皱效果

  • invertClip (boolean) 是否打开剖切反转，默认值：true
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

applySphereClipFilter(data, fn)

球型过滤器

Parameters:
Name Type Description
data object | array

有限元仿真对象球型过滤器的数据结构，可以是Object类型或者Array类型，支持以下属性：

  • id (string) 有限元仿真对象的唯一标识符ID

  • filterId (string) 过滤器ID

  • clipOrigin (array) 球的球心坐标：[X,Y,Z]，取值示例，数组元素类型：(number)，取值范围：[任意数值]

  • clipRadius (array) 球的半径，单位：米，取值范围：[0,任意正数]

  • crinkleClip (boolean) 是否对切面上的网格体进行剖切并只显示剖切区域的一侧，默认值：false 平滑切面效果，设置为true，则显示褶皱效果

  • invertClip (boolean) 是否打开剖切反转，默认值：true
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

applyThresholdFilter(data, fn)

根据模型属性字段对应的区间值添加过滤器并展示过滤后的有限元模型分析结果

Parameters:
Name Type Description
data object | array

有限元仿真对象过滤器的数据结构，可以是Object类型或者Array类型，支持以下属性：

  • id (string) 有限元仿真对象的唯一标识符ID

  • filterId (string) 过滤器ID

  • fieldName (string) 有限元模型对象包含的区间类型的属性字段名称，支持cell属性字段和点属性字段

  • range (array) 字段属性值的区间范围: [min~max]，区间范围的取值类型: number，取值示例：[10,20]
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

clear(fn)

清空场景中所有的有限元仿真对象

Parameters:
Name Type Description
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

clearFilter(ids, fn)

清空指定的有限元模型对象添加的所有过滤器

Parameters:
Name Type Description
ids string | array

有限元仿真对象的ID或ID数组
fn function

可选的回调函数，请参考二次开发：异步接口调用方式
Returns:

delete(ids, fn)

删除一个或多个有限元仿真对象

Parameters:
Name Type Description
ids string | array

要删除的有限元仿真对象ID或者ID数组（可以删除一个或者多个）
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

focus(ids, distance, flyTime, rotation, fn)

自动定位到合适的观察距离

Parameters:
Name Type Description
ids string | array

有限元仿真对象的ID或者ID数组
distance number

可选参数，观察点距离目标点（被拍摄物体）的距离，取值范围：[0.01~任意正数]，如果设置为0或者不设置，系统自动计算
flyTime number

可选参数，相机飞行的时间，取值范围：[0~任意正数]，单位：秒，默认值2秒
rotation array

可选参数，相机旋转的欧拉角：[Pitch,Yaw,Roll]，数组元素类型：(number)，取值范围：Pitch[-90~90] Yaw[-180~180] Roll[0]
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

get(ids, fn)

根据有限元分析ID获取有限元分析的详细信息

Parameters:
Name Type Description
ids string | array

要获取的有限元仿真对象ID或者ID数组（可以获取一个或者多个）
fn function

可选的回调函数，请参考二次开发：异步接口调用方式
Example
返回FiniteElement的详细信息

{
            "id":"fe_2",
            "filePath":"C:/HHKBZ.vtk",
            "location":[2209.658125,22.4936328125,8.699999389648437],
            "rotation":[0,0,0],
            "collision":true,
            "edgeColor": [0.1, 0.1, 0.1, 1],
            "showMesh":false,
            "edge": {
                "type": 1,
                "featureAngel": 30,
                "color": [0.1, 0,1, 0.1, 1]
            },
            "pointField":{
                "field":"U",
                //"component": "XY" //可选
            },
            "colors":
            {
                "colorStops":[
                    {
                        "value":0,
                        "color":[0.231373,0.298039,0.752941,1]
                    },
                    {
                        "value":0.5,
                        "color":[0.865,0.865,0.865,1]
                    },
                    {
                        "value":1,
                        "color":[0.705882,0.015686,0.14902,1]
                    }
                ]
            }
        };

hide(ids, fn)

隐藏有限元分析

Parameters:
Name Type Description
ids string | array

有限元仿真对象的ID或者ID数组
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

removeFilter(data, fn)

移除指定的有限元模型对象添加的相关过滤器

Parameters:
Name Type Description
data object | array

有限元仿真对象过滤器的数据结构，可以是Object类型或者Array类型

  • id (string) 有限元仿真对象的唯一标识符ID

  • filterIds (array) 过滤器ID数组
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

show(ids, fn)

显示有限元分析

Parameters:
Name Type Description
ids string | array

有限元仿真对象的ID或者ID数组
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

update(data, fn)

修改一个或多个有限元仿真对象

Parameters:
Name Type Description
data object | array

有限元仿真对象或对象数组，参考add方法参数。注意：不支持更新文件路径参数(filePath)，需先删除再添加
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

updateBegin()

用于批量多次修改对象的属性

在开始修改之前调用updateBegin，然后可以多次调用setXXX方法，最后调用updateEnd提交修改更新数据
注意：
updateBegin不是异步调用，不需要await，也没有回调函数参数

Inherited From:
Overrides:
Example
fdapi.xxx.updateBegin();
for (let i = 0; i < 1000; i++) {
     fdapi.xxx.setColor(i, Color.Yellow);
} 
fdapi.xxx.updateEnd(function () {
     log('update finished!');
});

updateEnd(fn)

用于批量多次修改对象的属性，与updateBegin配套使用
注意：
updateEnd是异步调用，可以用回调函数也可以await

Parameters:
Name Type Description
fn function

可选的回调函数，请参考二次开发：异步接口调用方式
Inherited From:
Overrides: