Class Node

节点，3D场景中的元素，是大部分类的基类

Example

const node = new Hilo3d.Node({
    name:'test',
    x:100,
    rotationX:30,
    onUpdate(){
        this.rotationY ++;
    }
});
node.scaleX = 0.3;
stage.addChild(node);

Hierarchy (View Summary)

EventDispatcher
- Node
  - Mesh
  - Stage
  - Camera
  - Light
  - AxisHelper

Index

Constructors

constructor

Accessors

matrix pivot pivotX pivotY pivotZ position quaternion rotation rotationX rotationY rotationZ scale scaleX scaleY scaleZ x y z

Constructors

constructor

new Node(params?: NodeParameters): Node
Parameters
- params: NodeParameters = {}
  初始化参数，所有params都会复制到实例上
Returns Node
Overrides EventDispatcher.constructor
- Defined in core/Node.ts:229

Properties

__forceUseParentWorldMatrix

__forceUseParentWorldMatrix: boolean = false

是否强制使用父元素 worldMatrix，供高级开发者使用

_listeners

_listeners: ListenerMap | null = null

_matrixDirty

_matrixDirty: boolean = false

`Optional`_originName

_originName?: string

_quatDirty

_quatDirty: boolean = false

anim

anim: Animation | null = null

动画

animationId

animationId: string = ''

animation 查找 id

autoUpdateChildWorldMatrix

autoUpdateChildWorldMatrix: boolean = true

是否自动更新子元素世界矩阵

autoUpdateWorldMatrix

autoUpdateWorldMatrix: boolean = true

是否自动更新世界矩阵

children

children: Node[]

className

className: string = 'Node'

id

id: string

isCamera

isCamera: boolean = false

isMesh

isMesh: boolean = false

isNode

isNode: boolean = true

isSkinnedMesh

isSkinnedMesh: boolean = false

jointName

jointName: string = ''

骨骼名称

matrixVersion

matrixVersion: number = 0

矩阵 version，每次改变会加一

name

name: string = ''

Node 的名字，可以通过 getChildByName 查找

needCallChildUpdate

needCallChildUpdate: boolean = true

每次更新的时候是否调用子节点的 onUpdate 方法

onlySyncQuaternion

onlySyncQuaternion: boolean = false

只同步四元数，不同步欧拉角

onUpdate

onUpdate: ((deltaTime: number) => void) | null = null

update 回调

parent

parent: Node | null = null

父节点

pointerChildren

pointerChildren: boolean = true

子元素是否接受交互事件。

pointerEnabled

pointerEnabled: boolean = true

可视对象是否接受交互事件。默认为接受交互事件，即true。

up

up: Vector3

useHandCursor

useHandCursor: boolean = false

是否用鼠标指针

userData

userData: unknown = null

用户数据

visible

visible: boolean = true

节点是否显示

worldMatrix

worldMatrix: Matrix4

worldMatrixVersion

worldMatrixVersion: number = 0

世界矩阵 version，每次改变会加一

`Static` `Readonly`TRAVERSE_STOP_ALL

TRAVERSE_STOP_ALL: 2 = TRAVERSE_STOP_ALL

traverse callback 返回值，执行后暂停所有 traverse

`Static` `Readonly`TRAVERSE_STOP_CHILDREN

TRAVERSE_STOP_CHILDREN: 1 = TRAVERSE_STOP_CHILDREN

traverse callback 返回值，执行后暂停子元素 traverse

`Static` `Readonly`TRAVERSE_STOP_NONE

TRAVERSE_STOP_NONE: 0 = TRAVERSE_STOP_NONE

traverse callback 返回值，执行后不暂停 traverse

`Static` `Readonly`typeName

typeName: string = 'Node'

Accessors

matrix

get matrix(): Matrix4Notifier
元素的矩阵

Returns Matrix4Notifier
- Defined in core/Node.ts:738

pivot

get pivot(): Vector3Notifier
中心点

Returns Vector3Notifier
- Defined in core/Node.ts:835

pivotX

get pivotX(): number
中心点x

Returns number
- Defined in core/Node.ts:841
set pivotX(value: number): void
中心点x
Parameters
- value: number
Returns void
- Defined in core/Node.ts:847

pivotY

get pivotY(): number
中心点y

Returns number
- Defined in core/Node.ts:854
set pivotY(value: number): void
中心点y
Parameters
- value: number
Returns void
- Defined in core/Node.ts:860

pivotZ

get pivotZ(): number
中心点z

Returns number
- Defined in core/Node.ts:867
set pivotZ(value: number): void
中心点z
Parameters
- value: number
Returns void
- Defined in core/Node.ts:873

position

get position(): Vector3Notifier
位置

Returns Vector3Notifier
- Defined in core/Node.ts:745

quaternion

get quaternion(): Quaternion
四元数角度

Returns Quaternion
- Defined in core/Node.ts:922

rotation

get rotation(): EulerNotifier
欧拉角

Returns EulerNotifier
- Defined in core/Node.ts:880

rotationX

get rotationX(): number
旋转角度 x, 角度制

Returns number
- Defined in core/Node.ts:886
set rotationX(value: number): void
旋转角度 x, 角度制
Parameters
- value: number
Returns void
- Defined in core/Node.ts:892

rotationY

get rotationY(): number
旋转角度 y, 角度制

Returns number
- Defined in core/Node.ts:898
set rotationY(value: number): void
旋转角度 y, 角度制
Parameters
- value: number
Returns void
- Defined in core/Node.ts:904

rotationZ

get rotationZ(): number
旋转角度 z, 角度制

Returns number
- Defined in core/Node.ts:910
set rotationZ(value: number): void
旋转角度 z, 角度制
Parameters
- value: number
Returns void
- Defined in core/Node.ts:916

scale

get scale(): Vector3Notifier
缩放

Returns Vector3Notifier
- Defined in core/Node.ts:790

scaleX

get scaleX(): number
缩放比例x

Returns number
- Defined in core/Node.ts:796
set scaleX(value: number): void
缩放比例x
Parameters
- value: number
Returns void
- Defined in core/Node.ts:802

scaleY

get scaleY(): number
缩放比例y

Returns number
- Defined in core/Node.ts:809
set scaleY(value: number): void
缩放比例y
Parameters
- value: number
Returns void
- Defined in core/Node.ts:815

scaleZ

get scaleZ(): number
缩放比例z

Returns number
- Defined in core/Node.ts:822
set scaleZ(value: number): void
缩放比例z
Parameters
- value: number
Returns void
- Defined in core/Node.ts:828

x

get x(): number
x轴坐标

Returns number
- Defined in core/Node.ts:751
set x(value: number): void
x轴坐标
Parameters
- value: number
Returns void
- Defined in core/Node.ts:757

y

get y(): number
y轴坐标

Returns number
- Defined in core/Node.ts:764
set y(value: number): void
y轴坐标
Parameters
- value: number
Returns void
- Defined in core/Node.ts:770

z

get z(): number
z轴坐标

Returns number
- Defined in core/Node.ts:777
set z(value: number): void
z轴坐标
Parameters
- value: number
Returns void
- Defined in core/Node.ts:783

Methods

_firePointerEvent

_firePointerEvent(event: NodePointerEvent): void
冒泡指针事件，并维护各 pointerId 的进入/离开状态。
Parameters
- event: NodePointerEvent
Returns void
- Defined in core/Node.ts:957

_onMatrixUpdate

_onMatrixUpdate(): void
Returns void
- Defined in core/Node.ts:1000

_onPivotUpdate

_onPivotUpdate(): void
Returns void
- Defined in core/Node.ts:1010

_onPositionUpdate

_onPositionUpdate(): void
Returns void
- Defined in core/Node.ts:1004

_onQuaternionUpdate

_onQuaternionUpdate(): void
Returns void
- Defined in core/Node.ts:1017

_onRotationUpdate

_onRotationUpdate(): void
Returns void
- Defined in core/Node.ts:1013

_onScaleUpdate

_onScaleUpdate(): void
Returns void
- Defined in core/Node.ts:1007

addChild

addChild(child: Node): this
添加一个子元素
Parameters
- child: Node
  需要添加的子元素
Returns this
this
- Defined in core/Node.ts:327

addTo

addTo(parent: Node): this
将当前元素添加到某个父元素的子元素中
Parameters
- parent: Node
  需要添加到的父元素
Returns this
this
- Defined in core/Node.ts:353

clone

clone(isChild?: boolean): Node
Parameters
- OptionalisChild: boolean
  是否子节点，子节点不会处理动画及骨骼Mesh，即如果有动画将共享
Returns Node
返回clone的Node
- Defined in core/Node.ts:262

destroy

destroy(renderer?: Renderer<RendererBackend>, destroyTextures?: boolean): this
销毁 Node 资源
Parameters
- Optionalrenderer: Renderer<RendererBackend>
  stage时可以不传
- destroyTextures: boolean = false
  是否销毁材质的贴图，默认不销毁
Returns this
this
- Defined in core/Node.ts:986

fire

fire(typeOrEvent?: string | DispatchEvent, detail?: unknown): boolean
Parameters
- OptionaltypeOrEvent: string | DispatchEvent
- Optionaldetail: unknown
Returns boolean
Inherited from EventDispatcher.fire
- Defined in core/EventDispatcher.ts:79

getBounds

getBounds(
    parent?: Node,
    currentMatrix?: Matrix4,
    bounds?: Bounds,
): Bounds | undefined
获取元素的包围盒信息
Parameters
- Optionalparent: Node
  元素相对于哪个祖先元素的包围盒，不传表示世界
- OptionalcurrentMatrix: Matrix4
  当前计算的矩阵
- Optionalbounds: Bounds
  当前计算的包围盒信息
Returns Bounds | undefined
返回计算的包围盒信息
- Defined in core/Node.ts:942

getChildByFn

getChildByFn(fn: NodeGetChildByCallback): Node | null
根据函数来获取一个子孙元素
Parameters
- fn: NodeGetChildByCallback
  判读函数
Returns Node | null
返回获取到的子孙元素
- Defined in core/Node.ts:570

getChildByFnBFS

getChildByFnBFS(fn: NodeGetChildByCallback): Node | null
根据函数来获取一个子孙元素(广度优先)
Parameters
- fn: NodeGetChildByCallback
  判读函数
Returns Node | null
返回获取到的子孙元素
- Defined in core/Node.ts:516

getChildById

getChildById(id: string): Node | null
获取指定id的子孙元素
Parameters
- id: string
  元素id
Returns Node | null
获取的元素
- Defined in core/Node.ts:616

getChildByName

getChildByName(name: string): Node | null
获取指定name的首个子孙元素
Parameters
- name: string
  元素name
Returns Node | null
获取的元素
- Defined in core/Node.ts:600

getChildByNamePath

getChildByNamePath(path: string[]): Node | null
根据 name path 来获取子孙元素
Parameters
- path: string[]
  名字数组, e.g., getChildByNamePath(['a', 'b', 'c'])
Returns Node | null
返回获取到的子孙元素
- Defined in core/Node.ts:532

getChildrenByBaseClassName

getChildrenByBaseClassName(className: string): Node[]
获取指定基类名的所有子孙元素
Parameters
- className: string
  类名
Returns Node[]
获取的元素数组
- Defined in core/Node.ts:632

getChildrenByClassName

getChildrenByClassName(className: string): Node[]
获取指定类名的所有子孙元素
Parameters
- className: string
  类名
Returns Node[]
获取的元素数组
- Defined in core/Node.ts:624

getChildrenByFn

getChildrenByFn(fn: NodeGetChildByCallback): Node[]
根据函数来获取匹配的所有子孙元素
Parameters
- fn: NodeGetChildByCallback
  判读函数
Returns Node[]
返回获取到的子孙元素
- Defined in core/Node.ts:586

getChildrenByName

getChildrenByName(name: string): Node[]
获取指定name的所有子孙元素
Parameters
- name: string
  元素name
Returns Node[]
获取的元素数组
- Defined in core/Node.ts:608

getChildrenNameMap

getChildrenNameMap(): Record<string, Node>
将所以子孙元素放到一个对象中，对象key为元素的name，value为该元素

Returns Record<string, Node>
返回获取的对象
- Defined in core/Node.ts:310

getConcatenatedMatrix

getConcatenatedMatrix(ancestor?: Node): Matrix4
获取当前元素相对于指定元素的矩阵
Parameters
- Optionalancestor: Node
  相对于的元素，需要是当前元素的祖先元素，不传表示获取世界矩阵
Returns Matrix4
返回获取的矩阵
- Defined in core/Node.ts:437

lookAt

lookAt(node: { x: number; y: number; z: number }): this
改变元素的朝向
Parameters
- node: { x: number; y: number; z: number }
  需要朝向的元素，或者坐标
Returns this
this
- Defined in core/Node.ts:684

off

off(type?: string, listener?: EventListener<DispatchEvent>): this
Parameters
- Optionaltype: string
- Optionallistener: EventListener<DispatchEvent>
Returns this
Inherited from EventDispatcher.off
- Defined in core/EventDispatcher.ts:60

on

on(type: string, listener: EventListener, once?: boolean): this
Parameters
- type: string
- listener: EventListener
- once: boolean = false
Returns this
Inherited from EventDispatcher.on
- Defined in core/EventDispatcher.ts:48

raycast

raycast(
    ray: Ray,
    sort?: boolean,
    eventMode?: boolean,
): Vector3[] | NodeRaycastInfo[] | null
raycast
Parameters
- ray: Ray
- sort: boolean = false
  是否按距离排序
- eventMode: boolean = false
  是否事件模式
Returns Vector3[] | NodeRaycastInfo[] | null
- Defined in core/Node.ts:699

removeChild

removeChild(child: Node): this
移除指定的子元素
Parameters
- child: Node
  需要移除的元素
Returns this
this
- Defined in core/Node.ts:340

removeFromParent

removeFromParent(): this
将当前元素从其父元素中移除

Returns this
this
- Defined in core/Node.ts:361

resetSkinnedMeshRootNode

resetSkinnedMeshRootNode(): void
重置子孙元素中 SkinnedMesh 的根节点为当前元素

Returns void
- Defined in core/Node.ts:299

setAnim

setAnim(anim: Animation): this
设置节点的动画，这个需要是模型的根节点
Parameters
- anim: Animation
  动画实例
Returns this
this
- Defined in core/Node.ts:291

setPivot

setPivot(x: number, y: number, z: number): this
设置中心点
Parameters
- x: number
  中心点x
- y: number
  中心点y
- z: number
  中心点z
Returns this
this
- Defined in core/Node.ts:675

setPosition

setPosition(x: number, y: number, z: number): this
设置元素的位置
Parameters
- x: number
  X方向位置
- y: number
  Y方向位置
- z: number
  Z方向位置
Returns this
this
- Defined in core/Node.ts:653

setRotation

setRotation(x: number, y: number, z: number): this
设置元素的旋转
Parameters
- x: number
  X轴旋转角度, 角度制
- y: number
  Y轴旋转角度, 角度制
- z: number
  Z轴旋转角度, 角度制
Returns this
this
- Defined in core/Node.ts:664

setScale

setScale(x: number, y?: number, z?: number): this
设置元素的缩放比例，如果只有一个参数三个轴等比缩放
Parameters
- x: number
  X缩放比例
- y: number = x
  Y缩放比例
- z: number = y
  Z缩放比例
Returns this
this
- Defined in core/Node.ts:642

traverse

traverse(callback: NodeTraverseCallback, onlyChild?: boolean): this
遍历当前元素的子孙元素
Parameters
- callback: NodeTraverseCallback
  每个元素都会调用这个函数处理
- onlyChild: boolean = false
  是否只遍历子元素
Returns this
this
- Defined in core/Node.ts:476

traverseBFS

traverseBFS(callback: NodeTraverseCallback, onlyChild?: boolean): this
遍历当前元素的子孙元素(广度优先)
Parameters
- callback: NodeTraverseCallback
  每个元素都会调用这个函数处理
- onlyChild: boolean = false
  是否只遍历子元素
Returns this
this
- Defined in core/Node.ts:486

traverseUpdate

traverseUpdate(dt: number): this
遍历调用子孙元素onUpdate方法
Parameters
- dt: number
Returns this
this
- Defined in core/Node.ts:553

updateMatrix

updateMatrix(): this
更新本地矩阵

Returns this
this
- Defined in core/Node.ts:371

updateMatrixWorld

updateMatrixWorld(force?: boolean): this
更新世界矩阵
Parameters
- Optionalforce: boolean
  是否强制更新
Returns this
this
- Defined in core/Node.ts:411

updateQuaternion

updateQuaternion(): this
更新四元数

Returns this
this
- Defined in core/Node.ts:389

updateTransform

updateTransform(): this
更新transform属性

Returns this
this
- Defined in core/Node.ts:400

Class Node

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Node

Properties

__forceUseParentWorldMatrix

_listeners

_matrixDirty

Optional_originName

_quatDirty

anim

animationId

autoUpdateChildWorldMatrix

autoUpdateWorldMatrix

children

className

id

isCamera

isMesh

isNode

isSkinnedMesh

jointName

matrixVersion

name

needCallChildUpdate

onlySyncQuaternion

onUpdate

parent

pointerChildren

pointerEnabled

up

useHandCursor

userData

visible

worldMatrix

worldMatrixVersion

Static ReadonlyTRAVERSE_STOP_ALL

Static ReadonlyTRAVERSE_STOP_CHILDREN

Static ReadonlyTRAVERSE_STOP_NONE

Static ReadonlytypeName

Accessors

matrix

Returns Matrix4Notifier

pivot

Returns Vector3Notifier

pivotX

Returns number

Parameters

Returns void

pivotY

Returns number

Parameters

Returns void

pivotZ

Returns number

Parameters

Returns void

position

Returns Vector3Notifier

quaternion

Returns Quaternion

rotation

Returns EulerNotifier

rotationX

Returns number

Parameters

Returns void

rotationY

Returns number

Parameters

Returns void

rotationZ

`Optional`_originName

`Static` `Readonly`TRAVERSE_STOP_ALL

`Static` `Readonly`TRAVERSE_STOP_CHILDREN

`Static` `Readonly`TRAVERSE_STOP_NONE

`Static` `Readonly`typeName