vtkTilesHelper Class Reference

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

#include <vtkTilesHelper.h>

Inheritance diagram for vtkTilesHelper:

Collaboration diagram for vtkTilesHelper:

Public Types
typedef vtkObject	Superclass

Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent) override
bool	GetTiledSizeAndOrigin (int rank, vtkVector2i &size, vtkVector2i &lowerLeft) const
	For the specified rank, returns the tile size and origin of the tile rendered by the rank in display coordinates. More...
bool	GetTiledSizeAndOrigin (int rank, vtkVector2i &size, vtkVector2i &lowerLeft, vtkVector4d viewport) const
	A GetTiledSizeAndOrigin overload that takes in a viewport expressed as (xmin, ymin, xmax, ymax) where each coordinate is in the range [0, 1.0] (same as vtkViewport::SetViewport). More...
bool	GetTileViewport (int rank, vtkVector4d &tile_viewport) const
	Provides the viewport for the tile displayed on the rank, if any. More...
bool	GetTileIndex (int rank, int *tileX, int *tileY) const
	Given the rank, returns the tile location. More...
bool	GetTileEnabled (int rank) const
	Returns true if current rank will render a tile. 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...
Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
virtual void	DebugOff ()
bool	GetDebug ()
void	SetDebug (bool debugFlag)
virtual void	Modified ()
virtual vtkMTimeType	GetMTime ()
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
int	HasObserver (unsigned long event)
int	HasObserver (const char *event)
int	InvokeEvent (unsigned long event)
int	InvokeEvent (const char *event)
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommand *	GetCommand (unsigned long tag)
void	RemoveObserver (vtkCommand *)
void	RemoveObservers (unsigned long event, vtkCommand *)
void	RemoveObservers (const char *event, vtkCommand *)
int	HasObserver (unsigned long event, vtkCommand *)
int	HasObserver (const char *event, vtkCommand *)
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
unsigned long	AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int	InvokeEvent (unsigned long event, void *callData)
int	InvokeEvent (const char *event, void *callData)
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommand *	GetCommand (unsigned long tag)
void	RemoveObserver (vtkCommand *)
void	RemoveObservers (unsigned long event, vtkCommand *)
void	RemoveObservers (const char *event, vtkCommand *)
int	HasObserver (unsigned long event, vtkCommand *)
int	HasObserver (const char *event, vtkCommand *)
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
unsigned long	AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int	InvokeEvent (unsigned long event, void *callData)
int	InvokeEvent (const char *event, void *callData)
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
virtual void	Delete ()
virtual void	FastDelete ()
void	Print (ostream &os)
virtual void	Register (vtkObjectBase *o)
virtual void	UnRegister (vtkObjectBase *o)
void	SetReferenceCount (int)
virtual void	PrintHeader (ostream &os, vtkIndent indent)
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
int	GetReferenceCount ()
void	PrintRevisions (ostream &)
virtual void	PrintHeader (ostream &os, vtkIndent indent)
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
int	GetReferenceCount ()
void	PrintRevisions (ostream &)

Static Public Member Functions
static vtkTilesHelper *	New ()
static int	IsTypeOf (const char *type)
static vtkTilesHelper *	SafeDownCast (vtkObject *o)
Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
static void	BreakOnError ()
static void	SetGlobalWarningDisplay (int val)
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static int	GetGlobalWarningDisplay ()
static void	SetGlobalWarningDisplay (int val)
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static int	GetGlobalWarningDisplay ()
Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
static vtkObjectBase *	New ()
static vtkObjectBase *	New ()

Protected Member Functions
	vtkTilesHelper ()
	~vtkTilesHelper () override
Protected Member Functions inherited from vtkObject
	vtkObject ()
virtual	~vtkObject ()
void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE
void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void	InternalReleaseFocus ()
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void	InternalReleaseFocus ()
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	CollectRevisions (ostream &)
virtual void	ReportReferences (vtkGarbageCollector *)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Protected Attributes
int	TileDimensions [2]
int	TileMullions [2]
int	TileWindowSize [2]
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount
vtkWeakPointerBase **	WeakPointers

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 19 of file vtkTilesHelper.h.

Member Typedef Documentation

Superclass

typedef vtkObject vtkTilesHelper::Superclass

Definition at line 23 of file vtkTilesHelper.h.

Constructor & Destructor Documentation

vtkTilesHelper()

vtkTilesHelper::vtkTilesHelper ( )

protected

~vtkTilesHelper()

vtkTilesHelper::~vtkTilesHelper ( )

overrideprotected

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

Reimplemented from vtkObjectBase.

SafeDownCast()

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

static

PrintSelf()

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

overridevirtual

Reimplemented from vtkObject.

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 single tile. An assumption, in ParaView is that all tiles will be of the same size.

SetTileWindowSize() [2/2]

void vtkTilesHelper::SetTileWindowSize

(

int

[2]

)

Set the tile size i.e.

the size of the render window for a single tile. An assumption, in ParaView is that all tiles will be of the same size.

GetTileWindowSize() [1/3]

virtual int* vtkTilesHelper::GetTileWindowSize ( )

virtual

Set the tile size i.e.

the size of the render window for a single tile. An assumption, in ParaView is that all tiles will be of the same size.

GetTileWindowSize() [2/3]

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

virtual

Set the tile size i.e.

the size of the render window for a single tile. An assumption, in ParaView is that all tiles will be of the same size.

GetTileWindowSize() [3/3]

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

virtual

Set the tile size i.e.

the size of the render window for a single tile. An assumption, in ParaView is that all tiles will be of the same size.

GetTiledSizeAndOrigin() [1/2]

bool vtkTilesHelper::GetTiledSizeAndOrigin	(	int	rank,
		vtkVector2i &	size,
		vtkVector2i &	lowerLeft
	)		const

For the specified rank, returns the tile size and origin of the tile rendered by the rank in display coordinates.

If the rank is not expected to render an tile then returns false and size and lowerLeft will be left unchanged. Otherwise, returns true after updating size and lowerLeft appropriately.

GetTiledSizeAndOrigin() [2/2]

bool vtkTilesHelper::GetTiledSizeAndOrigin	(	int	rank,
		vtkVector2i &	size,
		vtkVector2i &	lowerLeft,
		vtkVector4d	viewport
	)		const

A GetTiledSizeAndOrigin overload that takes in a viewport expressed as (xmin, ymin, xmax, ymax) where each coordinate is in the range [0, 1.0] (same as vtkViewport::SetViewport).

The size and origin returned are limited to the specified viewport.

GetTileViewport()

bool vtkTilesHelper::GetTileViewport	(	int	rank,
		vtkVector4d &	tile_viewport
	)		const

Provides the viewport for the tile displayed on the rank, if any.

Returns false if the rank is not expected to display a tile. Otherwise returns true after updating tile_viewport to the result.

GetTileIndex()

bool vtkTilesHelper::GetTileIndex	(	int	rank,
		int *	tileX,
		int *	tileY
	)		const

Given the rank, returns the tile location.

Returns false if the rank is not expected to render any tile.

GetTileEnabled()

bool vtkTilesHelper::GetTileEnabled ( int  rank ) const

inline

Returns true if current rank will render a tile.

Definition at line 86 of file vtkTilesHelper.h.

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:

• /builds/gitlab-kitware-sciviz-ci/Remoting/Views/vtkTilesHelper.h