VTK  9.1.20220522
vtkRenderState.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkRenderState.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
29 #ifndef vtkRenderState_h
30 #define vtkRenderState_h
31 
32 #include "vtkObject.h"
33 #include "vtkRenderingCoreModule.h" // For export macro
34 
35 class vtkRenderer;
36 class vtkProp;
38 class vtkInformation;
39 
40 class VTKRENDERINGCORE_EXPORT vtkRenderState
41 {
42 public:
50 
55  ~vtkRenderState() = default;
56 
60  bool IsValid() const;
61 
68 
75 
81 
85  void GetWindowSize(int size[2]) const;
86 
90  vtkProp** GetPropArray() const;
91 
97  int GetPropArrayCount() const;
98 
110  void SetPropArrayAndCount(vtkProp** propArray, int propArrayCount);
111 
118 
124 
125 protected:
131 
138 
140 
150 
156 
157 private:
158  vtkRenderState() = delete; // no default constructor.
159  vtkRenderState(const vtkRenderState&) = delete;
160  void operator=(const vtkRenderState&) = delete;
161 };
162 
163 #endif
164 // VTK-HeaderTest-Exclude: vtkRenderState.h
abstract interface to OpenGL FBOs
Store vtkAlgorithm input/output information.
abstract superclass for all actors, volumes and annotations
Definition: vtkProp.h:76
Context in which a vtkRenderPass will render.
void GetWindowSize(int size[2]) const
Get the window size of the state.
void SetRequiredKeys(vtkInformation *keys)
Set the required property keys for the props.
vtkRenderer * Renderer
The renderer in which the render pass is performed.
int GetPropArrayCount() const
Return the size of the array of filtered props.
bool IsValid() const
Tells if the RenderState is a valid one (Renderer is not null).
void SetPropArrayAndCount(vtkProp **propArray, int propArrayCount)
Set the array of filtered props and its size.
vtkRenderState(vtkRenderer *renderer)
Constructor.
vtkProp ** PropArray
Subset of props to render.
int PropArrayCount
Subset of props to render.
vtkProp ** GetPropArray() const
Return the array of filtered props.
void SetFrameBuffer(vtkFrameBufferObjectBase *fbo)
Set the FrameBuffer.
~vtkRenderState()=default
Destructor.
vtkInformation * RequiredKeys
It tells that the current render pass it supposed to render only props that have all the RequiredKeys...
vtkInformation * GetRequiredKeys() const
Return the required property keys for the props.
vtkFrameBufferObjectBase * GetFrameBuffer() const
Return the FrameBuffer.
vtkRenderer * GetRenderer() const
Return the Renderer.
vtkFrameBufferObjectBase * FrameBuffer
The framebuffer in use.
abstract specification for renderers
Definition: vtkRenderer.h:182
@ size
Definition: vtkX3D.h:259