Global

Type Definitions

Animate

css 动画对象

Properties:
Name Type Description
delay function

设置动画延时启动时间

duration function

设置动画持续时间

ease function

设置缓动方式

end function

启动当前的动画过程,可传入一个函数在动画队列完成后被回调

pop function

返回当前动画过程的上一个动画过程

rotate function

转换为 transform: rotate(n)

scale function

转换为 transform: scale(x, y)

scaleX function

转换为 transform: scaleX(y)

scaleY function

转换为 transform: scaleY(y)

set function

设置css样式

skew function

转换为 transform: skew(x, y)

skewX function

转换为 transform: skewX(n)

skewY function

转换为 transform: skewY(n)

tX function

同 translateX(n)

then function

在动画队列中加入一个新的动画过程

transform function

css transform 属性,如 scale(x,y) 等

translate function

转换为transform: translate(x, y),参数可以为数字(当作'px'处理),也可以为字符串度量值('10px', '20em'等)

translateX function

转换为 transform: translateX(n) 参数可以为数字或字符串度量值

translateY function

转换为 transform: translateY(n) 参数可以为数字或字符串度量值

ty function

同 translateY(n)

AnimInstance

动画实例

Properties:
Name Type Attributes Description
delay number <optional>

延迟执行时间

duration number <optional>

周期 Time-Based 方式执行动画,优先高于 Frame-Based

easing EasingFunc <optional>

缓动

frames number <optional>

帧数

interval number <optional>

执行间隔

action function <optional>

动画执行函数

finishFunc function <optional>

结束回调

isPaused function

动画是否暂停

isRunning function

是否正在执行

pause function

暂停动画

resume function

恢复动画

stop function

停止动画,会执行 finishFunc

AnimOption

动画选项

Properties:
Name Type Attributes Description
delay number <optional>

延迟执行时间

duration number <optional>

周期 Time-Based 方式执行动画,优先高于 Frame-Based

easing EasingFunc <optional>

缓动

frames number <optional>

帧数

interval number <optional>

执行间隔

action function <optional>

动画执行函数

finishFunc function <optional>

结束回调

basePainterClass

Properties:
Name Type Description
draw painter

画布函数

buttonConfig

对话框按钮配置

Properties:
Name Type Attributes Description
action Object <optional>
className string <optional>

指定按钮的样式名称,用于自定义按钮样式

label string

按钮文本

ConnectActionExtraInfo

Properties:
Name Type Attributes Description
delete Object <optional>
visible function <optional>

ConnectActionFunc(gv, source, target) → {void}

Parameters:
Name Type Description
gv ht.graph.GraphView
source ht.Node
target ht.Node
Returns:
void

deserializeFinishFunc(json, dm, view, datas) → {void}

Parameters:
Name Type Attributes Description
json Object <optional>

反序列化的 json 对象

dm ht.DataModel <optional>

数据模型

view ht.graph3d.Graph3dView | ht.graph.GraphView <optional>

拓扑视图对象

datas ht.List <optional>

反序列化的数据列表

Returns:
void

deserializeParams

Properties:
Name Type Attributes Description
disableInit boolean <optional>

取消执行 init 方法

disableOnPostDeserialize boolean <optional>

取消执行 onPostDeserialize 方法

disableOnPreDeserialize boolean <optional>

取消执行 onPreDeserialize 方法

finishFunc deserializeFinishFunc <optional>

反序列化完成后的回调函数

justDatas boolean <optional>

只序列化节点

reset boolean <optional>

重置场景状态

setId boolean <optional>

保持 Node id 不变

DialogConfig

对话框配置

Properties:
Name Type Attributes Description
action Object <optional>
borderWidth number <optional>

对话框的边框宽度

buttons Array.<buttonConfig> <optional>

指定对话框按钮组内容, 参数为一个数组

buttonsAlign string <optional>

指定对话框按钮的对齐方式,可选值为 left/right/center

closable boolean <optional>

可选值为 true/false ,表示是否显示关闭按钮

content any

指定对话框的内容,可以是html文本,或DOM元素,或HT组件对象(自动调用其invalidate)

contentPadding number <optional>

对话框内容区域的内边距

dragMode string <optional>

指定对话框拖拽模式,inside 表示对话框内容包含在父亲容器中,none 或 null 表示随意拖放,到达边界会留出最小 minDragSize 的可拖动区域

draggable boolean <optional>

指定对话框是否可拖拽调整位置,可选值为 true/false

height number <optional>

指定对话框的高度,如果为空,则取content的offsetHeight。由于HT组件对象没有自有高度,所以必须指定height属性

maximizable boolean <optional>

可选值为 true/false,表示对话框是否可被最大化

maximized boolean <optional>

将对话框最大化

minDragSize number <optional>

指定对话框在超出父亲容器的最小可拖动区域大小,默认为 20

position any <optional>

指定对话框的的位置,默认为字符串center,也可以通过一个对象格式指定x、y坐标:{x: 0, y: 0}

resizeMode string <optional>

鼠标移动到对话框右下角可改变对话框的大小,此参数控制resize模式:w表示只调整宽度,h表示只调整高度,wh表示宽高都可调整,none表示不可调整宽高

title string <optional>

对话框的标题

titleAlign string <optional>

标题文本对齐方式,可选值为left/right/center

titleBackground string <optional>

指定标题栏的背景色

titleColor string <optional>

指定标题栏文字的颜色

titleIcon string <optional>

标题栏图标

width number <optional>

指定对话框的宽度,如果为空,则取content的offsetWidth。由于HT组件对象没有自有宽度,所以必须指定width属性

EasingFunc(time) → {number}

缓动函数

Parameters:
Name Type Description
time number
Returns:
number

fbxAnimParams

Properties:
Name Type Description
duration number
loop string
name string
speed number
time number

FlyToOption

flyTo 配置项

Properties:
Name Type Attributes Description
animation boolean | AnimOption <optional>

默认false,是否使用动画,可以设置为true或者false或者animation动画对象

center Array.<number> <optional>

新的场景center点

direction Array.<number> <optional>

眼睛处于目标的方向(相对目标,受到目标自身旋转影响),例如[0,1,5]在目标正面的斜向上

distance number <optional>

眼睛跟中心的固定距离, 若定义 ratio 属性,则优先使用 ratio

ratio number <optional>

默认0.8,浮点类型,表示眼睛跟中心的距离动态计算(例如 0.8 表示眼睛在上述方向上动态计算距离以将目标包围盒的8个角全部适配到屏幕80%范围内)

worldDirection Array.<number> <optional>

眼睛处于目标的方向(相对场景,不受目标旋转影响),例如[0,1,5]在目标所在位置的斜向上

FrameParams

构建框架体模型配置

Properties:
Name Type Attributes Description
back boolean <optional>

true代表整体覆盖面,false代表该面为空,其余属性代表镂空,也即默认效果

bottom boolean <optional>

true代表整体覆盖面,false代表该面为空,其余属性代表镂空,也即默认效果

front boolean <optional>

true代表整体覆盖面,false代表该面为空,其余属性代表镂空,也即默认效果

left boolean <optional>

true代表整体覆盖面,false代表该面为空,其余属性代表镂空,也即默认效果

right boolean <optional>

true代表整体覆盖面,false代表该面为空,其余属性代表镂空,也即默认效果

top boolean <optional>

true代表整体覆盖面,false代表该面为空,其余属性代表镂空,也即默认效果

HTInteractiveEvent

Properties:
Name Type Attributes Description
data ht.Data <optional>
event any
kind string
part string <optional>
type string <optional>

HTPropertyChangeEvent

Properties:
Name Type Description
data any
newValue any
oldValue any
property string

LoadFbxParams

加载 fbx 模型配置

Properties:
Name Type Attributes Description
animationSources Array.<any> <optional>

外挂式动画源

animations boolean | object <optional>

表示是否解析动画,通过设置不同的属性值

center boolean <optional>

模型是否居中,默认为 false,设置为 true 则会移动模型位置使其内容居中

cube boolean <optional>

是否将模型缩放到单位 1 的尺寸范围内,默认为 false

flipY boolean <optional>

是否对 uv 做上下反转处理,默认值是 true,表示会反转,该属性是为了处理 HT 中 uv 原点坐标位置与建模软件中 uv 原点坐标有差异的问题,保证贴图能够正确渲染

matDef object <optional>

覆盖模型中的材质定义,使用由 HT 中定义的材质,保证效果能正确展示

playAutomatically boolean <optional>

模型初次加载完是否自动播放默认动画,默认是 false

rotationInterpolation boolean <optional>

动画旋转超过 180 度时是否需要插值,默认值是 undefined,表示使用内部定义的一套插值临界值判断算法,不保证效果一定正确,还可以设置为 true(无条件进行插值)、false(不做插值处理)

shape3d string <optional>

如果指定了 shape3d 名称,则 HT 将会以该名称在内存中注册模型

finishFunc function

LoadGltfParams

加载 gltf 模型配置

Properties:
Name Type Attributes Description
animationSources Array.<any> <optional>

外挂式动画源

animations boolean | object <optional>

表示是否解析动画,通过设置不同的属性值

center boolean <optional>

模型是否居中,默认为false,设置为 true 则会移动模型位置使其内容居中

cube boolean <optional>

是否将模型缩放到单位1的尺寸范围内,默认为 false

flipY boolean <optional>

是否对 uv 做上下反转处理,默认值是 true,表示会反转,该属性是为了处理 HT 中 uv 原点坐标位置与建模软件中 uv 原点坐标有差异的问题,保证贴图能够正确渲染

matDef object <optional>

覆盖模型中的材质定义,使用由 HT 中定义的材质,保证效果能正确展示

playAutomatically boolean <optional>

模型初次加载完是否自动播放默认动画,默认是 false

rotationInterpolation boolean <optional>

动画旋转超过 180 度时是否需要插值,默认值是 undefined,表示使用内部定义的一套插值临界值判断算法,不保证效果一定正确,还可以设置为 true(无条件进行插值)、false(不做插值处理)

shape3d string <optional>

如果指定了shape3d名称,则 HT 将会以该名称在内存中注册模型

finishFunc function

LoadObjParams

加载模型模型配置

Properties:
Name Type Attributes Description
center boolean <optional>

模型是否居中,默认为false,设置为true则会移动模型位置使其内容居中

cube boolean <optional>

是否将模型缩放到单位1的尺寸范围内,默认为false

flipFace boolean <optional>

默认为false,设置为true则代表翻转所有模型的面,也就是原来的正面变成反面,原来的反面变成正面

flipY boolean <optional>

图片上下翻转,默认为false,遇到模型图片上下颠倒的情况可设置该参数为true

ignoreColor boolean <optional>

忽略材质颜色kd属性,默认为false代表读取kd值,该属性在返回值中名称为color

ignoreImage boolean <optional>

忽略材质贴图map_kd属性,默认为false代表读取map_kd值,该属性在返回值中名称为image

ignoreMtls boolean <optional>

忽略部分材质,默认为空代表都读取,格式为 ['material2', 'material3'] 数组,忽略的材质不出现在返回值中

ignoreNormal boolean <optional>

忽略法线向量,默认为false会读取法线向量信息,设置为true则忽略不读取法线向量信息

ignoreTransparent boolean <optional>

忽略材质透明度d属性,默认为false代表读取d值,读取该属性将影响返回值的transparent和opacity属性

mat Array.<Array.<number>> <optional>

矩阵变化参数,可对模型进行矩阵变化后导入,一般通过 ht.Default.createMatrix 函数构建变化矩阵

part boolean <optional>

默认false,将会按照mtl名分组,即相同材质都将被批量的组在一起;改成true则按照group或name信息来进行分组

prefix string <optional>

图片路径前缀,即在map_kd值之前增加的前缀,如果是相对路径则以加载obj的html页面的路径为参考

r3 Array.<number> <optional>

旋转变化参数,格式为[rx, ry, rz]

reverseFlipMtls Array.<string> <optional>

模型反面显示正面一样的内容,传入*代表适用于全部材质,传入['material2', 'material3']数组格式代表适用于指定材质

rotationMode string <optional>

旋转模式参数

s3 Array.<number> <optional>

大小变化参数,格式为[sx, sy, sz]

shape3d string <optional>

如果指定了shape3d名称,则HT将自动将加载解析后的所有材质模型构建成数组的方式,以该名称进行注册

sync boolean <optional>

是否同步参数,默认为false代表异步加载,设置为true代表同步加载,意味数据加载后才运行loadObj之后的代码

t3 Array.<number> <optional>

位置变化参数,格式为[tx, ty, tz]

finishFunc function <optional>

用于加载后的回调处理

菜单配置

Properties:
Name Type Attributes Description
action Object <optional>
disabled boolean <optional>

禁用菜单项

groupId number <optional>

菜单项分组

href string <optional>

超链到某个URL

icon string <optional>

菜单图片ICON

items string | Array.<MenuParams> <optional>

菜单项

key Array.<any> <optional>

实际响应的快捷键

label string <optional>

菜单文字

linkTarget string <optional>

超链目标,默认_self

preventDefault boolean <optional>

是否阻止快捷键默认的行为,默认为true

scope string | object <optional>

指定回调函数中的this

suffix string <optional>

在菜单上显示的提示文字

type string <optional>

类型

modelAnimations

Properties:
Name Type Description
duration number
name string
sourceShortName string
sources Array.<any>
tag number
tracks Array.<any>

painter(g) → {void}

画布函数

Parameters:
Name Type Description
g CanvasRenderingContext2D

2D 渲染上下文

Returns:
void

PanelButtonObj

面板按钮配置

Properties:
Name Type Attributes Description
action Object <optional>
icon any <optional>

图标

independentSwitch any <optional>

控制 independent 参数,也可以是js对象,表示自定义按钮

minimize any <optional>

最小化按钮

name string <optional>

名称

toggle any <optional>

展开/合并按钮

toolTip any <optional>

提示内容

PanelConfig

面板配置

Properties:
Name Type Attributes Description
borderWidth number <optional>

边框宽度

buttons string | Array.<PanelButtonObj> <optional>

扩展标题栏中的按钮,此参数为一个数组,数组中元素可以是以下两个字符串

content any <optional>

面板的内容,可以为 HTML 文本、DOM 元素或 HT 组件

contentHeight number <optional>

指定面板内容的高度,对于 HTML 文本或 DOM 元素可以不指定此参数,由 HTML 内容撑开面板;由于 HT 组件自身没有尺寸,所以如果 content 为 HT 组件,必须指定此参数

exclusive boolean <optional>

此参数只在外层面板有效,表示是否只允许展开一个子面板,默认为 false

expanded boolean <optional>

面板是否展开,为 false 时表示合并,否则展开,默认为空

flowLayout boolean <optional>

如果为 true 表示使用流式布局,在此布局下无法使用最小化,拖拽位置、吸附等功能

id number <optional>

面板唯一标识,如果为空,面板内部会自动生成一个唯一标识。如果要获取面板的状态,如是否展开等,需要指定此参数

independent boolean <optional>

此参数只在内层面板有效,表示外层面板只允许展开一个子面板时,自身是否独立,换句话说,如果此参数为 true,此子面板不受外层面板 exclusive 参数影响

items Array.<PanelConfig> <optional>

此参数为一个数组,数组中每个 js 对象都表示一个子面板,子面板的配置参数如 PanelConfig。

minimizable boolean <optional>

面板是否可最小化,为 false 时表示面板不可最小化,默认为空

minimized boolean <optional>

面板是否最小化,为 true 时表示将面板最小化,默认为空

narrowWhenCollapse boolean <optional>

如果为 true 合并面板时收缩宽度

position string <optional>
resizeMode string <optional>

用户鼠标移动到面板右下角时可以 resize 面板,此参数控制 resize 模式:w 表示只允许调整宽度,h 表示只允许调整高度,wh 表示宽高都允许调整,none 表示不允许 resize

restoreIconSize number <optional>

恢复图标的尺寸

restoreToolTip string <optional>

恢复按钮的 toolTip

separatorColor string <optional>

内部面板之间分割线的颜色

separatorWidth number <optional>

内部面板之间分割线的宽度

title string <optional>

面板标题

titleBackground string <optional>

标题栏的背景颜色

titleColor string <optional>

标题文本的颜色

titleHeight number <optional>

标题栏的高度

titleIcon string <optional>

面板 icon,可以为 url 或 base64 字符

titleIconSize number <optional>

标题栏中图片的尺寸,包括展开/合并图标、最小化图标及 titleIcon

toggleToolTip string <optional>

展开/合并按钮的 toolTip

width number <optional>

指定面板的宽度,对于 HTML 文本或 DOM 元素可以不指定此参数,由 HTML 内容撑开面板;由于 HT 组件自身没有尺寸,所以如果 content 为HT组件,必须指定此参数

PanelIndependentObj

面板 independent 配置

Properties:
Name Type Attributes Description
action Object <optional>
icon string <optional>

按钮图片,可以为 url 或 base64 字符

name string <optional>

名称,唯一标识,请使用英文字母

toolTip string <optional>

鼠标悬停时的提示文本

ParseFbxParams

解析 fbx 模型配置

Properties:
Name Type Attributes Description
animationSources Array.<any> <optional>

外挂式动画源

animations boolean | object <optional>

表示是否解析动画,通过设置不同的属性值

center boolean <optional>

模型是否居中,默认为 false,设置为 true 则会移动模型位置使其内容居中

cube boolean <optional>

是否将模型缩放到单位 1 的尺寸范围内,默认为 false

flipY boolean <optional>

是否对 uv 做上下反转处理,默认值是 true,表示会反转,该属性是为了处理 HT 中 uv 原点坐标位置与建模软件中 uv 原点坐标有差异的问题,保证贴图能够正确渲染

matDef object <optional>

覆盖模型中的材质定义,使用由 HT 中定义的材质,保证效果能正确展示

playAutomatically boolean <optional>

模型初次加载完是否自动播放默认动画,默认是 false

rotationInterpolation boolean <optional>

动画旋转超过 180 度时是否需要插值,默认值是 undefined,表示使用内部定义的一套插值临界值判断算法,不保证效果一定正确,还可以设置为 true(无条件进行插值)、false(不做插值处理)

shape3d string <optional>

如果指定了 shape3d 名称,则 HT 将会以该名称在内存中注册模型

ParseGltfParams

解析 gltf 模型配置

Properties:
Name Type Attributes Description
animationSources Array.<any> <optional>

外挂式动画源

animations boolean | object <optional>

表示是否解析动画,通过设置不同的属性值

center boolean <optional>

模型是否居中,默认为false,设置为 true 则会移动模型位置使其内容居中

cube boolean <optional>

是否将模型缩放到单位1的尺寸范围内,默认为 false

flipY boolean <optional>

是否对 uv 做上下反转处理,默认值是 true,表示会反转,该属性是为了处理 HT 中 uv 原点坐标位置与建模软件中 uv 原点坐标有差异的问题,保证贴图能够正确渲染

matDef object <optional>

覆盖模型中的材质定义,使用由 HT 中定义的材质,保证效果能正确展示

playAutomatically boolean <optional>

模型初次加载完是否自动播放默认动画,默认是 false

rotationInterpolation boolean <optional>

动画旋转超过 180 度时是否需要插值,默认值是 undefined,表示使用内部定义的一套插值临界值判断算法,不保证效果一定正确,还可以设置为 true(无条件进行插值)、false(不做插值处理)

shape3d string <optional>

如果指定了shape3d名称,则 HT 将会以该名称在内存中注册模型

ParseObjParams

解析模型哦配置

Properties:
Name Type Attributes Description
center boolean <optional>

模型是否居中,默认为false,设置为true则会移动模型位置使其内容居中

cube boolean <optional>

是否将模型缩放到单位1的尺寸范围内,默认为false

flipFace boolean <optional>

默认为false,设置为true则代表翻转所有模型的面,也就是原来的正面变成反面,原来的反面变成正面

flipY boolean <optional>

图片上下翻转,默认为false,遇到模型图片上下颠倒的情况可设置该参数为true

ignoreColor boolean <optional>

忽略材质颜色kd属性,默认为false代表读取kd值,该属性在返回值中名称为color

ignoreImage boolean <optional>

忽略材质贴图map_kd属性,默认为false代表读取map_kd值,该属性在返回值中名称为image

ignoreMtls boolean <optional>

忽略部分材质,默认为空代表都读取,格式为 ['material2', 'material3'] 数组,忽略的材质不出现在返回值中

ignoreNormal boolean <optional>

忽略法线向量,默认为false会读取法线向量信息,设置为true则忽略不读取法线向量信息

ignoreTransparent boolean <optional>

忽略材质透明度d属性,默认为false代表读取d值,读取该属性将影响返回值的transparent和opacity属性

mat Array.<Array.<number>> <optional>

矩阵变化参数,可对模型进行矩阵变化后导入,一般通过 ht.Default.createMatrix 函数构建变化矩阵

part boolean <optional>

默认false,将会按照mtl名分组,即相同材质都将被批量的组在一起;改成true则按照group或name信息来进行分组

prefix string <optional>

图片路径前缀,即在map_kd值之前增加的前缀,如果是相对路径则以加载obj的html页面的路径为参考

r3 Array.<number> <optional>

旋转变化参数,格式为[rx, ry, rz]

reverseFlipMtls Array.<string> <optional>

模型反面显示正面一样的内容,传入*代表适用于全部材质,传入['material2', 'material3']数组格式代表适用于指定材质

rotationMode string <optional>

旋转模式参数

s3 Array.<number> <optional>

大小变化参数,格式为[sx, sy, sz]

shape3d string <optional>

如果指定了shape3d名称,则HT将自动将加载解析后的所有材质模型构建成数组的方式,以该名称进行注册

t3 Array.<number> <optional>

位置变化参数,格式为[tx, ty, tz]

Point

Properties:
Name Type Attributes Description
e number <optional>
x number
y number

Point3d

Properties:
Name Type Attributes Description
e number <optional>
x number
y number
z number

Rect

矩形区域

Properties:
Name Type Description
height number
width number
x number
y number

RulerConfig

刻度尺配置

Properties:
Name Type Attributes Description
background string <optional>

指定刻度尺背景色,默认为rgba(0, 0, 0, 0)

borderColor string <optional>

指定刻度尺的边框颜色,默认为#888

borderStyle string <optional>

指定刻度尺的边框样式,支持css提供的所有边框样式,默认为solid

borderWidth number <optional>

指定刻度尺的边框宽度,默认为1

defaultMajorTickSpacing number <optional>

指定刻度尺主刻度之间的间距,默认为50

guideColor string <optional>

指定参考线颜色,默认为rgb(0, 173, 239)

guideTipBackground string

指定参考线提示框的背景颜色,默认为#fff

guideTipBorderColor string

指定参考线提示框边框颜色,默认为#666

guideTipTextColor string <optional>

指定参考线提示框内的文本颜色,默认为#666

guideTipTextFont string

指定参考线提示框内的文本字体,默认为12px Arial

guideTipVisible boolean <optional>

指定参考线提示框是否可见, 默认为false

guideVisible boolean <optional>

参考线是否可见,默认为false

guideWidth number <optional>

指定参考线宽度,默认为2

majorTickColor string <optional>

指定主刻度标记的颜色,默认为#888

majorTickTextColor string <optional>

指定主刻度文字的颜色,默认为#666

majorTickTextFont string <optional>

指定主刻度文字的字体,默认为12px Arial

maxPhysicalMajorTickSpacing number <optional>

指定刻度尺主刻度之间的最大屏幕像素,如果tickSpacingAdaptable为true并且主刻度之间的屏幕像素大于此属性指定的值, 则自动收缩主刻度之间的间距; 默认值为100

minMajorTickSpacing number <optional>

主刻度之间的最小间距,默认为10

minPhysicalMajorTickSpacing number <optional>

指定刻度尺主刻度之间的最小屏幕像素,如果tickSpacingAdaptable为true并且主刻度之间的屏幕像素小于此属性指定的值, 则自动扩大主刻度之间的间距; 默认值为50

minorTickColor string <optional>

指定小刻度标记的颜色,默认为#ccc

size number <optional>

指定刻度尺的宽度,默认为20

tickSpacingAdaptable number | boolean <optional>

是否自动调整刻度尺主刻度之间的间距,默认为true

visible boolean <optional>

单个刻度尺配置是否可见,用于控制当前刻度尺是否可见, 默认只显示左、上两个刻度尺

ScheduleTask

调度任务对象

Properties:
Name Type Attributes Description
action function

间隔动作函数,对DataModel上的每个data节点都会执行一次action操作

afterAction function <optional>

调度开始之后的动作函数

beforeAction function <optional>

调度开始之前的动作函数

enabled boolean <optional>

是否启用开关,默认为true

interval number <optional>

间隔毫秒数,默认值为10

Size2d

Properties:
Name Type Description
height number
width number