vtkTilesHelper Class Reference

this is a helper class that handles viewport computations when rendering for tile-displays. More...

#include <vtkTilesHelper.h>

Inherits vtkObject.

Public Types
typedef vtkObject	Superclass

Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
bool	GetTileViewport (const double *viewport, int rank, int out_tile_viewport[4])
	Returns (x-origin, y-origin, x-max, y-max) in pixels for a tile with given rank. More...
bool	GetNormalizedTileViewport (const double *viewport, int rank, double out_tile_viewport[4])
	Same as GetTileViewport() except that the returns values are in normalized-display coordinates instead of display coordinates. More...
bool	GetPhysicalViewport (const double *global_viewport, int rank, double out_phyiscal_viewport[4])
	Given a global-viewport for a renderer, returns the physical viewport on the rank indicated. More...
void	GetTileIndex (int rank, int *tileX, int *tileY)
	Given the rank, returns the tile location. More...
virtual void	SetTileDimensions (int, int)
	Set the tile dimensions. More...
void	SetTileDimensions (int [2])
	Set the tile dimensions. More...
virtual int *	GetTileDimensions ()
	Set the tile dimensions. More...
virtual void	GetTileDimensions (int &, int &)
	Set the tile dimensions. More...
virtual void	GetTileDimensions (int [2])
	Set the tile dimensions. More...
virtual void	SetTileMullions (int, int)
	Set the tile mullions in pixels. More...
void	SetTileMullions (int [2])
	Set the tile mullions in pixels. More...
virtual int *	GetTileMullions ()
	Set the tile mullions in pixels. More...
virtual void	GetTileMullions (int &, int &)
	Set the tile mullions in pixels. More...
virtual void	GetTileMullions (int [2])
	Set the tile mullions in pixels. More...
virtual void	SetTileWindowSize (int, int)
	Set the tile size i.e. More...
void	SetTileWindowSize (int [2])
	Set the tile size i.e. More...
virtual int *	GetTileWindowSize ()
	Set the tile size i.e. More...
virtual void	GetTileWindowSize (int &, int &)
	Set the tile size i.e. More...
virtual void	GetTileWindowSize (int [2])
	Set the tile size i.e. More...

Static Public Member Functions
static vtkTilesHelper *	New ()
static int	IsTypeOf (const char *type)
static vtkTilesHelper *	SafeDownCast (vtkObject *o)

Protected Member Functions
	vtkTilesHelper ()
	~vtkTilesHelper ()

Protected Attributes
int	TileDimensions [2]
int	TileMullions [2]
int	TileWindowSize [2]

Detailed Description

this is a helper class that handles viewport computations when rendering for tile-displays.

This assumes that all tiles have the same pixel-size.

Definition at line 30 of file vtkTilesHelper.h.

Member Typedef Documentation

Superclass

typedef vtkObject vtkTilesHelper::Superclass

Definition at line 34 of file vtkTilesHelper.h.

Constructor & Destructor Documentation

vtkTilesHelper()

vtkTilesHelper::vtkTilesHelper ( )

protected

~vtkTilesHelper()

vtkTilesHelper::~vtkTilesHelper ( )

protected

Member Function Documentation

New()

static vtkTilesHelper* vtkTilesHelper::New ( )

static

GetClassName()

virtual const char* vtkTilesHelper::GetClassName ( )

virtual

IsTypeOf()

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

static

IsA()

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

virtual

SafeDownCast()

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

static

PrintSelf()

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

SetTileDimensions() [1/2]

virtual void vtkTilesHelper::SetTileDimensions ( int  , int    )

virtual

Set the tile dimensions.

Default is (1, 1).

SetTileDimensions() [2/2]

void vtkTilesHelper::SetTileDimensions

(

int

[2]

)

Set the tile dimensions.

Default is (1, 1).

GetTileDimensions() [1/3]

virtual int* vtkTilesHelper::GetTileDimensions ( )

virtual

Set the tile dimensions.

Default is (1, 1).

GetTileDimensions() [2/3]

virtual void vtkTilesHelper::GetTileDimensions ( int &  , int &    )

virtual

Set the tile dimensions.

Default is (1, 1).

GetTileDimensions() [3/3]

virtual void vtkTilesHelper::GetTileDimensions ( int  [2] )

virtual

Set the tile dimensions.

Default is (1, 1).

SetTileMullions() [1/2]

virtual void vtkTilesHelper::SetTileMullions ( int  , int    )

virtual

Set the tile mullions in pixels.

Use negative numbers to indicate overlap between tiles.

SetTileMullions() [2/2]

void vtkTilesHelper::SetTileMullions

(

int

[2]

)

Set the tile mullions in pixels.

Use negative numbers to indicate overlap between tiles.

GetTileMullions() [1/3]

virtual int* vtkTilesHelper::GetTileMullions ( )

virtual

Set the tile mullions in pixels.

Use negative numbers to indicate overlap between tiles.

GetTileMullions() [2/3]

virtual void vtkTilesHelper::GetTileMullions ( int &  , int &    )

virtual

Set the tile mullions in pixels.

Use negative numbers to indicate overlap between tiles.

GetTileMullions() [3/3]

virtual void vtkTilesHelper::GetTileMullions ( int  [2] )

virtual

Set the tile mullions in pixels.

Use negative numbers to indicate overlap between tiles.

SetTileWindowSize() [1/2]

virtual void vtkTilesHelper::SetTileWindowSize ( int  , int    )

virtual

Set the tile size i.e.

the size of the render window for a tile. We assumes that all tiles have the same size (since that's a requirement for IceT).

SetTileWindowSize() [2/2]

void vtkTilesHelper::SetTileWindowSize

(

int

[2]

)

Set the tile size i.e.

the size of the render window for a tile. We assumes that all tiles have the same size (since that's a requirement for IceT).

GetTileWindowSize() [1/3]

virtual int* vtkTilesHelper::GetTileWindowSize ( )

virtual

Set the tile size i.e.

the size of the render window for a tile. We assumes that all tiles have the same size (since that's a requirement for IceT).

GetTileWindowSize() [2/3]

virtual void vtkTilesHelper::GetTileWindowSize ( int &  , int &    )

virtual

Set the tile size i.e.

the size of the render window for a tile. We assumes that all tiles have the same size (since that's a requirement for IceT).

GetTileWindowSize() [3/3]

virtual void vtkTilesHelper::GetTileWindowSize ( int  [2] )

virtual

Set the tile size i.e.

the size of the render window for a tile. We assumes that all tiles have the same size (since that's a requirement for IceT).

GetTileViewport()

bool vtkTilesHelper::GetTileViewport	(	const double *	viewport,
		int	rank,
		int	out_tile_viewport[4]
	)

Returns (x-origin, y-origin, x-max, y-max) in pixels for a tile with given rank.

viewport is in normalized display coordinates i.e. in range [0, 1] indicating the viewport covered by the current renderer on the whole i.e. treating all tiles as one large display if TileDimensions > (1, 1). Returns false to indicate the result hasn't been computed.

GetNormalizedTileViewport()

bool vtkTilesHelper::GetNormalizedTileViewport	(	const double *	viewport,
		int	rank,
		double	out_tile_viewport[4]
	)

Same as GetTileViewport() except that the returns values are in normalized-display coordinates instead of display coordinates.

Returns false to indicate the result hasn't been computed.

GetPhysicalViewport()

bool vtkTilesHelper::GetPhysicalViewport	(	const double *	global_viewport,
		int	rank,
		double	out_phyiscal_viewport[4]
	)

Given a global-viewport for a renderer, returns the physical viewport on the rank indicated.

Returns false to indicate the result hasn't been computed.

GetTileIndex()

void vtkTilesHelper::GetTileIndex	(	int	rank,
		int *	tileX,
		int *	tileY
	)

Given the rank, returns the tile location.

Member Data Documentation

TileDimensions

int vtkTilesHelper::TileDimensions[2]

protected

Definition at line 96 of file vtkTilesHelper.h.

TileMullions

int vtkTilesHelper::TileMullions[2]

protected

Definition at line 97 of file vtkTilesHelper.h.

TileWindowSize

int vtkTilesHelper::TileWindowSize[2]

protected

Definition at line 98 of file vtkTilesHelper.h.

---

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

• /builddir/build/BUILD/ParaView-v5.2.0/ParaViewCore/VTKExtensions/Rendering/vtkTilesHelper.h