vtkPVView Class Reference

baseclass for all ParaView views. More...

#include <vtkPVView.h>

Inheritance diagram for vtkPVView:

Collaboration diagram for vtkPVView:

Public Types
typedef vtkView	Superclass
Public Types inherited from vtkView
typedef vtkObject	Superclass

Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent) override
virtual void	SetPPI (int)
	Description: Set the screen PPI. More...
virtual int	GetPPI ()
virtual void	StillRender ()=0
	Triggers a high-resolution render. More...
virtual void	InteractiveRender ()=0
	Triggers a interactive render. More...
virtual bool	GetViewTimeValid ()
	Get ViewTimeValid. More...
void	Update () override
	Overridden to not call Update() directly on the input representations, instead use ProcessViewRequest() for all vtkPVDataRepresentations. More...
bool	InTileDisplayMode ()
	Returns true if the application is currently in tile display mode. More...
bool	InCaveDisplayMode ()
	Returns true if the application is currently in cave/immersive display mode. More...
bool	GetLocalProcessSupportsInteraction ()
	Returns true if the local process can support interaction. More...
vtkRenderWindow *	GetRenderWindow ()
	If this view needs a render window (not all views may use one), this method can be used to get the render window associated with this view on the current process. More...
virtual void	ScaleRendererViewports (const double viewport[4])
	vtkViewLayout calls this method to update the total viewport available for this view. More...
vtkMTimeType	GetUpdateTimeStamp ()
	Provides access to the time when Update() was last called. More...
virtual void	Deliver (int use_lod, unsigned int size, unsigned int *representation_ids)
	Called on all processes to request data-delivery for the list of representations. More...
virtual bool	IsCached (vtkPVDataRepresentation *)
	Called in vtkPVDataRepresentation::ProcessViewRequest to check if the representation already has cached data. More...
virtual void	ClearCache (vtkPVDataRepresentation *)
	Called by vtkPVDataRepresentation whenever vtkPVDataRepresentation::MarkModified is called. More...
virtual void	SetPosition (int, int)
	Set the position on this view in the multiview configuration. More...
virtual int *	GetPosition ()
	Set the position on this view in the multiview configuration. More...
virtual void	GetPosition (int &, int &)
	Set the position on this view in the multiview configuration. More...
virtual void	GetPosition (int [2])
	Set the position on this view in the multiview configuration. More...
virtual void	SetSize (int, int)
	Set the size of this view in the multiview configuration. More...
virtual int *	GetSize ()
	Set the size of this view in the multiview configuration. More...
virtual void	GetSize (int &, int &)
	Set the size of this view in the multiview configuration. More...
virtual void	GetSize (int [2])
	Set the size of this view in the multiview configuration. More...
virtual void	SetViewTime (double value)
	Get/Set the time this view is showing. More...
virtual double	GetViewTime ()
	Get/Set the time this view is showing. More...
virtual void	SetCacheKey (double)
	Get/Set the cache key. More...
virtual double	GetCacheKey ()
	Get/Set the cache key. More...
virtual void	SetUseCache (bool)
	Get/Set whether caching is enabled. More...
virtual bool	GetUseCache ()
	Get/Set whether caching is enabled. More...
virtual void	PrepareForScreenshot ()
	These methods are used to setup the view for capturing screen shots. More...
virtual void	CleanupAfterScreenshot ()
	These methods are used to setup the view for capturing screen shots. More...
void	SetTileScale (int x, int y)
	When saving screenshots with tiling, these methods get called. More...
void	SetTileViewport (double x0, double y0, double x1, double y1)
	When saving screenshots with tiling, these methods get called. More...
virtual void	SetLogName (const std::string &name)
	This is solely intended to simplify debugging and use for any other purpose is vehemently discouraged. More...
const std::string &	GetLogName () const
	This is solely intended to simplify debugging and use for any other purpose is vehemently discouraged. More...
void	SetDeliveryManager (vtkPVDataDeliveryManager *)
	Provides access to data delivery & cache manager for this view. More...
virtual vtkPVDataDeliveryManager *	GetDeliveryManager ()
	Provides access to data delivery & cache manager for this view. More...
Public Member Functions inherited from vtkView
vtkView *	NewInstance () const
void	AddRepresentation (vtkDataRepresentation *rep)
void	SetRepresentation (vtkDataRepresentation *rep)
vtkDataRepresentation *	AddRepresentationFromInputConnection (vtkAlgorithmOutput *conn)
vtkDataRepresentation *	SetRepresentationFromInputConnection (vtkAlgorithmOutput *conn)
vtkDataRepresentation *	AddRepresentationFromInput (vtkDataObject *input)
vtkDataRepresentation *	SetRepresentationFromInput (vtkDataObject *input)
void	RemoveRepresentation (vtkDataRepresentation *rep)
void	RemoveRepresentation (vtkAlgorithmOutput *rep)
void	RemoveAllRepresentations ()
int	GetNumberOfRepresentations ()
vtkDataRepresentation *	GetRepresentation (int index=0)
bool	IsRepresentationPresent (vtkDataRepresentation *rep)
virtual void	ApplyViewTheme (vtkViewTheme *vtkNotUsed(theme))
vtkCommand *	GetObserver ()
void	RegisterProgress (vtkObject *algorithm, const char *message=NULL)
void	UnRegisterProgress (vtkObject *algorithm)
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 int	IsTypeOf (const char *type)
static vtkPVView *	SafeDownCast (vtkObject *o)
static void	SetEnableStreaming (bool)
static bool	GetEnableStreaming ()
static vtkInformationObjectBaseKey *	VIEW ()
	Key used to pass the vtkPVView pointer to the representation during any of the view passes such as REQUEST_UPDATE(), REQUEST_UPDATE_LOD(), REQUEST_RENDER(), etc. More...
static vtkInformationRequestKey *	REQUEST_UPDATE ()
	This is a Update-Data pass. More...
static vtkInformationRequestKey *	REQUEST_UPDATE_LOD ()
	This is a Update-LOD-Data pass. More...
static vtkInformationRequestKey *	REQUEST_RENDER ()
	This is a render pass. More...
static void	SetPiece (vtkInformation *info, vtkPVDataRepresentation *repr, vtkDataObject *data, unsigned long trueSize=0, int port=0)
static vtkDataObject *	GetPiece (vtkInformation *info, vtkPVDataRepresentation *repr, int port=0)
static vtkDataObject *	GetDeliveredPiece (vtkInformation *info, vtkPVDataRepresentation *repr, int port=0)
static void	SetPieceLOD (vtkInformation *info, vtkPVDataRepresentation *repr, vtkDataObject *data, unsigned long trueSize=0, int port=0)
static vtkDataObject *	GetPieceLOD (vtkInformation *info, vtkPVDataRepresentation *repr, int port=0)
static vtkDataObject *	GetDeliveredPieceLOD (vtkInformation *info, vtkPVDataRepresentation *repr, int port=0)
static void	SetUseGenericOpenGLRenderWindow (bool val)
	Use this to indicate that the process should use vtkGenericOpenGLRenderWindow rather than vtkRenderWindow when creating an new render window. More...
static bool	GetUseGenericOpenGLRenderWindow ()
	Use this to indicate that the process should use vtkGenericOpenGLRenderWindow rather than vtkRenderWindow when creating an new render window. More...
Static Public Member Functions inherited from vtkView
static vtkView *	New ()
static int	IsTypeOf (const char *type)
static vtkView *	SafeDownCast (vtkObjectBase *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
	vtkPVView (bool create_render_window=true)
	~vtkPVView () override
vtkRenderWindow *	NewRenderWindow ()
	Subclasses should use this method to create new render windows instead of directly creating a new one. More...
void	SetRenderWindow (vtkRenderWindow *)
	Subclasses can use this method to set the render window created for this view. More...
void	AllReduce (const vtkBoundingBox &source, vtkBoundingBox &dest)
	Reduce bounding box between all participating processes. More...
void	AllReduce (vtkTypeUInt64 source, vtkTypeUInt64 &dest, int operation, bool skip_data_server=false)
	Reduce between all participating processes using the operation (vtkCommunicator::StandardOperations) specified. More...
vtkPVSession *	GetSession ()
virtual bool	GetInCaptureScreenshot ()
	Flag set to true between calls to PrepareForScreenshot and CleanupAfterScreenshot. More...
void	SynchronizeRepresentationTemporalPipelineStates ()
	Called in Update() to sync HasTemporalPipeline flags between representations on all processes. More...
void	AddRepresentationInternal (vtkDataRepresentation *rep) override
	Overridden to assign IDs to each representation. More...
void	RemoveRepresentationInternal (vtkDataRepresentation *rep) override
	Overridden to assign IDs to each representation. More...
int	CallProcessViewRequest (vtkInformationRequestKey *passType, vtkInformation *request, vtkInformationVector *reply)
	Subclasses can use this method to trigger a pass on all representations. More...
Protected Member Functions inherited from vtkView
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkView ()
	~vtkView ()
virtual vtkDataRepresentation *	CreateDefaultRepresentation (vtkAlgorithmOutput *conn)
virtual void	ProcessEvents (vtkObject *caller, unsigned long eventId, void *callData)
virtual void	AddRepresentationInternal (vtkDataRepresentation *vtkNotUsed(rep))
virtual void	RemoveRepresentationInternal (vtkDataRepresentation *vtkNotUsed(rep))
virtual void	ProcessEvents (vtkObject *caller, unsigned long eventId, void *callData)
virtual void	AddRepresentationInternal (vtkDataRepresentation *vtkNotUsed(rep))
virtual void	RemoveRepresentationInternal (vtkDataRepresentation *vtkNotUsed(rep))
virtual void	SetReuseSingleRepresentation (bool)
virtual bool	GetReuseSingleRepresentation ()
virtual void	ReuseSingleRepresentationOn ()
virtual void	ReuseSingleRepresentationOff ()
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 &)

Static Protected Member Functions
static vtkPVDataDeliveryManager *	GetDeliveryManager (vtkInformation *info)

Protected Attributes
double	ViewTime
double	CacheKey
bool	UseCache
int	Size [2]
int	Position [2]
int	PPI
vtkTimeStamp	UpdateTimeStamp
	Keeps track of the time when vtkPVRenderView::Update() was called. More...
vtkInformation *	RequestInformation
	These are passed as arguments to vtkDataRepresentation::ProcessViewRequest(). More...
vtkInformationVector *	ReplyInformationVector
	These are passed as arguments to vtkDataRepresentation::ProcessViewRequest(). More...
Protected Attributes inherited from vtkView
bool	ReuseSingleRepresentation
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Detailed Description

baseclass for all ParaView views.

vtkPVView adds API to vtkView for ParaView specific views. Typically, one writes a simple vtkView subclass for their custom view. Then one subclasses vtkPVView to use their own vtkView subclass with added support for parallel rendering, tile-displays and client-server. Even if the view is client-only view, it needs to address these other configuration gracefully.

Definition at line 32 of file vtkPVView.h.

Member Typedef Documentation

Superclass

typedef vtkView vtkPVView::Superclass

Definition at line 35 of file vtkPVView.h.

Constructor & Destructor Documentation

vtkPVView()

vtkPVView::vtkPVView ( bool  create_render_window = true )

protected

~vtkPVView()

vtkPVView::~vtkPVView ( )

overrideprotected

Member Function Documentation

GetClassName()

virtual const char* vtkPVView::GetClassName ( )

virtual

Reimplemented in vtkPVXYChartView, vtkPVRenderView, vtkPVPlotMatrixView, vtkPVContextView, vtkPVOrthographicSliceView, vtkSpreadSheetView, vtkPythonView, vtkPVRenderViewWithEDL, and vtkPVMultiSliceView.

IsTypeOf()

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

static

IsA()

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

virtual

Reimplemented from vtkView.

Reimplemented in vtkPVXYChartView, vtkPVRenderView, vtkPVPlotMatrixView, vtkPVContextView, vtkPVOrthographicSliceView, vtkSpreadSheetView, vtkPythonView, vtkPVRenderViewWithEDL, and vtkPVMultiSliceView.

SafeDownCast()

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

static

PrintSelf()

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

overridevirtual

Reimplemented from vtkView.

Reimplemented in vtkPVXYChartView, vtkSpreadSheetView, and vtkPythonView.

SetEnableStreaming()

static void vtkPVView::SetEnableStreaming ( bool  )

static

GetEnableStreaming()

static bool vtkPVView::GetEnableStreaming ( )

static

SetPosition()

virtual void vtkPVView::SetPosition ( int  , int    )

virtual

Set the position on this view in the multiview configuration.

Note

CallOnAllProcesses

Reimplemented in vtkPVRenderView.

GetPosition() [1/3]

virtual int* vtkPVView::GetPosition ( )

virtual

Set the position on this view in the multiview configuration.

Note

CallOnAllProcesses

GetPosition() [2/3]

virtual void vtkPVView::GetPosition ( int &  , int &    )

virtual

Set the position on this view in the multiview configuration.

Note

CallOnAllProcesses

GetPosition() [3/3]

virtual void vtkPVView::GetPosition ( int  [2] )

virtual

Set the position on this view in the multiview configuration.

Note

CallOnAllProcesses

SetSize()

virtual void vtkPVView::SetSize ( int  , int    )

virtual

Set the size of this view in the multiview configuration.

Note

CallOnAllProcesses

Reimplemented in vtkPVRenderView.

GetSize() [1/3]

virtual int* vtkPVView::GetSize ( )

virtual

Set the size of this view in the multiview configuration.

Note

CallOnAllProcesses

GetSize() [2/3]

virtual void vtkPVView::GetSize ( int &  , int &    )

virtual

Set the size of this view in the multiview configuration.

Note

CallOnAllProcesses

GetSize() [3/3]

virtual void vtkPVView::GetSize ( int  [2] )

virtual

Set the size of this view in the multiview configuration.

Note

CallOnAllProcesses

SetPPI()

virtual void vtkPVView::SetPPI ( int  )

virtual

Description: Set the screen PPI.

Note

CallOnAllProcesses

GetPPI()

virtual int vtkPVView::GetPPI ( )

virtual

StillRender()

virtual void vtkPVView::StillRender ( )

pure virtual

Triggers a high-resolution render.

Note

CallOnAllProcesses

Implemented in vtkPVRenderView, vtkPythonView, vtkSpreadSheetView, and vtkPVContextView.

InteractiveRender()

virtual void vtkPVView::InteractiveRender ( )

pure virtual

Triggers a interactive render.

Based on the settings on the view, this may result in a low-resolution rendering or a simplified geometry rendering.

Note

CallOnAllProcesses

Implemented in vtkPVRenderView, vtkPythonView, vtkSpreadSheetView, and vtkPVContextView.

SetViewTime()

virtual void vtkPVView::SetViewTime ( double  value )

virtual

Get/Set the time this view is showing.

Note

CallOnAllProcesses

Reimplemented in vtkPVRenderView.

GetViewTime()

virtual double vtkPVView::GetViewTime ( )

virtual

Get/Set the time this view is showing.

Note

CallOnAllProcesses

GetViewTimeValid()

virtual bool vtkPVView::GetViewTimeValid ( )

virtual

Get ViewTimeValid.

SetCacheKey()

virtual void vtkPVView::SetCacheKey ( double  )

virtual

Get/Set the cache key.

When caching is enabled, this key is used to identify what geometry cache to use for the current render. It is passed on to the representations in vtkPVView::Update(). The CacheKey is respected only when UseCache is true.

Note

CallOnAllProcesses

GetCacheKey()

virtual double vtkPVView::GetCacheKey ( )

virtual

Get/Set the cache key.

When caching is enabled, this key is used to identify what geometry cache to use for the current render. It is passed on to the representations in vtkPVView::Update(). The CacheKey is respected only when UseCache is true.

Note

CallOnAllProcesses

SetUseCache()

virtual void vtkPVView::SetUseCache ( bool  )

virtual

Get/Set whether caching is enabled.

Note

CallOnAllProcesses

GetUseCache()

virtual bool vtkPVView::GetUseCache ( )

virtual

Get/Set whether caching is enabled.

Note

CallOnAllProcesses

PrepareForScreenshot()

virtual void vtkPVView::PrepareForScreenshot ( )

virtual

These methods are used to setup the view for capturing screen shots.

CleanupAfterScreenshot()

virtual void vtkPVView::CleanupAfterScreenshot ( )

virtual

These methods are used to setup the view for capturing screen shots.

VIEW()

static vtkInformationObjectBaseKey* vtkPVView::VIEW ( )

static

Key used to pass the vtkPVView pointer to the representation during any of the view passes such as REQUEST_UPDATE(), REQUEST_UPDATE_LOD(), REQUEST_RENDER(), etc.

REQUEST_UPDATE()

static vtkInformationRequestKey* vtkPVView::REQUEST_UPDATE ( )

static

This is a Update-Data pass.

All representations are expected to update their inputs and prepare geometries for rendering. All heavy work that has to happen only when input-data changes can be done in this pass. This is the first pass.

REQUEST_UPDATE_LOD()

static vtkInformationRequestKey* vtkPVView::REQUEST_UPDATE_LOD ( )

static

This is a Update-LOD-Data pass.

All representations are expected to update their lod-data, if any. This is assured to be called only after REQUEST_UPDATE() pass.

REQUEST_RENDER()

static vtkInformationRequestKey* vtkPVView::REQUEST_RENDER ( )

static

This is a render pass.

This is called for every render, hence representations should not do any work that doesn't depend on things that could change every render.

Update()

void vtkPVView::Update ( )

overridevirtual

Overridden to not call Update() directly on the input representations, instead use ProcessViewRequest() for all vtkPVDataRepresentations.

Reimplemented from vtkView.

Reimplemented in vtkPVXYChartView, vtkSpreadSheetView, and vtkPythonView.

InTileDisplayMode()

bool vtkPVView::InTileDisplayMode

(

)

Returns true if the application is currently in tile display mode.

InCaveDisplayMode()

bool vtkPVView::InCaveDisplayMode

(

)

Returns true if the application is currently in cave/immersive display mode.

GetLocalProcessSupportsInteraction()

bool vtkPVView::GetLocalProcessSupportsInteraction

(

)

Returns true if the local process can support interaction.

This will return true only on the client node e.g. Qt client (or pvpython) when connected to builtin or remote server. On server nodes this will return false. CAVEAT: Currently this returns true on root node on batch and false on all other nodes. In reality batch processes should not support interaction. Due to a bug in vtkPVAxesWidget, if there's no interactor, the batch mode ends up missing the orientation widget and hence rendering differently than pvpython. To avoid that, this method currently returns true on the root node in batch mode. This will however change in the future once vtkPVAxesWidget has been cleaned up.

GetRenderWindow()

vtkRenderWindow* vtkPVView::GetRenderWindow ( )

inline

If this view needs a render window (not all views may use one), this method can be used to get the render window associated with this view on the current process.

Note that this window may be shared with other views depending on the process on which this is called and the configuration ParaView is running under.

Definition at line 191 of file vtkPVView.h.

SetUseGenericOpenGLRenderWindow()

static void vtkPVView::SetUseGenericOpenGLRenderWindow ( bool  val )

static

Use this to indicate that the process should use vtkGenericOpenGLRenderWindow rather than vtkRenderWindow when creating an new render window.

GetUseGenericOpenGLRenderWindow()

static bool vtkPVView::GetUseGenericOpenGLRenderWindow ( )

static

Use this to indicate that the process should use vtkGenericOpenGLRenderWindow rather than vtkRenderWindow when creating an new render window.

SetTileScale()

void vtkPVView::SetTileScale	(	int	x,
		int	y
	)

When saving screenshots with tiling, these methods get called.

Not to be confused with tile scale and viewport setup on tile display.

See also

vtkViewLayout::UpdateLayoutForTileDisplay

SetTileViewport()

void vtkPVView::SetTileViewport	(	double	x0,
		double	y0,
		double	x1,
		double	y1
	)

When saving screenshots with tiling, these methods get called.

Not to be confused with tile scale and viewport setup on tile display.

See also

vtkViewLayout::UpdateLayoutForTileDisplay

SetLogName()

virtual void vtkPVView::SetLogName ( const std::string &  name )

inlinevirtual

This is solely intended to simplify debugging and use for any other purpose is vehemently discouraged.

Definition at line 219 of file vtkPVView.h.

GetLogName()

const std::string& vtkPVView::GetLogName ( ) const

inline

This is solely intended to simplify debugging and use for any other purpose is vehemently discouraged.

Definition at line 220 of file vtkPVView.h.

ScaleRendererViewports()

virtual void vtkPVView::ScaleRendererViewports ( const double  viewport[4] )

virtual

vtkViewLayout calls this method to update the total viewport available for this view.

Generally, views can assume viewport is [0, 0, 1, 1] i.e. the view has control over the complete window. However, in tile display mode, this may not be the case, and hence a reduced viewport may be passed. Generally, subclasses don't need to do much more than scale viewport for each renderer they create within the provided viewport.

Default implementation iterates over all renderers in the render window and scales each assuming reach render's viewport is [0, 0, 1, 1]. Subclasses may want to override to update renderers for which that is not the case.

Reimplemented in vtkPVRenderView, and vtkPVOrthographicSliceView.

GetUpdateTimeStamp()

vtkMTimeType vtkPVView::GetUpdateTimeStamp ( )

inline

Provides access to the time when Update() was last called.

Definition at line 240 of file vtkPVView.h.

SetDeliveryManager()

void vtkPVView::SetDeliveryManager

(

vtkPVDataDeliveryManager *

)

Provides access to data delivery & cache manager for this view.

GetDeliveryManager() [1/2]

virtual vtkPVDataDeliveryManager* vtkPVView::GetDeliveryManager ( )

virtual

Provides access to data delivery & cache manager for this view.

SetPiece()

static void vtkPVView::SetPiece ( vtkInformation *  info, vtkPVDataRepresentation *  repr, vtkDataObject *  data, unsigned long  trueSize = 0, int  port = 0  )

static

GetPiece()

static vtkDataObject* vtkPVView::GetPiece ( vtkInformation *  info, vtkPVDataRepresentation *  repr, int  port = 0  )

static

GetDeliveredPiece()

static vtkDataObject* vtkPVView::GetDeliveredPiece ( vtkInformation *  info, vtkPVDataRepresentation *  repr, int  port = 0  )

static

SetPieceLOD()

static void vtkPVView::SetPieceLOD ( vtkInformation *  info, vtkPVDataRepresentation *  repr, vtkDataObject *  data, unsigned long  trueSize = 0, int  port = 0  )

static

GetPieceLOD()

static vtkDataObject* vtkPVView::GetPieceLOD ( vtkInformation *  info, vtkPVDataRepresentation *  repr, int  port = 0  )

static

GetDeliveredPieceLOD()

static vtkDataObject* vtkPVView::GetDeliveredPieceLOD ( vtkInformation *  info, vtkPVDataRepresentation *  repr, int  port = 0  )

static

Deliver()

virtual void vtkPVView::Deliver ( int  use_lod, unsigned int  size, unsigned int *  representation_ids  )

virtual

Called on all processes to request data-delivery for the list of representations.

Note this method has to be called on all processes or it may lead to deadlock.

Reimplemented in vtkPVRenderView.

IsCached()

virtual bool vtkPVView::IsCached ( vtkPVDataRepresentation *  )

virtual

Called in vtkPVDataRepresentation::ProcessViewRequest to check if the representation already has cached data.

If so, the representation may choose to not update itself.

ClearCache()

virtual void vtkPVView::ClearCache ( vtkPVDataRepresentation *  )

virtual

Called by vtkPVDataRepresentation whenever vtkPVDataRepresentation::MarkModified is called.

Subclasses may use this method to clear internal caches, if needed.

NewRenderWindow()

vtkRenderWindow* vtkPVView::NewRenderWindow ( )

protected

Subclasses should use this method to create new render windows instead of directly creating a new one.

SetRenderWindow()

void vtkPVView::SetRenderWindow ( vtkRenderWindow *  )

protected

Subclasses can use this method to set the render window created for this view.

AllReduce() [1/2]

void vtkPVView::AllReduce ( const vtkBoundingBox &  source, vtkBoundingBox &  dest  )

protected

Reduce bounding box between all participating processes.

AllReduce() [2/2]

void vtkPVView::AllReduce ( vtkTypeUInt64  source, vtkTypeUInt64 &  dest, int  operation, bool  skip_data_server = false  )

protected

Reduce between all participating processes using the operation (vtkCommunicator::StandardOperations) specified.

Currently only vtkCommunicator::MIN_OP, vtkCommunicator::MAX_OP, and vtkCommunicator::SUM_OP are supported.

AddRepresentationInternal()

void vtkPVView::AddRepresentationInternal ( vtkDataRepresentation *  rep )

overrideprotected

Overridden to assign IDs to each representation.

This assumes that representations will be added/removed in a consistent fashion across processes even in multi-client modes. The only exception is vtk3DWidgetRepresentation. However, since vtk3DWidgetRepresentation never does any data-delivery, we don't assign IDs for these, nor affect the ID uniquifier when a vtk3DWidgetRepresentation is added.

RemoveRepresentationInternal()

void vtkPVView::RemoveRepresentationInternal ( vtkDataRepresentation *  rep )

overrideprotected

Overridden to assign IDs to each representation.

This assumes that representations will be added/removed in a consistent fashion across processes even in multi-client modes. The only exception is vtk3DWidgetRepresentation. However, since vtk3DWidgetRepresentation never does any data-delivery, we don't assign IDs for these, nor affect the ID uniquifier when a vtk3DWidgetRepresentation is added.

CallProcessViewRequest()

int vtkPVView::CallProcessViewRequest ( vtkInformationRequestKey *  passType, vtkInformation *  request, vtkInformationVector *  reply  )

protected

Subclasses can use this method to trigger a pass on all representations.

Returns

the count for representations that processed the call and returned success.

GetSession()

vtkPVSession* vtkPVView::GetSession ( )

protected

GetInCaptureScreenshot()

virtual bool vtkPVView::GetInCaptureScreenshot ( )

protectedvirtual

Flag set to true between calls to PrepareForScreenshot and CleanupAfterScreenshot.

GetDeliveryManager() [2/2]

static vtkPVDataDeliveryManager* vtkPVView::GetDeliveryManager ( vtkInformation *  info )

staticprotected

SynchronizeRepresentationTemporalPipelineStates()

void vtkPVView::SynchronizeRepresentationTemporalPipelineStates ( )

protected

Called in Update() to sync HasTemporalPipeline flags between representations on all processes.

Member Data Documentation

RequestInformation

vtkInformation* vtkPVView::RequestInformation

protected

These are passed as arguments to vtkDataRepresentation::ProcessViewRequest().

This avoid repeated creation and deletion of vtkInformation objects.

Definition at line 333 of file vtkPVView.h.

ReplyInformationVector

vtkInformationVector* vtkPVView::ReplyInformationVector

protected

These are passed as arguments to vtkDataRepresentation::ProcessViewRequest().

This avoid repeated creation and deletion of vtkInformation objects.

Definition at line 334 of file vtkPVView.h.

ViewTime

double vtkPVView::ViewTime

protected

Definition at line 353 of file vtkPVView.h.

CacheKey

double vtkPVView::CacheKey

protected

Definition at line 356 of file vtkPVView.h.

UseCache

bool vtkPVView::UseCache

protected

Definition at line 357 of file vtkPVView.h.

Size

int vtkPVView::Size[2]

protected

Definition at line 359 of file vtkPVView.h.

Position

int vtkPVView::Position[2]

protected

Definition at line 360 of file vtkPVView.h.

PPI

int vtkPVView::PPI

protected

Definition at line 361 of file vtkPVView.h.

UpdateTimeStamp

vtkTimeStamp vtkPVView::UpdateTimeStamp

protected

Keeps track of the time when vtkPVRenderView::Update() was called.

Definition at line 366 of file vtkPVView.h.

---

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

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