ParaView
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkTileDisplayHelper Class Reference

used on server side in tile display mode, to ensure that the tiles from multiple views are rendered correctly. More...

#include <vtkTileDisplayHelper.h>

Inherits vtkObject.

Public Member Functions

void SetTile (unsigned int key, double viewport[4], vtkRenderer *renderer, vtkSynchronizedRenderers::vtkRawImage &tile)
 Register a tile. More...
 
void EraseTile (unsigned int key)
 Erase a tile. More...
 
void EraseTile (unsigned int key, int leftEye)
 Same as EraseTile() except erases the tile for only the specified eye. More...
 
void FlushTiles (unsigned int key, int leftEye)
 Flush the tiles. More...
 
void SetDumpImagePath (const char *newPath)
 
void ResetEnabledKeys ()
 Set the enabled tiles-set. More...
 
void EnableKey (unsigned int)
 Set the enabled tiles-set. More...
 

Static Public Member Functions

static vtkTileDisplayHelperGetInstance ()
 Returns the singleton. More...
 

Protected Member Functions

 vtkTileDisplayHelper ()
 
 ~vtkTileDisplayHelper ()
 
typedef vtkObject Superclass
 Only one instance by process should be used, that's why everyone should use the instance returned by the GetInstance() methods. More...
 
static vtkTileDisplayHelperNew ()
 Only one instance by process should be used, that's why everyone should use the instance returned by the GetInstance() methods. More...
 
static int IsTypeOf (const char *type)
 Only one instance by process should be used, that's why everyone should use the instance returned by the GetInstance() methods. More...
 
static vtkTileDisplayHelperSafeDownCast (vtkObject *o)
 Only one instance by process should be used, that's why everyone should use the instance returned by the GetInstance() methods. More...
 
virtual const char * GetClassName ()
 Only one instance by process should be used, that's why everyone should use the instance returned by the GetInstance() methods. More...
 
virtual int IsA (const char *type)
 Only one instance by process should be used, that's why everyone should use the instance returned by the GetInstance() methods. More...
 
void PrintSelf (ostream &os, vtkIndent indent)
 Only one instance by process should be used, that's why everyone should use the instance returned by the GetInstance() methods. More...
 

Detailed Description

used on server side in tile display mode, to ensure that the tiles from multiple views are rendered correctly.

vtkTileDisplayHelper is used on server side in tile display mode, to ensure that the tiles from multiple views are rendered correctly. This is required since in multi-view configurations, only 1 view is rendered at a time, and when a view is being rendered, it may affect the renderings from other view which it must restore for the tile display to show the results correctly. We use this helper to keep buffered images from all views so that they can be restored.

Definition at line 38 of file vtkTileDisplayHelper.h.

Member Typedef Documentation

§ Superclass

Only one instance by process should be used, that's why everyone should use the instance returned by the GetInstance() methods.

But to allow that class to be used by a proxy, we need to expose the new. Beaware that a subset of methods will be available to the proxy.

Definition at line 49 of file vtkTileDisplayHelper.h.

Constructor & Destructor Documentation

§ vtkTileDisplayHelper()

vtkTileDisplayHelper::vtkTileDisplayHelper ( )
protected

§ ~vtkTileDisplayHelper()

vtkTileDisplayHelper::~vtkTileDisplayHelper ( )
protected

Member Function Documentation

§ New()

static vtkTileDisplayHelper* vtkTileDisplayHelper::New ( )
static

Only one instance by process should be used, that's why everyone should use the instance returned by the GetInstance() methods.

But to allow that class to be used by a proxy, we need to expose the new. Beaware that a subset of methods will be available to the proxy.

§ GetClassName()

virtual const char* vtkTileDisplayHelper::GetClassName ( )
virtual

Only one instance by process should be used, that's why everyone should use the instance returned by the GetInstance() methods.

But to allow that class to be used by a proxy, we need to expose the new. Beaware that a subset of methods will be available to the proxy.

§ IsTypeOf()

static int vtkTileDisplayHelper::IsTypeOf ( const char *  type)
static

Only one instance by process should be used, that's why everyone should use the instance returned by the GetInstance() methods.

But to allow that class to be used by a proxy, we need to expose the new. Beaware that a subset of methods will be available to the proxy.

§ IsA()

virtual int vtkTileDisplayHelper::IsA ( const char *  type)
virtual

Only one instance by process should be used, that's why everyone should use the instance returned by the GetInstance() methods.

But to allow that class to be used by a proxy, we need to expose the new. Beaware that a subset of methods will be available to the proxy.

§ SafeDownCast()

static vtkTileDisplayHelper* vtkTileDisplayHelper::SafeDownCast ( vtkObject *  o)
static

Only one instance by process should be used, that's why everyone should use the instance returned by the GetInstance() methods.

But to allow that class to be used by a proxy, we need to expose the new. Beaware that a subset of methods will be available to the proxy.

§ PrintSelf()

void vtkTileDisplayHelper::PrintSelf ( ostream &  os,
vtkIndent  indent 
)

Only one instance by process should be used, that's why everyone should use the instance returned by the GetInstance() methods.

But to allow that class to be used by a proxy, we need to expose the new. Beaware that a subset of methods will be available to the proxy.

§ GetInstance()

static vtkTileDisplayHelper* vtkTileDisplayHelper::GetInstance ( )
static

Returns the singleton.

§ SetTile()

void vtkTileDisplayHelper::SetTile ( unsigned int  key,
double  viewport[4],
vtkRenderer *  renderer,
vtkSynchronizedRenderers::vtkRawImage &  tile 
)

Register a tile.

§ EraseTile() [1/2]

void vtkTileDisplayHelper::EraseTile ( unsigned int  key)

Erase a tile.

§ EraseTile() [2/2]

void vtkTileDisplayHelper::EraseTile ( unsigned int  key,
int  leftEye 
)

Same as EraseTile() except erases the tile for only the specified eye.

§ FlushTiles()

void vtkTileDisplayHelper::FlushTiles ( unsigned int  key,
int  leftEye 
)

Flush the tiles.

§ ResetEnabledKeys()

void vtkTileDisplayHelper::ResetEnabledKeys ( )

Set the enabled tiles-set.

Only enabled keys are "flushed".

§ EnableKey()

void vtkTileDisplayHelper::EnableKey ( unsigned  int)

Set the enabled tiles-set.

Only enabled keys are "flushed".

§ SetDumpImagePath()

void vtkTileDisplayHelper::SetDumpImagePath ( const char *  newPath)
  • Method that can be used by the proxy.
  • The Path will be used to save the latest flush of the tiles.
  • Basically for a 2 processes tile display setting you will have two images dumped following the given pattern: ${DumpImagePath}_${processId}.png
  • If the DumpImagePath is set to NULL, then no image dump will occurs.

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