Wick.Timeline.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <title>JSDoc: Class: Timeline</title>

    <script src="scripts/prettify/prettify.js"> </script>
    <script src="scripts/prettify/lang-css.js"> </script>
    <!--[if lt IE 9]>
      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
    <![endif]-->
    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>

<body>

<div id="main">

    <h1 class="page-title">Class: Timeline</h1>

    
<section>

<header>
    
        <h2><span class="attribs"><span class="type-signature"></span></span>
            <span class="ancestors"><a href="global.html#Wick">Wick</a>.</span>Timeline<span class="signature">()</span><span class="type-signature"></span></h2>
        
            <div class="class-description">Class representing a Wick Timeline.</div>
        
    
</header>

<article>
    <div class="container-overview">
    
        
    <h2>Constructor</h2>
    

    <h4 class="name" id="Timeline"><span class="type-signature"></span>new Timeline<span class="signature">()</span><span class="type-signature"></span></h4>
    

<div class="description">
    Create a timeline.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Timeline.js.html">base/Timeline.js</a>, <a href="base_Timeline.js.html#line27">line 27</a>
    </li></ul></dd>
    

</dl>


    </div>

    
        <h3 class="subsection-title">Members</h3>

        
<h4 class="name" id="activeFrame"><span class="type-signature"></span>activeFrame<span class="type-signature"> :<a href="Wick.Frame.html">Wick.Frame</a></span></h4>


<div class="description">
    The active frame, determined by the playhead position.
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type"><a href="Wick.Frame.html">Wick.Frame</a></span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Timeline.js.html">base/Timeline.js</a>, <a href="base_Timeline.js.html#line150">line 150</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="activeFrames"><span class="type-signature"></span>activeFrames<span class="type-signature"> :Array.&lt;<a href="Wick.Frame.html">Wick.Frame</a>></span></h4>


<div class="description">
    The active frames, determined by the playhead position.
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Array.&lt;<a href="Wick.Frame.html">Wick.Frame</a>></span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Timeline.js.html">base/Timeline.js</a>, <a href="base_Timeline.js.html#line135">line 135</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="activeLayer"><span class="type-signature"></span>activeLayer<span class="type-signature"> :<a href="Wick.Layer.html">Wick.Layer</a></span></h4>


<div class="description">
    The active layer.
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type"><a href="Wick.Layer.html">Wick.Layer</a></span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Timeline.js.html">base/Timeline.js</a>, <a href="base_Timeline.js.html#line127">line 127</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="activeLayerIndex"><span class="type-signature"></span>activeLayerIndex<span class="type-signature"> :number</span></h4>


<div class="description">
    The index of the active layer. Determines which frame to draw onto.
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">number</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Timeline.js.html">base/Timeline.js</a>, <a href="base_Timeline.js.html#line100">line 100</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="clips"><span class="type-signature"></span>clips<span class="type-signature"> :Array.&lt;<a href="Wick.Clip.html">Wick.Clip</a>></span></h4>


<div class="description">
    All clips inside the timeline.
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Array.&lt;<a href="Wick.Clip.html">Wick.Clip</a>></span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Timeline.js.html">base/Timeline.js</a>, <a href="base_Timeline.js.html#line172">line 172</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="fillGapsMethod"><span class="type-signature"></span>fillGapsMethod<span class="type-signature"> :string</span></h4>


<div class="description">
    The method to use to fill gaps in-beteen frames. Options: "blank_frames" or "auto_extend" (see Wick.Layer.resolveGaps)
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">string</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Timeline.js.html">base/Timeline.js</a>, <a href="base_Timeline.js.html#line415">line 415</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="frames"><span class="type-signature"></span>frames<span class="type-signature"> :Array.&lt;<a href="Wick.Frame.html">Wick.Frame</a>></span></h4>


<div class="description">
    All frames inside the timeline.
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Array.&lt;<a href="Wick.Frame.html">Wick.Frame</a>></span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Timeline.js.html">base/Timeline.js</a>, <a href="base_Timeline.js.html#line158">line 158</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="layers"><span class="type-signature"></span>layers<span class="type-signature"> :<a href="Wick.Layer.html">Wick.Layer</a></span></h4>


<div class="description">
    The layers that belong to this timeline.
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type"><a href="Wick.Layer.html">Wick.Layer</a></span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Timeline.js.html">base/Timeline.js</a>, <a href="base_Timeline.js.html#line66">line 66</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="length"><span class="type-signature"></span>length<span class="type-signature"> :number</span></h4>


<div class="description">
    The total length of the timeline.
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">number</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Timeline.js.html">base/Timeline.js</a>, <a href="base_Timeline.js.html#line112">line 112</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="playheadPosition"><span class="type-signature"></span>playheadPosition<span class="type-signature"> :number</span></h4>


<div class="description">
    The position of the playhead. Determines which frames are visible.
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">number</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Timeline.js.html">base/Timeline.js</a>, <a href="base_Timeline.js.html#line74">line 74</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="waitToFillFrameGaps"><span class="type-signature"></span>waitToFillFrameGaps<span class="type-signature"> :boolean</span></h4>


<div class="description">
    Check if frame gap fixing should be deferred until later. Read only.
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">boolean</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Timeline.js.html">base/Timeline.js</a>, <a href="base_Timeline.js.html#line432">line 432</a>
    </li></ul></dd>
    

</dl>


        <h3 class="subsection-title">Methods</h3>

        
    <h4 class="name" id="addFrame"><span class="type-signature"></span>addFrame<span class="signature">(frame)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Add a frame to one of the layers on this timeline. If there is no layer where the frame wants to go, the frame will not be added.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>frame</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="Wick.Frame.html">Wick.Frame</a></span>


            </td>

            
            <td class="description last">the frame to add</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Timeline.js.html">base/Timeline.js</a>, <a href="base_Timeline.js.html#line194">line 194</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="addLayer"><span class="type-signature"></span>addLayer<span class="signature">(layer)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Adds a layer to the timeline.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>layer</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="Wick.Layer.html">Wick.Layer</a></span>


            </td>

            
            <td class="description last">The layer to add.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Timeline.js.html">base/Timeline.js</a>, <a href="base_Timeline.js.html#line208">line 208</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="addTween"><span class="type-signature"></span>addTween<span class="signature">(tween)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Adds a tween to a frame on this timeline.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>tween</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="Wick.Tween.html">Wick.Tween</a></span>


            </td>

            
            <td class="description last">the tween to add.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Timeline.js.html">base/Timeline.js</a>, <a href="base_Timeline.js.html#line223">line 223</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="advance"><span class="type-signature"></span>advance<span class="signature">()</span><span class="type-signature"></span></h4>
    

<div class="description">
    Advances the timeline one frame forwards. Loops back to beginning if the end is reached.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Timeline.js.html">base/Timeline.js</a>, <a href="base_Timeline.js.html#line322">line 322</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="deferFrameGapResolve"><span class="type-signature"></span>deferFrameGapResolve<span class="signature">()</span><span class="type-signature"></span></h4>
    

<div class="description">
    Disables frame gap filling until resolveFrameGaps is called again.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Timeline.js.html">base/Timeline.js</a>, <a href="base_Timeline.js.html#line439">line 439</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="getAllFrames"><span class="type-signature"></span>getAllFrames<span class="signature">(recursive)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Get all frames in this timeline.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>recursive</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>


            </td>

            
            <td class="description last">If set to true, will also include the children of all child timelines.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Timeline.js.html">base/Timeline.js</a>, <a href="base_Timeline.js.html#line282">line 282</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="getFrameByName"><span class="type-signature"></span>getFrameByName<span class="signature">()</span><span class="type-signature"></span></h4>
    

<div class="description">
    Finds the frame with a given name.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Timeline.js.html">base/Timeline.js</a>, <a href="base_Timeline.js.html#line184">line 184</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="getFramesAtPlayheadPosition"><span class="type-signature"></span>getFramesAtPlayheadPosition<span class="signature">(playheadPosition)</span><span class="type-signature"> &rarr; {Array.&lt;<a href="Wick.Frame.html">Wick.Frame</a>>}</span></h4>
    

<div class="description">
    Gets the frames at the given playhead position.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>playheadPosition</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            </td>

            
            <td class="description last">the playhead position to search.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Timeline.js.html">base/Timeline.js</a>, <a href="base_Timeline.js.html#line267">line 267</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    The frames at the playhead position.
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Array.&lt;<a href="Wick.Frame.html">Wick.Frame</a>></span>


    </dd>
</dl>

    
    <h4 class="name" id="getFramesInRange"><span class="type-signature"></span>getFramesInRange<span class="signature">(playheadPositionStart, playheadPositionEnd, layerIndexStart, layerIndexEnd)</span><span class="type-signature"> &rarr; {Array.&lt;<a href="Wick.Frame.html">Wick.Frame</a>>}</span></h4>
    

<div class="description">
    Gets all frames in the layer that are between the two given playhead positions and layer indices.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>playheadPositionStart</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            </td>

            
            <td class="description last">The start of the horizontal range to search</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>playheadPositionEnd</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            </td>

            
            <td class="description last">The end of the horizontal range to search</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>layerIndexStart</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            </td>

            
            <td class="description last">The start of the vertical range to search</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>layerIndexEnd</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            </td>

            
            <td class="description last">The end of the vertical range to search</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Timeline.js.html">base/Timeline.js</a>, <a href="base_Timeline.js.html#line306">line 306</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    The frames in the given range.
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Array.&lt;<a href="Wick.Frame.html">Wick.Frame</a>></span>


    </dd>
</dl>

    
    <h4 class="name" id="gotoAndPlay"><span class="type-signature"></span>gotoAndPlay<span class="signature">(frame)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Plays the timeline and moves to a given frame number or name.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>frame</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>
|

<span class="param-type">number</span>


            </td>

            
            <td class="description last">A playhead position or name of a frame to move to.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Timeline.js.html">base/Timeline.js</a>, <a href="base_Timeline.js.html#line361">line 361</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="gotoAndStop"><span class="type-signature"></span>gotoAndStop<span class="signature">(frame)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Stops the timeline and moves to a given frame number or name.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>frame</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>
|

<span class="param-type">number</span>


            </td>

            
            <td class="description last">A playhead position or name of a frame to move to.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Timeline.js.html">base/Timeline.js</a>, <a href="base_Timeline.js.html#line352">line 352</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="gotoFrame"><span class="type-signature"></span>gotoFrame<span class="signature">(frame)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Moves the playhead to a given frame number or name.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>frame</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>
|

<span class="param-type">number</span>


            </td>

            
            <td class="description last">A playhead position or name of a frame to move to.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Timeline.js.html">base/Timeline.js</a>, <a href="base_Timeline.js.html#line395">line 395</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="gotoNextFrame"><span class="type-signature"></span>gotoNextFrame<span class="signature">()</span><span class="type-signature"></span></h4>
    

<div class="description">
    Moves the timeline forward one frame. Loops back to 1 if gotoNextFrame moves the playhead past the past frame.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Timeline.js.html">base/Timeline.js</a>, <a href="base_Timeline.js.html#line369">line 369</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="gotoPrevFrame"><span class="type-signature"></span>gotoPrevFrame<span class="signature">()</span><span class="type-signature"></span></h4>
    

<div class="description">
    Moves the timeline backwards one frame. Loops to the last frame if gotoPrevFrame moves the playhead before the first frame.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Timeline.js.html">base/Timeline.js</a>, <a href="base_Timeline.js.html#line382">line 382</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="moveLayer"><span class="type-signature"></span>moveLayer<span class="signature">(layer, index)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Moves a layer to a different position, inserting it before/after other layers if needed.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>layer</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="Wick.Layer.html">Wick.Layer</a></span>


            </td>

            
            <td class="description last">The layer to add.</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>index</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            </td>

            
            <td class="description last">the new position to move the layer to.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Timeline.js.html">base/Timeline.js</a>, <a href="base_Timeline.js.html#line256">line 256</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="play"><span class="type-signature"></span>play<span class="signature">()</span><span class="type-signature"></span></h4>
    

<div class="description">
    Makes the timeline advance automatically during ticks.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Timeline.js.html">base/Timeline.js</a>, <a href="base_Timeline.js.html#line337">line 337</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="removeLayer"><span class="type-signature"></span>removeLayer<span class="signature">(layer)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Remmoves a layer from the timeline.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>layer</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="Wick.Layer.html">Wick.Layer</a></span>


            </td>

            
            <td class="description last">The layer to remove.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Timeline.js.html">base/Timeline.js</a>, <a href="base_Timeline.js.html#line237">line 237</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="resolveFrameGaps"><span class="type-signature"></span>resolveFrameGaps<span class="signature">(newOrModifiedFrames)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Fill in all gaps between frames in all layers in this timeline.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>newOrModifiedFrames</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array.&lt;<a href="Wick.Frame.html">Wick.Frame</a>></span>


            </td>

            
            <td class="description last">The frames that should not be affected by the gap fill by being extended or shrunk.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Timeline.js.html">base/Timeline.js</a>, <a href="base_Timeline.js.html#line447">line 447</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="resolveFrameOverlap"><span class="type-signature"></span>resolveFrameOverlap<span class="signature">(newOrModifiedFrames)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Prevents frames from overlapping each other by removing pieces of frames that are touching.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>newOrModifiedFrames</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array.&lt;<a href="Wick.Frame.html">Wick.Frame</a>></span>


            </td>

            
            <td class="description last">the frames that should take precedence when determining which frames should get "eaten".</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Timeline.js.html">base/Timeline.js</a>, <a href="base_Timeline.js.html#line462">line 462</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="stop"><span class="type-signature"></span>stop<span class="signature">()</span><span class="type-signature"></span></h4>
    

<div class="description">
    Stops the timeline from advancing during ticks.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Timeline.js.html">base/Timeline.js</a>, <a href="base_Timeline.js.html#line344">line 344</a>
    </li></ul></dd>
    

</dl>


</article>

</section>


</div>

<nav>
    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="BuiltinAssets.html">BuiltinAssets</a></li><li><a href="GlobalAPI.html">GlobalAPI</a></li><li><a href="paper.SelectionGUI.html">SelectionGUI</a></li><li><a href="paper-paper.Selection.html">Selection</a></li><li><a href="SelectionWidget.html">SelectionWidget</a></li><li><a href="Wick.AutoSave.html">AutoSave</a></li><li><a href="Wick.Base.html">Base</a></li><li><a href="Wick.Button.html">Button</a></li><li><a href="Wick.Clip.html">Clip</a></li><li><a href="Wick.Clipboard.html">Clipboard</a></li><li><a href="Wick.FileCache.html">FileCache</a></li><li><a href="Wick.Frame.html">Frame</a></li><li><a href="Wick.GUIElement.Project.html">Project</a></li><li><a href="Wick.GUIElement.Timeline.html">Timeline</a></li><li><a href="Wick.GUIElement-Wick.GUIElement.Breadcrumbs.html">Breadcrumbs</a></li><li><a href="Wick.GUIElement-Wick.GUIElement.Button.html">Button</a></li><li><a href="Wick.History.html">History</a></li><li><a href="Wick.HTMLExport.html">HTMLExport</a></li><li><a href="Wick.HTMLPreview.html">HTMLPreview</a></li><li><a href="Wick.ImageSequence.html">ImageSequence</a></li><li><a href="Wick.Layer.html">Layer</a></li><li><a href="Wick.Path.html">Path</a></li><li><a href="Wick.Project.html">Project</a></li><li><a href="Wick.Selection.html">Selection</a></li><li><a href="Wick.Tickable.html">Tickable</a></li><li><a href="Wick.Timeline.html">Timeline</a></li><li><a href="Wick.Tools-Wick.Tools.Brush.html">Brush</a></li><li><a href="Wick.Tools-Wick.Tools.Cursor.html">Cursor</a></li><li><a href="Wick.Tools-Wick.Tools.Ellipse.html">Ellipse</a></li><li><a href="Wick.Tools-Wick.Tools.Eraser.html">Eraser</a></li><li><a href="Wick.Tools-Wick.Tools.Eyedropper.html">Eyedropper</a></li><li><a href="Wick.Tools-Wick.Tools.FillBucket.html">FillBucket</a></li><li><a href="Wick.Tools-Wick.Tools.Interact.html">Interact</a></li><li><a href="Wick.Tools-Wick.Tools.Line.html">Line</a></li><li><a href="Wick.Tools-Wick.Tools.None.html">None</a></li><li><a href="Wick.Tools-Wick.Tools.Pan.html">Pan</a></li><li><a href="Wick.Tools-Wick.Tools.Pencil.html">Pencil</a></li><li><a href="Wick.Tools-Wick.Tools.Rectangle.html">Rectangle</a></li><li><a href="Wick.Tools-Wick.Tools.Text.html">Text</a></li><li><a href="Wick.Tools-Wick.Tools.Zoom.html">Zoom</a></li><li><a href="Wick.Transformation.html">Transformation</a></li><li><a href="Wick.Tween.html">Tween</a></li><li><a href="Wick.View-Wick.View.Clip.html">Clip</a></li><li><a href="Wick.View-Wick.View.Frame.html">Frame</a></li><li><a href="Wick.View-Wick.View.Path.html">Path</a></li><li><a href="Wick.View-Wick.View.Selection.html">Selection</a></li><li><a href="Wick.WickFile.html">WickFile</a></li><li><a href="Wick.WickObjectFile.html">WickObjectFile</a></li><li><a href="Wick.ZIPExport.html">ZIPExport</a></li><li><a href="WickObjectCache.html">WickObjectCache</a></li><li><a href="Wick-Wick.Asset.html">Asset</a></li><li><a href="Wick-Wick.AudioTrack.html">AudioTrack</a></li><li><a href="Wick-Wick.ClipAsset.html">ClipAsset</a></li><li><a href="Wick-Wick.Color.html">Color</a></li><li><a href="Wick-Wick.FileAsset.html">FileAsset</a></li><li><a href="Wick-Wick.FontAsset.html">FontAsset</a></li><li><a href="Wick-Wick.GIFAsset.html">GIFAsset</a></li><li><a href="Wick-Wick.GUIElement.html">GUIElement</a></li><li><a href="Wick-Wick.ImageAsset.html">ImageAsset</a></li><li><a href="Wick-Wick.SoundAsset.html">SoundAsset</a></li><li><a href="Wick-Wick.SVGAsset.html">SVGAsset</a></li><li><a href="Wick-Wick.Tool.html">Tool</a></li><li><a href="Wick-Wick.ToolSettings.html">ToolSettings</a></li><li><a href="Wick-Wick.View.html">View</a></li></ul><h3>Global</h3><ul><li><a href="global.html#type">type</a></li><li><a href="global.html#Wick">Wick</a></li></ul>
</nav>

<br class="clear">

<footer>
    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.4</a> on Fri Apr 24 2020 15:26:13 GMT-0400 (Eastern Daylight Time)
</footer>

<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>