VTK
Public Member Functions | Protected Attributes | List of all members
vtkRenderState Class Reference

Context in which a vtkRenderPass will render. More...

#include <vtkRenderState.h>

Collaboration diagram for vtkRenderState:
[legend]

Public Member Functions

 vtkRenderState (vtkRenderer *renderer)
 Constructor. More...
 
 ~vtkRenderState ()
 Destructor. More...
 
bool IsValid () const
 Tells if the RenderState is a valid one (Renderer is not null). More...
 
vtkRendererGetRenderer () const
 Return the Renderer. More...
 
vtkFrameBufferObjectBaseGetFrameBuffer () const
 Return the FrameBuffer. More...
 
void SetFrameBuffer (vtkFrameBufferObjectBase *fbo)
 Set the FrameBuffer. More...
 
void GetWindowSize (int size[2]) const
 Get the window size of the state. More...
 
vtkProp ** GetPropArray () const
 Return the array of filtered props. More...
 
int GetPropArrayCount () const
 Return the size of the array of filtered props. More...
 
void SetPropArrayAndCount (vtkProp **propArray, int propArrayCount)
 Set the array of filtered props and its size. More...
 
vtkInformationGetRequiredKeys () const
 Return the required property keys for the props. More...
 
void SetRequiredKeys (vtkInformation *keys)
 Set the required property keys for the props. More...
 

Protected Attributes

vtkRendererRenderer
 The renderer in which the render pass is performed. More...
 
vtkFrameBufferObjectBaseFrameBuffer
 The framebuffer in use. More...
 
vtkProp ** PropArray
 Subset of props to render. More...
 
int PropArrayCount
 
vtkInformationRequiredKeys
 It tells that the current render pass it supposed to render only props that have all the RequiredKeys in their property keys. More...
 

Detailed Description

Context in which a vtkRenderPass will render.

vtkRenderState is a ligthweight effective class which gather information used by a vtkRenderPass to perform its execution.

Attention
Get methods are const to enforce that a renderpass cannot modify the RenderPass object. It works in conjunction with vtkRenderPass::Render where the argument vtkRenderState is const.
See also
vtkRenderPass vtkRenderer vtkFrameBufferObject vtkProp

Definition at line 40 of file vtkRenderState.h.

Constructor & Destructor Documentation

◆ vtkRenderState()

vtkRenderState::vtkRenderState ( vtkRenderer renderer)

Constructor.

All values are initialized to 0 or NULL.

Precondition
renderer_exists: renderer!=0
Postcondition
renderer_is_set: GetRenderer()==renderer.
valid_state: IsValid()

◆ ~vtkRenderState()

vtkRenderState::~vtkRenderState ( )

Destructor.

As a vtkRenderState does not own any of its variables, the destructor does nothing.

Member Function Documentation

◆ IsValid()

bool vtkRenderState::IsValid ( ) const

Tells if the RenderState is a valid one (Renderer is not null).

◆ GetRenderer()

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.

Postcondition
result_exists: result!=0

◆ GetFrameBuffer()

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).

◆ SetFrameBuffer()

void vtkRenderState::SetFrameBuffer ( vtkFrameBufferObjectBase fbo)

Set the FrameBuffer.

See GetFrameBuffer().

Postcondition
is_set: GetFrameBuffer()==fbo

◆ GetWindowSize()

void vtkRenderState::GetWindowSize ( int  size[2]) const

Get the window size of the state.

◆ GetPropArray()

vtkProp** vtkRenderState::GetPropArray ( ) const

Return the array of filtered props.

See SetPropArrayAndCount().

◆ GetPropArrayCount()

int vtkRenderState::GetPropArrayCount ( ) const

Return the size of the array of filtered props.

See SetPropArrayAndCount().

Postcondition
positive_result: result>=0

◆ SetPropArrayAndCount()

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.

Precondition
positive_size: propArrayCount>=0
valid_null_array: propArray!=0 || propArrayCount==0
Postcondition
is_set: GetPropArray()==propArray && GetPropArrayCount()==propArrayCount

◆ GetRequiredKeys()

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.

◆ SetRequiredKeys()

void vtkRenderState::SetRequiredKeys ( vtkInformation keys)

Set the required property keys for the props.

See GetRequiredKeys().

Postcondition
is_set: GetRequiredKeys()==keys

Member Data Documentation

◆ Renderer

vtkRenderer* vtkRenderState::Renderer
protected

The renderer in which the render pass is performed.

It gives access to the RenderWindow, to the props.

Definition at line 131 of file vtkRenderState.h.

◆ FrameBuffer

vtkFrameBufferObjectBase* vtkRenderState::FrameBuffer
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 138 of file vtkRenderState.h.

◆ PropArray

vtkProp** vtkRenderState::PropArray
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.

◆ PropArrayCount

int vtkRenderState::PropArrayCount
protected

Definition at line 149 of file vtkRenderState.h.

◆ RequiredKeys

vtkInformation* vtkRenderState::RequiredKeys
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 156 of file vtkRenderState.h.


The documentation for this class was generated from the following file: