#include <pqPipelineFilter.h>

Inheritance diagram for pqPipelineFilter:

Collaboration diagram for pqPipelineFilter:

Signals
void	producerChanged (const QString &inputportname)
	fired whenever an input connection changes. More...

Signals inherited from pqPipelineSource
void	connectionAdded (pqPipelineSource source, pqPipelineSource consumer, int srcOutputPort)
	fired when a connection is created between two pqPipelineSources. More...

void	preConnectionAdded (pqPipelineSource source, pqPipelineSource consumer, int srcOutputPort)

void	connectionRemoved (pqPipelineSource source, pqPipelineSource consumer, int srcOutputPort)
	fired when a connection is broken between two pqPipelineSources. More...

void	preConnectionRemoved (pqPipelineSource source, pqPipelineSource consumer, int srcOutputPort)

void	representationAdded (pqPipelineSource source, pqDataRepresentation repr, int srcOutputPort)
	fired when a representation is added. More...

void	representationRemoved (pqPipelineSource source, pqDataRepresentation repr, int srcOutputPort)
	fired when a representation is removed. More...

void	visibilityChanged (pqPipelineSource source, pqDataRepresentation repr)
	Fired when the visbility of a representation for the source changes. More...

void	dataUpdated (pqPipelineSource *source)
	Fired right after the underlying algorithm updates (executes). More...

void	selectionChanged (pqOutputPort *port)
	Fired when the selection on a port has changed. 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...

Public Member Functions
	pqPipelineFilter (QString name, vtkSMProxy proxy, pqServer server, QObject *parent=nullptr)

	~pqPipelineFilter () override

int	getNumberOfInputPorts () const
	Returns the number of input ports available on this filter. More...

QString	getInputPortName (int index) const
	Returns the name of the input port at a given index. More...

int	getNumberOfInputs (const QString &portname) const
	Returns the number of input proxies connected to given named input port. More...

QList< pqOutputPort * >	getInputs (const QString &portname) const
	Returns the input proxies connected to the given named input port. More...

QList< pqOutputPort * >	getAllInputs () const
	Returns inputs connected to all input ports connections. More...

QMap< QString, QList< pqOutputPort * > >	getNamedInputs () const
	Returns a map of input port name to the list of output ports that are set as the input to that port. More...

pqOutputPort *	getInput (const QString &portname, int index) const
	Returns a pair (input, output port) at the given index on the given named input port. More...

int	getInputCount () const
	Get number of inputs. More...

QList< pqOutputPort * >	getInputs () const
	Get a list of all inputs. More...

pqPipelineSource *	getInput (int index) const
	Get input at given index. More...

pqOutputPort *	getAnyInput () const
	Get first available input, any port, any index. More...

int	replaceInput () const
	"Replace input" is a hint given to the GUI to turn off input visibility when the filter is created. More...

Public Member Functions inherited from pqPipelineSource
	pqPipelineSource (const QString &name, vtkSMProxy proxy, pqServer server, QObject *parent=nullptr)

	~pqPipelineSource () override

int	getNumberOfOutputPorts () const
	A source may have multiple output ports. More...

pqOutputPort *	getOutputPort (int outputport) const
	Returns the pqOutputPort for the given output port. More...

pqOutputPort *	getOutputPort (const QString &portName) const
	Returns the pqOutputPort given the name of the port. More...

QList< pqOutputPort * >	getOutputPorts () const
	Returns all the output ports. More...

int	getNumberOfConsumers (int outputport) const
	Returns the number of consumers connected to the given output port. More...

int	getNumberOfConsumers () const
	Get the number of consumers connected to output port 0. More...

pqPipelineSource *	getConsumer (int outputport, int index) const
	Get the consumer at a particulat index on a given output port. More...

pqPipelineSource *	getConsumer (int index) const
	Get consumer at a particular index on output port 0. More...

QList< pqPipelineSource * >	getAllConsumers () const
	Returns a list of consumers for all output ports. More...

QList< pqDataRepresentation * >	getRepresentations (int outputport, pqView *view) const
	Returns a list of representations for this source in the given view. More...

QList< pqDataRepresentation * >	getRepresentations (pqView *view) const

pqDataRepresentation *	getRepresentation (int outputport, pqView *view) const
	Returns the first representation for this source in the given view. More...

pqDataRepresentation *	getRepresentation (pqView *view) const

QList< pqView * >	getViews () const
	Returns a list of render modules in which this source has representations added (the representations may not be visible). More...

void	renderAllViews (bool force=false)
	This method updates all render modules to which all representations for this source belong, if force is true, it for an immediate render otherwise render on idle. More...

void	updatePipeline ()
	Update the pipeline with the current time. More...

vtkSMSourceProxy *	getSourceProxy ()
	Return the vtkSMSourceProxy instance corresponding to this pqPipelineSource. 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 QList< const char * >	getInputPorts (vtkSMProxy *)
	Returns the inputs ports on any proxy. More...

static QList< const char * >	getRequiredInputPorts (vtkSMProxy *)
	Returns the required inputs ports on any 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...

Protected Slots
void	inputChanged (vtkObject , unsigned long, void client_data)
	process some change in the input property for the proxy. More...

Protected Slots inherited from pqPipelineSource
void	onRepresentationVisibilityChanged ()
	Called when the visibility of any representation for this source changes. More...

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

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

Protected Member Functions
void	initialize () override
	Use this method to initialize the pqObject state using the underlying vtkSMProxy. More...

void	inputChanged (const QString &portname)
	Called when a input property changes. More...

Protected Member Functions inherited from pqPipelineSource
void	removeConsumer (int outputport, pqPipelineSource *)
	called by pqPipelineFilter when the connections change. More...

void	addConsumer (int outputport, pqPipelineSource *)

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 pqProxy
enum	ModifiedState { UNINITIALIZED, MODIFIED, UNMODIFIED }
	The modification state of this proxy. More...

Detailed Description

Definition at line 19 of file pqPipelineFilter.h.

Constructor & Destructor Documentation

◆ pqPipelineFilter()

pqPipelineFilter::pqPipelineFilter	(	QString	name,
		vtkSMProxy *	proxy,
		pqServer *	server,
		QObject *	parent = `nullptr`
	)

◆ ~pqPipelineFilter()

pqPipelineFilter::~pqPipelineFilter ( )

override

Member Function Documentation

◆ getInputPorts()

static QList<const char*> pqPipelineFilter::getInputPorts ( vtkSMProxy * )

static

Returns the inputs ports on any proxy.

◆ getRequiredInputPorts()

static QList<const char*> pqPipelineFilter::getRequiredInputPorts ( vtkSMProxy * )

static

Returns the required inputs ports on any proxy.

This is generally same as getInputPorts() except if the property has a "hint" saying it's optional.

◆ getNumberOfInputPorts()

int pqPipelineFilter::getNumberOfInputPorts ( ) const

Returns the number of input ports available on this filter.

◆ getInputPortName()

QString pqPipelineFilter::getInputPortName ( int index ) const

Returns the name of the input port at a given index.

◆ getNumberOfInputs()

int pqPipelineFilter::getNumberOfInputs ( const QString & portname ) const

Returns the number of input proxies connected to given named input port.

◆ getInputs() [1/2]

QList<pqOutputPort*> pqPipelineFilter::getInputs ( const QString & portname ) const

Returns the input proxies connected to the given named input port.

◆ getAllInputs()

QList<pqOutputPort*> pqPipelineFilter::getAllInputs ( ) const

Returns inputs connected to all input ports connections.

◆ getNamedInputs()

QMap<QString, QList<pqOutputPort*> > pqPipelineFilter::getNamedInputs ( ) const

Returns a map of input port name to the list of output ports that are set as the input to that port.

◆ getInput() [1/2]

pqOutputPort* pqPipelineFilter::getInput	(	const QString &	portname,
		int	index
	)		const

Returns a pair (input, output port) at the given index on the given named input port.

◆ getInputCount()

int pqPipelineFilter::getInputCount ( ) const

inline

Get number of inputs.

Definition at line 80 of file pqPipelineFilter.h.

◆ getInputs() [2/2]

QList<pqOutputPort*> pqPipelineFilter::getInputs ( ) const

inline

Get a list of all inputs.

Definition at line 85 of file pqPipelineFilter.h.

◆ getInput() [2/2]

pqPipelineSource* pqPipelineFilter::getInput ( int index ) const

Get input at given index.

◆ getAnyInput()

pqOutputPort* pqPipelineFilter::getAnyInput ( ) const

Get first available input, any port, any index.

Return nullptr if none are available.

◆ replaceInput()

int pqPipelineFilter::replaceInput ( ) const

"Replace input" is a hint given to the GUI to turn off input visibility when the filter is created.

Returns if this proxy replaces input on creation. This checks the "Hints" for the proxy, if any. If a <Visibility> element is present with replace_input="0", then this method returns false, otherwise true.

◆ producerChanged

void pqPipelineFilter::producerChanged ( const QString & inputportname )

signal

fired whenever an input connection changes.

◆ inputChanged [1/2]

void pqPipelineFilter::inputChanged	(	vtkObject *	,
		unsigned	long,
		void *	client_data
	)

protectedslot

process some change in the input property for the proxy.

◆ initialize()

void pqPipelineFilter::initialize ( )

overrideprotectedvirtual

Use this method to initialize the pqObject state using the underlying vtkSMProxy.

This needs to be done only once, after the object has been created.

Reimplemented from pqProxy.

◆ inputChanged() [2/2]

void pqPipelineFilter::inputChanged ( const QString & portname )

protected

Called when a input property changes.

portname is the name of the input port represented by the property.

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

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

Signals

Public Member Functions

Static Public Member Functions

Protected Slots

Protected Member Functions

Additional Inherited Members