PolyDataMapper
Introduction
The OpenGL backend view node for vtkMapper.
Methods
applyShaderReplacements
Apply the user supplied shader replacements found on the renderable's OpenGL view specific properties.
| Argument | Type | Required | Description |
|---|---|---|---|
shaders | Yes | ||
viewSpec | Yes | the OpenGL view specific properties, may be undefined | |
pre | Yes | when true only the replacements flagged replaceFirst are applied |
buildBufferObjects
| Argument | Type | Required | Description |
|---|---|---|---|
ren | vtkRenderer | Yes | |
actor | vtkActor | Yes |
buildPass
Locate the scene graph nodes this mapper renders through.
| Argument | Type | Required | Description |
|---|---|---|---|
prepass | Yes |
buildShaders
Assemble the full shader sources for the given renderer and actor.
| Argument | Type | Required | Description |
|---|---|---|---|
shaders | Yes | ||
ren | vtkRenderer | Yes | |
actor | vtkActor | Yes |
extend
Method used to decorate a given object (publicAPI+model) with vtkOpenGLPolyDataMapper 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 | IOpenGLPolyDataMapperInitialValues | No | (default: {}) |
getAllocatedGPUMemoryInBytes
The GPU memory the primitives of this mapper currently hold, in bytes.
getCoincidentParameters
The polygon offset factor and offset to use for the primitive currently being rendered.
| Argument | Type | Required | Description |
|---|---|---|---|
ren | vtkRenderer | Yes | |
actor | vtkActor | Yes |
getContext
The WebGL context this mapper renders into.
getNeedToRebuildBufferObjects
| Argument | Type | Required | Description |
|---|---|---|---|
ren | vtkRenderer | Yes | |
actor | vtkActor | Yes |
getNeedToRebuildShaders
| Argument | Type | Required | Description |
|---|---|---|---|
cellBO | Yes | the helper holding the program for a primitive type | |
ren | vtkRenderer | Yes | |
actor | vtkActor | Yes |
getReplacedShaderTemplate
Fetch the shader templates and apply the per shader code overrides found on the renderable's OpenGL view specific properties.
| Argument | Type | Required | Description |
|---|---|---|---|
shaders | Yes | ||
ren | vtkRenderer | Yes | |
actor | vtkActor | Yes |
getShaderTemplate
Fill the shader sources with the templates this mapper starts from.
| Argument | Type | Required | Description |
|---|---|---|---|
shaders | Yes | ||
ren | vtkRenderer | Yes | |
actor | vtkActor | Yes |
invokeShaderCallbacks
Invoke the user supplied shader callbacks registered on the renderable.
| Argument | Type | Required | Description |
|---|---|---|---|
cellBO | Yes | ||
ren | vtkRenderer | Yes | |
actor | vtkActor | Yes |
newInstance
Method used to create a new instance of vtkOpenGLPolyDataMapper.
| Argument | Type | Required | Description |
|---|---|---|---|
initialValues | IOpenGLPolyDataMapperInitialValues | No | for pre-setting some of its content |
opaquePass
| Argument | Type | Required | Description |
|---|---|---|---|
prepass | Yes |
opaqueZBufferPass
| Argument | Type | Required | Description |
|---|---|---|---|
prepass | Yes |
releaseGraphicsResources
Release the primitive buffers and the internal color texture.
render
Renders the piece held by this mapper.
renderPiece
| Argument | Type | Required | Description |
|---|---|---|---|
ren | vtkRenderer | Yes | |
actor | vtkActor | Yes |
renderPieceDraw
| Argument | Type | Required | Description |
|---|---|---|---|
ren | vtkRenderer | Yes | |
actor | vtkActor | Yes |
renderPieceFinish
| Argument | Type | Required | Description |
|---|---|---|---|
ren | vtkRenderer | Yes | |
actor | vtkActor | Yes |
renderPieceStart
| Argument | Type | Required | Description |
|---|---|---|---|
ren | vtkRenderer | Yes | |
actor | vtkActor | Yes |
replaceShaderClip
| Argument | Type | Required | Description |
|---|---|---|---|
shaders | Yes | ||
ren | vtkRenderer | Yes | |
actor | vtkActor | Yes |
replaceShaderCoincidentOffset
Add the polygon offset uniforms when the coincident parameters are non zero.
| Argument | Type | Required | Description |
|---|---|---|---|
shaders | Yes | ||
ren | vtkRenderer | Yes | |
actor | vtkActor | Yes |
replaceShaderColor
| Argument | Type | Required | Description |
|---|---|---|---|
shaders | Yes | ||
ren | vtkRenderer | Yes | |
actor | vtkActor | Yes |
replaceShaderLight
| Argument | Type | Required | Description |
|---|---|---|---|
shaders | Yes | ||
ren | vtkRenderer | Yes | |
actor | vtkActor | Yes |
replaceShaderNormal
| Argument | Type | Required | Description |
|---|---|---|---|
shaders | Yes | ||
ren | vtkRenderer | Yes | |
actor | vtkActor | Yes |
replaceShaderPicking
| Argument | Type | Required | Description |
|---|---|---|---|
shaders | Yes | ||
ren | vtkRenderer | Yes | |
actor | vtkActor | Yes |
replaceShaderPositionVC
| Argument | Type | Required | Description |
|---|---|---|---|
shaders | Yes | ||
ren | vtkRenderer | Yes | |
actor | vtkActor | Yes |
replaceShaderTCoord
| Argument | Type | Required | Description |
|---|---|---|---|
shaders | Yes | ||
ren | vtkRenderer | Yes | |
actor | vtkActor | Yes |
replaceShaderValues
Run every shader replacement this mapper implements.
| Argument | Type | Required | Description |
|---|---|---|---|
shaders | Yes | ||
ren | vtkRenderer | Yes | |
actor | vtkActor | Yes |
setCameraShaderParameters
| Argument | Type | Required | Description |
|---|---|---|---|
cellBO | Yes | ||
ren | vtkRenderer | Yes | |
actor | vtkActor | Yes |
setContext
| Argument | Type | Required | Description |
|---|---|---|---|
context | Yes |
setLightingShaderParameters
| Argument | Type | Required | Description |
|---|---|---|---|
cellBO | Yes | ||
ren | vtkRenderer | Yes | |
actor | vtkActor | Yes |
setMapperShaderParameters
| Argument | Type | Required | Description |
|---|---|---|---|
cellBO | Yes | ||
ren | vtkRenderer | Yes | |
actor | vtkActor | Yes |
setPropertyShaderParameters
| Argument | Type | Required | Description |
|---|---|---|---|
cellBO | Yes | ||
ren | vtkRenderer | Yes | |
actor | vtkActor | Yes |
translucentPass
| Argument | Type | Required | Description |
|---|---|---|---|
prepass | Yes | ||
renderPass | vtkRenderPass | Yes |
updateBufferObjects
Rebuild the buffer objects when they are out of date.
| Argument | Type | Required | Description |
|---|---|---|---|
ren | vtkRenderer | Yes | |
actor | vtkActor | Yes |
updateMaximumPointCellIds
Tell the hardware selector the largest point and cell ids this mapper can emit.
| Argument | Type | Required | Description |
|---|---|---|---|
ren | vtkRenderer | Yes | |
actor | vtkActor | Yes |
zBufferPass
| Argument | Type | Required | Description |
|---|---|---|---|
prepass | Yes |