VolumeController
Introduction
vtkVolumeController is a DOM overlay providing interactive control over a volume actor: color map preset, shading, sample distance, edge gradient opacity and a piecewise gaussian editor for the scalar opacity.
Methods
extend
Method used to decorate a given object (publicAPI+model) with vtkVolumeController characteristics.
| Argument | Type | Required | Description |
|---|---|---|---|
publicAPI | Yes | object on which methods will be bounds (public) | |
model | Yes | object on which data structure will be bounds (protected) | |
initialValues | IVolumeControllerInitialValues | No | (default: {}) |
getWidget
The embedded piecewise gaussian widget used to edit the scalar opacity.
newInstance
Method used to create a new instance of vtkVolumeController.
| Argument | Type | Required | Description |
|---|---|---|---|
initialValues | IVolumeControllerInitialValues | No | for pre-setting some of its content |
render
Render the embedded piecewise function editor.
setContainer
Attach the controller to the given DOM element, detaching it from any previously set one.
| Argument | Type | Required | Description |
|---|---|---|---|
el | Yes |
setRescaleColorMap
When true, the color transfer function mapping range follows the opacity range selected in the piecewise function editor.
| Argument | Type | Required | Description |
|---|---|---|---|
value | Boolean | Yes |
setSize
Resize the embedded piecewise function editor.
| Argument | Type | Required | Description |
|---|---|---|---|
width | Number | Yes | |
height | Number | Yes |
setupContent
Build the controller DOM content and wire it to the given volume actor.
| Argument | Type | Required | Description |
|---|---|---|---|
renderWindow | vtkRenderWindow | Yes | |
actor | vtkVolume | Yes | |
isBackgroundDark | Boolean | Yes | selects the light or dark widget styling |
useShadow | String or Number | No | (default: '1') |
presetName | String | No | (default: 'erdc_rainbow_bright') |
toggleVisibility
Show or hide everything but the toggle button.