ImageCPRMapper

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

Methods

buildBufferObjects

Build the volume, color and opacity textures, and the vertex buffer of the quads the straightened image is drawn on.

Argument	Type	Required	Description
ren	vtkRenderer	Yes	The renderer.
actor	vtkImageSlice	Yes	The image slice being rendered.

buildPass

Resolve the ancestors this mapper renders with: its image slice, its renderer, its render window and the camera view node.

Argument	Type	Required	Description
prepass	Boolean	Yes	Whether the traversal is on its way down.

buildShaders

Fill in the shader template and run the mapper's own substitutions.

Argument	Type	Required	Description
shaders	IShaderSources	Yes	The shader sources, edited in place.
ren	vtkRenderer	Yes	The renderer.
actor	vtkImageSlice	Yes	The image slice being rendered.

extend

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

getCoincidentParameters

Get the polygon offset the renderable asks for, or null when it does not resolve coincident topology with a polygon offset.

Argument	Type	Required	Description
ren	vtkRenderer	Yes	The renderer.
actor	vtkImageSlice	Yes	The image slice being rendered.

getNeedToRebuildBufferObjects

Whether the textures and the vertex buffer are out of date.

Argument	Type	Required	Description
ren	vtkRenderer	Yes	The renderer.
actor	vtkImageSlice	Yes	The image slice being rendered.

getNeedToRebuildShaders

Whether the shader program has to be rebuilt for the given helper.

Argument	Type	Required	Description
cellBO		Yes	The OpenGL helper carrying the shader program.
ren	vtkRenderer	Yes	The renderer.
actor	vtkImageSlice	Yes	The image slice being rendered.

getShaderTemplate

Fill in the shader sources with the default polydata shader template.

Argument	Type	Required	Description
shaders	IShaderSources	Yes	The shader sources, edited in place.
ren	vtkRenderer	Yes	The renderer.
actor	vtkImageSlice	Yes	The image slice being rendered.

newInstance

Method used to create a new instance of vtkOpenGLImageCPRMapper.

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

opaquePass

Render the straightened image during the opaque pass, remembering the render pass so that its shader replacement is applied.

Argument	Type	Required	Description
prepass	Boolean	Yes	Whether the traversal is on its way down.
renderPass	vtkRenderPass	Yes	The render pass being traversed.

opaqueZBufferPass

Capture the depth of the straightened image during the opaque z-buffer pass.

Argument	Type	Required	Description
prepass	Boolean	Yes	Whether the traversal is on its way down.

render

Render the straightened image.

renderPiece

Update the renderable, then render the straightened image for the given renderer and prop. Does nothing when the renderable's pre-render check fails.

Argument	Type	Required	Description
ren	vtkRenderer	Yes	The renderer.
prop	vtkImageSlice	Yes	The image slice being rendered.

renderPieceDraw

Activate the textures, update the shaders and draw the quads.

Argument	Type	Required	Description
ren	vtkRenderer	Yes	The renderer.
actor	vtkImageSlice	Yes	The image slice being rendered.

renderPieceFinish

Hook run after the straightened image has been drawn. It does nothing.

Argument	Type	Required	Description
ren	vtkRenderer	Yes	The renderer.
actor	vtkImageSlice	Yes	The image slice being rendered.

renderPieceStart

Bring the buffer objects up to date before the quads are drawn.

Argument	Type	Required	Description
ren	vtkRenderer	Yes	The renderer.
actor	vtkImageSlice	Yes	The image slice being rendered.

replaceShaderClip

Substitute the clipping plane declarations and implementation into the shader sources.

Argument	Type	Required	Description
shaders	IShaderSources	Yes	The shader sources, edited in place.
ren	vtkRenderer	Yes	The renderer.
actor	vtkImageSlice	Yes	The image slice being rendered.

replaceShaderCoincidentOffset

Substitute the depth offset the renderable's coincident topology resolution asks for into the fragment shader.

Argument	Type	Required	Description
shaders	IShaderSources	Yes	The shader sources, edited in place.
ren	vtkRenderer	Yes	The renderer.
actor	vtkImageSlice	Yes	The image slice being rendered.

replaceShaderValues

Substitute the mapper's own declarations and implementation into the shader sources.

Argument	Type	Required	Description
shaders	IShaderSources	Yes	The shader sources, edited in place.
ren	vtkRenderer	Yes	The renderer.
actor	vtkImageSlice	Yes	The image slice being rendered.

setCameraShaderParameters

Set the camera uniforms of the shader program.

Argument	Type	Required	Description
cellBO		Yes	The OpenGL helper carrying the shader program.
ren	vtkRenderer	Yes	The renderer.
actor	vtkImageSlice	Yes	The image slice being rendered.

setMapperShaderParameters

Set the texture and geometry uniforms of the shader program.

Argument	Type	Required	Description
cellBO		Yes	The OpenGL helper carrying the shader program.
ren	vtkRenderer	Yes	The renderer.
actor	vtkImageSlice	Yes	The image slice being rendered.

setPropertyShaderParameters

Set the image property uniforms of the shader program.

Argument	Type	Required	Description
cellBO		Yes	The OpenGL helper carrying the shader program.
ren	vtkRenderer	Yes	The renderer.
actor	vtkImageSlice	Yes	The image slice being rendered.

updateBufferObjects

Rebuild the buffer objects when they are out of date, then set the texture filters from the interpolation type of the actor property.

Argument	Type	Required	Description
ren	vtkRenderer	Yes	The renderer.
actor	vtkImageSlice	Yes	The image slice being rendered.

updateShaders

Make the helper's shader program current, rebuilding it when needed, and push the mapper, camera and property uniforms.

Argument	Type	Required	Description
cellBO		Yes	The OpenGL helper carrying the shader program.
ren	vtkRenderer	Yes	The renderer.
actor	vtkImageSlice	Yes	The image slice being rendered.