VTK
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 "vtkRenderingCoreModule.h" // For export macro
33 #include "vtkObject.h"
34 
35 class vtkRenderer;
36 class vtkProp;
38 class vtkInformation;
39 
40 class VTKRENDERINGCORE_EXPORT vtkRenderState
41 {
42  public:
50 
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,
111  int propArrayCount);
112 
119 
125 
126  protected:
132 
139 
141 
151 
157 
158 private:
159  vtkRenderState(); // no default constructor.
160  vtkRenderState(const vtkRenderState &) = delete;
161  void operator=(const vtkRenderState &) = delete;
162 };
163 
164 #endif
165 // VTK-HeaderTest-Exclude: vtkRenderState.h
vtkRenderState::GetRenderer
vtkRenderer * GetRenderer() const
Return the Renderer.
vtkRenderState::GetPropArray
vtkProp ** GetPropArray() const
Return the array of filtered props.
vtkRenderState::GetWindowSize
void GetWindowSize(int size[2]) const
Get the window size of the state.
vtkRenderState::vtkRenderState
vtkRenderState(vtkRenderer *renderer)
Constructor.
vtkRenderState::SetRequiredKeys
void SetRequiredKeys(vtkInformation *keys)
Set the required property keys for the props.
vtkRenderState::Renderer
vtkRenderer * Renderer
The renderer in which the render pass is performed.
Definition: vtkRenderState.h:131
vtkFrameBufferObjectBase
abstract interface to OpenGL FBOs
Definition: vtkFrameBufferObjectBase.h:33
vtkRenderState::SetPropArrayAndCount
void SetPropArrayAndCount(vtkProp **propArray, int propArrayCount)
Set the array of of filtered props and its size.
vtkX3D::size
@ size
Definition: vtkX3D.h:253
vtkRenderState::~vtkRenderState
~vtkRenderState()
Destructor.
vtkObject.h
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:87
vtkProp
abstract superclass for all actors, volumes and annotations
Definition: vtkProp.h:53
vtkRenderState::RequiredKeys
vtkInformation * RequiredKeys
It tells that the current render pass it supposed to render only props that have all the RequiredKeys...
Definition: vtkRenderState.h:156
vtkRenderState::PropArrayCount
int PropArrayCount
Definition: vtkRenderState.h:149
vtkRenderState::FrameBuffer
vtkFrameBufferObjectBase * FrameBuffer
The framebuffer in use.
Definition: vtkRenderState.h:138
vtkRenderer
abstract specification for renderers
Definition: vtkRenderer.h:64
vtkRenderState::GetRequiredKeys
vtkInformation * GetRequiredKeys() const
Return the required property keys for the props.
vtkRenderState::GetFrameBuffer
vtkFrameBufferObjectBase * GetFrameBuffer() const
Return the FrameBuffer.
vtkRenderState::IsValid
bool IsValid() const
Tells if the RenderState is a valid one (Renderer is not null).
vtkRenderState
Context in which a vtkRenderPass will render.
Definition: vtkRenderState.h:41
vtkRenderState::SetFrameBuffer
void SetFrameBuffer(vtkFrameBufferObjectBase *fbo)
Set the FrameBuffer.
vtkRenderState::GetPropArrayCount
int GetPropArrayCount() const
Return the size of the array of filtered props.
vtkRenderState::PropArray
vtkProp ** PropArray
Subset of props to render.
Definition: vtkRenderState.h:148