VTKScene

in progress

Class: VTKScene

VTKScene(container, resetSide)

This class encapsulates various basic vtk elements such as the renderer, and supplies methods for using them.

Constructor

new VTKScene(container, resetSide)

Parameters:

Name	Type	Description
container	Object	jquery element in which to place the scene
resetSide	string	the dimension to display facing the user when the scene is reset

Source:

• sirepo-plotting-vtk.js, line 108

Classes

CAM_DEFAULTS

Methods

addActor(actor)

Convenience method for adding an actor to the renderer

Parameters:

Name	Type	Description
actor	vtk.Rendering.Core.vtkActor

Source:

• sirepo-plotting-vtk.js, line 159

directionIcon() → {string}

Gets an icon based on the view direction ("into/out of the screen")

Source:

• sirepo-plotting-vtk.js, line 167

Returns:

Type
string

hasMarker() → {boolean}

Source:

• sirepo-plotting-vtk.js, line 174

Returns:

- true if an orientation marker has been defined

Type
boolean

refreshMarker(doRender)

Refreshes the visibility of the orientation marker, if one exists

Parameters:

Name	Type	Default	Description
doRender		true	if true, perform a render

Source:

• sirepo-plotting-vtk.js, line 288

removeActor(actor)

Convenience method for removing the given actor from the renderer

Parameters:

Name	Type	Description
actor	vtk.Rendering.Core.vtkActor

Source:

• sirepo-plotting-vtk.js, line 182

removeActors(actors)

Convenience method for removing the given actors from the renderer, or all actors if input is null/empty

Parameters:

Name	Type	Description
actors	Array.<vtk.Rendering.Core.vtkActor> | null

Source:

• sirepo-plotting-vtk.js, line 193

render()

Convenience method for triggering a render in the render window

Source:

• sirepo-plotting-vtk.js, line 207

resetView()

Sets the camera so that the resetSide is facing the user

Source:

• sirepo-plotting-vtk.js, line 214

sceneBoundingBox(padPct) → {BoxBundle}

Builds a wireframe box around all the objects in the scene, with optional padding

Parameters:

Name	Type	Default	Description
padPct	number	0	additional padding as a percentage of the size

Source:

• sirepo-plotting-vtk.js, line 223

Returns:

Type
BoxBundle

setBgColor(color)

Sets the background color of the renderer

Parameters:

Name	Type	Description
color	string | Array.<number>

Source:

• sirepo-plotting-vtk.js, line 233

setCam(position, viewUp)

Sets the camera to the given position, pointing such that "up" is in the given direction

Parameters:

Name	Type	Description
position	Array.<number>
viewUp	Array.<number>

Source:

• sirepo-plotting-vtk.js, line 243

setCamProperty(dim, name, val)

Sets a property for the camera along the given dimension

Parameters:

Name	Type	Description
dim	string	x|y|z
name	string
val	*

Source:

• sirepo-plotting-vtk.js, line 261

setMarker(m)

Sets an orientation marker

Parameters:

Name	Type	Description
m	vtk.Interaction.Widgets.vtkOrientationMarkerWidget

Source:

• sirepo-plotting-vtk.js, line 302

showSide(side, direction)

Sets the camera so that the given side is facing the user. If that side is already set, flip to the other side

Parameters:

Name	Type	Default	Description
side	string		x|y|z
direction	number	0	-1|0|1

Source:

• sirepo-plotting-vtk.js, line 271

teardown()

Cleans up vtk items

Source:

• sirepo-plotting-vtk.js, line 311