VTK  9.3.20240328
vtkValuePass.h
Go to the documentation of this file.
1 // SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2 // SPDX-License-Identifier: BSD-3-Clause
52 #ifndef vtkValuePass_h
53 #define vtkValuePass_h
54 
55 #include "vtkOpenGLRenderPass.h"
56 #include "vtkRenderingOpenGL2Module.h" // For export macro
57 #include "vtkSmartPointer.h" //for ivar
58 
59 VTK_ABI_NAMESPACE_BEGIN
60 class vtkAbstractArray;
61 class vtkActor;
62 class vtkDataArray;
63 class vtkDataObject;
64 class vtkFloatArray;
65 class vtkMapper;
67 class vtkProperty;
68 class vtkRenderer;
69 class vtkRenderWindow;
70 class vtkShaderProgram;
71 
72 class VTKRENDERINGOPENGL2_EXPORT vtkValuePass : public vtkOpenGLRenderPass
73 {
74 public:
75  enum Mode
76  {
77  INVERTIBLE_LUT = 1,
78  FLOATING_POINT = 2
79  };
80 
81  static vtkValuePass* New();
83  void PrintSelf(ostream& os, vtkIndent indent) override;
84 
85  void SetInputArrayToProcess(int fieldAssociation, const char* name);
86  void SetInputArrayToProcess(int fieldAssociation, int fieldId);
88 
93  void Render(const vtkRenderState* s) override;
94 
101 
107  void GetFloatImageData(int format, int width, int height, void* data);
108 
114 
115  void ReleaseGraphicsResources(vtkWindow* win) override;
116 
117 protected:
119  ~vtkValuePass() override;
120 
122 
131  bool PostReplaceShaderValues(std::string& vertexShader, std::string& geometryShader,
132  std::string& fragmentShader, vtkAbstractMapper* mapper, vtkProp* prop) override;
138  vtkOpenGLVertexArrayObject* VAO = nullptr) override;
148 
153  void BeginPass(vtkRenderer* ren);
154 
158  void EndPass();
159 
165 
170 
175 
180  void BeginMapperRender(vtkMapper* mapper, vtkDataArray* dataArray, vtkProperty* property);
181 
185  void EndMapperRender(vtkMapper* mapper, vtkProperty* property);
186 
188 
192  bool UpdateShaders(std::string& VSSource, std::string& FSSource);
193 
199 
201 
206  void ReleaseFBO(vtkWindow* win);
208 
209  class vtkInternalsFloat;
210  vtkInternalsFloat* ImplFloat;
211 
212  class vtkInternalsInvertible;
213  vtkInternalsInvertible* ImplInv;
214 
215  struct Parameters;
216  Parameters* PassState;
217 
219 
220 private:
221  vtkDataArray* GetCurrentArray(vtkMapper* mapper, Parameters* arrayPar);
222 
223  vtkAbstractArray* GetArrayFromCompositeData(vtkMapper* mapper, Parameters* arrayPar);
224 
225  vtkSmartPointer<vtkAbstractArray> MultiBlocksArray;
226 
227  void PopulateCellCellMap(const vtkRenderState* s);
228 
229  vtkValuePass(const vtkValuePass&) = delete;
230  void operator=(const vtkValuePass&) = delete;
231 };
232 
233 VTK_ABI_NAMESPACE_END
234 #endif
Abstract superclass for all arrays.
abstract class specifies interface to map data
represents an object (geometry & properties) in a rendered scene
Definition: vtkActor.h:150
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:154
general representation of visualization data
dynamic, self-adjusting array of float
a simple class to control print indentation
Definition: vtkIndent.h:108
abstract class specifies interface to map data to graphics primitives
Definition: vtkMapper.h:136
Abstract render pass with shader modifications.
The VertexArrayObject class uses, or emulates, vertex array objects.
abstract superclass for all actors, volumes and annotations
Definition: vtkProp.h:65
represent surface properties of a geometric object
Definition: vtkProperty.h:166
Context in which a vtkRenderPass will render.
create a window for renderers to draw into
abstract specification for renderers
Definition: vtkRenderer.h:171
The ShaderProgram uses one or more Shader objects.
Renders geometry using the values of a field array as fragment colors.
Definition: vtkValuePass.h:73
void ReleaseGraphicsResources(vtkWindow *win) override
Release graphics resources and ask components to release their own resources.
void BindUniforms(vtkShaderProgram *prog)
void ReleaseFBO(vtkWindow *win)
Methods managing graphics resources required during FLOATING_POINT mode.
void RenderOpaqueGeometry(const vtkRenderState *s)
Opaque pass with key checking.
bool InitializeFBO(vtkRenderer *ren)
Methods managing graphics resources required during FLOATING_POINT mode.
void RenderPieceFinish()
Unbind textures, etc.
void BindAttributes(vtkShaderProgram *prog, vtkOpenGLVertexArrayObject *VAO)
Bind shader variables.
bool HasWindowSizeChanged(vtkRenderer *ren)
Methods managing graphics resources required during FLOATING_POINT mode.
static vtkValuePass * New()
void RenderPieceStart(vtkDataArray *dataArr, vtkMapper *m)
Upload new data if necessary, bind textures, etc.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
void InitializeBuffers(vtkRenderer *ren)
int * GetFloatImageExtents()
Interface to get the rendered image in FLOATING_POINT mode.
void EndPass()
Unbinds internal FBO when FLOATING_POINT mode is enabled.
bool PostReplaceShaderValues(std::string &vertexShader, std::string &geometryShader, std::string &fragmentShader, vtkAbstractMapper *mapper, vtkProp *prop) override
vtkOpenGLRenderPass API.
void Render(const vtkRenderState *s) override
Perform rendering according to a render state s.
void GetFloatImageData(int format, int width, int height, void *data)
Interface to get the rendered image in FLOATING_POINT mode.
bool SetShaderParameters(vtkShaderProgram *program, vtkAbstractMapper *mapper, vtkProp *prop, vtkOpenGLVertexArrayObject *VAO=nullptr) override
Update the uniforms of the shader program.
vtkInternalsFloat * ImplFloat
Definition: vtkValuePass.h:209
void EndMapperRender(vtkMapper *mapper, vtkProperty *property)
Revert any changes made in BeginMapperRender.
bool UpdateShaders(std::string &VSSource, std::string &FSSource)
Add necessary shader definitions.
void SetInputArrayToProcess(int fieldAssociation, int fieldId)
~vtkValuePass() override
void SetInputArrayToProcess(int fieldAssociation, const char *name)
void BeginPass(vtkRenderer *ren)
Manages graphics resources depending on the rendering mode.
vtkFloatArray * GetFloatImageDataArray(vtkRenderer *ren)
Interface to get the rendered image in FLOATING_POINT mode.
vtkInternalsInvertible * ImplInv
Definition: vtkValuePass.h:212
Parameters * PassState
Definition: vtkValuePass.h:215
void BeginMapperRender(vtkMapper *mapper, vtkDataArray *dataArray, vtkProperty *property)
Setup the mapper state, buffer objects or property variables necessary to render the active rendering...
vtkMTimeType GetShaderStageMTime() override
For multi-stage render passes that need to change shader code during a single pass,...
void SetInputComponentToProcess(int component)
window superclass for vtkRenderWindow
Definition: vtkWindow.h:47
@ component
Definition: vtkX3D.h:175
@ height
Definition: vtkX3D.h:254
@ name
Definition: vtkX3D.h:219
@ data
Definition: vtkX3D.h:315
@ string
Definition: vtkX3D.h:490
vtkTypeUInt32 vtkMTimeType
Definition: vtkType.h:270