pqComparativeRenderView Class Reference

RenderView used for comparative visualization (or film-strip visualization). More...

#include <pqComparativeRenderView.h>

Inheritance diagram for pqComparativeRenderView:

Collaboration diagram for pqComparativeRenderView:

Public Member Functions
	pqComparativeRenderView (const QString &group, const QString &name, vtkSMViewProxy *renModule, pqServer *server, QObject *parent=nullptr)
	~pqComparativeRenderView () override
vtkSMComparativeViewProxy *	getComparativeRenderViewProxy () const
	Returns the comparative view proxy. More...
vtkSMRenderViewProxy *	getRenderViewProxy () const override
	Returns the root render view in the comparative view. More...
Public Member Functions inherited from pqRenderView
	pqRenderView (const QString &group, const QString &name, vtkSMViewProxy *renModule, pqServer *server, QObject *parent=nullptr)
	pqRenderView (const QString &tname, const QString &group, const QString &name, vtkSMViewProxy *renModule, pqServer *server, QObject *parent=nullptr)
	~pqRenderView () override
void	resetCamera (bool closest=false, double offsetRatio=0.9) override
	Resets the camera to include all visible data. More...
virtual void	resetCenterOfRotation ()
	Resets the center of rotation to the focal point. More...
virtual void	resetParallelScale ()
	Resets the parallel scale which is used for a parallel projection. More...
virtual bool	getOrientationAxesVisibility () const
	Get if the orientation axes is visible. More...
virtual bool	getOrientationAxesInteractivity () const
	Get if the orientation axes is interactive. More...
virtual QColor	getOrientationAxesLabelColor () const
	Get orientation axes label color. More...
virtual QColor	getOrientationAxesOutlineColor () const
	Get orientation axes outline color. More...
virtual bool	getResetCenterWithCamera () const
	Get whether resetCamera() resets the center of rotation as well. More...
virtual bool	getUseMultipleRepresentationSelection () const
	Get whether selection will be done on multiple representations. More...
virtual bool	getCenterAxesVisibility () const
	Get center axes visibility. More...
virtual void	getCenterOfRotation (double center[3]) const
	Get the current center of rotation. More...
bool	supportsUndo () const override
	Returns if this view module can support undo/redo. More...
bool	supportsCapture () const override
	Returns if this view module can support image capture. More...
virtual void	clearUndoStack ()
	Clears interaction undo stack of this view (and all linked views, if any). More...
virtual void	resetViewDirection (double look_x, double look_y, double look_z, double up_x, double up_y, double up_z)
	Reset/Adjust camera view direction. More...
virtual void	adjustView (const int &adjustType, const double &angle)
virtual void	adjustAzimuth (const double &value)
virtual void	adjustElevation (const double &value)
virtual void	adjustRoll (const double &value)
virtual void	adjustZoom (const double &value)
virtual void	applyIsometricView ()
virtual void	resetViewDirectionToPositiveX ()
virtual void	resetViewDirectionToNegativeX ()
virtual void	resetViewDirectionToPositiveY ()
virtual void	resetViewDirectionToNegativeY ()
virtual void	resetViewDirectionToPositiveZ ()
virtual void	resetViewDirectionToNegativeZ ()
virtual pqDataRepresentation *	pick (int pos[2])
	Picks the representation at the given position. More...
virtual pqDataRepresentation *	pickBlock (int pos[2], unsigned int &flatIndex, int &rank)
	Picks the representation at the given position. More...
virtual void	selectBlock (int rectangle[4], int selectionModifier=pqView::PV_SELECTION_DEFAULT)
	Creates a "block" selection given the rectangle in display coordinates. More...
bool	canUndo () const override
	Returns if the view module can undo/redo interaction given the current state of the interaction undo stack. More...
bool	canRedo () const override
	Returns if the view module can undo/redo interaction given the current state of the interaction undo stack. More...
virtual void	linkUndoStack (pqRenderView *other)
	For linking of interaction undo stacks. More...
virtual void	unlinkUndoStack (pqRenderView *other)
	For linking of interaction undo stacks. More...
virtual void	setCursor (const QCursor &)
	Let internal class handle which internal widget should change its cursor This is usually used for selection and in case of QuadView/SliceView which contains an aggregation of QWidget, we don't necessary want all of them to share the same cursor. More...
virtual QCursor	cursor ()
	Let internal class handle which internal widget should change its cursor This is usually used for selection and in case of QuadView/SliceView which contains an aggregation of QWidget, we don't necessary want all of them to share the same cursor. More...
void	setCursorVisible (bool visible)
	Set / get the cursor visibility when the mouse hovers the widget associated with this view. More...
bool	cursorVisible ()
	Set / get the cursor visibility when the mouse hovers the widget associated with this view. More...
virtual void	selectCellsOnSurface (int rectangle[4], int selectionModifier=pqView::PV_SELECTION_DEFAULT, const char *array=nullptr)
virtual void	selectPointsOnSurface (int rectangle[4], int selectionModifier=pqView::PV_SELECTION_DEFAULT, const char *array=nullptr)
virtual void	selectFrustumCells (int rectangle[4], int selectionModifier=pqView::PV_SELECTION_DEFAULT)
virtual void	selectFrustumPoints (int rectangle[4], int selectionModifier=pqView::PV_SELECTION_DEFAULT)
virtual void	selectFrustumBlocks (int rectangle[4], int selectionModifier=pqView::PV_SELECTION_DEFAULT)
virtual void	selectPolygonPoints (vtkIntArray *polygon, int selectionModifier=pqView::PV_SELECTION_DEFAULT)
	Creates a new surface selection given the polygon in display coordinates. More...
virtual void	selectPolygonCells (vtkIntArray *polygon, int selectionModifier=pqView::PV_SELECTION_DEFAULT)
	Creates a new surface selection given the polygon in display coordinates. More...
Public Member Functions inherited from pqRenderViewBase
	~pqRenderViewBase () override
void	resetDisplay (bool closest=false) override
	Called to reset the view's display. More...
Public Member Functions inherited from pqView
	~pqView () override
vtkSMViewProxy *	getViewProxy () const
	Returns the internal render Module proxy associated with this object. More...
virtual vtkView *	getClientSideView () const
	Return the client-side vtkView encapsulated by this view (if any), or return nullptr. More...
QWidget *	widget ()
	Return a widget associated with this view. More...
QString	getViewType () const
	Returns the type of this view module. More...
virtual QSize	getSize ()
	Returns the current size of the rendering context. More...
bool	hasRepresentation (pqRepresentation *repr) const
	This method checks if the representation is shown in this view. More...
int	getNumberOfRepresentations () const
	Returns the number representations in the view. More...
int	getNumberOfVisibleRepresentations () const
int	getNumberOfVisibleDataRepresentations () const
pqRepresentation *	getRepresentation (int index) const
	Returns the representation for the specified index where (index < getNumberOfRepresentations()). More...
QList< pqRepresentation * >	getRepresentations () const
	Returns a list of representations in this view. More...
bool	canDisplay (pqOutputPort *opPort) const
	This method returns is any pqPipelineSource can be displayed in this view. More...
Public Member Functions inherited from pqProxy
	pqProxy (const QString &group, const QString &name, vtkSMProxy *proxy, pqServer *server, QObject *parent=nullptr)
	~pqProxy () override
pqServer *	getServer () const
	Get the server on which this proxy exists. More...
void	rename (const QString &newname)
	This is a convenience method. More...
const QString &	getSMName ()
	Get the name with which this proxy is registered on the server manager. More...
const QString &	getSMGroup ()
vtkSMProxy *	getProxy () const
	Get the vtkSMProxy this object stands for. More...
ModifiedState	modifiedState () const
	Gets whether or not the source has been modified. More...
void	setModifiedState (ModifiedState modified)
	Sets whether or not the source has been modified. More...
vtkPVXMLElement *	getHints () const
	Returns the hints for this proxy, if any. More...
QList< vtkSMProxy * >	getHelperProxies () const
	Returns a list of all helper proxies. More...
QList< vtkSMProxy * >	getHelperProxies (const QString &key) const
	Returns a list of all the helper proxies added with a given key. More...
QList< QString >	getHelperKeys () const
	Returns the keys for helper proxies. More...
virtual void	addHelperProxy (const QString &key, vtkSMProxy *)
	Concept of helper proxies: A pqProxy is created for every important vtkSMProxy registered. More...
void	removeHelperProxy (const QString &key, vtkSMProxy *)
void	updateHelperProxies () const
	Updates the internal datastructures using the proxies currently registered under the group that would be used for helper proxies. More...
vtkSMSessionProxyManager *	proxyManager () const
	Returns the proxy manager by calling this->getProxy()->GetProxyManager();. More...
bool	userModifiedSMName ()
	Return whether or not the user has modified the GUI name of the source. More...
Public Member Functions inherited from pqServerManagerModelItem
	pqServerManagerModelItem (QObject *parent=nullptr)
	~pqServerManagerModelItem () override

Static Public Member Functions
static QString	comparativeRenderViewType ()
Static Public Member Functions inherited from pqRenderView
static QString	renderViewType ()
Static Public Member Functions inherited from pqProxy
static pqProxy *	findProxyWithHelper (vtkSMProxy *aproxy, QString &key)
	Returns a pqProxy instance, of any, whose helper proxy is the aproxy. More...
static std::string	rstToHtml (const char *rstStr)
	convert proxy documentation from RST to HTML (so that it can be used in Qt) More...
static QString	rstToHtml (const QString &rstStr)
	convert proxy documentation from RST to HTML (so that it can be used in Qt) More...

Protected Slots
void	updateViewWidgets (QWidget *container=nullptr)
	Called when the layout on the comparative vis changes. More...
Protected Slots inherited from pqRenderView
virtual void	onInteractionModeChange ()
	Called when VTK event get trigger to notify that the interaction mode has changed. More...
virtual void	onGenericFilmicPresetsChange ()
	Called when VTK event get trigger to notify that the generic filmic presets has changed. More...
virtual void	onResetCameraEvent ()
virtual void	onUndoStackChanged ()
	Called when undo stack changes. More...
Protected Slots inherited from pqRenderViewBase
virtual void	initializeAfterObjectsCreated ()
void	beginDelayInteractiveRender ()
	Triggered by DelayNonInteractiveRenderEvent. More...
void	endDelayInteractiveRender ()
void	updateStatusMessage ()
	Triggered by internal timer to update the status bar message. More...
Protected Slots inherited from pqProxy
void	onProxyRegistered (const QString &, const QString &, vtkSMProxy *)
void	onProxyUnRegistered (const QString &, const QString &, vtkSMProxy *)

Protected Member Functions
QWidget *	createWidget () override
	Creates a new instance of the QWidget subclass to be used to show this view. More...
Protected Member Functions inherited from pqRenderView
virtual void	fakeUndoRedo (bool redo, bool self)
	Updates undo stack without actually performing the undo/redo actions. More...
virtual void	fakeInteraction (bool start)
	Updates undo stack of all linked views to record a programmatic change in camera as a interaction. More...
QWidget *	createWidget () override
	Creates a new instance of the QWidget subclass to be used to show this view. More...
void	initialize () override
	Overridden to initialize the interaction undo/redo stack. More...
Protected Member Functions inherited from pqRenderViewBase
	pqRenderViewBase (const QString &type, const QString &group, const QString &name, vtkSMViewProxy *renModule, pqServer *server, QObject *parent=nullptr)
bool	eventFilter (QObject *caller, QEvent *e) override
	Overridden to popup the context menu, if some actions have been added using addMenuAction. More...
QWidget *	createWidget () override
	Creates a new instance of the QWidget subclass to be used to show this view. More...
void	initialize () override
	Use this method to initialize the pqObject state using the underlying vtkSMProxy. More...
Protected Member Functions inherited from pqView
	pqView (const QString &type, const QString &group, const QString &name, vtkSMViewProxy *view, pqServer *server, QObject *parent=nullptr)
	Constructor: type :- view type. More...
void	initialize () override
	Use this method to initialize the pqObject state using the underlying vtkSMProxy. More...
Protected Member Functions inherited from pqProxy
void	setSMName (const QString &new_name)
	Make this pqProxy take on a new identity. More...
virtual void	addInternalHelperProxy (const QString &key, vtkSMProxy *) const
virtual void	removeInternalHelperProxy (const QString &key, vtkSMProxy *) const
Protected Member Functions inherited from pqServerManagerModelItem
vtkEventQtSlotConnect *	getConnector ()
	All subclasses generally need some vtkEventQtSlotConnect instance to connect to VTK events. More...

Additional Inherited Members
Public Types inherited from pqView
enum	SelectionModifier { PV_SELECTION_DEFAULT = 0, PV_SELECTION_ADDITION, PV_SELECTION_SUBTRACTION, PV_SELECTION_TOGGLE }
Public Types inherited from pqProxy
enum	ModifiedState { UNINITIALIZED, MODIFIED, UNMODIFIED }
	The modification state of this proxy. More...
Public Slots inherited from pqRenderView
virtual void	setOrientationAxesVisibility (bool visible)
virtual void	setOrientationAxesInteractivity (bool interactive)
virtual void	setOrientationAxesLabelColor (const QColor &)
virtual void	setOrientationAxesOutlineColor (const QColor &)
virtual void	setCenterOfRotation (double x, double y, double z)
virtual void	setCenterOfRotation (double xyz[3])
virtual void	setParallelScale (double scale)
virtual void	setCenterAxesVisibility (bool visible)
virtual void	setResetCenterWithCamera (bool b)
	Get/Set whether resetCamera() resets the center of rotation as well. More...
virtual void	setUseMultipleRepresentationSelection (bool b)
	Set whether selection will be done on multiple representations. More...
virtual void	linkToOtherView ()
	start the link to other view process More...
void	undo () override
	Called to undo interaction. More...
void	redo () override
	Called to redo interaction. More...
virtual void	resetCenterOfRotationIfNeeded ()
	Resets center of rotation if this->ResetCenterWithCamera is true. More...
virtual void	updateInteractionMode (pqOutputPort *opPort)
	Try to provide the best view orientation and interaction mode. More...
Public Slots inherited from pqView
virtual void	render ()
	Request a StillRender on idle. More...
virtual void	forceRender ()
	Forces an immediate render. More...
void	cancelPendingRenders ()
	Cancels any pending renders. More...
virtual void	undo ()
	Called to undo interaction. More...
virtual void	redo ()
	Called to redo interaction. More...
Signals inherited from pqRenderView
void	updateInteractionMode (int mode)
Signals inherited from pqView
void	updateDataEvent ()
	Fired when the vtkSMViewProxy fires the vtkCommand::UpdateDataEvent The view proxy fires this event at the end of vtkSMViewProxy::Update() when the update executes, not just when the method is called. More...
void	representationAdded (pqRepresentation *)
	Fired after a representation has been added to this view. More...
void	representationRemoved (pqRepresentation *)
	Fired after a representation has been removed from this view. More...
void	beginRender ()
	Fired when the render module fires a vtkCommand::StartEvent signalling the beginning of rendering. More...
void	endRender ()
	Fired when the render module fires a vtkCommand::EndEvent signalling the end of rendering. More...
void	representationVisibilityChanged (pqRepresentation *repr, bool visible)
	Fired when any representation visibility changes. More...
void	canUndoChanged (bool)
	Fired when interaction undo stack status changes. More...
void	canRedoChanged (bool)
	Fired when interaction undo stack status changes. More...
void	selected (pqOutputPort *opport)
	Fired when a selection is made in this view. More...
void	picked (pqOutputPort *opport)
	Fired when a port is picked. More...
void	beginProgress ()
	Fired before doing any actions that may result in progress events that must be reported by the client. More...
void	endProgress ()
	Fired after performing any actions that may result in progress events. More...
void	progress (const QString &message, int percent_progress)
	Fired to notify the current execution progress. More...
void	multipleSelected (QList< pqOutputPort *> opports)
	Fired when UseMultipleRepresentationSelection is set to on and selection on multiple representations is made in this view. More...
Signals inherited from pqProxy
void	nameChanged (pqServerManagerModelItem *)
	Fired when the name of the proxy is changed. More...
void	modifiedStateChanged (pqServerManagerModelItem *)
	Fired when the modified status changes for the proxy. More...
Protected Attributes inherited from pqRenderView
bool	ResetCenterWithCamera
bool	UseMultipleRepresentationSelection

Detailed Description

RenderView used for comparative visualization (or film-strip visualization).

Definition at line 14 of file pqComparativeRenderView.h.

Constructor & Destructor Documentation

pqComparativeRenderView()

pqComparativeRenderView::pqComparativeRenderView	(	const QString &	group,
		const QString &	name,
		vtkSMViewProxy *	renModule,
		pqServer *	server,
		QObject *	parent = nullptr
	)

~pqComparativeRenderView()

pqComparativeRenderView::~pqComparativeRenderView ( )

override

Member Function Documentation

comparativeRenderViewType()

static QString pqComparativeRenderView::comparativeRenderViewType ( )

inlinestatic

Definition at line 20 of file pqComparativeRenderView.h.

getComparativeRenderViewProxy()

vtkSMComparativeViewProxy* pqComparativeRenderView::getComparativeRenderViewProxy

(

)

const

Returns the comparative view proxy.

getRenderViewProxy()

vtkSMRenderViewProxy* pqComparativeRenderView::getRenderViewProxy ( ) const

overridevirtual

Returns the root render view in the comparative view.

Reimplemented from pqRenderView.

updateViewWidgets

void pqComparativeRenderView::updateViewWidgets ( QWidget *  container = nullptr )

protectedslot

Called when the layout on the comparative vis changes.

createWidget()

QWidget* pqComparativeRenderView::createWidget ( )

overrideprotectedvirtual

Creates a new instance of the QWidget subclass to be used to show this view.

Default implementation creates a pqQVTKWidgetBase.

Implements pqView.

---

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

• /builds/gitlab-kitware-sciviz-ci/Qt/Core/pqComparativeRenderView.h