Class: TextureSlides

TextureSlides(textureIn) → {TextureSlides}

new TextureSlides(textureIn) → {TextureSlides}

Provides a class which create a texture stacks in a block with shaders allowing slices of texture to be displayed.
Parameters:
Name Type Description
textureIn TextureArray An object of texture array holding texture information.
Author:
  • Alan Wu
Source:
Returns:
Type
TextureSlides

Methods

createSlide(settings) → {SLIDE_SETTINGS}

Create a slide required for visualisation based on the slide settings. The slide itself is an {THREE.PlanGeometry} object.
Parameters:
Name Type Description
settings SLIDE_SETTINGS settings of the slide to be created.
Source:
Returns:
- Returned settings, it includes the newly created mesh's id.
Type
SLIDE_SETTINGS

createSlides(slideSettings)

Create the slides required for visualisation based on the slide settings. The slides themselves are {THREE.PlanGeometry} objects.
Parameters:
Name Type Description
slideSettings SLIDE_SETTINGS An array to each slide settings.
Source:

dispose()

Clean up all internal objects.
Source:

getBoundingBox() → {THREE.Box3}

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.
Source:
Returns:
.
Type
THREE.Box3

getSlides() → {Array}

Get the array of slides, return them in an array
Source:
Returns:
- Return an array of
Type
Array

getTextureSettings() → {SLIDE_SETTINGS

Return a copy of texture settings used by this object.
Source:
Returns:
- Returned the list of settings.
Type
SLIDE_SETTINGS

getTextureSettingsWithId() → {SLIDE_SETTINGS}

Return a copy of texture settings with corresponding id used by this object.
Source:
Returns:
- Returned a copy of settings with corresponding id.
Type
SLIDE_SETTINGS

modifySlideSettings(settings)

Modify the mesh based on a setting
Parameters:
Name Type Description
settings SLIDE_SETTINGS s.
Source:

removeSlide(slide)

Remove a slide, this will dispose the slide and its material.
Parameters:
Name Type Description
slide Slide Slide to be remvoed
Source:

removeSlideWithId(id)

Remove a slide, this will dispose the slide and its material.
Parameters:
Name Type Description
id Number id of slide to be remvoed
Source:

(inner) setUniformSlideSettingsOfMesh(mesh, slideSettings)

Set the value of the uniforms for a specific mesh in this texture slide object.
Parameters:
Name Type Description
mesh THREE.Mesh Mesh to be modified
slideSettings SLIDE_SETTINGS Slide settings.
Source: