Members
-
constant AccuracyMode :string
-
精确模式
Properties:
Name Type Description Basicstring 基础模式 Accuratestring 精确模式 -
constant ActionQueueType :string
-
动作队列类型。
Properties:
Name Type Description EnterLevelstring 进入对象层级的动作。 -
constant AlignType :string
-
对齐类型。
Properties:
Name Type Description Centerstring 居中对齐。 Leftstring 左对齐。 Topstring 顶部对齐。 TopLeftstring 左上对齐。 TopRightstring 右上对齐。 Rightstring 右对齐。 Bottomstring 底部对齐。 BottomLeftstring 左下对齐。 BottomRightstring 右下对齐。 -
constant AnimationDirectionType :string
-
动画方向类型。
Properties:
Name Type Description Normalstring 正常模式播放。 Reversestring 反向模式播放。 -
constant AxisType :string
-
坐标轴类型。
Properties:
Name Type Description Xstring X轴 Ystring Y轴 Zstring Z轴 -
constant BezierMode :string
-
贝塞尔曲线模式
Properties:
Name Type Description Symmetrystring 对称模式 Pursuitstring 追逐模式 -
constant BlendingType :string
-
混合类型。
Properties:
Name Type Description Nostring 禁用混合。 Normalstring 正常混合。颜色(RGB) = (源颜色 * 1) + (目标颜色 * (1 - 源Alpha))颜色(A) = (源Alpha * 1) + (目标Alpha * (1 - 源Alpha)) Additivestring 加法混合。颜色(RGBA) = (源颜色 * 1) + (目标颜色 * 1)。 Subtractivestring 减法混合。颜色(RGB) = 目标颜色 * (1 - 源Alpha)颜色(A) = 目标Alpha * 1 Multiplystring 乘法混合。颜色(RGB) = 目标颜色 * 源颜色颜色(A) = 目标Alpha * 源Alpha -
constant BoxHelperModeType :string
-
包围盒显示方案
Properties:
Name Type Description Allstring All 物体以及所有子物体都计算到一个包围盒中(会显示一个最大的包围盒) Rootstring Root 只显示物体自身的包围盒,忽略所有子物体 Bodiesstring Bodies 显示物体以及所有子物体自身的包围盒(会显示多个包围盒) -
constant CameraMode :string
-
相机模式
Properties:
Name Type Description Mapstring 地图模式 Normalstring 普通模式 -
constant CodeType :string
-
按键代码。
Properties:
Name Type Description Escapestring ESC键 Digit1string 数字键1 Digit2string 数字键2 Digit3string 数字键3 Digit4string 数字键4 Digit5string 数字键5 Digit6string 数字键6 Digit7string 数字键7 Digit8string 数字键8 Digit9string 数字键9 Digit0string 数字键0 Minusstring 减号 Equalstring 等号 Backspacestring 退格键 Tabstring Tab键 KeyQstring Q键 KeyWstring W键 KeyEstring E键 KeyRstring R键 KeyTstring T键 KeyYstring Y键 KeyUstring U键 KeyIstring I键 KeyOstring O键 KeyPstring P键 BracketLeftstring 左方括号 BracketRightstring 右方括号 Enterstring 回车键 ControlLeftstring 左控制键 KeyAstring A键 KeySstring S键 KeyDstring D键 KeyFstring F键 KeyGstring G键 KeyHstring H键 KeyJstring J键 KeyKstring K键 KeyLstring L键 Semicolonstring 分号 Quotestring 引号 Backquotestring 反引号 ShiftLeftstring 左Shift键 Backslashstring 反斜杠 KeyZstring Z键 KeyXstring X键 KeyCstring C键 KeyVstring V键 KeyBstring B键 KeyNstring N键 KeyMstring M键 Commastring 逗号 Periodstring 句点 Slashstring 斜杠 ShiftRightstring 右Shift键 NumpadMultiplystring 小键盘乘法 AltLeftstring 左Alt键 Spacestring 空格键 CapsLockstring 大写锁定 F1string F1键 F2string F2键 F3string F3键 F4string F4键 F5string F5键 F6string F6键 F7string F7键 F8string F8键 F9string F9键 F10string F10键 Pausestring 暂停键 ScrollLockstring 滚动锁定 Numpad7string 小键盘7 Numpad8string 小键盘8 Numpad9string 小键盘9 NumpadSubtractstring 小键盘减法 Numpad4string 小键盘4 Numpad5string 小键盘5 Numpad6string 小键盘6 NumpadAddstring 小键盘加法 Numpad1string 小键盘1 Numpad2string 小键盘2 Numpad3string 小键盘3 Numpad0string 小键盘0 NumpadDecimalstring 小键盘小数点 F11string F11键 F12string F12键 F13string F13键 F14string F14键 F15string F15键 F16string F16键 F17string F17键 F18string F18键 F19string F19键 F20string F20键 F21string F21键 F22string F22键 F23string F23键 F24string F24键 NumpadCommastring 小键盘逗号 NumpadEnterstring 小键盘回车 ControlRightstring 右控制键 BrowserHomestring 浏览器主页 NumpadDividestring 小键盘除法 PrintScreenstring 打印屏幕 AltRightstring 右Alt键 NumLockstring 数字锁定 Homestring Home键 ArrowUpstring 上箭头 PageUpstring Page Up键 ArrowLeftstring 左箭头 ArrowRightstring 右箭头 Endstring End键 ArrowDownstring 下箭头 PageDownstring Page Down键 Insertstring 插入键 Deletestring 删除键 -
constant ColliderType :string
-
碰撞体类型。
Properties:
Name Type Description Boxstring 使用包围盒检查碰撞。 Spherestring 使用包围球检查碰撞。 -
constant EventType :string
-
事件类型
Properties:
Name Type Description AppQuitstring 当应用程序退出时。 AppEnterstring 当应用程序被设置为当前时。 AppLeavestring 当应用程序被设置为非当前时。 Updatestring 当更新时。 FocusInstring 当应用程序获得焦点时。 FocusOutstring 当应用程序失去焦点时。 Resizestring 当应用程序调整大小时。 MouseEnterstring 当鼠标进入对象时。 MouseLeavestring 当鼠标离开对象时。 MouseMovestring 当鼠标移动时。 MouseUpstring 当鼠标按钮抬起时。 MouseDownstring 当鼠标按钮按下时。 Wheelstring 当鼠标滚轮滚动时。 Clickstring 当触摸结束时。 DBLClickstring 当双击触摸结束时。 KeyDownstring 当按键按下时。 KeyUpstring 当按键抬起时。 KeyPressstring 当按键正在按下时。 DropFilesstring 当将文件拖放到应用程序容器中时。 TimelineChangestring 当时间线改变时。 EnterStatestring 当进入状态时。 AfterEnterStatestring LeaveStatestring 当离开状态时。 AfterLeaveStatestring RegisterLevelActionstring 当第一次为层级组件注册层级动作时 BeforeLeaveLevelstring 在离开对象层级之前。 LeaveLevelstring 离开对象层级。 LeaveObjectLevelstring 离开对象层级。 AfterLeaveLevelstring 离开对象层级之后。 BeforeEnterLevelstring 在进入对象层级之前。 EnterLevelstring 进入对象层级。 EnterObjectLevelstring 进入对象层级。 AfterEnterLevelstring 进入对象层级之后。 CompleteEnterLevelstring 完成对象层级进入。 ObjectLevelCompletestring 离开对象层级完成。 ColliderEnterstring 当进入(碰撞)对象的碰撞体时(在离开碰撞体之前只触发一次)。 ColliderLeavestring 当离开对象的碰撞体时。 CreateSyncstring 当创建对象事件时(同步)。 Createstring 当创建对象事件时。 Loadstring 当加载对象资源事件时。 Progressstring 当加载对象资源时。 Errorstring 当加载对象资源失败时。 BeforeDestroystring 在销毁对象事件之前。 Destroystring 当销毁对象事件时。 AfterDestroystring 在销毁对象事件之后。 BeforeAddChildstring 在将子对象添加到对象之前。 AfterAddChildstring 在将子对象添加到对象之后。 BeforeRemoveChildstring 在从对象中移除子对象之前。 AfterRemoveChildstring 在从对象中移除子对象之后。 StartFlyingstring 当对象开始飞行时。 Flyingstring 当对象正在飞行时。 StopFlyingstring 当对象停止飞行时。 CompleteFlyingstring 当对象完成飞行时。 ActiveChangestring 当对象的活动属性改变时。 VisibleChangestring 当对象的可见属性改变时。 StopAnimationstring 当对象停止播放动画时。 PlayAnimationstring 当对象开始播放动画时。 ChangeAttributesstring 当对象改变属性时。 EnableViewportstring 当相机启用视口时。 CameraChangePreStartstring 当相机准备开始改变时。 CameraChangeStartstring 当相机开始改变时。 CameraChangestring 当相机正在改变时。 CameraChangePreEndstring 当相机准备结束改变时。 CameraChangeEndstring 当相机结束改变时。 BeforeCameraCapturestring 当相机开始捕获屏幕时。 AfterCameraCapturestring 当相机完成捕获屏幕时。 BeforeLoadResolversstring 在场景加载器中加载解析器之前 Selectstring Deselectstring SelectionChangestring RenderSettingsLightChangestring -
constant ExtrudeShapeDirection :string
-
挤压形状的可见方向
Properties:
Name Type Description Topstring 前 Bottomstring 后 Bothstring 两者 Nonestring 无 -
constant ImageColorFormat :string
-
图像颜色格式类型。
Properties:
Name Type Description RGBstring 红、绿、蓝(RGB)颜色格式。 RGBAstring 透明度、红、绿、蓝(RGBA)颜色格式。 BC7_M6_OPAQUE_ONLYstring BC7_M6_OPAQUE_ONLY压缩格式 -
constant ImageEncodingType :string
-
图像编码类型。
Properties:
Name Type Description LINEARstring 线性编码 SRGBstring sRGB编码 RGBEstring RGBE编码 RGBM7string RGBM7编码 RGBM16string RGBM16编码 RGBDstring RGBD编码 GAMMAstring 伽玛编码 -
constant ImageFilterType :string
-
图像过滤类型。
Properties:
Name Type Description NearestFilterstring 使用最接近指定纹理坐标的纹理元素的值。 NearestMipmapNearestFilterstring 选择与被纹理化像素大小最接近的mipmap,并使用NearestFilter。 NearestMipmapLinearFilterstring 选择与被纹理化像素大小最接近的两个mipmap,并使用NearestFilter。 LinearFilterstring 使用最接近指定纹理坐标的四个纹理元素的加权平均值。 LinearMipmapNearestFilterstring 选择与被纹理化像素大小最接近的mipmap,并使用LinearFilter。 LinearMipmapLinearFilterstring 选择与被纹理化像素大小最接近的两个mipmap,并使用LinearFilter。 -
constant ImageMappingType :string
-
图像映射类型。
Properties:
Name Type Description UVstring 图像纹理正常映射。 CubeReflectionstring 立方体反射 CubeRefractionstring 立方体折射 EquirectangularReflectionstring 使用单一环境贴图显示图像,如天空盒等。 EquirectangularRefractionstring 等矩形折射 -
constant ImageSlotType :string
-
图像槽类型。
Properties:
Name Type Description Mapstring 贴图 EnvMapstring 环境贴图 AlphaMapstring 透明度贴图 EmissiveMapstring 自发光贴图 NormalMapstring 法线贴图 ColorMappingstring 颜色映射 AOMapstring 环境光遮蔽贴图 -
constant ImageWrapType :string
-
图像填充类型。
Properties:
Name Type Description Repeatstring 图像以重复模式填充。 ClampToEdgestring 图像使用边缘重复。 MirroredRepeatstring 图像以重复/镜像一一对应模式填充。 -
constant InheritType :string
-
继承类型。
Properties:
Name Type Description Normalstring 对象将正常处理动作(处理后传递给子对象)。 Breakstring 对象将处理动作但不传递给子对象。 Jumpstring 对象将跳过动作但继续传递给子对象。 Stopstring 对象将中断动作且不传递给子对象。 -
constant LoopType :string
-
循环类型。
Properties:
Name Type Description Repeatstring 值在重复循环模式下变化。 PingPongstring 值在乒乓循环模式下变化。 -
constant MouseButtonType :string
-
鼠标按钮类型。
Properties:
Name Type Description Nonestring 无效的鼠标按钮类型。 Leftstring 鼠标左键类型。 Middlestring 鼠标中键类型。 Rightstring 鼠标右键类型。 -
constant PivotMode :string
-
轴心点模式。
Properties:
Name Type Description Autostring 自动 Locationstring 位置 -
constant PlayState :string
-
动画播放状态
Properties:
Name Type Description Readystring 准备就绪。 Playingstring 正在播放。 Pausedstring 已暂停。 Stoppedstring 已停止。 Finishedstring 已完成。 -
constant ProjectionType :string
-
投影类型。
Properties:
Name Type Description Orthographicstring 正交投影 Perspectivestring 透视投影 -
constant RelationshipDirection :string
-
关系方向类型。
Properties:
Name Type Description Outstring 出 源 -> 目标 Instring 入 目标 -> 源 InOutstring 双向 Nonestring 无 -
constant RenderType :string
-
渲染类型。
Properties:
Name Type Description Spritestring 精灵 Planestring 平面 -
constant ScaleMode :string
-
缩放模式
Properties:
Name Type Description ScaleFactorstring 宽高乘系数作为缩放 ScaleRatiostring 宽高比乘系数作为缩放 ScaleFixedstring 固定缩放 (宽大于高,固定宽,修改高保持宽高比。反之固定高,修改宽保持宽高比) -
constant ShadowQualityType :number
-
阴影质量类型。
Properties:
Name Type Description Lownumber 512x512 阴影纹理大小。 Mediumnumber 1024x1024 阴影纹理大小。 Highnumber 2048x2048 阴影纹理大小。 Ultranumber 4096x4096 阴影纹理大小。 -
constant SideType :string
-
面渲染类型.
Properties:
Name Type Description Frontstring 只绘制正面 Backstring 只绘制背面 Doublestring 绘制正面和背面 -
constant SpaceType :string
-
空间类型。
Properties:
Name Type Description Selfstring 基于自身空间。 Localstring 基于局部空间。 Worldstring 基于世界空间。 -
constant TexelEncodingType :string
-
纹理元素编码类型。
Properties:
Name Type Description LINEARstring 线性编码 SRGBstring sRGB编码 RGBEstring RGBE编码 RGBM7string RGBM7编码 RGBM16string RGBM16编码 RGBDstring RGBD编码 GAMMAstring 伽马编码 -
constant Transform :number
-
变换类型
Properties:
Name Type Description Rotationnumber 旋转变换 Scalenumber 缩放变换 -
constant UVMode :string
-
UV模式。
Properties:
Name Type Description Tilestring 以平铺方式重复填充UV。 Stretchstring 以拉伸图像模式填充UV。 Customstring 自定义UV。 -
constant ViewMode :string
-
视图模式。
Properties:
Name Type Description Topstring 顶视图 Bottomstring 底视图 Leftstring 左视图 Rightstring 右视图 Frontstring 前视图 Backstring 后视图
Type Definitions
-
AnimationResult
-
动画信息
Properties:
Name Type Description namestring 动画名称 durationnumber 时长(秒) speednumber 播放速度 statePlayState 播放状态 -
Back
-
Properties:
Name Type Description InLerpCallback 回弹插值 - 进入 OutLerpCallback 回弹插值 - 离开 InOutLerpCallback 回弹插值 - 进入和离开 -
Bloom
-
辉光效果
Properties:
Name Type Description enableboolean 是否开启 strengthnumber 强度 radiusnumber 半径 thresholdnumber 阈值 -
BlurEdge
-
模糊边缘效果配置
Properties:
Name Type Description enableboolean 是否开启 offsetnumber 偏移 -
Bounce
-
Properties:
Name Type Description InLerpCallback 弹跳插值 - 进入 OutLerpCallback 弹跳插值 - 离开 InOutLerpCallback 弹跳插值 - 进入和离开 -
BoundingBoxResult
-
BoundingBox对象
Properties:
Name Type Description centerArray.<number> 中心点坐标 halfSizeArray.<number> 包围盒三个轴向尺寸的一半 -
BoxHelperResult
-
Properties:
Name Type Description visibleboolean 是否可见 colorArray.<number> 颜色 modeBoxHelperModeType 显示模式 -
CameraGhostingEffect
-
残影效果
Properties:
Name Type Description enableboolean 是否开启 centerArray.<number> 中心位置 -
CameraGlowEffect
-
发光效果
Properties:
Name Type Description enableboolean 是否开启 strengthnumber 强度 thresholdnumber 阈值 radiusnumber 半径 -
CameraInnerGlowEffect
-
内发光效果
Properties:
Name Type Description enableboolean 是否开启 colorArray.<number> 颜色 strengthnumber 强度 stridenumber 跨度 -
CameraLineBloomEffect
-
线辉光效果
Properties:
Name Type Description enableboolean 是否开启 blendRatenumber 混合比例 blurSizenumber 模糊半径 strengthnumber 强度 -
CameraLineBloomEffect
-
选中效果
Properties:
Name Type Description thicknessnumber 厚度 strengthnumber 强度 -
CameraRadialEffect
-
扩散效果
Properties:
Name Type Description enableboolean 是否开启 centerArray.<number> 中心 -
CameraTailingEffect
-
拖尾效果
Properties:
Name Type Description enableboolean 是否开启 directionArray.<number> 方向 centerArray.<number> 中心点 -
CapsuleParam
-
构造胶囊需要的参数
Properties:
Name Type Attributes Default Description radiusnumber <optional>
0.5 中间界面的半径 cylinderHeightnumber <optional>
1.0 胶囊的高度 widthSegmentsnumber <optional>
64 横截面是多少边形,值越大越精细,三角面越密集 heightSegmentsnumber <optional>
64 高度方向片段个数,值越大越精细,三角面越密集 -
ChromaticAberration
-
色差
Properties:
Name Type Description enableboolean 是否开启 chromaFactornumber 色彩分离系数 -
CircleParam
-
构造圆形需要的参数
Properties:
Name Type Attributes Default Description radiusnumber <optional>
1 半径 segmentsnumber <optional>
64 模拟圆形使用的多边形的边数 startRadnumber <optional>
0 开始位置(弧度) arcnumber <optional>
Math.PI * 2 所形成的扇形的角度(弧度) Example
let cirecle = THING.MeshBuilder.createCircle(); // @expect(cirecle.index.length == 192 ); -
Circular
-
Properties:
Name Type Description InLerpCallback 圆形插值 - 进入 OutLerpCallback 圆形插值 - 离开 InOutLerpCallback 圆形插值 - 进入和离开 -
ClippingPlaneResult
-
Properties:
Name Type Description directionArray.<number> 世界坐标系下的方向 heightnumber 高度,单位:米 -
ColorCorrection
-
颜色校正配置
Properties:
Name Type Description enableboolean 是否开启 exposurenumber 曝光度 brightnessnumber 亮度 contrastnumber 对比度 saturationnumber 饱和度 gammanumber 伽马值 -
Cubic
-
Properties:
Name Type Description InLerpCallback 三次插值 - 进入 OutLerpCallback 三次插值 - 离开 InOutLerpCallback 三次插值 - 进入和离开 -
CylinderParam
-
构造圆柱需要的参数
Properties:
Name Type Attributes Default Description radiusTopnumber <optional>
1 顶部半径 radiusBottomnumber <optional>
1 底部半径 heightnumber <optional>
2 高度 radialSegmentsnumber <optional>
64 圆柱体截面是几边形 默认64代表圆柱体截面是64边形 heightSegmentsnumber <optional>
64 高度方向分段数 openEndedboolean <optional>
false 顶面和地面是否封闭 thetaStartnumber <optional>
0 开始的角度(弧度) thetaLengthnumber <optional>
Math.PI*2 结束角度(弧度) -
Dof
-
景深效果配置
Properties:
Name Type Description enableboolean 是否开启 focalDepthnumber 相机焦点的深度位置 focalLengthnumber 焦距 fstopnumber 光圈 maxblurnumber 最大允许的模糊半径 thresholdnumber 阈值 gainnumber 模糊效果的增益因子 越大越模糊 biasnumber 偏差 可以改变焦点周围模糊区域的过渡方式 ditheringnumber 抖动 改善模糊边缘的过渡效果 -
Elastic
-
Properties:
Name Type Description InLerpCallback 弹性插值 - 进入 OutLerpCallback 弹性插值 - 离开 InOutLerpCallback 弹性插值 - 进入和离开 -
Environment
-
Properties:
Name Type Description envMapTHING.ImageTexture | THING.CubeTexture 场景的环境贴图。 diffuseIntensitynumber 环境贴图的漫反射光照强度。 -
EventCallback(ev) → {any}
-
EventCallback表示一个事件触发的回调函数。
Parameters:
Name Type Description evMouseEvent | KeyboardEvent 事件对象,包含了事件的类型和相关属性。 Returns:
any -
Exponential
-
Properties:
Name Type Description InLerpCallback 指数插值 - 进入 OutLerpCallback 指数插值 - 离开 InOutLerpCallback 指数插值 - 进入和离开 -
FXAA
-
FXAA的配置信息。
Properties:
Name Type Description enableboolean 是否开启。True表示开启。 -
Film
-
电影效果配置
Properties:
Name Type Description enableboolean 是否开启 grayscaleboolean 是否开启灰度模式(黑白效果) noiseIntensitynumber 噪声强度 scanlinesIntensitynumber 扫描线强度 scanlinesCountnumber 扫面线个数 -
FlyInfoParams
-
计算飞行插值参数的对象
Properties:
Name Type Attributes Description positionArray.<number> <optional>
要飞到的位置 targetArray.<number> | THING.BaseObject 飞行的目标位置,如果是一个物体,则自动选择其边界框的最佳位置。飞行到目标位置后,物体的target属性表示物体的方向,即target和position的差表示物体的方向。如果传入一个BaseObject,则target是目标对象的位置。如果没有传入position,则会根据目标对象的距离、水平角度和垂直角度来计算position。参见 https://en.wikipedia.org/wiki/Spherical_coordinate_system upArray.<number> 飞行到目标位置后物体的上方向。 distancenumber 距离(仅适用于对象目标模式)。如果目标位置是一个Object3D对象,则表示与目标对象的距离。 horzAnglenumber 水平角度(仅适用于对象目标模式)。如果目标位置是一个Object3D对象,则表示与目标对象的水平夹角。 -
FogInfo
-
雾效配置
Properties:
Name Type Description enableboolean 是否开启 typeFogType 雾的类型 nearnumber 雾效起始位置(仅线性雾生效) farnumber 雾效结束位置(仅线性雾生效) densitynumber 雾的强度(仅指数雾生效) colornumber | string | Array.<string> 颜色 SkyFogSkyFog 天空盒的雾效 -
GetCenterFunction(target) → {Array.<number>}
-
获取中心位置。
Parameters:
Name Type Description targetArray.<number> 用于保存结果的目标数组。 Returns:
Array.<number> - 目标数组的引用。 -
GroundTruthAmbientOcclusion
-
GTAO
Properties:
Name Type Description enableboolean 是否开启 multiBounce是否开启多次反弹boolean 开启产生更加真实和逼真的环境光遮蔽效果,也会增加计算的复杂度和资源消耗 maxDistancenumber 环境光遮蔽计算的最大距离 maxPixelnumber 环境光遮蔽计算的最大像素数量 rayMarchSegmentnumber 光线追踪的段数 darkFactornumber 深度因子 -
InheritData
-
Properties:
Name Type Description style?InheritType 是否继承样式 visible?InheritType 是否继承可见状态 pickable?InheritType 是否继承拾取状态 -
InstancingNodeOptions
-
Properties:
Name Type Attributes Description maxNumbernumber 实例的最大数量。 numbernumber 当前渲染的实例数量。 matricesArray.<Array.<number>> 实例的变换矩阵数组。 pickedIdsArray.<number> <optional>
(可选)实例的拾取 ID,在拾取事件中返回 pickId。 colorsArray.<Array.<number>> <optional>
(可选)实例的颜色数组。 -
LensflareElement
-
镜头光晕元素。
Properties:
Name Type Description imageTextureImageTexture 元素的图像纹理资源。 colorArray.<number> 元素的颜色。 scalenumber 元素的缩放比例。 offsetnumber 元素的偏移量。 -
LerpArgs
-
Properties:
Name Type Attributes Default Description fromobject 源属性 toobject 目标属性 timesnumber <optional>
-1 循环次数 -1代表无限 durationnumber <optional>
1000 时间 单位毫秒 delayTimenumber <optional>
0 延时 单位毫秒 lerpTypeLerpType <optional>
插值类型 见THING.LerpType loopTypeLoopType <optional>
循环类型 见THING.LoopType orientToPathboolean <optional>
移动时是随路径调整自身朝向 onRepeatfunction <optional>
每一次插值结束,下一次插值开始时触发 onStartfunction <optional>
开始时触发 onStopfunction <optional>
停止时触发 onUpdatefunction <optional>
插值过程每帧触发 onCompletefunction <optional>
所有插值结束时触发 -
LerpFlyToArgs
-
飞行的插值参数
Properties:
Name Type Attributes Description positionArray.<number> <optional>
要飞到的位置 targetArray.<number> | THING.BaseObject 飞到目标位置之后物体的target,即物体target和position的差代表对象的方向,如果传入一个BaseObject,target就是目标对象的位置,如果没有传position,会根据距离目标对象的距离,水平角,垂直角来计算position参见 https://en.wikipedia.org/wiki/Spherical_coordinate_system upArray.<number> <optional>
飞到目标点后对象的up朝向 durationnumber <optional>
飞行时间 delayTimenumber <optional>
延迟时间 distancenumber <optional>
如果目标点是一个Object3D,且没传position,代表距离目标对象的距离,用于计算position horzAnglenumber <optional>
如果目标点是一个Object3D,且没传position,代表与目标对象的水平夹角,用于计算position vertAnglenumber <optional>
如果目标点是一个Object3D,且没传position,代表与目标对象的垂直夹角,用于计算position lerpTypeLerpType <optional>
插值类型 positionLerpTypeLerpType <optional>
飞行时positoin的插值类型 targetLerpTypeLerpType <optional>
飞行时target的插值类型 upLerpTypeLerpType <optional>
飞行时up的插值类型 onStartfunction <optional>
开始飞行时的回调 onStopfunction <optional>
停止飞行时的回调 onResumefunction <optional>
恢复飞行时的回调 onPausefunction <optional>
暂停飞行时的回调 onUpdatefunction <optional>
飞行时每帧回调 onCompletefunction <optional>
飞行完成时的回调 -
LerpType
-
插值类型。用于描述插值行为的配置对象。
Properties:
Name Type Description Linearobject 线性插值 Quadraticobject 二次插值 Cubicobject 三次插值 Quarticobject 四次插值 Quinticobject 五次插值 Sinusoidalobject 正弦插值 Exponentialobject 指数插值 Circularobject 圆形插值 Elasticobject 弹性插值 Backobject 回弹插值 Bounceobject 弹跳插值 -
LerpWithSpaceTypeArgs
-
Properties:
Name Type Attributes Default Description fromobject 源属性 toobject 目标属性 timesnumber <optional>
-1 循环次数 -1代表无限 durationnumber <optional>
1000 时间 单位毫秒 delayTimenumber <optional>
0 延时 单位毫秒 lerpTypeLerpType <optional>
插值类型 见THING.LerpType loopTypeLoopType <optional>
循环类型 见THING.LoopType orientToPathboolean <optional>
移动时是随路径调整自身朝向 onRepeatfunction <optional>
每一次插值结束,下一次插值开始时触发 onStartfunction <optional>
开始时触发 onStopfunction <optional>
停止时触发 onUpdatefunction <optional>
插值过程每帧触发 onCompletefunction <optional>
所有插值结束时触发 spaceTypeTHING.SpaceType <optional>
THING.SpaceType.World 参数中的位置是在世界空间还是自身空间 -
LevelChangeOptions
-
层级切换参数
Properties:
Name Type Description onStopLevelChangedCallback 停止切换层级的回调 onCompleteLevelChangedCallback 最终切换完成的回调 -
LevelChangedCallback(ev)
-
层级改变时调用的函数
Parameters:
Name Type Description evobject 回调参数 Properties
Name Type Description currentTHING.BaseObject 当前层级 prevTHING.BaseObject 上一层级 path层级切换的路径(都经过了哪些层级)Array.<THING.BaseObject> -
LevelConfig
-
层级配置参数信息
Properties:
Name Type Description ignoreVisibleboolean 是否忽略层级设置中对象的可见性设置。 ignoreEventboolean 是否忽略层级设置中对象的鼠标事件。 ignoreStyleboolean 是否忽略层级设置中对象的样式。 -
Lights
-
Properties:
Name Type Description ambientLightsArray.<AmbientLight> 场景的环境光列表。 directionalLightsArray.<DirectionalLight> 场景的方向光列表。 hemisphereLightsArray.<HemisphereLight> 场景的半球光列表。 -
Linear
-
Properties:
Name Type Description NoneLerpCallback 无插值 -
LoadTextureResourceSamplerInfo
-
Properties:
Name Type Description minFilterImageFilterType 放大时的过滤方式 magFilterImageFilterType 缩小时的过滤方式 wrapSImageWrapType 水平方向的循环方式 wrapTImageWrapType 垂直方向的循环方式 mappingTypeImageMappingType 纹理映射类型 例如普通的UV映射 立方体映射 单张图作为环境图的映射 -
LookAtArgs
-
lookAt的参数
Properties:
Name Type Attributes Default Description upArray.<number> lookAt时 物体的up方向 lockAxisAxisType <optional>
锁定自身的轴向(x,y,z) alwaysboolean <optional>
false 是否一直看目标 默认false 代表只看一次,如果传true,观察者或被观察者移动时也会看向目标 lookOnPlaneboolean <optional>
false 是看向目标物体还是看向目标物体的垂直平面 默认false 如果为true时,看的方向是当前位置与目标物体垂直平面的垂线方向 -
MSAA
-
MSAA配置信息。
Properties:
Name Type Description enableboolean 是否开启。True表示开启。 -
MouseEventData
-
Properties:
Name Type Description typestring 事件类型,小写形式。 altKeyboolean 检查是否按下 alt 键。 ctrlKeyboolean 检查是否按下 control 键。 shiftKeyboolean 检查是否按下 shift 键。 deltaXnumber 鼠标光标的 x 方向位移(以像素为单位)。 deltaYnumber 鼠标光标的 y 方向位移(以像素为单位)。 xnumber 鼠标光标的 x 坐标(以像素为单位)。 ynumber 鼠标光标的 y 坐标(以像素为单位)。 objectTHING.BaseObject 选中的对象(可能为 null)。 pickedPositionArray.<number> 选中位置的世界坐标。 normalArray.<number> 世界坐标中的法线方向。 -
MovePathLerpArgs
-
Properties:
Name Type Attributes Default Description fromobject 源属性 toobject 目标属性 timesnumber <optional>
-1 循环次数 -1代表无限 durationnumber <optional>
1000 时间 单位毫秒 delayTimenumber <optional>
0 延时 单位毫秒 lerpType?LerpType 插值类型 见THING.LerpType loopType?LoopType 循环类型 见THING.LoopType orientToPath?boolean 移动时是随路径调整自身朝向 onRepeatfunction 每一次插值结束,下一次插值开始时触发 onStartfunction 开始时触发 onStopfunction 停止时触发 onUpdatefunction 插值过程每帧触发 onCompletefunction 所有插值结束时触发 spaceTypeTHING.SpaceType <optional>
THING.SpaceType.World 参数中的位置是在世界空间还是自身空间 upArray.<number> 向上的方向 closureboolean <optional>
false 路径是否闭合,即移动到最后一个点之后是否要返回第一个点 -
Object3DInitialOptions
-
Properties:
Name Type Description localPosition?Array.<number> 本地位置。相对于父物体的位置 localScale?Array.<number> 本地缩放。相对于父物体的缩放 localAngels?Array.<number> 本地旋转角度。相对于父物体的旋转角度 position?Array.<number> 世界位置。世界坐标系下的位置 scale?Array.<number> 世界缩放。世界坐标系下的缩放 angels?Array.<number> 世界旋转角度。世界坐标系下的旋转角度 -
ObjectEventOptions
-
Properties:
Name Type Description onceboolean 是否只触发一次 useCaptureboolean 如果是true,会阻断孩子身上原有的事件,并给所有孩子注册这个事件 propagateboolean 是否传播事件 -
ObjectListenerInfo
-
Properties:
Name Type Description typestring 事件类型。 conditionstring 选择对象的条件。 callbackfunction 事件回调函数。 tagstring 事件标签。 prioritynumber 事件优先级。 onceboolean 表示只触发一次的事件。 pausedboolean 表示事件是否已暂停。 -
ObjectQueryOptions
-
Properties:
Name Type Description recursiveboolean 是否递归查询 默认true includeSelfboolean 是否包括自身 默认不包含 -
OnActiveChangeComponentCallback(value)
-
当活动状态改变时。
Parameters:
Name Type Description valueboolean 活动状态。 -
OnAddChildComponentCallback(object)
-
当添加子对象时。
Parameters:
Name Type Description objectTHING.BaseObject 子对象。 -
OnAfterAddComponentCallback()
-
当添加组件之后。
-
OnAfterRemoveComponentCallback()
-
当移除组件之后。
-
OnBeforeAddComponentCallback(object)
-
当添加组件之前。
Parameters:
Name Type Description objectTHING.BaseObject 子对象。 -
OnBeforeRemoveComponentCallback()
-
当移除组件之前。
-
OnCopyComponentCallback(component)
-
当复制组件时。
Parameters:
Name Type Description componentTHING.BaseComponent 组件。 -
OnExportComponentCallback() → {object}
-
当导出数据时。
Returns:
object -
OnFilterObjectsInSelector(object, index, objects) → {boolean}
-
用于筛选对象的回调函数。
Parameters:
Name Type Description objectTHING.BaseObject 对象。 indexnumber 对象的索引。 objectsArray.<THING.BaseObject> 对象数组。 Returns:
boolean -
OnFitBodyScaleCallback(info)
-
当适应图片尺寸时调用的函数。
Parameters:
Name Type Description infoobject 参数 Properties
Name Type Description objectTHING.Marker 对象。Marker对象 imageobject 图片。图片对象 -
OnImportComponentCallback(param)
-
当导入数据时。
Parameters:
Name Type Description paramobject 参数。 -
OnInitComponentCallback()
-
当初始化组件时。
-
OnLoadResourceComponentCallback()
-
当加载资源时。
-
OnParentChangeComponentCallback(parent)
-
当父对象改变时。
Parameters:
Name Type Description parentTHING.BaseObject 新的父对象。 -
OnRefreshComponentCallback()
-
当刷新组件时。
-
OnRemoveChildComponentCallback(object)
-
当移除子对象时。
Parameters:
Name Type Description objectTHING.BaseObject 子对象。 -
OnRenderComponentCallback(layout)
-
当渲染组件时。
Parameters:
Name Type Description layoutRenderLayout 布局信息 -
OnResizeComponentCallback(width, height)
-
当组件调整大小时。
Parameters:
Name Type Description widthnumber 以像素为单位的宽度。 heightnumber 以像素为单位的高度。 -
OnSortObjectsInSelector(obj1, obj2) → {number}
-
用于排序对象的回调函数。
Parameters:
Name Type Description obj1THING.BaseObject 第一个对象。 obj2THING.BaseObject 第二个对象。 Returns:
number - < 0: obj1 < obj2== 0: obj1 == obj2> 0: obj1 > obj2 -
OnUnloadResourceComponentCallback()
-
当卸载资源时。
-
OnUpdateComponentCallback(deltaTime)
-
当更新组件时。
Parameters:
Name Type Description deltaTimenumber 以秒为单位的时间增量。 -
OnVisibleChangeComponentCallback(value)
-
当(主体)可见性改变时。
Parameters:
Name Type Description valueboolean 可见状态。 -
OrientedBoxResult
-
旋转包围盒对象
Properties:
Name Type Description anglesArray.<number> 中心点旋转角度 centerArray.<number> 中心点世界坐标 sizeArray.<number> 包围盒尺寸 halfSizeArray.<number> 包围盒尺寸x,y,z三个方向分别除以2可得到该参数 radiusnumber 包围盒最小点和最大点的距离的一半 -
PickResult
-
Properties:
Name Type Description objectTHING.BaseObject 拾取到的对象 positionArray.<number> 拾取的位置 normalArray.<number> 拾取的法向量 pickedIdnumber 拾取的ID externalobject 拾取到的附加信息 -
PlayAnimationArgs
-
动画播放的参数
Properties:
Name Type Attributes Default Description namestring 动画名称 times?number 循环次数 loopType?LoopType 循环类型 speednumber <optional>
1 播放速度 reverseboolean <optional>
false 是否反向播放 onCompletefunction <optional>
null 播放完成回调函数 -
PostEffectInfo
-
后期效果的配置。
Properties:
Name Type Description enableboolean true表示开启。是否开启后期效果 bloomBloom 泛光效果。 screenSpaceAmbientOcclusionScreenSpaceAmbientOcclusion 屏幕空间环境光遮蔽(SSAO)效果。 groundTruthAmbientOcclusionGroundTruthAmbientOcclusion 真实世界环境光遮蔽(GTAO)效果。 screenSpaceReflectionScreenSpaceReflection 屏幕空间反射(SSR)效果。 colorCorrectionColorCorrection 颜色校正效果。 dofDof 景深效果。 vignettingVignetting 暗角效果。 blurEdgeBlurEdge 边缘模糊效果。 filmFilm 胶片效果。 chromaticAberrationChromaticAberration 色彩分离效果。 FXAAFXAA 快速近似抗锯齿效果。 MSAAMSAA 多重采样抗锯齿效果。 temporalSuperSamplingTemporalSuperSampling 时序超采样效果。(TSS) -
Quadratic
-
Properties:
Name Type Description InLerpCallback 二次插值 - 进入 OutLerpCallback 二次插值 - 离开 InOutLerpCallback 二次插值 - 进入和离开 -
Quartic
-
Properties:
Name Type Description InLerpCallback 四次插值 - 进入 OutLerpCallback 四次插值 - 离开 InOutLerpCallback 四次插值 - 进入和离开 -
Quintic
-
Properties:
Name Type Description InLerpCallback 五次插值 - 进入 OutLerpCallback 五次插值 - 离开 InOutLerpCallback 五次插值 - 进入和离开 -
RaycastInfo
-
Properties:
Name Type Description originArray.<number> 射线起点位置 directionArray.<number> 射线在世界坐标系下的方向 -
RaycastResult
-
Properties:
Name Type Description objectTHING.Object3D 被射线检测到的对象 positionArray.<number> 射线与对象相交的位置 distancenumber 射线起点到相交点的距离 -
RenderSettingsInfo
-
Properties:
Name Type Description lightsLights 灯光配置 fogTHING.CameraFogComponent 雾效配置 backgroundTHING.ImageTexture | THING.CubeTexture | Array.<number> 背景 environmentEnvironment 场景的全局环境 postEffectsTHING.CameraPostEffectComponent 后处理效果 cameraEffectsTHING.CameraEffectComponent 摄像机效果 -
ResourceResult
-
Properties:
Name Type Attributes Description urlstring 资源路径 localPositionArray.<number> <optional>
相对父物体的位置 localAnglesArray.<number> <optional>
相对父物体的旋转 localScaleArray.<number> <optional>
相对父物体的缩放 childrenArray.<ResourceResult> <optional>
孩子的资源 -
RotateAroundLerpArgs
-
Properties:
Name Type Attributes Default Description objectTHING.BaseObject 环绕的目标对象。 targetArray.<number> 世界坐标系下某个点的坐标(可从 object 中选择一个)。 yRotateAnglenumber 绕Y轴旋转的角度(仰视平面,即垂直平面内的角度,范围0~180度)。 xRotateAnglenumber <optional>
绕X轴旋转的角度(方位平面,即水平平面内的角度,范围0~360度)(此参数不能在地球上使用)。 timesnumber <optional>
-1 循环次数,-1表示无限循环。 timenumber <optional>
1000 旋转所需时间(毫秒)。 delayTimenumber <optional>
0 延迟时间(毫秒)。 lerpTypeTHING.LerpType <optional>
插值类型。 loopTypeTHING.LoopType <optional>
循环类型。 onRepeatfunction 重复动作回调函数。 onStopfunction 停止动作回调函数。 onUpdatefunction 更新动作回调函数。 onCompletefunction 完成动作回调函数。 -
SceneRenderEnvironmentOptions
-
Properties:
Name Type Description quaternionArray.<number> 环境贴图旋转四元数。 -
SceneRenderOptions
-
Properties:
Name Type Description environmentSceneRenderEnvironmentOptions 环境渲染配置。 -
ScreenSpaceAmbientOcclusion
-
屏幕空间环境光遮蔽配置
Properties:
Name Type Description enableboolean 是否开启 radiusnumber 半径 qualitystring SSAO的质量。可选值为'low'|'medium'|'high'|'ultra'。 intensitynumber 强度 temporalFilterboolean 是否在时序超采样模式下使用滤波器。 ignoreTransparentboolean 是否忽略透明物体。 -
ScreenSpaceReflection
-
屏幕空间反射配置
Properties:
Name Type Description enableboolean 开关 maxRayDistancenumber 反射光线追踪的最大距离 pixelStridenumber 步长 enablePixelStrideZCutoffboolean 是否限制反射光线的最大距离,以避免对远处或过远的物体进行反射计算 falloffnumber 屏幕空间反射效果的衰减函数或者衰减参数 strengthnumber 反射强度 pixelStrideZCutoffnumber 屏幕空间反射计算中根据像素之间的距离进行截断 screenEdgeFadeStartnumber 屏幕边缘开始淡化的距离 eyeFadeStartnumber 屏幕空间反射效果在摄像机视角附近开始逐渐减弱的位置 eyeFadeEndnumber 屏幕空间反射效果在摄像机视角附近结束减弱的位置 minGlossinessnumber 控制屏幕空间反射效果中反射光滑度的最小值,具有高光滑度的表面通常会产生清晰的反射,而具有低光滑度的表面则会产生模糊的反射。 -
SelfToWorldFunction(position, ignoreScale, target) → {Array.<number>}
-
将自身位置转换为世界位置。
Parameters:
Name Type Description positionArray.<number> 世界位置。 ignoreScaleboolean 为true表示忽略缩放。 targetArray.<number> 用于保存结果的目标数组。 Returns:
Array.<number> - 目标数组的引用。 -
ShadowRangeInfo
-
阴影范围
Properties:
Name Type Description widthnumber 宽度 heightnumber 高度 nearnumber 近 farnumber 远 -
Sinusoidal
-
Properties:
Name Type Description InLerpCallback 正弦插值 - 进入 OutLerpCallback 正弦插值 - 离开 InOutLerpCallback 正弦插值 - 进入和离开 -
SkyFog
-
天空盒的雾效
Properties:
Name Type Description enableboolean 是否开启 startnumber 开始位置 heightnumber 高度 -
StyleColorOperationCallback(baseValue, style)
-
当更新颜色时调用的函数。
Parameters:
Name Type Description baseValueArray.<number> 基础颜色。 styleTHING.Style 样式。 -
StyleEdgeResult
-
样式的边框效果。
Properties:
Name Type Description enableboolean 是否开启边框。 colorArray.<number> 边框的颜色。 opacitynumber 边框的不透明度。 glowboolean 边框是否具有发光效果。 thresholdAnglenumber 边框的阈值角度。 -
StyleEffectResult
-
Properties:
Name Type Description glownumber 发光强度(null表示恢复原始效果) innerGlowboolean 是否开启内发光(null表示恢复原始效果) lineBloomboolean 是否开启辉光(null表示恢复原始效果) tailingboolean 是否开启拖尾效果(null表示恢复原始效果) radialboolean 是否开启扩散效果(null表示恢复原始效果) ghostingboolean 是否开启残影效果(null表示恢复原始效果) -
StyleImagesResult
-
Properties:
Name Type Description mapobject 漫反射贴图(最基础的贴图) envMapobject 环境光贴图 alphaMapobject 透明贴图 emissiveMapobject 自发光贴图 normalMapobject 发现贴图 colorMappingobject 颜色映射 aoMapobject 环境光遮蔽贴图 -
StyleUVMatrixResult
-
Properties:
Name Type Description offsetArray.<number> 偏移 通过调整偏移可以使贴图移动 repeatArray.<number> default: [1, 1] 贴图重复度 centerArray.<number> default: [0, 0] 纹理变换的中心位置,偏移 重复 旋转都基于该位置 rotationnumber 旋转角度 -
StyleValueOperationCallback(baseValue, style)
-
当更新值时调用的函数。
Parameters:
Name Type Description baseValuenumber 基础值。 styleTHING.Style 样式。 -
TorusParam
-
构造圆环需要的参数
Properties:
Name Type Attributes Default Description radiusnumber <optional>
0.8 圆环内径 tubenumber <optional>
0.2 圆环截面(管)的半径 radialSegmentsnumber <optional>
64 圆环横切面使用多少边形 tubularSegmentsnumber <optional>
64 圆环纵切面(管)使用多少边形 arcnumber <optional>
Math.PI*2 圆环范围(默认是一圈,即Math.PI*2,如果是Math.PI,代表圆环是一个半圆) -
TraverseNodesCallback(nodeObject)
-
Parameters:
Name Type Description nodeObjectNodeObject 子节点对象 -
Viewpoint
-
视点信息
Properties:
Name Type Description positionArray.<number> 摄像机位置。 targetArray.<number> 目标位置。 -
Vignetting
-
镜头暗角效果配置
Properties:
Name Type Description enableboolean 是否开启 colorArray.<number> 边缘的颜色,仅适用于颜色类型 offsetnumber 偏移 -
WorldToScreenFunction(position, target) → {Array.<number>}
-
将世界位置转换为屏幕位置。
Parameters:
Name Type Description positionArray.<number> 世界位置。 targetArray.<number> 用于保存结果的目标数组。 Returns:
Array.<number> - 目标数组的引用。