#include <vtkViewLayout.h>

Inheritance diagram for vtkViewLayout:

Collaboration diagram for vtkViewLayout:

[legend]

Public Types
enum	{ RequestUpdateLayoutEvent = vtkCommand::UserEvent + 1, RequestUpdateDisplayEvent }

typedef vtkObject	Superclass

Public Member Functions
virtual const char *	GetClassName ()

virtual int	IsA (const char *type)

void	PrintSelf (ostream &os, vtkIndent indent) override

void	ShowOnTileDisplay ()
	This method is called to make this layout the one to be shown on the tile display, if any. More...

bool	SaveAsPNG (int rank, const char *fname)
	Intended for testing and debugging. More...


void	RemoveAllViews ()
	Add/remove views in this layout. More...

void	AddView (vtkPVView , const double viewport)
	Add/remove views in this layout. More...

void	AddView (vtkPVComparativeView , const double viewport)
	Add/remove views in this layout. More...


virtual void	SetSeparatorColor (double, double, double)
	Set the color to use for separator between views in multi-view configurations when saving images. More...

virtual void	SetSeparatorColor (double [3])
	Set the color to use for separator between views in multi-view configurations when saving images. More...

virtual double *	GetSeparatorColor ()
	Set the color to use for separator between views in multi-view configurations when saving images. More...

virtual void	GetSeparatorColor (double &, double &, double &)
	Set the color to use for separator between views in multi-view configurations when saving images. More...

virtual void	GetSeparatorColor (double [3])
	Set the color to use for separator between views in multi-view configurations when saving images. More...


virtual void	SetSeparatorWidth (int)
	Get/Set the separator width (in pixels) to use for separator between views in multi-view configurations. More...

virtual int	GetSeparatorWidth ()
	Get/Set the separator width (in pixels) to use for separator between views in multi-view configurations. 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 vtkViewLayout *	New ()

static int	IsTypeOf (const char *type)

static vtkViewLayout *	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
	vtkViewLayout ()

	~vtkViewLayout () override

void	UpdateLayout (vtkObject , unsigned long, void )

void	UpdateLayoutForTileDisplay (vtkRenderWindow *)

void	UpdateLayoutForCAVE (vtkRenderWindow *)

void	UpdateDisplay (vtkObject , unsigned long, void )

void	Paint (vtkViewport *)

bool	NeedsActiveStereo () const
	Returns true if any of the layout needs active stereo for current render. 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...

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

Friends
class	vtkViewLayoutProp

Additional Inherited Members
Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

used by vtkSMViewLayoutProxy.

vtkViewLayout is the server-side object corresponding to vtkSMViewLayoutProxy. vtkSMViewLayoutProxy corresponds to a single layout of views. In ParaView UI, this corresponds to a single tab. In tile-display mode, the server-side only has "1 tab", in a manner of speaking. Thus, we need to ensure that the server shows the views laid out in the active tab. This class helps vtkSMViewLayoutProxy do that.

In addition, in tile display mode this class handles setting of window size and positions for each view known to the layout before any of view renders. Additionally, it also handles pasting back rendering results on the processes specific render window (see vtkPVProcessWindow), if any, if appropriate for current mode e.g. in tile display mode, CAVE mode, client-server mode when PV_DEBUG_REMOTE_RENDERING is set or on root node in batch mode.

Definition at line 38 of file vtkViewLayout.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkViewLayout::Superclass

Definition at line 42 of file vtkViewLayout.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
RequestUpdateLayoutEvent	Event fired by vtkPVView's internal render window to request update of the layout before a window is rendered.
RequestUpdateDisplayEvent	Event fired by vtkPVView's internal render window to request update of the layout after a window is rendered.

Definition at line 86 of file vtkViewLayout.h.

Constructor & Destructor Documentation

◆ vtkViewLayout()

vtkViewLayout::vtkViewLayout ( )

protected

◆ ~vtkViewLayout()

vtkViewLayout::~vtkViewLayout ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkViewLayout* vtkViewLayout::New ( )

static

◆ GetClassName()

virtual const char* vtkViewLayout::GetClassName ( )

virtual

◆ IsTypeOf()

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

static

◆ IsA()

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

virtual

Reimplemented from vtkObjectBase.

◆ SafeDownCast()

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

static

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkObject.

◆ ShowOnTileDisplay()

void vtkViewLayout::ShowOnTileDisplay ( )

This method is called to make this layout the one to be shown on the tile display, if any.

This will deactivate the previously chosen layout, if any.

◆ RemoveAllViews()

void vtkViewLayout::RemoveAllViews ( )

Add/remove views in this layout.

◆ AddView() [1/2]

void vtkViewLayout::AddView	(	vtkPVView *	,
		const double *	viewport
	)

Add/remove views in this layout.

◆ AddView() [2/2]

void vtkViewLayout::AddView	(	vtkPVComparativeView *	,
		const double *	viewport
	)

Add/remove views in this layout.

◆ SaveAsPNG()

bool vtkViewLayout::SaveAsPNG	(	int	rank,
		const char *	fname
	)

Intended for testing and debugging.

When called, this will save the layout results to an png file.