VTKUtils - radiasoft/sirepo GitHub Wiki

subject to change - please see the latest code

Collection of static methods

Source:

• sirepo-plotting-vtk line 12

Modes when interacting with the vtk canvas

Source:

• sirepo-plotting-vtk.js line 18

- interactionModes

Type
Object

Builds a wireframe box with the specified bounds and optional padding

Name	Type	Default	Description
bounds	Array.<number>		the bounds in the format [xMin, xMax, yMin, yMax, zMin, zMax]
padPct	number	0	additional padding as a percentage of the size

Source:

• sirepo-plotting-vtk.js line 31

Type
BoxBundle

Makes an orientation widget out of the given vtk actor and interactor, placed in the given corner of the viewport

Name	Type	Description
actor	vtk.Rendering.Core.vtkActor	vtk actor
interactor	vtk.Rendering.Core.vtkRenderWindowInteractor	interactor from a render window
location	vtk.Interaction.Widgets.vtkOrientationMarkerWidget.Corners	which corner to place the widget

Source:

• sirepo-plotting-vtk.js line 54

Type
vtk.Interaction.Widgets.vtkOrientationMarkerWidget

Converts a string or an array of floats to an array of floats using vtk's conversion util, for use in colors

Name	Type	Description
hexStringOrArray	string | Array.<number>	a color string (#rrggbb) or array of floats

Source:

• sirepo-plotting-vtk.js line 74

- array of floats ranging from 0 - 1.

Type
Array.<number>

Converts a string or an array of floats to a string using vtk's conversion util, for use in colors

Name	Type	Description
hexStringOrArray	string | Array.<number>	a color string (#rrggbb) or array of floats

Source:

• sirepo-plotting-vtk.js line 84

- a color string (#rrggbb)

Type
string

Creates a vtk user matrix from a SquareMatrix.

Name	Type	Description
matrix	SquareMatrix	vtk actor

Source:

• sirepo-plotting-vtk.js line 93

Type
Array.<Array.<number>>