Constructor
new Frame(start, end)
- Description:
Create a new frame.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
start |
number | The start of the frame. Optional, defaults to 1. |
end |
number | The end of the frame. Optional, defaults to be the same as start. |
Members
clips :Array.<Wick.Clip>
- Description:
The clips on the frame.
- Source:
The clips on the frame.
Type:
- Array.<Wick.Clip>
contentful :boolean
- Description:
True if there are clips or paths on the frame.
- Source:
True if there are clips or paths on the frame.
Type:
- boolean
drawable :Array.<Wick.Base>
- Description:
The drawable objectson the frame.
- Source:
The drawable objectson the frame.
Type:
- Array.<Wick.Base>
dynamicTextPaths :Array.<Wick.Path>
- Description:
The paths that are text and have identifiers, for dynamic text.
- Source:
The paths that are text and have identifiers, for dynamic text.
Type:
- Array.<Wick.Path>
layerIndex :number
- Description:
The index of the parent layer.
- Source:
The index of the parent layer.
Type:
- number
length :number
- Description:
The length of the frame.
- Source:
The length of the frame.
Type:
- number
midpoint :number
- Description:
The midpoint of the frame.
- Source:
The midpoint of the frame.
Type:
- number
onionSkinned
- Description:
True if this frame should currently be onion skinned.
- Source:
True if this frame should currently be onion skinned.
onScreen :boolean
- Description:
Is true if the frame is currently visible.
- Source:
Is true if the frame is currently visible.
Type:
- boolean
originalLayerIndex :number
- Description:
The index of the layer that this frame last belonged to. Used when copying and pasting frames.
- Source:
The index of the layer that this frame last belonged to. Used when copying and pasting frames.
Type:
- number
paths :Array.<Wick.Path>
- Description:
The paths on the frame.
- Source:
The paths on the frame.
Type:
- Array.<Wick.Path>
playheadSoundOffsetMS :number
- Description:
The amount of time, in milliseconds, that the frame's sound should play before stopping.
- Source:
The amount of time, in milliseconds, that the frame's sound should play before stopping.
Type:
- number
projectFrameStart
- Description:
Returns the frame's start position in relation to the root timeline.
- Source:
Returns the frame's start position in relation to the root timeline.
sound :Wick.SoundAsset
- Description:
The sound attached to the frame.
- Source:
The sound attached to the frame.
Type:
soundEndMS :number
- Description:
When should the sound end, in milliseconds.
- Source:
When should the sound end, in milliseconds.
Type:
- number
soundLoop :boolean
- Description:
Whether or not the sound loops.
- Source:
Whether or not the sound loops.
Type:
- boolean
soundStart :number
- Description:
The amount of time the sound playing should be offset, in milliseconds. If this is 0, the sound plays normally. A negative value means the sound should start at a later point in the track. THIS DOES NOT DETERMINE WHEN A SOUND PLAYS.
- Source:
The amount of time the sound playing should be offset, in milliseconds. If this is 0, the sound plays normally. A negative value means the sound should start at a later point in the track. THIS DOES NOT DETERMINE WHEN A SOUND PLAYS.
Type:
- number
soundStartMS :number
- Description:
When should the sound start, in milliseconds.
- Source:
When should the sound start, in milliseconds.
Type:
- number
soundVolume :number
- Description:
The volume of the sound attached to the frame.
- Source:
The volume of the sound attached to the frame.
Type:
- number
tweens :Array.<Wick.Tween>
- Description:
The tweens on this frame.
- Source:
The tweens on this frame.
Type:
- Array.<Wick.Tween>
Methods
addClip(clip)
- Description:
Add a clip to the frame.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
clip |
Wick.Clip | the clip to add. |
addPath(path)
- Description:
Add a path to the frame.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
path |
Wick.Path | the path to add. |
addTween(tween)
- Description:
Add a tween to the frame.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
tween |
Wick.Tween | the tween to add. |
applyClipSingleFramePositions()
- Description:
Applies single frame positions to timelines if necessary.
- Source:
applyTweenTransforms()
- Description:
Applies the transformation of current tween to the objects on the frame.
- Source:
containedWithin(start, end) → {boolean}
- Description:
True if the frame is contained fully within a given range.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
start |
number | the start of the range to check. |
end |
number | the end of the range to check. |
Returns:
- Type
- boolean
createTween()
- Description:
Automatically creates a tween at the current playhead position. Converts all objects into one clip if needed.
- Source:
cut()
- Description:
Cut this frame in half using the parent timeline's playhead position.
- Source:
distanceFrom(playheadPosition)
- Description:
The number of frames that this frame is from a given playhead position.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
playheadPosition |
number |
extendAndPushOtherFrames()
- Description:
Extend this frame by one and push all frames right of this frame to the right.
- Source:
getActiveTween()
- Description:
The tween being used to transform the objects on the frame.
- Source:
Returns:
getLinkedAssets() → {Array.<Wick.Asset>}
- Description:
The asset of the sound attached to this frame, if one exists
- Source:
Returns:
- Type
- Array.<Wick.Asset>
getRelativePlayheadPosition() → {number}
- Description:
Get the position of this frame in relation to the parent timeline's playhead position.
- Source:
Returns:
- Type
- number
getTweenAtCurrentPlayheadPosition()
- Description:
Returns the tween at the current playhead position, if one exists on the frame. Null otherwise.
- Source:
Returns:
getTweenAtPosition(playheadPosition)
- Description:
Get the tween at the given playhead position. Returns null if there is no tween.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
playheadPosition |
number | the playhead position to look for tweens at. |
Returns:
inPosition(playheadPosition) → {boolean}
- Description:
True if the playhead is on this frame.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
playheadPosition |
number | the position of the playhead. |
Returns:
- Type
- boolean
inRange(start, end) → {boolean}
- Description:
True if the frame exists within the given range.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
start |
number | the start of the range to check. |
end |
number | the end of the range to check. |
Returns:
- Type
- boolean
isSoundPlaying() → {boolean}
- Description:
Check if the sound on this frame is playing.
- Source:
Returns:
true if the sound is playing
- Type
- boolean
playSound()
- Description:
Plays the sound attached to this frame.
- Source:
remove()
- Description:
Removes this frame from its parent layer.
- Source:
removeAllTweens()
- Description:
Remove all tweens from this frame.
- Source:
removeClip(clip)
- Description:
Remove a clip from the frame.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
clip |
Wick.Clip | the clip to remove. |
removePath(path)
- Description:
Remove a path from the frame.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
path |
Wick.Path | the path to remove. |
removeSound()
- Description:
Removes the sound attached to this frame.
- Source:
removeTween(tween)
- Description:
Remove a tween from the frame.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
tween |
Wick.Tween | the tween to remove. |
seekTweenBehind() → {Wick.Tween}
- Description:
Find the first tween on this frame that exists behind the given playhead position.
- Source:
Returns:
- Type
- Wick.Tween
seekTweenInFront() → {Wick.Tween}
- Description:
Find the first tween on this frame that exists past the given playhead position.
- Source:
Returns:
- Type
- Wick.Tween
shrinkAndPullOtherFrames()
- Description:
Shrink this frame by one and pull all frames left of this frame to the left.
- Source:
stopSound()
- Description:
Stops the sound attached to this frame.
- Source:
updateClipTimelinesForAnimationType()
- Description:
Update all clip timelines for their animation type.
- Source: