Interface IVector3TimelinePlayerEntry`Beta`

A Vector3 timeline entry owned by a Timeline Player pane

interface IVector3TimelinePlayerEntry {
    id: string;
    paneId: string;
    title: LocalizedString | undefined;
    addKeyframe(keyframe: IVector3Keyframe): void;
    getKeyframes(): IVector3Keyframe[];
    getSelectedKeyframeId(): string | undefined;
    removeKeyframe(id: string): void;
    setKeyframes(keyframes: IVector3Keyframe[]): void;
    setSelectedKeyframeId(keyframeId: string | undefined): void;
    setTitle(title: LocalizedString | undefined): void;
    updateKeyframe(keyframe: IVector3Keyframe): void;
}

Hierarchy (View Summary)

ITimelinePlayerEntry
- IVector3TimelinePlayerEntry

Index

Properties

id paneId title

Methods

addKeyframe getKeyframes getSelectedKeyframeId removeKeyframe setKeyframes setSelectedKeyframeId setTitle updateKeyframe

Properties

`Readonly` `Beta`id

id: string

Remarks

Unique identifier for the entry.

`Readonly` `Beta`paneId

paneId: string

Remarks

Identifier of the parent Timeline Player pane.

`Readonly` `Beta`title

title: LocalizedString | undefined

Remarks

Display title shown next to the entry's graph.

Methods

addKeyframe

addKeyframe(keyframe: IVector3Keyframe): void
Beta
Parameters
- keyframe: IVector3Keyframe
  Keyframe to add.
Returns void
Remarks
Add a keyframe.
- Defined in tmp/package/index.d.ts:11717

getKeyframes

getKeyframes(): IVector3Keyframe[]
Beta
Returns IVector3Keyframe[]
Remarks
Get the list of keyframes for this entry.
- Defined in tmp/package/index.d.ts:11723

getSelectedKeyframeId

getSelectedKeyframeId(): string | undefined
Beta
Returns string | undefined
Remarks
Get the currently selected keyframe identifier for this entry, or undefined if no keyframe in this entry is selected.
- Defined in tmp/package/index.d.ts:11731

removeKeyframe

removeKeyframe(id: string): void
Beta
Parameters
- id: string
  Identifier of the keyframe to remove.
Returns void
Remarks
Remove a keyframe by its identifier.
- Defined in tmp/package/index.d.ts:11739

setKeyframes

setKeyframes(keyframes: IVector3Keyframe[]): void
Beta
Parameters
- keyframes: IVector3Keyframe[]
  New set of keyframes.
Returns void
Remarks
Bulk replace all keyframes.
- Defined in tmp/package/index.d.ts:11747

setSelectedKeyframeId

setSelectedKeyframeId(keyframeId: string | undefined): void
Beta
Parameters
- keyframeId: string | undefined
  Identifier of the keyframe to select, or undefined to deselect.
Returns void
Remarks
Set the selected keyframe for this entry.
- Defined in tmp/package/index.d.ts:11756

setTitle

setTitle(title: LocalizedString | undefined): void
Beta
Parameters
- title: LocalizedString | undefined
  New title.
Returns void
Remarks
Updates title of the entry.
Inherited from ITimelinePlayerEntry.setTitle
- Defined in tmp/package/index.d.ts:11272

updateKeyframe

updateKeyframe(keyframe: IVector3Keyframe): void
Beta
Parameters
- keyframe: IVector3Keyframe
  Keyframe with updated time/value.
Returns void
Remarks
Update an existing keyframe. Matched by the id field.
- Defined in tmp/package/index.d.ts:11764