ImageSlice

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

Introduction

vtkImageSlice provides 2D image display support for vtk. It can be associated with a vtkImageSlice prop and placed within a Renderer.

This class resolves coincident topology with the same methods as vtkMapper.

Methods

extend

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

getActors

getBoundsForSlice

Get the bounds for a given slice as [xmin, xmax, ymin, ymax,zmin, zmax].

Argument	Type	Required	Description
slice	Number	Yes	The slice index. If undefined, the current slice is considered.
thickness	Number	No	The slice thickness. If undefined, 0 is considered.

getForceOpaque

If true, render during the opaque pass even if the opacity value is below 1.0.

getForceTranslucent

If true, render during the translucent pass even if the opacity value is 1.0.

getImages

getIsOpaque

getMTime

Return the Modified Time which is a monotonic increasing integer global for all vtkObjects.

This allow to solve a question such as:

• Is that object created/modified after another one?
• Do I need to re-execute this filter, or not? ...

getMapper

getMaxXBound

Get the maximum X bound

getMaxYBound

Get the maximum Y bound

getMaxZBound

Get the maximum Z bound

getMinXBound

Get the minimum X bound

getMinYBound

Get the minimum Y bound

getMinZBound

Get the minimum Z bound

getRedrawMTime

getSupportsSelection

hasTranslucentPolygonalGeometry

Always render during opaque pass, to keep the behavior predictable and because depth-peeling kills alpha-blending. In the future, the Renderer should render images in layers, i.e. where each image will have a layer number assigned to it, and the Renderer will do the images in their own pass.

makeProperty

Create a new property suitable for use with this type of Actor.

Argument	Type	Required	Description
initialValues	IImageSliceInitialValues	No	(default: {})

newInstance

Method use to create a new instance of vtkImageSlice

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

setForceOpaque

Argument	Type	Required	Description
forceOpaque	boolean	Yes	If true, render during opaque pass even if opacity value is below 1.0.

setForceTranslucent

Argument	Type	Required	Description
forceTranslucent	boolean	Yes	If true, render during translucent pass even if opacity value is 1.0.

setMapper

Argument	Type	Required	Description
mapper	vtkAbstractImageMapper	Yes	An instance that derives from vtkAbstractImageMapper.