Class: DepthEnhancedLayer

Defined in: src/display/DepthEnhancedLayer.ts:69

DepthEnhancedLayer renders adjacent slices with blur and parallax effects to provide depth cues in 2D slice viewing.

Features:

• Renders slices before and after the current slice
• Applies Gaussian blur proportional to distance from current slice
• Parallax effect: adjacent slices shift based on cursor position
• Opacity falloff with distance
• Toggleable at runtime

Example

const depthLayer = new DepthEnhancedLayer(imageLayer, {
  depthLayers: 2,
  maxBlurRadius: 8,
  parallaxAmount: 0.03
});
sliceView.addLayer('depth-enhanced', depthLayer);

Implements

• SliceLayer

Constructors

Constructor

new DepthEnhancedLayer(imageLayer, options?): DepthEnhancedLayer;

Defined in: src/display/DepthEnhancedLayer.ts:94

Parameters

imageLayer

ImageLayer

options?

DepthEnhancedOptions

Returns

DepthEnhancedLayer

Properties

neuroSpace

neuroSpace: NeuroSpace;

Defined in: src/display/DepthEnhancedLayer.ts:70

The NeuroSpace associated with the layer. Ensures spatial coherence with other layers in the viewer.

Implementation of

SliceLayer.neuroSpace

---

enabled

enabled: boolean;

Defined in: src/display/DepthEnhancedLayer.ts:88

---

depthLayers

depthLayers: number;

Defined in: src/display/DepthEnhancedLayer.ts:89

---

maxBlurRadius

maxBlurRadius: number;

Defined in: src/display/DepthEnhancedLayer.ts:90

---

parallaxAmount

parallaxAmount: number;

Defined in: src/display/DepthEnhancedLayer.ts:91

---

baseOpacity

baseOpacity: number;

Defined in: src/display/DepthEnhancedLayer.ts:92

Methods

initialize()

initialize(): void;

Defined in: src/display/DepthEnhancedLayer.ts:127

Initializes the layer, loading any necessary data or resources. This method is called once when the layer is added to the SliceViewer. It can perform asynchronous operations if needed.

Returns

void

Implementation of

SliceLayer.initialize

---

renderSlice()

renderSlice(
   sliceIndex, 
   coord, 
   viewAxes, 
   parentContainer): Container<ContainerChild> | null;

Defined in: src/display/DepthEnhancedLayer.ts:134

Render adjacent slices with depth effects

Parameters

sliceIndex

number

coord

number[]

viewAxes

AxisSet3D

parentContainer

Container

Returns

Container<ContainerChild> | null

Implementation of

SliceLayer.renderSlice

---

setPosition()

setPosition(coord): void;

Defined in: src/display/DepthEnhancedLayer.ts:239

Update position - triggers parallax recalculation

Parameters

coord

number[]

Returns

void

Implementation of

SliceLayer.setPosition

---

onPointerMove()

onPointerMove(event): boolean;

Defined in: src/display/DepthEnhancedLayer.ts:246

Handle pointer move for parallax effect

Parameters

event

SlicePointerEvent

Returns

boolean

Implementation of

SliceLayer.onPointerMove

---

onPointerDown()

onPointerDown(event): boolean;

Defined in: src/display/DepthEnhancedLayer.ts:292

Handles pointer (mouse or touch) down events. Layers can implement this method to provide interactive behaviors, such as selecting regions or initiating drag operations.

Parameters

event

SlicePointerEvent

The PIXI.InteractionEvent containing event details.

Returns

boolean

A boolean indicating whether the event has been fully handled. If true, the event propagation stops, preventing other layers from handling it.

Implementation of

SliceLayer.onPointerDown

---

setEnabled()

setEnabled(enabled): void;

Defined in: src/display/DepthEnhancedLayer.ts:300

Toggle depth enhancement on/off

Parameters

enabled

boolean

Returns

void

---

setOptions()

setOptions(options): void;

Defined in: src/display/DepthEnhancedLayer.ts:308

Update depth enhancement settings

Parameters

options

Partial<DepthEnhancedOptions>

Returns

void

---

getOptions()

getOptions(): Required<DepthEnhancedOptions>;

Defined in: src/display/DepthEnhancedLayer.ts:331

Get current settings

Returns

Required<DepthEnhancedOptions>

---

dispose()

dispose(): void;

Defined in: src/display/DepthEnhancedLayer.ts:341

Disposes of the layer, cleaning up any resources or event listeners. This method is called when the layer is removed from the SliceViewer or when the SliceViewer itself is disposed.

Returns

void

Implementation of

SliceLayer.dispose