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

    




<section>

<header>
    
        <h2><span class="attribs"><span class="type-signature"></span></span>TextureSlides<span class="signature">(textureIn)</span><span class="type-signature"> &rarr; {<a href="TextureSlides.html">TextureSlides</a>}</span></h2>
        
    
</header>

<article>
    <div class="container-overview">
    
        

    

    
    <h4 class="name" id="TextureSlides"><span class="type-signature"></span>new TextureSlides<span class="signature">(textureIn)</span><span class="type-signature"> &rarr; {<a href="TextureSlides.html">TextureSlides</a>}</span></h4>
    

    



<div class="description">
    Provides a class which create a texture stacks in a block
with shaders allowing slices of texture to be displayed.
</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>textureIn</code></td>
            

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


            
            </td>

            

            

            <td class="description last">An object of texture array
holding texture information.</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    
    <dt class="tag-author">Author:</dt>
    <dd class="tag-author">
        <ul>
            <li>Alan Wu</li>
        </ul>
    </dd>
    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="primitives_textureSlides.js.html">primitives/textureSlides.js</a>, <a href="primitives_textureSlides.js.html#line14">line 14</a>
    </li></ul></dd>
    

    

    

    
</dl>















<h5>Returns:</h5>

        


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


    </dd>
</dl>

    





    
    </div>

    

    

    

    

    

    

    

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

        
            

    

    
    <h4 class="name" id="createSlide"><span class="type-signature"></span>createSlide<span class="signature">(settings)</span><span class="type-signature"> &rarr; {<a href="global.html#SLIDE_SETTINGS">SLIDE_SETTINGS</a>}</span></h4>
    

    



<div class="description">
    Create a slide required for visualisation based on the slide settings.
The slide itself is an {THREE.PlanGeometry} 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>settings</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="global.html#SLIDE_SETTINGS">SLIDE_SETTINGS</a></span>


            
            </td>

            

            

            <td class="description last">settings of the slide to be created.</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="primitives_textureSlides.js.html">primitives/textureSlides.js</a>, <a href="primitives_textureSlides.js.html#line107">line 107</a>
    </li></ul></dd>
    

    

    

    
</dl>















<h5>Returns:</h5>

        
<div class="param-desc">
    - Returned settings, it includes the newly
created mesh's id.
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="global.html#SLIDE_SETTINGS">SLIDE_SETTINGS</a></span>


    </dd>
</dl>

    





        
            

    

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

    



<div class="description">
    Create the slides required for visualisation based on the slide settings.
The slides themselves are {THREE.PlanGeometry} objects.
</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>slideSettings</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="global.html#SLIDE_SETTINGS">SLIDE_SETTINGS</a></span>


            
            </td>

            

            

            <td class="description last">An array to each slide settings.</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="primitives_textureSlides.js.html">primitives/textureSlides.js</a>, <a href="primitives_textureSlides.js.html#line40">line 40</a>
    </li></ul></dd>
    

    

    

    
</dl>




















        
            

    

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

    



<div class="description">
    Clean up all internal objects.
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="primitives_textureSlides.js.html">primitives/textureSlides.js</a>, <a href="primitives_textureSlides.js.html#line215">line 215</a>
    </li></ul></dd>
    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="getBoundingBox"><span class="type-signature"></span>getBoundingBox<span class="signature">()</span><span class="type-signature"> &rarr; {THREE.Box3}</span></h4>
    

    



<div class="description">
    Get the bounding box of this slides.
It uses the max and min of the slides position and the
transformation to calculate the position of the box.
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="primitives_textureSlides.js.html">primitives/textureSlides.js</a>, <a href="primitives_textureSlides.js.html#line262">line 262</a>
    </li></ul></dd>
    

    

    

    
</dl>















<h5>Returns:</h5>

        
<div class="param-desc">
    .
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">THREE.Box3</span>


    </dd>
</dl>

    





        
            

    

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

    



<div class="description">
    Get  the array of slides, return them in an array
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

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

    

    

    
</dl>















<h5>Returns:</h5>

        
<div class="param-desc">
    - Return an array of </div> <dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Array</span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="getTextureSettings"><span class="type-signature"></span>getTextureSettings<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="global.html#SLIDE_SETTINGS">SLIDE_SETTINGS</a></span></h4>
    

    



<div class="description">
    Return a copy of texture settings used by this object.
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

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

    

    

    
</dl>















<h5>Returns:</h5>

        
<div class="param-desc">
    - Returned the list of settings.
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="global.html#SLIDE_SETTINGS">SLIDE_SETTINGS</a></span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="getTextureSettingsWithId"><span class="type-signature"></span>getTextureSettingsWithId<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="global.html#SLIDE_SETTINGS">SLIDE_SETTINGS</a>}</span></h4>
    

    



<div class="description">
    Return a copy of texture settings with corresponding id used by this object.
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="primitives_textureSlides.js.html">primitives/textureSlides.js</a>, <a href="primitives_textureSlides.js.html#line159">line 159</a>
    </li></ul></dd>
    

    

    

    
</dl>















<h5>Returns:</h5>

        
<div class="param-desc">
    - Returned a copy of settings with corresponding id.
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="global.html#SLIDE_SETTINGS">SLIDE_SETTINGS</a></span>


    </dd>
</dl>

    





        
            

    

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

    



<div class="description">
    Modify the mesh based on a setting
</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>settings</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="global.html#SLIDE_SETTINGS">SLIDE_SETTINGS</a></span>


            
            </td>

            

            

            <td class="description last">s.</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="primitives_textureSlides.js.html">primitives/textureSlides.js</a>, <a href="primitives_textureSlides.js.html#line91">line 91</a>
    </li></ul></dd>
    

    

    

    
</dl>




















        
            

    

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

    



<div class="description">
    Remove a slide, this will dispose the slide and its material.
</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>slide</code></td>
            

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


            
            </td>

            

            

            <td class="description last">Slide to be remvoed</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="primitives_textureSlides.js.html">primitives/textureSlides.js</a>, <a href="primitives_textureSlides.js.html#line182">line 182</a>
    </li></ul></dd>
    

    

    

    
</dl>




















        
            

    

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

    



<div class="description">
    Remove a slide, this will dispose the slide and its material.
</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>id</code></td>
            

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


            
            </td>

            

            

            <td class="description last">id of slide to be remvoed</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

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

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="~setUniformSlideSettingsOfMesh"><span class="type-signature">(inner) </span>setUniformSlideSettingsOfMesh<span class="signature">(mesh, slideSettings)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    Set the value of the uniforms for a specific mesh in this
texture slide 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>mesh</code></td>
            

            <td class="type">
            
                
<span class="param-type">THREE.Mesh</span>


            
            </td>

            

            

            <td class="description last">Mesh to be modified</td>
        </tr>

    

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

            <td class="type">
            
                
<span class="param-type"><a href="global.html#SLIDE_SETTINGS">SLIDE_SETTINGS</a></span>


            
            </td>

            

            

            <td class="description last">Slide settings.</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="primitives_textureSlides.js.html">primitives/textureSlides.js</a>, <a href="primitives_textureSlides.js.html#line51">line 51</a>
    </li></ul></dd>
    

    

    

    
</dl>




















        
    

    

    
</article>

</section>




</div>

<nav>
    <h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="Zinc.html">Zinc</a></li></ul><h3>Classes</h3><ul><li><a href="CameraControls.html">CameraControls</a></li><li><a href="Geometry.html">Geometry</a></li><li><a href="Glyph.html">Glyph</a></li><li><a href="Glyphset.html">Glyphset</a></li><li><a href="GlyphsetCSG.html">GlyphsetCSG</a></li><li><a href="LOD.html">LOD</a></li><li><a href="Label.html">Label</a></li><li><a href="Lines.html">Lines</a></li><li><a href="Lines2.html">Lines2</a></li><li><a href="Marker.html">Marker</a></li><li><a href="MarkerCluster.html">MarkerCluster</a></li><li><a href="Minimap.html">Minimap</a></li><li><a href="Pointset.html">Pointset</a></li><li><a href="Region.html">Region</a></li><li><a href="Renderer.html">Renderer</a></li><li><a href="Scene.html">Scene</a></li><li><a href="SceneExporter.html">SceneExporter</a></li><li><a href="SceneLoader.html">SceneLoader</a></li><li><a href="Texture.html">Texture</a></li><li><a href="TextureArray.html">TextureArray</a></li><li><a href="TexturePrimitive.html">TexturePrimitive</a></li><li><a href="TextureSlides.html">TextureSlides</a></li><li><a href="VideoHandler.html">VideoHandler</a></li><li><a href="Viewport.html">Viewport</a></li><li><a href="ZincObject.html">ZincObject</a></li></ul><h3>Global</h3><ul><li><a href="global.html#ModifiedDeviceOrientationControls">ModifiedDeviceOrientationControls</a></li><li><a href="global.html#StereoCameraZoomFixed">StereoCameraZoomFixed</a></li><li><a href="global.html#StereoEffect">StereoEffect</a></li><li><a href="global.html#augmentMorphColor">augmentMorphColor</a></li><li><a href="global.html#createBufferGeometry">createBufferGeometry</a></li></ul>
</nav>

<br class="clear">

<footer>
    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Thu Jan 09 2025 15:01:27 GMT+1300 (New Zealand Daylight Time)
</footer>

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