rune.camera.CameraViewport.html

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

    
<section>

<header>
    
        <h2><span class="attribs"><span class="type-signature"></span></span>
            <span class="ancestors"><a href="rune.html">rune</a><a href="rune.camera.html">.camera</a>.</span>CameraViewport<span class="signature">(camera)</span><span class="type-signature"></span></h2>
        
            <div class="class-description">The CameraViewport class represents a camera's viewport in the form of a 
rectangle. DisplayObject located inside the viewport is rendered to the 
camera's pixel buffer.</div>
        
    
</header>

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

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

<div class="description">
    Creates a CameraViewport object.
</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>camera</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="rune.camera.Camera.html">rune.camera.Camera</a></span>


            </td>

            
            <td class="description last">Reference to the camera object to which the viewport is connected.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="camera_CameraViewport.js.html">camera/CameraViewport.js</a>, <a href="camera_CameraViewport.js.html#line20">line 20</a>
    </li></ul></dd>
    

</dl>


    </div>

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

        
    <ul>
        <li><a href="rune.geom.Rectangle.html">rune.geom.Rectangle</a></li>
    </ul>


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

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


<div class="description">
    The sum of the y and height properties.
</div>


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


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="rune.geom.Rectangle.html#bottom">rune.geom.Rectangle#bottom</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="geom_Rectangle.js.html">geom/Rectangle.js</a>, <a href="geom_Rectangle.js.html#line195">line 195</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="bottomLeft"><span class="type-signature"></span>bottomLeft<span class="type-signature"> :<a href="rune.geom.Rectangle.html">rune.geom.Rectangle</a></span></h4>


<div class="description">
    The location of the Rectangle object's bottom-left corner, determined by the
values of the left and bottom properties.
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type"><a href="rune.geom.Rectangle.html">rune.geom.Rectangle</a></span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="rune.geom.Rectangle.html#bottomLeft">rune.geom.Rectangle#bottomLeft</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="geom_Rectangle.js.html">geom/Rectangle.js</a>, <a href="geom_Rectangle.js.html#line220">line 220</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="bottomRight"><span class="type-signature"></span>bottomRight<span class="type-signature"> :<a href="rune.geom.Rectangle.html">rune.geom.Rectangle</a></span></h4>


<div class="description">
    The location of the Rectangle object's bottom-right corner, determined by the
values of the right and bottom properties.
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type"><a href="rune.geom.Rectangle.html">rune.geom.Rectangle</a></span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="rune.geom.Rectangle.html#bottomRight">rune.geom.Rectangle#bottomRight</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="geom_Rectangle.js.html">geom/Rectangle.js</a>, <a href="geom_Rectangle.js.html#line247">line 247</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="center"><span class="type-signature"></span>center<span class="type-signature"> :<a href="rune.geom.Point.html">rune.geom.Point</a></span></h4>


<div class="description">
    The center point of the rectangle object.
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type"><a href="rune.geom.Point.html">rune.geom.Point</a></span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="rune.geom.Rectangle.html#center">rune.geom.Rectangle#center</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="geom_Rectangle.js.html">geom/Rectangle.js</a>, <a href="geom_Rectangle.js.html#line274">line 274</a>
    </li></ul></dd>
    

</dl>


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


<div class="description">
    The x coordinate of the center of the object.
</div>


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


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="rune.geom.Rectangle.html#centerX">rune.geom.Rectangle#centerX</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="geom_Rectangle.js.html">geom/Rectangle.js</a>, <a href="geom_Rectangle.js.html#line300">line 300</a>
    </li></ul></dd>
    

</dl>


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


<div class="description">
    The y coordinate of the center of the object.
</div>


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


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="rune.geom.Rectangle.html#centerY">rune.geom.Rectangle#centerY</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="geom_Rectangle.js.html">geom/Rectangle.js</a>, <a href="geom_Rectangle.js.html#line325">line 325</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 rectangle, in pixels.
</div>


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


        </li>
    </ul>


<dl class="details">

    
    <dt class="tag-overrides">Overrides:</dt>
    <dd class="tag-overrides"><ul class="dummy"><li>
        <a href="rune.geom.Rectangle.html#height">rune.geom.Rectangle#height</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="geom_Rectangle.js.html">geom/Rectangle.js</a>, <a href="geom_Rectangle.js.html#line350">line 350</a>
    </li></ul></dd>
    

</dl>


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


<div class="description">
    The x coordinate of the top-left corner of the rectangle.
</div>


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


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="rune.geom.Rectangle.html#left">rune.geom.Rectangle#left</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="geom_Rectangle.js.html">geom/Rectangle.js</a>, <a href="geom_Rectangle.js.html#line375">line 375</a>
    </li></ul></dd>
    

</dl>


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


<div class="description">
    The sum of the x and width properties.
</div>


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


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="rune.geom.Rectangle.html#right">rune.geom.Rectangle#right</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="geom_Rectangle.js.html">geom/Rectangle.js</a>, <a href="geom_Rectangle.js.html#line400">line 400</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="size"><span class="type-signature"></span>size<span class="type-signature"> :<a href="rune.geom.Point.html">rune.geom.Point</a></span></h4>


<div class="description">
    The size of the Rectangle object, expressed as a Point object with the values
of the width and height properties.
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type"><a href="rune.geom.Point.html">rune.geom.Point</a></span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="rune.geom.Rectangle.html#size">rune.geom.Rectangle#size</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="geom_Rectangle.js.html">geom/Rectangle.js</a>, <a href="geom_Rectangle.js.html#line425">line 425</a>
    </li></ul></dd>
    

</dl>


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


<div class="description">
    The y coordinate of the top-left corner of the rectangle.
</div>


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


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="rune.geom.Rectangle.html#top">rune.geom.Rectangle#top</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="geom_Rectangle.js.html">geom/Rectangle.js</a>, <a href="geom_Rectangle.js.html#line455">line 455</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="topLeft"><span class="type-signature"></span>topLeft<span class="type-signature"> :<a href="rune.geom.Point.html">rune.geom.Point</a></span></h4>


<div class="description">
    The location of the Rectangle object's top-left corner, determined by the x 
and y coordinates of the point.
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type"><a href="rune.geom.Point.html">rune.geom.Point</a></span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="rune.geom.Rectangle.html#topLeft">rune.geom.Rectangle#topLeft</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="geom_Rectangle.js.html">geom/Rectangle.js</a>, <a href="geom_Rectangle.js.html#line480">line 480</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="topRight"><span class="type-signature"></span>topRight<span class="type-signature"> :<a href="rune.geom.Point.html">rune.geom.Point</a></span></h4>


<div class="description">
    The location of the Rectangle object's top-right corner, determined by the x 
and y coordinates of the point.
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type"><a href="rune.geom.Point.html">rune.geom.Point</a></span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="rune.geom.Rectangle.html#topRight">rune.geom.Rectangle#topRight</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="geom_Rectangle.js.html">geom/Rectangle.js</a>, <a href="geom_Rectangle.js.html#line507">line 507</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 rectangle, in pixels.
</div>


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


        </li>
    </ul>


<dl class="details">

    
    <dt class="tag-overrides">Overrides:</dt>
    <dd class="tag-overrides"><ul class="dummy"><li>
        <a href="rune.geom.Rectangle.html#width">rune.geom.Rectangle#width</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="geom_Rectangle.js.html">geom/Rectangle.js</a>, <a href="geom_Rectangle.js.html#line534">line 534</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 horizontal coordinate of the point. The default value is 0.
</div>


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


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="rune.geom.Point.html#x">rune.geom.Point#x</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="geom_Point.js.html">geom/Point.js</a>, <a href="geom_Point.js.html#line91">line 91</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 vertical coordinate of the point. The default value is 0.
</div>


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


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="rune.geom.Point.html#y">rune.geom.Point#y</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="geom_Point.js.html">geom/Point.js</a>, <a href="geom_Point.js.html#line116">line 116</a>
    </li></ul></dd>
    

</dl>


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


<div class="description">
    Current zoom value, where 1.0 is the default, ie. rendered on a 100% 
scale. The value can vary between 0.25 (min) and 4.0 (max).
</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="camera_CameraViewport.js.html">camera/CameraViewport.js</a>, <a href="camera_CameraViewport.js.html#line118">line 118</a>
    </li></ul></dd>
    

</dl>


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

        
    <h4 class="name" id="containsPoint"><span class="type-signature"></span>containsPoint<span class="signature">(point)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
    

<div class="description">
    Determines whether the specified point is contained within the rectangular 
region defined by this Rectangle object.
</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>point</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="rune.geom.Point.html">rune.geom.Point</a></span>


            </td>

            
            <td class="description last">The point, as represented by its x and y coordinates.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="rune.geom.Rectangle.html#containsPoint">rune.geom.Rectangle#containsPoint</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="geom_Rectangle.js.html">geom/Rectangle.js</a>, <a href="geom_Rectangle.js.html#line585">line 585</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    A value of true if the Rectangle object contains the specified point; otherwise false.
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">boolean</span>


    </dd>
</dl>

    
    <h4 class="name" id="containsRectangle"><span class="type-signature"></span>containsRectangle<span class="signature">(rect)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
    

<div class="description">
    Determines whether the Rectangle object specified by the rect parameter is 
contained within this Rectangle object. A Rectangle object is said to contain
another if the second Rectangle object falls entirely within the boundaries 
of the first.
</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>rect</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="rune.geom.Rectangle.html">rune.geom.Rectangle</a></span>


            </td>

            
            <td class="description last">The Rectangle object being checked.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="rune.geom.Rectangle.html#containsRectangle">rune.geom.Rectangle#containsRectangle</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="geom_Rectangle.js.html">geom/Rectangle.js</a>, <a href="geom_Rectangle.js.html#line606">line 606</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    A value of true if the Rectangle object that you specify is contained by this Rectangle object; otherwise false.
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">boolean</span>


    </dd>
</dl>

    
    <h4 class="name" id="distance"><span class="type-signature"></span>distance<span class="signature">(point)</span><span class="type-signature"> &rarr; {number}</span></h4>
    

<div class="description">
    Returns the distance between the current and specified point.
</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>point</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="rune.geom.Point.html">rune.geom.Point</a></span>


            </td>

            
            <td class="description last">The specified point.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="rune.geom.Point.html#distance">rune.geom.Point#distance</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="geom_Point.js.html">geom/Point.js</a>, <a href="geom_Point.js.html#line152">line 152</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">number</span>


    </dd>
</dl>

    
    <h4 class="name" id="interpolate"><span class="type-signature"></span>interpolate<span class="signature">(point, fraction<span class="signature-attributes">opt</span>, output<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {<a href="rune.geom.Point.html">rune.geom.Point</a>}</span></h4>
    

<div class="description">
    Determines a point between two specified points. The parameter fraction 
determines where the new interpolated point is located relative to the two 
end points.
</div>


    <h5>Parameters:</h5>
    

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

        <th>Type</th>

        
        <th>Attributes</th>
        

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

    <tbody>
    

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

            <td class="type">
            
                
<span class="param-type"><a href="rune.geom.Point.html">rune.geom.Point</a></span>


            </td>

            
                <td class="attributes">
                

                </td>
            

            <td class="description last">The second point.</td>
        </tr>

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

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


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last">The level of interpolation between the two points.</td>
        </tr>

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

            <td class="type">
            
                
<span class="param-type"><a href="rune.geom.Point.html">rune.geom.Point</a></span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last">Save results to this object.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="rune.geom.Point.html#interpolate">rune.geom.Point#interpolate</a>
    </li></ul></dd>
    

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

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    The new, interpolated point.
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="rune.geom.Point.html">rune.geom.Point</a></span>


    </dd>
</dl>

    
    <h4 class="name" id="intersection"><span class="type-signature"></span>intersection<span class="signature">(toIntersect, output<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {<a href="rune.geom.Rectangle.html">rune.geom.Rectangle</a>}</span></h4>
    

<div class="description">
    If the Rectangle object specified in the toIntersect parameter intersects 
with this Rectangle object, returns the area of intersection as a Rectangle 
object. If the rectangles do not intersect, this method returns an empty 
Rectangle object with its properties set to 0.
</div>


    <h5>Parameters:</h5>
    

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

        <th>Type</th>

        
        <th>Attributes</th>
        

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

    <tbody>
    

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

            <td class="type">
            
                
<span class="param-type"><a href="rune.geom.Rectangle.html">rune.geom.Rectangle</a></span>


            </td>

            
                <td class="attributes">
                

                </td>
            

            <td class="description last">The Rectangle object to compare against to see if it intersects with this Rectangle object.</td>
        </tr>

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

            <td class="type">
            
                
<span class="param-type"><a href="rune.geom.Rectangle.html">rune.geom.Rectangle</a></span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last">A Rectangle object to store the intersection results in.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="rune.geom.Rectangle.html#intersection">rune.geom.Rectangle#intersection</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="geom_Rectangle.js.html">geom/Rectangle.js</a>, <a href="geom_Rectangle.js.html#line630">line 630</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    A Rectangle object that equals the area of intersection.
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="rune.geom.Rectangle.html">rune.geom.Rectangle</a></span>


    </dd>
</dl>

    
    <h4 class="name" id="intersects"><span class="type-signature"></span>intersects<span class="signature">(toIntersect)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
    

<div class="description">
    Determines whether the object specified in the toIntersect parameter 
intersects with this Rectangle object.
</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>toIntersect</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="rune.geom.Rectangle.html">rune.geom.Rectangle</a></span>


            </td>

            
            <td class="description last">The Rectangle object to compare against this Rectangle object.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="rune.geom.Rectangle.html#intersects">rune.geom.Rectangle#intersects</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="geom_Rectangle.js.html">geom/Rectangle.js</a>, <a href="geom_Rectangle.js.html#line652">line 652</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    A value of true if the specified object intersects with this Rectangle object; otherwise false.
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">boolean</span>


    </dd>
</dl>

    
    <h4 class="name" id="toString"><span class="type-signature"></span>toString<span class="signature">()</span><span class="type-signature"> &rarr; {string}</span></h4>
    

<div class="description">
    Returns a string representation of the hitbox. Useful for troubleshooting.
</div>


<dl class="details">

    
    <dt class="tag-overrides">Overrides:</dt>
    <dd class="tag-overrides"><ul class="dummy"><li>
        <a href="rune.geom.Rectangle.html#toString">rune.geom.Rectangle#toString</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="display_Hitbox.js.html">display/Hitbox.js</a>, <a href="display_Hitbox.js.html#line433">line 433</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">string</span>


    </dd>
</dl>

    
</article>

</section>


</div>

<nav>
    <h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="rune.html">rune</a></li><li><a href="rune.animation.html">animation</a></li><li><a href="rune.camera.html">camera</a></li><li><a href="rune.color.html">color</a></li><li><a href="rune.console.html">console</a></li><li><a href="rune.data.html">data</a></li><li><a href="rune.debug.html">debug</a></li><li><a href="rune.display.html">display</a></li><li><a href="rune.geom.html">geom</a></li><li><a href="rune.input.html">input</a></li><li><a href="rune.media.html">media</a></li><li><a href="rune.net.html">net</a></li><li><a href="rune.particle.html">particle</a></li><li><a href="rune.physics.html">physics</a></li><li><a href="rune.resource.html">resource</a></li><li><a href="rune.scene.html">scene</a></li><li><a href="rune.state.html">state</a></li><li><a href="rune.system.html">system</a></li><li><a href="rune.text.html">text</a></li><li><a href="rune.tilemap.html">tilemap</a></li><li><a href="rune.timer.html">timer</a></li><li><a href="rune.tween.html">tween</a></li><li><a href="rune.ui.html">ui</a></li><li><a href="rune.util.html">util</a></li></ul><h3>Classes</h3><ul><li><a href="rune.animation.Animation.html">Animation</a></li><li><a href="rune.animation.Animations.html">Animations</a></li><li><a href="rune.animation.AnimationScripts.html">AnimationScripts</a></li><li><a href="rune.camera.Camera.html">Camera</a></li><li><a href="rune.camera.CameraFade.html">CameraFade</a></li><li><a href="rune.camera.CameraFlash.html">CameraFlash</a></li><li><a href="rune.camera.Cameras.html">Cameras</a></li><li><a href="rune.camera.CameraShake.html">CameraShake</a></li><li><a href="rune.camera.CameraTargets.html">CameraTargets</a></li><li><a href="rune.camera.CameraTint.html">CameraTint</a></li><li><a href="rune.camera.CameraTintTween.html">CameraTintTween</a></li><li><a href="rune.camera.CameraViewport.html">CameraViewport</a></li><li><a href="rune.color.Color24.html">Color24</a></li><li><a href="rune.color.Color32.html">Color32</a></li><li><a href="rune.color.ColorComponent.html">ColorComponent</a></li><li><a href="rune.console.Console.html">Console</a></li><li><a href="rune.console.ConsoleCommand.html">ConsoleCommand</a></li><li><a href="rune.console.ConsoleCommands.html">ConsoleCommands</a></li><li><a href="rune.console.ConsoleCursor.html">ConsoleCursor</a></li><li><a href="rune.console.ConsoleHistory.html">ConsoleHistory</a></li><li><a href="rune.console.ConsoleInput.html">ConsoleInput</a></li><li><a href="rune.console.ConsoleManager.html">ConsoleManager</a></li><li><a href="rune.console.ConsoleOutput.html">ConsoleOutput</a></li><li><a href="rune.data.Highscores.html">Highscores</a></li><li><a href="rune.data.Loader.html">Loader</a></li><li><a href="rune.data.LoaderDebug.html">LoaderDebug</a></li><li><a href="rune.data.Logo.html">Logo</a></li><li><a href="rune.data.Requests.html">Requests</a></li><li><a href="rune.debug.Debugger.html">Debugger</a></li><li><a href="rune.debug.Framerate.html">Framerate</a></li><li><a href="rune.debug.Histogram.html">Histogram</a></li><li><a href="rune.debug.Master.html">Master</a></li><li><a href="rune.debug.Memory.html">Memory</a></li><li><a href="rune.debug.Music.html">Music</a></li><li><a href="rune.debug.Render.html">Render</a></li><li><a href="rune.debug.Sound.html">Sound</a></li><li><a href="rune.debug.Update.html">Update</a></li><li><a href="rune.display.Artboard.html">Artboard</a></li><li><a href="rune.display.Canvas.html">Canvas</a></li><li><a href="rune.display.DisplayGroup.html">DisplayGroup</a></li><li><a href="rune.display.DisplayGroups.html">DisplayGroups</a></li><li><a href="rune.display.DisplayObject.html">DisplayObject</a></li><li><a href="rune.display.DisplayObjectContainer.html">DisplayObjectContainer</a></li><li><a href="rune.display.Flicker.html">Flicker</a></li><li><a href="rune.display.Frame.html">Frame</a></li><li><a href="rune.display.Graphic.html">Graphic</a></li><li><a href="rune.display.Graphics.html">Graphics</a></li><li><a href="rune.display.Hitbox.html">Hitbox</a></li><li><a href="rune.display.InteractiveObject.html">InteractiveObject</a></li><li><a href="rune.display.Quadtree.html">Quadtree</a></li><li><a href="rune.display.RepeatedGraphic.html">RepeatedGraphic</a></li><li><a href="rune.display.Screen.html">Screen</a></li><li><a href="rune.display.Sprite.html">Sprite</a></li><li><a href="rune.display.Stage.html">Stage</a></li><li><a href="rune.display.Texture.html">Texture</a></li><li><a href="rune.geom.Point.html">Point</a></li><li><a href="rune.geom.Rectangle.html">Rectangle</a></li><li><a href="rune.geom.Vector2D.html">Vector2D</a></li><li><a href="rune.input.Gamepad.html">Gamepad</a></li><li><a href="rune.input.Gamepads.html">Gamepads</a></li><li><a href="rune.input.GamepadsOptions.html">GamepadsOptions</a></li><li><a href="rune.input.Inputs.html">Inputs</a></li><li><a href="rune.input.Keyboard.html">Keyboard</a></li><li><a href="rune.input.KeyboardKey.html">KeyboardKey</a></li><li><a href="rune.input.KeyboardOptions.html">KeyboardOptions</a></li><li><a href="rune.media.Sound.html">Sound</a></li><li><a href="rune.media.SoundChannel.html">SoundChannel</a></li><li><a href="rune.media.Sounds.html">Sounds</a></li><li><a href="rune.net.URLLoader.html">URLLoader</a></li><li><a href="rune.net.URLRequest.html">URLRequest</a></li><li><a href="rune.net.URLResponse.html">URLResponse</a></li><li><a href="rune.particle.Emitter.html">Emitter</a></li><li><a href="rune.particle.EmitterOptions.html">EmitterOptions</a></li><li><a href="rune.particle.Particle.html">Particle</a></li><li><a href="rune.physics.Space.html">Space</a></li><li><a href="rune.physics.Velocity.html">Velocity</a></li><li><a href="rune.resource.Request.html">Request</a></li><li><a href="rune.resource.Requester.html">Requester</a></li><li><a href="rune.resource.RequesterOptions.html">RequesterOptions</a></li><li><a href="rune.resource.Requests.html">Requests</a></li><li><a href="rune.resource.Resource.html">Resource</a></li><li><a href="rune.resource.Resources.html">Resources</a></li><li><a href="rune.scene.Scene.html">Scene</a></li><li><a href="rune.scene.Scenes.html">Scenes</a></li><li><a href="rune.state.State.html">State</a></li><li><a href="rune.state.States.html">States</a></li><li><a href="rune.system.Application.html">Application</a></li><li><a href="rune.system.Config.html">Config</a></li><li><a href="rune.system.Time.html">Time</a></li><li><a href="rune.text.BitmapField.html">BitmapField</a></li><li><a href="rune.text.BitmapFormat.html">BitmapFormat</a></li><li><a href="rune.tilemap.Block.html">Block</a></li><li><a href="rune.tilemap.Tile.html">Tile</a></li><li><a href="rune.tilemap.Tilemap.html">Tilemap</a></li><li><a href="rune.tilemap.TilemapLayer.html">TilemapLayer</a></li><li><a href="rune.timer.Timer.html">Timer</a></li><li><a href="rune.timer.TimerOptions.html">TimerOptions</a></li><li><a href="rune.timer.Timers.html">Timers</a></li><li><a href="rune.tween.Circular.html">Circular</a></li><li><a href="rune.tween.Cubic.html">Cubic</a></li><li><a href="rune.tween.Expo.html">Expo</a></li><li><a href="rune.tween.Linear.html">Linear</a></li><li><a href="rune.tween.Quad.html">Quad</a></li><li><a href="rune.tween.Quart.html">Quart</a></li><li><a href="rune.tween.Quint.html">Quint</a></li><li><a href="rune.tween.Sine.html">Sine</a></li><li><a href="rune.tween.Tween.html">Tween</a></li><li><a href="rune.tween.Tweens.html">Tweens</a></li><li><a href="rune.tween.TweenValue.html">TweenValue</a></li><li><a href="rune.ui.Counter.html">Counter</a></li><li><a href="rune.ui.CounterDigit.html">CounterDigit</a></li><li><a href="rune.ui.Progressbar.html">Progressbar</a></li><li><a href="rune.ui.VTList.html">VTList</a></li><li><a href="rune.ui.VTListElement.html">VTListElement</a></li><li><a href="rune.ui.VTMenu.html">VTMenu</a></li><li><a href="rune.ui.VTMenuPointer.html">VTMenuPointer</a></li><li><a href="rune.util.Executable.html">Executable</a></li><li><a href="rune.util.Filter.html">Filter</a></li><li><a href="rune.util.Math.html">Math</a></li><li><a href="rune.util.Palette.html">Palette</a></li><li><a href="rune.util.Path.html">Path</a></li><li><a href="rune.util.Paths.html">Paths</a></li><li><a href="rune.util.Stack.html">Stack</a></li><li><a href="rune.util.URL.html">URL</a></li></ul>
</nav>

<br class="clear">

<footer>
    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Tue Apr 01 2025 09:55:09 GMT+0200 (Central European Summer Time)
</footer>

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