Wick.Selection.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <title>JSDoc: Class: Selection</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: Selection</h1>

    
<section>

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

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

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

<div class="description">
    Create a Wick Selection.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Selection.js.html">base/Selection.js</a>, <a href="base_Selection.js.html#line35">line 35</a>
    </li></ul></dd>
    

</dl>


    </div>

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

        
<h4 class="name" id="allAttributeNames"><span class="type-signature"></span>allAttributeNames<span class="type-signature"> :Array.&lt;string></span></h4>


<div class="description">
    The names of all attributes of the selection that can be changed.
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Array.&lt;string></span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Selection.js.html">base/Selection.js</a>, <a href="base_Selection.js.html#line79">line 79</a>
    </li></ul></dd>
    

</dl>


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


<div class="description">
    The animation type of a clip.
</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_Selection.js.html">base/Selection.js</a>, <a href="base_Selection.js.html#line355">line 355</a>
    </li></ul></dd>
    

</dl>


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


<div class="description">
    The easing type of a selected tween. See Wick.Tween.VALID_EASING_TYPES.
</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_Selection.js.html">base/Selection.js</a>, <a href="base_Selection.js.html#line790">line 790</a>
    </li></ul></dd>
    

</dl>


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


<div class="description">
    The filename of the selected asset. Read only.
</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_Selection.js.html">base/Selection.js</a>, <a href="base_Selection.js.html#line814">line 814</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="fillColor"><span class="type-signature"></span>fillColor<span class="type-signature"> :paper.Color</span></h4>


<div class="description">
    The fill color of the selected object.
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">paper.Color</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Selection.js.html">base/Selection.js</a>, <a href="base_Selection.js.html#line642">line 642</a>
    </li></ul></dd>
    

</dl>


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


<div class="description">
    The font family of the selected object.
</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_Selection.js.html">base/Selection.js</a>, <a href="base_Selection.js.html#line678">line 678</a>
    </li></ul></dd>
    

</dl>


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


<div class="description">
    The font size of the selected object.
</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_Selection.js.html">base/Selection.js</a>, <a href="base_Selection.js.html#line690">line 690</a>
    </li></ul></dd>
    

</dl>


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


<div class="description">
    The font style of the selected object. ('italic' or 'oblique')
</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_Selection.js.html">base/Selection.js</a>, <a href="base_Selection.js.html#line714">line 714</a>
    </li></ul></dd>
    

</dl>


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


<div class="description">
    The font weight of the selected object.
</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_Selection.js.html">base/Selection.js</a>, <a href="base_Selection.js.html#line702">line 702</a>
    </li></ul></dd>
    

</dl>


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


<div class="description">
    The length of the selected frame.
</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_Selection.js.html">base/Selection.js</a>, <a href="base_Selection.js.html#line751">line 751</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="fullRotations"><span class="type-signature"></span>fullRotations<span class="type-signature"> :Number</span></h4>


<div class="description">
    The amount of rotations to perform during a tween. Positive value = clockwise rotation.
</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_Selection.js.html">base/Selection.js</a>, <a href="base_Selection.js.html#line802">line 802</a>
    </li></ul></dd>
    

</dl>


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


<div class="description">
    The height of the selection.
</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_Selection.js.html">base/Selection.js</a>, <a href="base_Selection.js.html#line479">line 479</a>
    </li></ul></dd>
    

</dl>


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


<div class="description">
    The identifier of the selected object.
</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_Selection.js.html">base/Selection.js</a>, <a href="base_Selection.js.html#line618">line 618</a>
    </li></ul></dd>
    

</dl>


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


<div class="description">
    True if the selection is scriptable. 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_Selection.js.html">base/Selection.js</a>, <a href="base_Selection.js.html#line822">line 822</a>
    </li></ul></dd>
    

</dl>


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


<div class="description">
    The location of the objects in the selection. (see LOCATION_NAMES)
</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_Selection.js.html">base/Selection.js</a>, <a href="base_Selection.js.html#line243">line 243</a>
    </li></ul></dd>
    

</dl>


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


<div class="description">
    The name of the selected object.
</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_Selection.js.html">base/Selection.js</a>, <a href="base_Selection.js.html#line630">line 630</a>
    </li></ul></dd>
    

</dl>


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


<div class="description">
    The number of objects in the selection.
</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_Selection.js.html">base/Selection.js</a>, <a href="base_Selection.js.html#line323">line 323</a>
    </li></ul></dd>
    

</dl>


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


<div class="description">
    The opacity of the selected object.
</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_Selection.js.html">base/Selection.js</a>, <a href="base_Selection.js.html#line726">line 726</a>
    </li></ul></dd>
    

</dl>


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


<div class="description">
    It is the original height of the selection at creation.
</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_Selection.js.html">base/Selection.js</a>, <a href="base_Selection.js.html#line517">line 517</a>
    </li></ul></dd>
    

</dl>


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


<div class="description">
    It is the original width of the selection at creation.
</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_Selection.js.html">base/Selection.js</a>, <a href="base_Selection.js.html#line505">line 505</a>
    </li></ul></dd>
    

</dl>


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


<div class="description">
    The origin position the selection.
</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_Selection.js.html">base/Selection.js</a>, <a href="base_Selection.js.html#line421">line 421</a>
    </li></ul></dd>
    

</dl>


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


<div class="description">
    The origin position the selection.
</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_Selection.js.html">base/Selection.js</a>, <a href="base_Selection.js.html#line443">line 443</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="pivotPoint"><span class="type-signature"></span>pivotPoint<span class="type-signature"> :object</span></h4>


<div class="description">
    The point that transformations to the selection will be based around.
</div>


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


        </li>
    </ul>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Selection.js.html">base/Selection.js</a>, <a href="base_Selection.js.html#line343">line 343</a>
    </li></ul></dd>
    

</dl>


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


<div class="description">
    The rotation of the selection.
</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_Selection.js.html">base/Selection.js</a>, <a href="base_Selection.js.html#line492">line 492</a>
    </li></ul></dd>
    

</dl>


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


<div class="description">
    The scale of the selection on the X axis.
</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_Selection.js.html">base/Selection.js</a>, <a href="base_Selection.js.html#line529">line 529</a>
    </li></ul></dd>
    

</dl>


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


<div class="description">
    The scale of the selection on the Y axis.
</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_Selection.js.html">base/Selection.js</a>, <a href="base_Selection.js.html#line552">line 552</a>
    </li></ul></dd>
    

</dl>


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


<div class="description">
    A single string describing the contents of the selection.
</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_Selection.js.html">base/Selection.js</a>, <a href="base_Selection.js.html#line264">line 264</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="singleFrameNumber"><span class="type-signature"></span>singleFrameNumber<span class="type-signature"></span></h4>


<div class="description">
    If a clip is set to singleFrame, this number will be used to determine that frame.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Selection.js.html">base/Selection.js</a>, <a href="base_Selection.js.html#line374">line 374</a>
    </li></ul></dd>
    

</dl>


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


<div class="description">
    The sound attached to the selected frame.
</div>


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


        </li>
    </ul>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Selection.js.html">base/Selection.js</a>, <a href="base_Selection.js.html#line739">line 739</a>
    </li></ul></dd>
    

</dl>


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


<div class="description">
    The starting position of the sound on the frame in ms.
</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_Selection.js.html">base/Selection.js</a>, <a href="base_Selection.js.html#line778">line 778</a>
    </li></ul></dd>
    

</dl>


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


<div class="description">
    The volume of the sound attached to the selected frame.
</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_Selection.js.html">base/Selection.js</a>, <a href="base_Selection.js.html#line766">line 766</a>
    </li></ul></dd>
    

</dl>


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


<div class="description">
    The source (dataURL) of the selected ImageAsset or SoundAsset. Read only.
</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_Selection.js.html">base/Selection.js</a>, <a href="base_Selection.js.html#line830">line 830</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="strokeColor"><span class="type-signature"></span>strokeColor<span class="type-signature"> :paper.Color</span></h4>


<div class="description">
    The stroke color of the selected object.
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">paper.Color</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Selection.js.html">base/Selection.js</a>, <a href="base_Selection.js.html#line654">line 654</a>
    </li></ul></dd>
    

</dl>


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


<div class="description">
    The stroke width of the selected object.
</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_Selection.js.html">base/Selection.js</a>, <a href="base_Selection.js.html#line666">line 666</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="types"><span class="type-signature"></span>types<span class="type-signature"> :Array.&lt;string></span></h4>


<div class="description">
    The types of the objects in the selection. (see SELECTABLE_OBJECT_TYPES)
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Array.&lt;string></span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Selection.js.html">base/Selection.js</a>, <a href="base_Selection.js.html#line252">line 252</a>
    </li></ul></dd>
    

</dl>


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


<div class="description">
    The rotation of the selection (used for canvas selections)
</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_Selection.js.html">base/Selection.js</a>, <a href="base_Selection.js.html#line331">line 331</a>
    </li></ul></dd>
    

</dl>


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


<div class="description">
    The width of the selection.
</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_Selection.js.html">base/Selection.js</a>, <a href="base_Selection.js.html#line466">line 466</a>
    </li></ul></dd>
    

</dl>


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


<div class="description">
    The position of the selection.
</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_Selection.js.html">base/Selection.js</a>, <a href="base_Selection.js.html#line395">line 395</a>
    </li></ul></dd>
    

</dl>


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


<div class="description">
    The position of the selection.
</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_Selection.js.html">base/Selection.js</a>, <a href="base_Selection.js.html#line408">line 408</a>
    </li></ul></dd>
    

</dl>


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

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

<div class="description">
    Brings the selected objects to the front.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Selection.js.html">base/Selection.js</a>, <a href="base_Selection.js.html#line596">line 596</a>
    </li></ul></dd>
    

</dl>


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

<div class="description">
    Remove all objects from the selection with an optional filter.
</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>filter</code></td>
            

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


            </td>

            
            <td class="description last">A location or a type (see SELECTABLE_OBJECT_TYPES and LOCATION_NAMES)</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Selection.js.html">base/Selection.js</a>, <a href="base_Selection.js.html#line175">line 175</a>
    </li></ul></dd>
    

</dl>


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

<div class="description">
    Remove a wick object from the selection.
</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>object</code></td>
            

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


            </td>

            
            <td class="description last">The object to deselect.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Selection.js.html">base/Selection.js</a>, <a href="base_Selection.js.html#line160">line 160</a>
    </li></ul></dd>
    

</dl>


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

<div class="description">
    Flips the selected obejcts horizontally.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Selection.js.html">base/Selection.js</a>, <a href="base_Selection.js.html#line573">line 573</a>
    </li></ul></dd>
    

</dl>


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

<div class="description">
    Flips the selected obejcts vertically.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Selection.js.html">base/Selection.js</a>, <a href="base_Selection.js.html#line581">line 581</a>
    </li></ul></dd>
    

</dl>


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

<div class="description">
    Get a list of only the farthest left frames on each layer.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Selection.js.html">base/Selection.js</a>, <a href="base_Selection.js.html#line861">line 861</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<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="getRightmostFrames"><span class="type-signature"></span>getRightmostFrames<span class="signature">()</span><span class="type-signature"> &rarr; {Array.&lt;<a href="Wick.Frame.html">Wick.Frame</a>>}</span></h4>
    

<div class="description">
    Get a list of only the farthest right frames on each layer.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Selection.js.html">base/Selection.js</a>, <a href="base_Selection.js.html#line838">line 838</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<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="getSelectedObject"><span class="type-signature"></span>getSelectedObject<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="Wick.Base.html">Wick.Base</a>}</span></h4>
    

<div class="description">
    Get the first object in the selection if there is a single object in the selection.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Selection.js.html">base/Selection.js</a>, <a href="base_Selection.js.html#line193">line 193</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    The first object in the selection.
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="Wick.Base.html">Wick.Base</a></span>


    </dd>
</dl>

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

<div class="description">
    Get the objects in the selection with an optional filter.
</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>filter</code></td>
            

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


            </td>

            
            <td class="description last">A location or a type (see SELECTABLE_OBJECT_TYPES and LOCATION_NAMES)</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Selection.js.html">base/Selection.js</a>, <a href="base_Selection.js.html#line206">line 206</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    The selected objects.
</div>


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


    </dd>
</dl>

    
    <h4 class="name" id="getSelectedObjectUUIDs"><span class="type-signature"></span>getSelectedObjectUUIDs<span class="signature">(filter)</span><span class="type-signature"> &rarr; {Array.&lt;string>}</span></h4>
    

<div class="description">
    Get the UUIDs of the objects in the selection with an optional filter.
</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>filter</code></td>
            

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


            </td>

            
            <td class="description last">A location or a type (see SELECTABLE_OBJECT_TYPES and LOCATION_NAMES)</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Selection.js.html">base/Selection.js</a>, <a href="base_Selection.js.html#line233">line 233</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    The UUIDs of the selected objects.
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Array.&lt;string></span>


    </dd>
</dl>

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

<div class="description">
    Checks if a given object is selected.
</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>object</code></td>
            

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


            </td>

            
            <td class="description last">The object to check selection of.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Selection.js.html">base/Selection.js</a>, <a href="base_Selection.js.html#line185">line 185</a>
    </li></ul></dd>
    

</dl>


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

<div class="description">
    Moves the selected objects backwards.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Selection.js.html">base/Selection.js</a>, <a href="base_Selection.js.html#line610">line 610</a>
    </li></ul></dd>
    

</dl>


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

<div class="description">
    Moves the selected objects forwards.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Selection.js.html">base/Selection.js</a>, <a href="base_Selection.js.html#line603">line 603</a>
    </li></ul></dd>
    

</dl>


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

<div class="description">
    Add a wick object to the selection.
</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>object</code></td>
            

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


            </td>

            
            <td class="description last">The object to select.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Selection.js.html">base/Selection.js</a>, <a href="base_Selection.js.html#line117">line 117</a>
    </li></ul></dd>
    

</dl>


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

<div class="description">
    Sends the selected objects to the back.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="base_Selection.js.html">base/Selection.js</a>, <a href="base_Selection.js.html#line589">line 589</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>