Class BBKeyframe

Keyframe class

BBKeyframe is an alias for Keyframe. Blockbench's Keyframe class conflicts with libdom's Keyframe type with its own Keyframe Class, but TypeScript doesn't include a way to overwrite UMD global types.

You can use BBKeyframe to get around the Typescript conflict, or use Keyframe.

Constructors

constructor

new BBKeyframe(options: KeyframeOptions, uuid: any): BBKeyframe
Parameters
- options: KeyframeOptions
- uuid: any
Returns BBKeyframe
- Defined in types/custom/keyframe.d.ts:46

Methods

calc

calc(axis: axisLetter, data_point?: number): number
Parameters
- axis: axisLetter
- Optionaldata_point: number
Returns number
- Defined in types/custom/keyframe.d.ts:68

callPlayhead

callPlayhead(): this
Returns this
- Defined in types/custom/keyframe.d.ts:90

compileBedrockKeyframe

compileBedrockKeyframe(): any
Returns any
- Defined in types/custom/keyframe.d.ts:87

extend

extend(data: KeyframeOptions): this
Parameters
- data: KeyframeOptions
Returns this
- Defined in types/custom/keyframe.d.ts:66

flip

flip(axis: axisLetter): this
Parameters
- axis: axisLetter
Returns this
- Defined in types/custom/keyframe.d.ts:71

forSelected

forSelected(
callback: (keyframe: BBKeyframe) => void,
undo_tag: any,
): BBKeyframe[]
Parameters
- callback: (keyframe: BBKeyframe) => void
- undo_tag: any
Returns BBKeyframe[]
- Defined in types/custom/keyframe.d.ts:94

get

get(axis: axisLetter, data_point?: number): string | number
Parameters
- axis: axisLetter
- Optionaldata_point: number
Returns string | number
- Defined in types/custom/keyframe.d.ts:67

getArray

getArray(data_point?: number): (string | number)[]
Parameters
- Optionaldata_point: number
Returns (string | number)[]
- Defined in types/custom/keyframe.d.ts:81

getCatmullromLerp

getCatmullromLerp(
    before_plus: BBKeyframe,
    before: BBKeyframe,
    after: BBKeyframe,
    after_plus: BBKeyframe,
    axis: axisLetter,
    alpha: number,
): number
Parameters
- before_plus: BBKeyframe
- before: BBKeyframe
- after: BBKeyframe
- after_plus: BBKeyframe
- axis: axisLetter
- alpha: number
Returns number
- Defined in types/custom/keyframe.d.ts:73

getFixed

getFixed(
data_point?: number,
get_quaternion?: boolean,
): Vector3 | Euler | Quaternion
Parameters
- Optionaldata_point: number
- Optionalget_quaternion: boolean
Returns Vector3 | Euler | Quaternion
- Defined in types/custom/keyframe.d.ts:82

getLerp

getLerp(
    other: BBKeyframe,
    axis: axisLetter,
    amount: number,
    allow_expression?: boolean,
): number
Parameters
- other: BBKeyframe
- axis: axisLetter
- amount: number
- Optionalallow_expression: boolean
Returns number
- Defined in types/custom/keyframe.d.ts:72

getTimecodeString

getTimecodeString(): string
Returns string
- Defined in types/custom/keyframe.d.ts:86

getUndoCopy

getUndoCopy(
save: any,
): { animator: any; channel?: string; data_points: KeyframeDataPoint[] }
Parameters
- save: any
Returns { animator: any; channel?: string; data_points: KeyframeDataPoint[] }
- Defined in types/custom/keyframe.d.ts:95

offset

offset(axis: axisLetter, amount: any, data_point?: number): void
Parameters
- axis: axisLetter
- amount: any
- Optionaldata_point: number
Returns void
- Defined in types/custom/keyframe.d.ts:70

remove

remove(): void
Returns void
- Defined in types/custom/keyframe.d.ts:93

replaceOthers

replaceOthers(save: any): void
Parameters
- save: any
Returns void
- Defined in types/custom/keyframe.d.ts:88

select

select(event?: any): this
Parameters
- Optionalevent: any
Returns this
- Defined in types/custom/keyframe.d.ts:89

set

set(axis: axisLetter, value: any, data_point?: number): this
Parameters
- axis: axisLetter
- value: any
- Optionaldata_point: number
Returns this
- Defined in types/custom/keyframe.d.ts:69

showContextMenu

showContextMenu(event: Event): this
Parameters
- event: Event
Returns this
- Defined in types/custom/keyframe.d.ts:92

showInTimeline

showInTimeline(): void
Returns void
- Defined in types/custom/keyframe.d.ts:91

Properties

animator

animator: GeneralAnimator

bezier_left_time

bezier_left_time: ArrayVector3

bezier_left_value

bezier_left_value: ArrayVector3

bezier_linked

bezier_linked: boolean

bezier_right_time

bezier_right_time: ArrayVector3

bezier_right_value

bezier_right_value: ArrayVector3

channel

channel: string

color

color: number

`Optional`cooldown

cooldown?: boolean

data_points

data_points: KeyframeDataPoint[]

has_expressions

has_expressions: boolean

interpolation

interpolation: string

selected

selected: boolean

time

time: number

transform

transform: boolean

uniform

uniform: boolean

uuid

uuid: string

`Static`selected

selected: BBKeyframe[]

Class BBKeyframe

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns BBKeyframe

Methods

calc

Parameters

Returns number

callPlayhead

Returns this

compileBedrockKeyframe

Returns any

extend

Parameters

Returns this

flip

Parameters

Returns this

forSelected

Parameters

Returns BBKeyframe[]

get

Parameters

Returns string | number

getArray

Parameters

Returns (string | number)[]

getCatmullromLerp

Parameters

Returns number

getFixed

Parameters

Returns Vector3 | Euler | Quaternion

getLerp

Parameters

Returns number

getTimecodeString

Returns string

getUndoCopy

Parameters

Returns { animator: any; channel?: string; data_points: KeyframeDataPoint[] }

offset

Parameters

Returns void

remove

Returns void

replaceOthers

Parameters

Returns void

select

Parameters

Returns this

set

Parameters

Returns this

showContextMenu

Parameters

Returns this

showInTimeline

Returns void

Properties

animator

bezier_left_time

bezier_left_value

bezier_linked

bezier_right_time

bezier_right_value

channel

color

Optionalcooldown

data_points

has_expressions

interpolation

selected

time

`Optional`cooldown

`Static`selected