VTK  9.3.20240327
vtkRenderState.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
17 #ifndef vtkRenderState_h
18 #define vtkRenderState_h
19 
20 #include "vtkObject.h"
21 #include "vtkRenderingCoreModule.h" // For export macro
22 
23 VTK_ABI_NAMESPACE_BEGIN
24 class vtkRenderer;
25 class vtkProp;
27 class vtkInformation;
28 
29 class VTKRENDERINGCORE_EXPORT vtkRenderState
30 {
31 public:
39 
44  ~vtkRenderState() = default;
45 
49  bool IsValid() const;
50 
57 
64 
70 
74  void GetWindowSize(int size[2]) const;
75 
79  vtkProp** GetPropArray() const;
80 
86  int GetPropArrayCount() const;
87 
99  void SetPropArrayAndCount(vtkProp** propArray, int propArrayCount);
100 
107 
113 
114 protected:
120 
127 
129 
139 
145 
146 private:
147  vtkRenderState() = delete; // no default constructor.
148  vtkRenderState(const vtkRenderState&) = delete;
149  void operator=(const vtkRenderState&) = delete;
150 };
151 
152 VTK_ABI_NAMESPACE_END
153 #endif
154 // 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:65
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:171
@ size
Definition: vtkX3D.h:253