pqContextView is an abstract base class for all charting views based on the VTK context charting library. More...

#include <pqContextView.h>

Inheritance diagram for pqContextView:

[legend]

Collaboration diagram for pqContextView:

Public Member Functions
	~pqContextView () override

virtual vtkContextView *	getVTKContextView () const
	Returns the internal vtkContextView which provides the implementation for the chart rendering. More...

virtual vtkSMContextViewProxy *	getContextViewProxy () const
	Returns the context view proxy associated with this object. More...

virtual bool	supportsSelection () const
	Returns true if selection can be done. More...

bool	supportsCapture () const override
	Returns if this view module can support image capture. More...

virtual void	setSelectionAction (int selAction)
	set/get the selection action in the context view, defined by vtkChart enumeration from SELECT to SELECT_POLYGON. More...

virtual int	selectionAction ()

void	resetDisplay (bool closest=false) override
	Resets the zoom level to 100%. 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...

virtual bool	supportsUndo () const
	Returns if this view module can support undo/redo. More...

QString	getViewType () const
	Returns the type of this view module. More...

virtual bool	canUndo () const
	Returns true if undo can be done. More...

virtual bool	canRedo () const
	Returns true if redo can be done. 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

Protected Slots

void	startInteraction ()
	Slots called when vtkCommand::StartInteractionEvent and vtkCommand::EndInteractionEvent are fired by vtkSMContextViewProxy. More...

void	endInteraction ()
	Slots called when vtkCommand::StartInteractionEvent and vtkCommand::EndInteractionEvent are fired by vtkSMContextViewProxy. More...

Protected Slots inherited from pqProxy
void	onProxyRegistered (const QString &, const QString &, vtkSMProxy *)

void	onProxyUnRegistered (const QString &, const QString &, vtkSMProxy *)

Protected Member Functions
	pqContextView (const QString &type, const QString &group, const QString &name, vtkSMViewProxy view, pqServer server, QObject *parent=nullptr)
	Constructor: `type` :- view type. More...

QWidget *	createWidget () override
	Creates a new instance of the QWidget subclass to be used to show this view. More...

virtual void	selectionChanged ()
	Listen for new selection events, and pass them back to ParaView. More...

virtual void	setSelection (vtkSelection *)
	Set selection to the view. 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...

Protected Attributes
command *	Command

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 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 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...

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...

Detailed Description

pqContextView is an abstract base class for all charting views based on the VTK context charting library.

Definition at line 19 of file pqContextView.h.

Constructor & Destructor Documentation

◆ ~pqContextView()

pqContextView::~pqContextView ( )

override

◆ pqContextView()

pqContextView::pqContextView	(	const QString &	type,
		const QString &	group,
		const QString &	name,
		vtkSMViewProxy *	view,
		pqServer *	server,
		QObject *	parent = `nullptr`
	)

protected

Constructor: type :- view type.

group :- SManager registration group. name :- SManager registration name. view :- View proxy. server:- server on which the proxy is created. parent:- QObject parent.

Member Function Documentation

◆ getVTKContextView()

virtual vtkContextView* pqContextView::getVTKContextView ( ) const

virtual

Returns the internal vtkContextView which provides the implementation for the chart rendering.

Reimplemented in pqComparativeContextView.

◆ getContextViewProxy()

virtual vtkSMContextViewProxy* pqContextView::getContextViewProxy ( ) const

virtual

Returns the context view proxy associated with this object.

Reimplemented in pqComparativeContextView.

◆ supportsSelection()

virtual bool pqContextView::supportsSelection ( ) const

virtual

Returns true if selection can be done.

Reimplemented in pqXYHistogramChartView, and pqXYBarChartView.

◆ supportsCapture()

bool pqContextView::supportsCapture ( ) const

inlineoverridevirtual

Returns if this view module can support image capture.

Returns false by default. Subclassess must override if that's not the case.

Reimplemented from pqView.

Definition at line 48 of file pqContextView.h.

◆ setSelectionAction()

virtual void pqContextView::setSelectionAction ( int selAction )

virtual

set/get the selection action in the context view, defined by vtkChart enumeration from SELECT to SELECT_POLYGON.

◆ selectionAction()

virtual int pqContextView::selectionAction ( )

virtual

◆ resetDisplay()

void pqContextView::resetDisplay ( bool closest = false )

overridevirtual

Resets the zoom level to 100%.

Reimplemented from pqView.

◆ startInteraction

void pqContextView::startInteraction ( )

protectedslot

Slots called when vtkCommand::StartInteractionEvent and vtkCommand::EndInteractionEvent are fired by vtkSMContextViewProxy.

We use these to mark an undo-set.

◆ endInteraction

void pqContextView::endInteraction ( )

protectedslot

Slots called when vtkCommand::StartInteractionEvent and vtkCommand::EndInteractionEvent are fired by vtkSMContextViewProxy.

We use these to mark an undo-set.

◆ createWidget()

QWidget* pqContextView::createWidget ( )

overrideprotectedvirtual

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

This will create a pqQVTKWidget for the render window.

Implements pqView.

◆ selectionChanged()

virtual void pqContextView::selectionChanged ( )

protectedvirtual

Listen for new selection events, and pass them back to ParaView.

◆ setSelection()

virtual void pqContextView::setSelection ( vtkSelection * )

protectedvirtual

Set selection to the view.

Member Data Documentation

◆ Command

command* pqContextView::Command

protected

Definition at line 102 of file pqContextView.h.

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

/builds/gitlab-kitware-sciviz-ci/Qt/Core/pqContextView.h

Public Member Functions

Protected Slots

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~pqContextView()

◆ pqContextView()

Member Function Documentation

◆ getVTKContextView()

◆ getContextViewProxy()

◆ supportsSelection()

◆ supportsCapture()

◆ setSelectionAction()

◆ selectionAction()

◆ resetDisplay()

◆ startInteraction

◆ endInteraction

◆ createWidget()

◆ selectionChanged()

◆ setSelection()

Member Data Documentation

◆ Command