VTKScene - radiasoft/sirepo GitHub Wiki
in progress
This class encapsulates various basic vtk elements such as the renderer, and supplies methods for using them.
| 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:
Convenience method for adding an actor to the renderer
| Name | Type | Description |
|---|---|---|
actor |
vtk.Rendering.Core.vtkActor |
Source:
Gets an icon based on the view direction ("into/out of the screen")
Source:
Type
string
Source:
- true if an orientation marker has been defined
Type
boolean
Refreshes the visibility of the orientation marker, if one exists
| Name | Type | Default | Description |
|---|---|---|---|
doRender |
true | if true, perform a render |
Source:
Convenience method for removing the given actor from the renderer
| Name | Type | Description |
|---|---|---|
actor |
vtk.Rendering.Core.vtkActor |
Source:
Convenience method for removing the given actors from the renderer, or all actors if input is null/empty
| Name | Type | Description |
|---|---|---|
actors |
Array.<vtk.Rendering.Core.vtkActor> | null |
Source:
Convenience method for triggering a render in the render window
Source:
Sets the camera so that the resetSide is facing the user
Source:
sceneBoundingBox(padPct) â {BoxBundle}
Builds a wireframe box around all the objects in the scene, with optional padding
| Name | Type | Default | Description |
|---|---|---|---|
padPct |
number | 0 | additional padding as a percentage of the size |
Source:
Type
BoxBundle
Sets the background color of the renderer
| Name | Type | Description |
|---|---|---|
color |
string | Array.<number> |
Source:
Sets the camera to the given position, pointing such that "up" is in the given direction
| Name | Type | Description |
|---|---|---|
position |
Array.<number> | |
viewUp |
Array.<number> |
Source:
Sets a property for the camera along the given dimension
| Name | Type | Description |
|---|---|---|
dim |
string | x|y|z |
name |
string | |
val |
* |
Source:
Sets an orientation marker
| Name | Type | Description |
|---|---|---|
m |
vtk.Interaction.Widgets.vtkOrientationMarkerWidget |
Source:
Sets the camera so that the given side is facing the user. If that side is already set, flip to the other side
| Name | Type | Default | Description |
|---|---|---|---|
side |
string | x|y|z | |
direction |
number | 0 | -1|0|1 |
Source:
Cleans up vtk items
Source:
License: http://www.apache.org/licenses/LICENSE-2.0.html
Copyright Šī¸ 2015â2025 RadiaSoft LLC. All Rights Reserved.
