0.1.21 • Published 2 years ago

@tlbs/galaxy-model v0.1.21

Weekly downloads
-
License
ISC
Repository
-
Last release
2 years ago

模型JSSDK接口文档

toc

创建实例

初始化实例。

构造函数

  • 语法

    	```
    	new TModel.Scene(container, sceneOptions);
    	```
  • 参数说明

参数名类型说明
containerString/HTMLDIVElement模型DOM容器,创建模型需要在页面中创建一个空div元素,传入该div元素或者该元素的id
sceneOptionsObject模型查看器初始化参数,对象规范详见SceneOptions

SceneOptions 对象规范

模型配置参数。

属性

名称类型说明
lightobject可选,默认为环境光,颜色fff, 强度为1
cameraPostionTModel.Vector3可选,默认为0.100.0,透视相机,fov为60 , 由position 指向0,0,0

方法

方法名返回值说明
addModel(Model: Model)model新增模型
deleteModel(modelId: String)this删除模型
addLight(lightOptions: LightOptions)增加光源
updateLight(lightId: String, lightOptions: LightOptions)this更新光源
deleteLight(light: TModel.Light)this删除光源
getLights()THREE.Light[]获取所有光源
updateCamera(cameraOptions: CameraOptions)this更新相机
setBackground(path: String)thispath为图片路径,把一张图片作为模型渲染背景
clearBackground()this清空背景
easeTo(easeToOptions: EaseToOptions)thistarget:需要过渡的物体 dest:终点位置 type:过渡动画类型
addLine(: TModel.Color, start:TModel.Vector3, end: TModel.Vector3 )thiscolor:线颜色 start:线起点位置 end:线终点位置
deleteLine(target: TModel.Object3D)this删除线
addText(textOptions: textOptions)this新增文字
deleteText(textOptions: textOptions)this删除文字
addAnimation(animationOptions: AnimationOptions)thistype:动画类型 position:动画位置

Model类

初始化实例。

构造函数

  • 语法

    new TModel.Model(modelOptions);
  • 参数说明

参数名类型说明
modelOptionsObject模型初始化参数,对象规范详见ModelOptions

ModelOptions 对象规范

创建模型对象的配置参数。

属性

名称类型说明
urlString模型资源url
positionTModel.Vector3模型锚点所对应的坐标,格式为[x, y, z],默认为[0, 0, 0]
idString(可选)模型唯一标识
rotationTModel.Vector3(可选)模型XYZ三轴上的旋转角度,格式为[x, y, z],默认为[0, 0, 0]
scaleNumber | TModel.Vector3(可选)模型在XYZ三轴上的缩放比例。若为数字,则三轴均以该比值进行缩放;若为数组,则可分别指定三轴缩放比例,格式为[x, y, z]。默认为1

方法

方法名返回值说明
setPosition(position: TModel.Vector3)this设置模型锚点所在的xyz坐标
getBoundaryTModel.Vector3xy, xz, yz 表示三个坐标轴方向的长度
setRotation(rotation: TModel.Vector3)this设置模型旋转角度
setScale(scale: Number | TModel.Vector3)this设置模型缩放比例
getPosition()TModel.Vector3获取模型锚点所在的xyz坐标
getRotation()TModel.Vector3获取模型旋转角度
getScale()TModel.Vector3获取模型缩放比例
destroy()this销毁模型对象
show()this显示模型
hide()this隐藏模型
on(eventName:String, listener:Function)this添加listenereventName事件的监听器数组中
off(eventName:String, listener:Function)thiseventName事件的监听器数组中移除指定的listener

事件

事件名返回值说明
loadedModelLoadEvent模型资源加载完成
loadingModelLoadEvent模型资源加载中
load_failedModelLoadEvent模型资源加载失败

ModelLoadEvent 对象规范

模型对象的加载事件返回对象。 属性

名称类型说明
targetModel事件的目标模型对象
errorError加载失败的错误对象,load_failed事件返回

LightOptions 对象规范

光源配置参数,不同类型的光源可配置参数不同,详见下表。

属性

名称类型说明
typeLIGHT_TYPE光源类型
idString(通用)光源id,默认为随机字符串
colorString(通用)光色,支持rgb()#RRGGBB形式,默认为#FFFFFF
intensityNumber(通用)光强,默认为1.0
directionTModel.Vector3(方向光)光线投射方向,为一个三维向量,格式为[x, y, z], 默认目标位置为0,0,0
positionTModel.Vector3(点光源)光源的xyz位置

LIGHT_TYPE 常量说明

光源类型常量说明。

常量说明
LIGHT_TYPE.AMBIENT环境光
LIGHT_TYPE.DIRECTION方向光
LIGHT_TYPE.POINT点光源

cameraOptions

  • 参数说明
参数名类型说明
positionTModel.Vector3位置xyz
typeString类型,正交Orthographic和透视Perspective两种
propertiesPerspectiveCameraOptions/OrthographicCameraOptions相机参数

PerspectiveCameraOptions

数名类型说明
fovNumber(可选)摄像机视锥体垂直视野角度,默认为60
aspectNumber(可选)摄像机视锥体长宽比,默认为容器长宽比
nearNumber(可选)摄像机视锥体近端面
farNumber(可选)摄像机视锥体远端面

OrthographicCameraOptions

参数名类型说明
leftNumber摄像机视锥体左侧面
rightNumber摄像机视锥体右侧面
topNumber摄像机视锥体上侧面
bottomNumber摄像机视锥体下侧面
nearNumber摄像机视锥体近端面
farNumber摄像机视锥体远端面

textOptions类

  • 参数说明
参数名类型说明
textString文字内容
positionTModel.Vector3坐标x, y, z
rotationTModel.Vector3旋转x, y, z
scaleTModel.Vector3缩放比例x, y, z
styleObject文字参数

style

参数名类型说明
fontString字体
sizeNumber字体大小
heightNumber文本厚度
colorTModel.Color字体颜色

EaseToOptions 对象规范 过渡动画

参数名类型说明
targetTModel.Object3D目标动画物体
destTModel.Vector3目标动画终点位置
easeTypeEaseType过渡动画类型

EaseType 对象规范

过渡动画类型

类型说明
QuadraticIn符合二次函数的动画。会在初始较慢的速度,然后加速到中间,并以较快的速度到终点
QuadraticOut与QuadraticIn相反

AnimationOptions | 参数名 | 类型 | 说明 | | -------- | -------------- | ------------ | | type | AnimationType | 动画效果类型 | | position | TModel.Vector3 | 动画效果位置 |

AnimationType 对象规范 动画效果类型

名称类型说明
typeString可选项:streamer。流光效果
0.1.20

2 years ago

0.1.21

2 years ago

0.1.18

2 years ago

0.1.19

2 years ago

0.1.12

2 years ago

0.1.13

2 years ago

0.1.14

2 years ago

0.1.15

2 years ago

0.1.17-beta.1

2 years ago

0.1.17-beta.0

2 years ago

0.1.17-beta.2

2 years ago

0.1.16

2 years ago

0.1.17

2 years ago

0.1.11

2 years ago

0.1.10

2 years ago