Class PathCurve

Hierarchy

Tool<PathCurveOptions, any>
- PathCurve

Index

Constructors

Properties

app distanceBetween forward lx ly lz nodePercent nodes pathLength percentPreUnit position precision px py pz rotation step toolOptions toolOptionsDefault up

Accessors

Methods

cancelDraw draw fire getCurrentPath getPosition getRotation getTangent hasEvent off on onDisable onEnable once setOptions updateNodes updateOptions

Constructors

constructor

new PathCurve(options: PathCurveOptions): PathCurve
创建路径曲线
Parameters
- options: PathCurveOptions
  
  路径曲线选项
Returns PathCurve
Overrides Tool.constructor
- Defined in src/tools/curve/pathCurve.ts:59

Properties

app

app: AppBase

`Private` distanceBetween

distanceBetween: Vec3

`Private` forward

forward: Vec3

`Private` lx

lx: Curve

`Private` ly

ly: Curve

`Private` lz

lz: Curve

nodePercent

nodePercent: number[]

nodes

nodes: GraphNode[]

pathLength

pathLength: number

percentPreUnit

percentPreUnit: number

`Private` position

position: Vec3

`Private` precision

precision: number

`Private` px

px: Curve

`Private` py

py: Curve

`Private` pz

pz: Curve

`Private` rotation

rotation: Quat

`Private` step

step: number

toolOptions

toolOptions: PathCurveOptions

`Protected` toolOptionsDefault

toolOptionsDefault: PathCurveOptions = ...

`Private` up

up: Vec3

Accessors

enabled

get enabled(): boolean
获得工具的启用状态

Returns boolean
Inherited from Tool.enabled
- Defined in src/utils/helpers/toolBase.ts:43
set enabled(value: boolean): void
设置工具启用状态（触发启用和禁用时的额外操作）
Parameters
- value: boolean
Returns void
Inherited from Tool.enabled
- Defined in src/utils/helpers/toolBase.ts:34

Methods

cancelDraw

cancelDraw(): void
取消曲线绘制

Returns void
- Defined in src/tools/curve/pathCurve.ts:199

draw

draw(option: { color?: Color; drawNormal?: boolean; drawTangent: boolean }): void
绘制曲线，并随节点更新
Parameters
- option: { color?: Color; drawNormal?: boolean; drawTangent: boolean }
  - Optional color?: Color
  - Optional drawNormal?: boolean
  - drawTangent: boolean
Returns void
- Defined in src/tools/curve/pathCurve.ts:150

`Protected` fire

fire<EventName>(eventName: EventName, arg1?: any, arg2?: any, arg3?: any, arg4?: any, arg5?: any, arg6?: any, arg7?: any, arg8?: any): EventHandler
手动触发事件

Returns
EventHandler
Type Parameters
- EventName extends string | number | symbol
Parameters
- eventName: EventName
  
  事件名称
- Optional arg1: any
  
  参数1
- Optional arg2: any
  
  参数2
- Optional arg3: any
  
  参数3
- Optional arg4: any
  
  参数4
- Optional arg5: any
  
  参数5
- Optional arg6: any
  
  参数6
- Optional arg7: any
  
  参数7
- Optional arg8: any
  
  参数8
Returns EventHandler
Inherited from Tool.fire
- Defined in src/utils/helpers/toolBase.ts:128

getCurrentPath

getCurrentPath(percent: number): number
获得当前所处的节点

Returns
当前所处节点
Parameters
- percent: number
  
  此位置在曲线上的百分比
Returns number
- Defined in src/tools/curve/pathCurve.ts:258

getPosition

getPosition(percent: number): Vec3
获得某处坐标

Returns
此处的坐标
Parameters
- percent: number
  
  此位置在曲线上的百分比
Returns Vec3
- Defined in src/tools/curve/pathCurve.ts:209

getRotation

getRotation(percent: number, nodeRotation?: boolean, inverse?: boolean): Quat
获得某处rotation,可以是沿切线方向，也可以是路径点朝向的插值

Returns
此处的旋转
Parameters
- percent: number
  
  此位置在曲线上的百分比
- Optional nodeRotation: boolean
  
  是否使用节点的旋转的插值作为曲线的旋转
- Optional inverse: boolean
  
  是否反向
Returns Quat
- Defined in src/tools/curve/pathCurve.ts:222

getTangent

getTangent(percent: number): Vec3
获得某处坐标

Returns
此处的切线方向
Parameters
- percent: number
  
  此位置在曲线上的百分比
Returns Vec3
- Defined in src/tools/curve/pathCurve.ts:248

hasEvent

hasEvent<EventName>(eventName: EventName): boolean
检测是否监听此事件

Returns
是否监听此事件
Type Parameters
- EventName extends string | number | symbol
Parameters
- eventName: EventName
  
  事件名称
Returns boolean
Inherited from Tool.hasEvent
- Defined in src/utils/helpers/toolBase.ts:111

off

off<EventName>(eventName: EventName, linstener: any, scope?: object): EventHandler
注销事件监听

Returns
EventHandler
Type Parameters
- EventName extends string | number | symbol
Parameters
- eventName: EventName
  
  事件名称
- linstener: any
  
  监听回调
- Optional scope: object
  
  回调函数this指向
Returns EventHandler
Inherited from Tool.off
- Defined in src/utils/helpers/toolBase.ts:102

on

on<EventName>(eventName: EventName, linstener: any, scope?: object): EventHandler
注册事件监听

Returns
EventHandler
Type Parameters
- EventName extends string | number | symbol
Parameters
- eventName: EventName
  
  事件名称
- linstener: any
  
  监听回调
- Optional scope: object
  
  回调函数this指向
Returns EventHandler
Inherited from Tool.on
- Defined in src/utils/helpers/toolBase.ts:80

`Protected` onDisable

onDisable(): void
Returns void
Inherited from Tool.onDisable
- Defined in src/utils/helpers/toolBase.ts:134

`Protected` onEnable

onEnable(): void
Returns void
Inherited from Tool.onEnable
- Defined in src/utils/helpers/toolBase.ts:133

once

once<EventName>(eventName: EventName, linstener: any, scope?: object): EventHandler
注册单次事件监听

Returns
EventHandler
Type Parameters
- EventName extends string | number | symbol
Parameters
- eventName: EventName
  
  事件名称
- linstener: any
  
  监听回调
- Optional scope: object
  
  回调函数this指向
Returns EventHandler
Inherited from Tool.once
- Defined in src/utils/helpers/toolBase.ts:91

setOptions

setOptions(options: PathCurveOptions): void
设置选项
Parameters
- options: PathCurveOptions
  
  选项
Returns void
Inherited from Tool.setOptions
- Defined in src/utils/helpers/toolBase.ts:52

updateNodes

updateNodes(): void
更新节点

Returns void
- Defined in src/tools/curve/pathCurve.ts:104

updateOptions

updateOptions(options: { curveMode?: number; parentNode?: Entity }): void
更新选项
Parameters
- options: { curveMode?: number; parentNode?: Entity }
  
  选项
  - Optional curveMode?: number
  - Optional parentNode?: Entity
Returns void
Inherited from Tool.updateOptions
- Defined in src/utils/helpers/toolBase.ts:65