-
Notifications
You must be signed in to change notification settings - Fork 32
VTK
in progress
VTK is open-source 3D rendering code authored by KitWare. We use it to visualize particle trajectories in WarpVND, magnets in Radia, and beamlines in SRW and OPAL. Many upcoming projects also feature 3D visualization.
VTK is available in several languages. Development is most active in C++; it can be useful as a guide to its capabilities. We use the javascript version, which though it lags C++, is still under very active development, often releasing several updates in a day. We wait on major versions ("x" of "x.y.z") (or soon thereafter).
We have wrapped common VTK code in our own classes for ease of reuse across apps; see the documentation below.
- VTKUtils
- VTKScene
- ActorBundle
- CoordMapper
- ViewPortObject
Collection of static methods and fields related to vtk
Source:
(static) buildBoundingBox(bounds, padPct) → {BoxBundle}
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:
Type
BoxBundle
(static) buildOrientationMarke(actor, interactor, location) → {vtk.Interaction.Widgets.vtkOrientationMarkerWidget}
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:
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:
- 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:
- a color string (#rrggbb)
Type
string
Modes when interacting with the vtk canvas
Source:
- interactionModes
Type
Object
Creates a vtk user matrix from a SquareMatrix. * @param {SquareMatrix} matrix - vtk actor
Source:
Type
Array.<Array.<number>>
Documentation generated by JSDoc 3.6.10 on Wed Jul 13 2022 15:19:06 GMT+0000 (GMT)
(generated jsdoc)
A convenient object bundling a source, actor, and mapper, which almost always appear together anyway
Name | Type | Description |
---|---|---|
source |
* | a vtk source, reader, etc. |
transform |
SIREPO.GEOMETRY.Transform | a Transform to translate between "lab" and "local" coordinate systems |
actorProperties |
Object | a map of actor properties (e.g. 'color') to values |
Source:
the transform
- vtk.Rendering.Core.vtkActor
Source:
properties of the actor
- vtk.Rendering.Core.Property
Source:
a mapper
- vtk.Rendering.Core.vtkMapper
Source:
the transform
- SIREPO.GEOMETRY.Transform
Source:
actorBoundingBox(padPct) → {BoxBundle}
Builds a wireframe box around this actor, with optional padding
Name | Type | Default | Description |
---|---|---|---|
padPct |
number | 0 | additional padding as a percentage of the size |
Source:
Type
BoxBundle
Gets the value of the actor property with the given name
Name | Type | Description |
---|---|---|
name |
string | the name of the property |
Source:
Type
*
Sets the actor property with the given name to the given value
Name | Type | Description |
---|---|---|
name |
string | the name of the property |
value |
* | the value to set |
Source:
Convenience method for setting the color. Uses colorToFloat to convert
Name | Type | Description |
---|---|---|
color |
string | Array.<number> |
Source:
Sets the mapper for this bundle as well as the actor
Name | Type | Description |
---|---|---|
mapper |
vtk.Rendering.Core.vtkMapper |
Source:
Sets the source for this bundle. Also sets the mapper's input connection to the source's output
Name | Type | Description |
---|---|---|
source |
* | vtk source |
Source:
Documentation generated by JSDoc 3.6.10 on Wed Jul 13 2022 15:19:06 GMT+0000 (GMT)
A bundle for a cube source
Name | Type | Description |
---|---|---|
labSize |
Array.<number> | array of the x, y, z sides of the box in the lab |
labCenter |
Array.<number> | array of the x, y, z coords of the box's center in the lab |
transform |
SIREPO.GEOMETRY.Transform | a Transform to translate between "lab" and "local" coordinate systems |
actorProperties |
Object | a map of actor properties (e.g. 'color') to values |
Source:
Sets the center of the box
Name | Type | Description |
---|---|---|
labCenter |
Array.<number> | array of the x, y, z coords of the box's center in the lab |
Source:
Sets the size of the box
Name | Type | Description |
---|---|---|
labSize- |
Array.<number> | array of the x, y, z lengths of the box |
Source:
Documentation generated by JSDoc 3.6.10 on Wed Jul 13 2022 15:19:06 GMT+0000 (GMT)
Provides a mapping from "lab" coordinates to vtk's coordinates via a SIREPO.GEOMETRY.Transform. Also wraps the creation of various Bundles so the transform gets applied automatically
Name | Type | Description |
---|---|---|
transform |
SIREPO.GEOMETRY.Transform | a Transform to translate between "lab" and "local" coordinate systems |
Source:
Creates a Bundle from an arbitrary source
Name | Type | Description |
---|---|---|
source |
* | a vtk source, reader, etc. |
transform |
SIREPO.GEOMETRY.Transform | a Transform to translate between "lab" and "local" coordinate systems |
actorProperties |
Object | a map of actor properties (e.g. 'color') to values |
Source:
buildBox(labSize, labCenter, actorProperties) → {BoxBundle}
Builds a box
Name | Type | Description |
---|---|---|
labSize |
Array.<number> | array of the x, y, z sides of the box in the lab |
labCenter |
Array.<number> | array of the x, y, z coords of the box's center in the lab |
actorProperties |
Object | a map of actor properties (e.g. 'color') to values |
Source:
Type
BoxBundle
buildLine(labP1, labP2, actorProperties) → {LineBundle}
Builds a line
Name | Type | Description |
---|---|---|
labP1 |
Array.<number> | 1st point |
labP2 |
Array.<number> | 2nd point |
actorProperties |
Object | a map of actor properties (e.g. 'color') to values |
Source:
Type
LineBundle
buildPlane(labOrigin, labP1, labP2, actorProperties) → {LineBundle}
Builds a plane
Name | Type | Description |
---|---|---|
labOrigin |
Array.<number> | origin |
labP1 |
Array.<number> | 1st point |
labP2 |
Array.<number> | 2nd point |
actorProperties |
Object | a map of actor properties (e.g. 'color') to values |
Source:
Type
LineBundle
buildSphere(labCenter, radius, actorProperties) → {SphereBundle}
Builds a sphere
Name | Type | Description |
---|---|---|
labCenter |
Array.<number> | center in the lab |
radius |
number | |
actorProperties |
Object | a map of actor properties (e.g. 'color') to values |
Source:
Type
SphereBundle
Documentation generated by JSDoc 3.6.10 on Wed Jul 13 2022 15:19:06 GMT+0000 (GMT)
Also see sirepo-geometry.js
License: http://www.apache.org/licenses/LICENSE-2.0.html
Copyright ©️ 2015–2020 RadiaSoft LLC. All Rights Reserved.
- Activait
- Controls
- elegant
- FLASH
- Genesis
- JSPEC
- JupyterHub
- MAD-X
- OPAL
- Radia
- Shadow
- Synchrotron Radiation Workshop (SRW)
- Warp PBA
- Warp VND
- Zgoubi
- Authentication and Account Creation
- How Your Sirepo Workspace Works
- Navigating the Sirepo Simulations Interface
- How to upload a lattice file
- How to share a Sirepo simulation via URL
- How Example simulations work
- How to report a bug in Sirepo
- Using lattice files in Sirepo
- Resetting an Example Simulation to default
- Backup SRW Sirepo simulations
- SRW Aperture
- SRW Brilliance Report
- SRW Circular Cylinder Mirror
- SRW CRL
- SRW Crystal
- SRW Electron Beam
- SRW Elliptical Cylinder Mirror
- SRW Fiber
- SRW Flux
- SRW Fully Coherent Gaussian Beam
- SRW Import Python or JSON Simulation File
- SRW Initial Wavefront Simulation Grid
- SRW Intensity Report
- SRW Planar Mirror
- SRW Power Density Report
- SRW Propagation Parameters
- SRW Single Electron Spectrum Report
- SRW Spherical Mirror
- SRW Toroid Mirror
- SRW Watchpoint
- SRW Additional Documentation