Key

aeq. Key

new Key(property, index) → {aeq.Key}

Source:

Converts a Key into an aeq.Key object

Parameters:
Name Type Description
property Property

Property to find key on

index number

The index of the key

Returns:

aeq.Key object

Type
aeq.Key

Methods

copyTo(targetProp, timeopt) → {aeq.Key}

Source:

Copies current key to a new property at current (or target) time

Parameters:
Name Type Attributes Default Description
targetProp Property

Property to create new key on

time number <optional>
aeq.KeyInfo.time

Time to create new key at; defaults to current key's time

Returns:

New key

Type
aeq.Key

getKeyinfo() → {aeq.KeyInfo}

Source:

Gets key data

Returns:

[description]

Type
aeq.KeyInfo

getTime() → {number}

Source:

Gets comp time of current key

Returns:

Key time of current key, in seconds

Type
number

interpolationType(inTypeopt, outTypeopt) → {InterpolationType|boolean}

Source:

Gets or sets interpolation type of current key

Parameters:
Name Type Attributes Description
inType KeyframeInterpolationType <optional>

In KeyframeInterpolationType enumerated value to set

outType KeyframeInterpolationType <optional>

Out KeyframeInterpolationType enumerated value to set

Returns:

Object of In/Out Interp types, or true/false if can/can't set type

Type
InterpolationType | boolean

moveTo(time)

Source:

Moves current key to new time

Parameters:
Name Type Description
time number

New key time

remove()

Source:

Removes current key from property

spatialTangent(inTypeopt, outTypeopt) → {SpatialTangent}

Source:

Gets or sets in/out spatial tangents of current key

Parameters:
Name Type Attributes Description
inType KeyframeSpatialTangent <optional>

In KeyframeSpatialTangent enumerated value to set

outType KeyframeSpatialTangent <optional>

Out KeyframeSpatialTangent enumerated value to set

Returns:

Object of In/Out spatial tangent values

Type
SpatialTangent

temporalEase(inTypeopt, outTypeopt) → {TemporalEase}

Source:

Gets or sets in/out temporal ease of current key

Parameters:
Name Type Attributes Description
inType KeyframeTemporalEase <optional>

In KeyframeTemporalEase enumerated value to set

outType KeyframeTemporalEase <optional>

Out KeyframeTemporalEase enumerated value to set

Returns:

Object of In/Out temporal ease values

Type
TemporalEase

time() → {number}

Source:

Gets comp time of current key

Returns:

Key time of current key, in seconds

Type
number

valueTypeIs(type) → {boolean}

Source:

Checks whether this property type matches argument

Parameters:
Name Type Description
type string

PropertyValueType to check

Returns:

true if property type matches argument

Type
boolean