Class TimelineAsset

Hierarchy

BaseResource
- TimelineAsset

Implements

ITimelineAsset

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new TimelineAsset(): TimelineAsset

Overrides BaseResource.constructor
- Defined in src/engine/assets/classes/playable/timelineAsset.ts:240
资源的基类，弱引用逻辑。

Returns TimelineAsset

Properties

Optional groupID

groupID: string

Optional resourceID

resourceID: string

编辑器中使用的资源id。

memberof: BaseResource

Accessors

duration

get duration(): number

- Defined in src/engine/assets/classes/playable/timelineAsset.ts:189
Timeline持续的事件。

readonly

memberof

TimelineAsset

Returns number

durationMode

get durationMode(): DurationMode
set durationMode(val: DurationMode): void

- Defined in src/engine/assets/classes/playable/timelineAsset.ts:82
Timeline执行的时长模式。

memberof

TimelineAsset

Returns DurationMode
- Defined in src/engine/assets/classes/playable/timelineAsset.ts:85
Timeline执行的时长模式。

Parameters
- val: DurationMode
Returns void

fixedDuration

get fixedDuration(): number
set fixedDuration(val: number): void

- Defined in src/engine/assets/classes/playable/timelineAsset.ts:96
若DurationMode为FixedLength时，该值表示该Timeline资源的总执行时长。

memberof

TimelineAsset

Returns number
- Defined in src/engine/assets/classes/playable/timelineAsset.ts:99
若DurationMode为FixedLength时，该值表示该Timeline资源的总执行时长。

Parameters
- val: number
Returns void

flattenTracks

get flattenTracks(): TrackAsset[]

- Defined in src/engine/assets/classes/playable/timelineAsset.ts:166
所有轨道展平后的列表。

readonly

memberof

TimelineAsset

Returns TrackAsset[]

frameRate

get frameRate(): number
set frameRate(val: number): void

- Defined in src/engine/assets/classes/playable/timelineAsset.ts:111
Timeline资源的帧率。

memberof

TimelineAsset

Returns number
- Defined in src/engine/assets/classes/playable/timelineAsset.ts:114
Timeline资源的帧率。

Parameters
- val: number
Returns void

name

get name(): string
set name(val: string): void

- Defined in src/engine/assets/classes/playable/timelineAsset.ts:67
Timeline资源的名字。

memberof

TimelineAsset

Returns string
- Defined in src/engine/assets/classes/playable/timelineAsset.ts:70
Timeline资源的名字。

Parameters
- val: string
Returns void

outputTracks

get outputTracks(): TrackAsset[]

- Defined in src/engine/assets/classes/playable/timelineAsset.ts:145
有输出的的轨道列表。如剔除了GroupTrack以及subTrack。

readonly

memberof

TimelineAsset

Returns TrackAsset[]

rootTracks

get rootTracks(): TrackAsset[]

- Defined in src/engine/assets/classes/playable/timelineAsset.ts:129
根轨道（track）的列表。

readonly

memberof

TimelineAsset

Returns TrackAsset[]

Methods

createPlayable

createPlayable(graph: PlayableGraph): PlayableClass

Implementation of ITimelineAsset.createPlayable
- Defined in src/engine/assets/classes/playable/timelineAsset.ts:254
创建playable实例。

memberof

TimelineAsset

Parameters
- graph: PlayableGraph
Returns PlayableClass

createTrack

createTrack(type: string | PlaybaleTrackAssetType, name: string, parent?: TrackAsset): TrackAsset

Implementation of ITimelineAsset.createTrack
- Defined in src/engine/assets/classes/playable/timelineAsset.ts:269
SDK 新建一个trackAsset。

memberof

TimelineAsset

Parameters
- type: string | PlaybaleTrackAssetType
  
  若是custom trackAsset，type为其装饰器上的serialize名字
- name: string
- parent: TrackAsset = null
Returns TrackAsset

deleteClip

deleteClip(clip: TimelineClip): boolean

Implementation of ITimelineAsset.deleteClip
- Defined in src/engine/assets/classes/playable/timelineAsset.ts:357
删除TimelineClip。

memberof

TimelineAsset

Parameters
- clip: TimelineClip
Returns boolean

deleteTrack

deleteTrack(trackAsset: TrackAsset): boolean

Implementation of ITimelineAsset.deleteTrack
- Defined in src/engine/assets/classes/playable/timelineAsset.ts:331
删除Track。

memberof

TimelineAsset

Parameters
- trackAsset: TrackAsset
Returns boolean

Generated using TypeDoc