VRView - DigleTTK

Constructor

new VRView(element)

Source:

vrView.js, line 38

Create a volume rendering scene

Parameters:

Name	Type	Description
`element`	HTMLElement	the target html element to render the scene

Classes

VRView

Members

blurOnInteraction :bool

Source:

vrView.js, line 256

Toggle blurring on interaction (Increase performance)

Type:

bool

cropWidget :bool

Source:

vrView.js, line 202

Crop widget on / off

Type:

bool

edgeEnhancement

Source:

vrView.js, line 293

Toggle edge enhancement

lut :String

Source:

vrView.js, line 214

Set colormap and opacity function
lutName - as in presets list

Type:

String

presetsList :Array

Source:

vrView.js, line 144

Presets

Type:

Array

rangeLUT :Array

Source:

vrView.js, line 190

Set range to apply lut !!! WIP

Type:

Array

rescaleLUT :bool

Source:

vrView.js, line 169

Flag to set lut rescaling on opacity range

Type:

bool

resolution :Number

Source:

vrView.js, line 128

raysDistance

Type:

Number

widgetElement :HTMLelement

Source:

vrView.js, line 152

PGwidgetElement (set null to hide)

Type:

HTMLelement

wwwl :Array

Source:

vrView.js, line 103

wwwl

Type:

Array

Methods

_initCropWidget()

Source:

vrView.js, line 701

Setup crop widget

_initPicker()

Source:

vrView.js, line 847

initPicker

addLandmarks(landmarks)

Source:

vrView.js, line 379

Add landmarks to be rendered as spheres

Parameters:

Name	Type	Description
`landmarks`	Array	[{label, x, y, z, color, radius}]

addSurface()

Source:

vrView.js, line 350

Add surfaces to be rendered

Parameters:

Type	Description
Object	{buffer: bufferarray, fileType?: string, props: Object} Props contains color, label, opacity, wireframe

destroy()

Source:

vrView.js, line 544

Destroy webgl content and release listeners

getLutList() → {Array}

Source:

vrView.js, line 467

Get vtk LUTs list

Returns:

Lut list as array of strings

Type: Array

resetMeasurementState(measurementState)

Source:

vrView.js, line 475

Reset measurement state to default

Parameters:

Name	Type	Description
`measurementState`	*

resetView()

Source:

vrView.js, line 526

Reset view

resize()

Source:

vrView.js, line 536

on resize callback

setImage(image)

Source:

vrView.js, line 308

Set the image to be rendered

Parameters:

Name	Type	Description
`image`	ArrayBuffer	The image content data as buffer array

setSurfaceVisibility(label, toggle)

Source:

vrView.js, line 428

Toggle surface visibility on/off

Parameters:

Name	Type	Description
`label`	String	The string that identifies the surface
`toggle`	Boolean

setTool(toolName, options, measurementState)

Source:

vrView.js, line 502

Set active tool
("Length/Angle", {mouseButtonMask:1}, measurementState)

Parameters:

Name	Type	Description
`toolName`	*
`options`	*
`measurementState`	*

turnPickingOff()

Source:

vrView.js, line 837

Unregister the picking callback.

turnPickingOn(callback, targetLabels)

Source:

vrView.js, line 781

Register a callback for picking on a list of actors.
The callback will receive an object with { worldPosition, displayPosition, actorLabel }

Parameters:

Name	Type	Description
`callback`	function	The function to call on pick.
`targetLabels`	Array.<String>	A list of actor labels to pick from.

updateLandmarkPosition(label, position)

Source:

vrView.js, line 411

Update the position of an existing landmark.

Parameters:

Name	Type	Description
`label`	String	The label of the landmark.
`position`	Array.<Number>	The new position as [x, y, z].

updateSurface(label, buffer, fileType)

Source:

vrView.js, line 440

Update surface buffer
TODO maybe there is a more efficient way

Parameters:

Name	Type	Description
`label`	String	The string that identifies the surface
`buffer`	ArrayBuffer
`fileType`	String	Optional file type ('stl' or 'vtp')