VTK
9.1.0
|
Context in which a vtkRenderPass will render. More...
#include <vtkRenderState.h>
Public Member Functions | |
vtkRenderState (vtkRenderer *renderer) | |
Constructor. | |
~vtkRenderState ()=default | |
Destructor. | |
bool | IsValid () const |
Tells if the RenderState is a valid one (Renderer is not null). | |
vtkRenderer * | GetRenderer () const |
Return the Renderer. | |
vtkFrameBufferObjectBase * | GetFrameBuffer () const |
Return the FrameBuffer. | |
void | SetFrameBuffer (vtkFrameBufferObjectBase *fbo) |
Set the FrameBuffer. | |
void | GetWindowSize (int size[2]) const |
Get the window size of the state. | |
vtkProp ** | GetPropArray () const |
Return the array of filtered props. | |
int | GetPropArrayCount () const |
Return the size of the array of filtered props. | |
void | SetPropArrayAndCount (vtkProp **propArray, int propArrayCount) |
Set the array of filtered props and its size. | |
vtkInformation * | GetRequiredKeys () const |
Return the required property keys for the props. | |
void | SetRequiredKeys (vtkInformation *keys) |
Set the required property keys for the props. | |
Protected Attributes | |
vtkRenderer * | Renderer |
The renderer in which the render pass is performed. | |
vtkFrameBufferObjectBase * | FrameBuffer |
The framebuffer in use. | |
vtkInformation * | RequiredKeys |
It tells that the current render pass it supposed to render only props that have all the RequiredKeys in their property keys. | |
vtkProp ** | PropArray |
Subset of props to render. | |
int | PropArrayCount |
Subset of props to render. | |
Context in which a vtkRenderPass will render.
vtkRenderState is a ligthweight effective class which gather information used by a vtkRenderPass to perform its execution.
Definition at line 40 of file vtkRenderState.h.
vtkRenderState::vtkRenderState | ( | vtkRenderer * | renderer | ) |
Constructor.
All values are initialized to 0 or NULL.
|
default |
Destructor.
As a vtkRenderState does not own any of its variables, the destructor does nothing.
bool vtkRenderState::IsValid | ( | ) | const |
Tells if the RenderState is a valid one (Renderer is not null).
vtkRenderer * vtkRenderState::GetRenderer | ( | ) | const |
Return the Renderer.
This is the renderer in which the render pass is performed. It gives access to the RenderWindow, to the props.
vtkFrameBufferObjectBase * vtkRenderState::GetFrameBuffer | ( | ) | const |
Return the FrameBuffer.
This is the framebuffer in use. NULL means it is the FrameBuffer provided by the RenderWindow (it can actually be an FBO in case the RenderWindow is in off screen mode).
void vtkRenderState::SetFrameBuffer | ( | vtkFrameBufferObjectBase * | fbo | ) |
void vtkRenderState::GetWindowSize | ( | int | size[2] | ) | const |
Get the window size of the state.
vtkProp ** vtkRenderState::GetPropArray | ( | ) | const |
Return the array of filtered props.
int vtkRenderState::GetPropArrayCount | ( | ) | const |
Return the size of the array of filtered props.
void vtkRenderState::SetPropArrayAndCount | ( | vtkProp ** | propArray, |
int | propArrayCount | ||
) |
Set the array of filtered props and its size.
It is a subset of props to render. A renderpass might ignore this filtered list and access to all the props of the vtkRenderer object directly. For example, a render pass may filter props that are visible and not culled by the frustum, but a sub render pass building a shadow map may need all the visible props.
vtkInformation * vtkRenderState::GetRequiredKeys | ( | ) | const |
Return the required property keys for the props.
It tells that the current render pass it supposed to render only props that have all the RequiredKeys in their property keys.
void vtkRenderState::SetRequiredKeys | ( | vtkInformation * | keys | ) |
Set the required property keys for the props.
See GetRequiredKeys().
|
protected |
The renderer in which the render pass is performed.
It gives access to the RenderWindow, to the props.
Definition at line 130 of file vtkRenderState.h.
|
protected |
The framebuffer in use.
NULL means the FrameBuffer provided by the RenderWindow (it can actually be an FBO in case the RenderWindow is in off screen mode).
Definition at line 137 of file vtkRenderState.h.
|
protected |
Subset of props to render.
A renderpass might ignore this filtered list and access to all the props of the vtkRenderer object directly. For example, a render pass may filter props that are visible and not culled by the frustum, but a sub render pass building a shadow map may need all the visible props.
Definition at line 147 of file vtkRenderState.h.
|
protected |
Subset of props to render.
A renderpass might ignore this filtered list and access to all the props of the vtkRenderer object directly. For example, a render pass may filter props that are visible and not culled by the frustum, but a sub render pass building a shadow map may need all the visible props.
Definition at line 148 of file vtkRenderState.h.
|
protected |
It tells that the current render pass it supposed to render only props that have all the RequiredKeys in their property keys.
Definition at line 155 of file vtkRenderState.h.