ImageCroppingWidget

Source (.js)Source (.d.ts)

Methods

copyImageDataDescription

Copy the transforms and dimensions of the given image into the widget state, resetting the cropping planes to the full extent of the image.

Argument	Type	Required	Description
image	vtkImageData	Yes	The image to crop

extend

Method used to decorate a given object (publicAPI+model) with vtkImageCroppingWidget 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	IImageCroppingWidgetInitialValues	No	(default: {})

getCornerManipulator

Get the manipulator driving the corner handles.

getCroppingPlanes

Get and set the sub-state holding the cropping planes. It can be observed independently of the rest of the widget state.

getEdgeManipulator

Get the manipulator driving the edge handles.

getFaceManipulator

Get the manipulator driving the face handles.

getIndexToWorldT

Get the index-to-world transform copied from the cropped image.

getPlanes

Get the cropping planes, in index space.

getRepresentationsForViewType

The representation builders the widget uses in the given view type.

getWorldToIndexT

Get the world-to-index transform copied from the cropped image.

newInstance

Method used to create a new instance of vtkImageCroppingWidget

Argument	Type	Required	Description
initialValues	IImageCroppingWidgetInitialValues	No	for pre-setting some of its content

setCornerHandlesEnabled

Show or hide the eight corner handles.

setCornerManipulator

Set the manipulator driving the corner handles.

setDisplayCallback

Set a callback invoked by the sphere handle representation when handles are rendered.

setEdgeHandlesEnabled

Show or hide the twelve edge handles.

setEdgeManipulator

Set the manipulator driving the edge handles.

setFaceHandlesEnabled

Show or hide the six face handles.

setFaceManipulator

Set the manipulator driving the face handles.

setIndexToWorldT

Set the index-to-world transform.

setPlanes

Set the cropping planes, in index space.

setWorldToIndexT

Set the world-to-index transform.

updateHandles

Reposition the handles from the current cropping planes. Called automatically whenever the cropping planes sub-state is modified.