Keyframe

KeyframeDataPoint

Extends: Object

new KeyframeDataPoint( keyframe )

Creates a new KeyframeDataPoint

Arguments:

keyframe: _Keyframe

Property	Type	Description
constructor	Function	The initial value of Object.prototype.constructor is the standard built-in Object constructor.
boneConfig	Record

KeyframeDataPoint.assign( target, source )

Copy the values of all of the enumerable own properties from one or more source objects to a target object. Returns the target object.

Arguments:

target: T - The target object to copy to.
source: U - The source object from which to copy properties.

Returns:

KeyframeDataPoint.assign( target, source1, source2 )

Copy the values of all of the enumerable own properties from one or more source objects to a target object. Returns the target object.

Arguments:

target: T - The target object to copy to.
source1: U - The first source object from which to copy properties.
source2: V - The second source object from which to copy properties.

Returns:

KeyframeDataPoint.assign( target, source1, source2, source3 )

Copy the values of all of the enumerable own properties from one or more source objects to a target object. Returns the target object.

Arguments:

target: T - The target object to copy to.
source1: U - The first source object from which to copy properties.
source2: V - The second source object from which to copy properties.
source3: W - The third source object from which to copy properties.

Returns:

KeyframeDataPoint.assign( target, sources )

Copy the values of all of the enumerable own properties from one or more source objects to a target object. Returns the target object.

Arguments:

target: object - The target object to copy to.
sources: Array of any - One or more source objects from which to copy properties

Returns: any

KeyframeDataPoint.getOwnPropertySymbols( o )

Returns an array of all symbol properties found directly on object o.

Arguments:

o: any - Object to retrieve the symbols from.

Returns: Array of symbol

KeyframeDataPoint.is( value1, value2 )

Returns true if the values are the same value, false otherwise.

Arguments:

value1: any - The first value.
value2: any - The second value.

Returns: boolean

KeyframeDataPoint.setPrototypeOf( o, proto )

Sets the prototype of a specified object o to object proto or null. Returns the object o.

Arguments:

o: any - The object to change its prototype.
proto: null or object - The value of the new prototype or null.

Returns: any

KeyframeDataPoint.values( o )

Returns an array of values of the enumerable properties of an object

Arguments:

o: See types or ArrayLike - Object that contains the properties and methods. This can be an object that you created or an existing Document Object Model (DOM) object.

Returns: Array of T

KeyframeDataPoint.values( o )

Returns an array of values of the enumerable properties of an object

Arguments:

o: See types - Object that contains the properties and methods. This can be an object that you created or an existing Document Object Model (DOM) object.

Returns: Array of any

KeyframeDataPoint.entries( o )

Returns an array of key/values of the enumerable properties of an object

Arguments:

o: See types or ArrayLike - Object that contains the properties and methods. This can be an object that you created or an existing Document Object Model (DOM) object.

Returns: Array of Array

KeyframeDataPoint.entries( o )

Returns an array of key/values of the enumerable properties of an object

Arguments:

o: See types - Object that contains the properties and methods. This can be an object that you created or an existing Document Object Model (DOM) object.

Returns: Array of Array

KeyframeDataPoint.getOwnPropertyDescriptors( o )

Returns an object containing all own property descriptors of an object

Arguments:

o: T - Object that contains the properties and methods. This can be an object that you created or an existing Document Object Model (DOM) object.

Returns:

KeyframeDataPoint.fromEntries( entries )

Returns an object created by key-value entries for properties and methods

Arguments:

entries: Iterable - An iterable object that contains key-value entries for properties and methods.

Returns: See types

KeyframeDataPoint.fromEntries( entries )

Returns an object created by key-value entries for properties and methods

Arguments:

entries: Iterable - An iterable object that contains key-value entries for properties and methods.

Returns: any

toString()

Returns a string representation of an object.

Returns: string

toLocaleString()

Returns a date converted to a string using the current locale.

Returns: string

valueOf()

Returns the primitive value of the specified object.

Returns: Object

hasOwnProperty( v )

Determines whether an object has a property with the specified name.

Arguments:

v: PropertyKey - A property name.

Returns: boolean

isPrototypeOf( v )

Determines whether an object exists in another object's prototype chain.

Arguments:

v: Object - Another object whose prototype chain is to be checked.

Returns: boolean

propertyIsEnumerable( v )

Determines whether a specified property is enumerable.

Arguments:

v: PropertyKey - A property name.

Returns: boolean

KeyframeDataPoint.getPrototypeOf( o )

Returns the prototype of an object.

Arguments:

o: any - The object that references the prototype.

Returns: any

KeyframeDataPoint.getOwnPropertyDescriptor( o, p )

Gets the own property descriptor of the specified object. An own property descriptor is one that is defined directly on the object and is not inherited from the object's prototype.

Arguments:

o: any - Object that contains the property.
p: PropertyKey - Name of the property.

Returns: undefined or PropertyDescriptor

KeyframeDataPoint.getOwnPropertyNames( o )

Returns the names of the own properties of an object. The own properties of an object are those that are defined directly on that object, and are not inherited from the object's prototype. The properties of an object include both fields (objects) and functions.

Arguments:

o: any - Object that contains the own properties.

Returns: Array of string

KeyframeDataPoint.create( o )

Creates an object that has the specified prototype or that has null prototype.

Arguments:

o: null or object - Object to use as a prototype. May be null.

Returns: any

KeyframeDataPoint.create( o, properties )

Creates an object that has the specified prototype, and that optionally contains specified properties.

Arguments:

o: null or object - Object to use as a prototype. May be null
properties: - JavaScript object that contains one or more property descriptors.

Returns: any

KeyframeDataPoint.defineProperty( o, p, attributes )

Adds a property to an object, or modifies attributes of an existing property.

Arguments:

o: T - Object on which to add or modify the property. This can be a native JavaScript object (that is, a user-defined object or a built in object) or a DOM object.
p: PropertyKey - The property name.
attributes: - Descriptor for the property. It can be for a data property or an accessor property.

Returns: T

KeyframeDataPoint.defineProperties( o, properties )

Adds one or more properties to an object, and/or modifies attributes of existing properties.

Arguments:

o: T - Object on which to add or modify the properties. This can be a native JavaScript object or a DOM object.
properties: - JavaScript object that contains one or more descriptor objects. Each descriptor object describes a data property or an accessor property.

Returns: T

KeyframeDataPoint.seal( o )

Prevents the modification of attributes of existing properties, and prevents the addition of new properties.

Arguments:

o: T - Object on which to lock the attributes.

Returns: T

KeyframeDataPoint.freeze( f )

Prevents the modification of existing property attributes and values, and prevents the addition of new properties.

Arguments:

f: T - Object on which to lock the attributes.

Returns: T

KeyframeDataPoint.freeze( o )

Prevents the modification of existing property attributes and values, and prevents the addition of new properties.

Arguments:

o: T - Object on which to lock the attributes.

Returns: Readonly

KeyframeDataPoint.freeze( o )

Prevents the modification of existing property attributes and values, and prevents the addition of new properties.

Arguments:

o: T - Object on which to lock the attributes.

Returns: Readonly

KeyframeDataPoint.preventExtensions( o )

Prevents the addition of new properties to an object.

Arguments:

o: T - Object to make non-extensible.

Returns: T

KeyframeDataPoint.isSealed( o )

Returns true if existing property attributes cannot be modified in an object and new properties cannot be added to the object.

Arguments:

o: any - Object to test.

Returns: boolean

KeyframeDataPoint.isFrozen( o )

Returns true if existing property attributes and values cannot be modified in an object, and new properties cannot be added to the object.

Arguments:

o: any - Object to test.

Returns: boolean

KeyframeDataPoint.isExtensible( o )

Returns a value that indicates whether new properties can be added to an object.

Arguments:

o: any - Object to test.

Returns: boolean

KeyframeDataPoint.keys( o )

Returns the names of the enumerable string properties and methods of an object.

Arguments:

o: object - Object that contains the properties and methods. This can be an object that you created or an existing Document Object Model (DOM) object.

Returns: Array of string

KeyframeDataPoint.keys( o )

Returns the names of the enumerable string properties and methods of an object.

Arguments:

o: See types - Object that contains the properties and methods. This can be an object that you created or an existing Document Object Model (DOM) object.

Returns: Array of string

extend( data )

Arguments:

data: KeyframeDataPointData

getUndoCopy()

Returns: See types

properties

Static Property

Type: Record

Keyframe

new _Keyframe( options, uuid )

Creates a new Keyframe

Arguments:

options: KeyframeOptions
- channel: string (Optional)
- data_points: Array of See types
- time: number
- color: number (Optional)
- uniform: boolean (Optional)
- interpolation: string (Optional)
- bezier_linked: boolean (Optional)
- bezier_left_time: ArrayVector3 (Optional)
- bezier_left_value: ArrayVector3 (Optional)
- bezier_right_time: ArrayVector3 (Optional)
- bezier_right_value: ArrayVector3 (Optional)
uuid: any

Property	Type	Description
data_points	Array of KeyframeDataPoint
animator	GeneralAnimator
channel	string
time	number
uuid	string
color	number
uniform	boolean
interpolation	`"linear"` or `"catmullrom"` or `"bezier"` or `"step"`
cooldown	boolean
bezier_linked	boolean
bezier_left_time	ArrayVector3
bezier_right_time	ArrayVector3
bezier_left_value	ArrayVector3
bezier_right_value	ArrayVector3
selected	boolean
transform	boolean
has_expressions	boolean

extend( data )

Arguments:

data: KeyframeOptions
- channel: string (Optional)
- data_points: Array of See types
- time: number
- color: number (Optional)
- uniform: boolean (Optional)
- interpolation: string (Optional)
- bezier_linked: boolean (Optional)
- bezier_left_time: ArrayVector3 (Optional)
- bezier_left_value: ArrayVector3 (Optional)
- bezier_right_time: ArrayVector3 (Optional)
- bezier_right_value: ArrayVector3 (Optional)

Returns: _Keyframe

get( axis[, data_point] )

Arguments:

axis: axisLetter
data_point: number (Optional)

Returns: string or number

calc( axis[, data_point] )

Arguments:

axis: axisLetter
data_point: number (Optional)

Returns: number

set( axis, value[, data_point] )

Arguments:

axis: axisLetter
value: any
data_point: number (Optional)

Returns: _Keyframe

offset( axis, amount[, data_point] )

Arguments:

axis: axisLetter
amount: any
data_point: number (Optional)

flip( axis )

Arguments:

axis: axisLetter

Returns: _Keyframe

getLerp( other, axis, amount[, allow_expression] )

Arguments:

other: _Keyframe
axis: axisLetter
amount: number
allow_expression: boolean (Optional)

Returns: number

getCatmullromLerp( before_plus, before, after, after_plus, axis, alpha )

Arguments:

before_plus: _Keyframe
before: _Keyframe
after: _Keyframe
after_plus: _Keyframe
axis: axisLetter
alpha: number

Returns: number

getArray( [data_point] )

Arguments:

data_point: number (Optional)

Returns: Array of string or number

getFixed( [data_point, get_quaternion] )

Arguments:

data_point: number (Optional)
get_quaternion: boolean (Optional)

Returns: THREE.Vector3 or THREE.Euler or THREE.Quaternion

getTimecodeString()

Returns: string

compileBedrockKeyframe()

Returns: any

replaceOthers( save )

Arguments:

save: any

select( [event] )

Arguments:

event: any (Optional)

Returns: _Keyframe

callPlayhead()

Returns: _Keyframe

showContextMenu( event )

Arguments:

event: Event

Returns: _Keyframe

remove()

forSelected( callback, undo_tag )

Arguments:

callback: See types
undo_tag: any

Returns: Array of _Keyframe

getUndoCopy( save )

Arguments:

save: any

Returns: See types

selected

Static Property

Type: Array of _Keyframe