PQ representation for a vtkSMProxy that can be involved in a pipeline. More...

#include <pqPipelineSource.h>

Inheritance diagram for pqPipelineSource:

Collaboration diagram for pqPipelineSource:

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

Protected Slots
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	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	initialize ()

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

Friends
class	pqPipelineFilter

Additional Inherited Members
Public Types inherited from pqProxy
enum	ModifiedState { UNINITIALIZED, MODIFIED, UNMODIFIED }
	The modification state of this 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 pqProxy *	findProxy (vtkSMProxy *aproxy)
	Returns a pqProxy found under current pqServer and matching given vtkSMProxy. 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

PQ representation for a vtkSMProxy that can be involved in a pipeline.

i.e that can have input and/or output. The public API is to observe the object, changes to the pipeline structure are only through protected function. These changes happen automatically as a reflection of the SM state.

Definition at line 32 of file pqPipelineSource.h.

Constructor & Destructor Documentation

◆ pqPipelineSource()

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

◆ ~pqPipelineSource()

pqPipelineSource::~pqPipelineSource ( )

override

Member Function Documentation

◆ getNumberOfOutputPorts()

int pqPipelineSource::getNumberOfOutputPorts ( ) const

A source may have multiple output ports.

This method returns the number of output ports supported by this source.

◆ getOutputPort() [1/2]

pqOutputPort* pqPipelineSource::getOutputPort ( int outputport ) const

Returns the pqOutputPort for the given output port.

◆ getOutputPort() [2/2]

pqOutputPort* pqPipelineSource::getOutputPort ( const QString & portName ) const

Returns the pqOutputPort given the name of the port.

◆ getOutputPorts()

QList<pqOutputPort*> pqPipelineSource::getOutputPorts ( ) const

Returns all the output ports.

◆ getNumberOfConsumers() [1/2]

int pqPipelineSource::getNumberOfConsumers ( int outputport ) const

Returns the number of consumers connected to the given output port.

◆ getNumberOfConsumers() [2/2]

int pqPipelineSource::getNumberOfConsumers ( ) const

inline

Get the number of consumers connected to output port 0.

Equivalent to calling getNumberOfConsumers(0);

Definition at line 72 of file pqPipelineSource.h.

◆ getConsumer() [1/2]

pqPipelineSource* pqPipelineSource::getConsumer	(	int	outputport,
		int	index
	)		const

Get the consumer at a particulat index on a given output port.

◆ getConsumer() [2/2]

pqPipelineSource* pqPipelineSource::getConsumer ( int index ) const

inline

Get consumer at a particular index on output port 0.

Equivalent to calling getConsumer(0, index);

Definition at line 83 of file pqPipelineSource.h.

◆ getAllConsumers()

QList<pqPipelineSource*> pqPipelineSource::getAllConsumers ( ) const

Returns a list of consumers for all output ports.

◆ getRepresentations() [1/2]

QList<pqDataRepresentation*> pqPipelineSource::getRepresentations	(	int	outputport,
		pqView *	view
	)		const

Returns a list of representations for this source in the given view.

If view == nullptr, returns all representations of this source.

◆ getRepresentations() [2/2]

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

inline

Definition at line 95 of file pqPipelineSource.h.

◆ getRepresentation() [1/2]

pqDataRepresentation* pqPipelineSource::getRepresentation	(	int	outputport,
		pqView *	view
	)		const

Returns the first representation for this source in the given view.

If view is nullptr, returns 0.

◆ getRepresentation() [2/2]

pqDataRepresentation* pqPipelineSource::getRepresentation ( pqView * view ) const

inline

Definition at line 105 of file pqPipelineSource.h.

◆ getViews()

QList<pqView*> pqPipelineSource::getViews ( ) const

Returns a list of render modules in which this source has representations added (the representations may not be visible).

◆ renderAllViews()

void pqPipelineSource::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.

◆ updatePipeline()

void pqPipelineSource::updatePipeline ( )

Update the pipeline with the current time.

◆ getSourceProxy()

vtkSMSourceProxy* pqPipelineSource::getSourceProxy ( )

Return the vtkSMSourceProxy instance corresponding to this pqPipelineSource.

◆ connectionAdded

void pqPipelineSource::connectionAdded	(	pqPipelineSource *	source,
		pqPipelineSource *	consumer,
		int	srcOutputPort
	)

signal

fired when a connection is created between two pqPipelineSources.

◆ preConnectionAdded

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

signal

◆ connectionRemoved

void pqPipelineSource::connectionRemoved	(	pqPipelineSource *	source,
		pqPipelineSource *	consumer,
		int	srcOutputPort
	)

signal

fired when a connection is broken between two pqPipelineSources.

◆ preConnectionRemoved

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

signal

◆ representationAdded

void pqPipelineSource::representationAdded	(	pqPipelineSource *	source,
		pqDataRepresentation *	repr,
		int	srcOutputPort
	)

signal

fired when a representation is added.

◆ representationRemoved

void pqPipelineSource::representationRemoved	(	pqPipelineSource *	source,
		pqDataRepresentation *	repr,
		int	srcOutputPort
	)

signal

fired when a representation is removed.

◆ visibilityChanged

void pqPipelineSource::visibilityChanged	(	pqPipelineSource *	source,
		pqDataRepresentation *	repr
	)

signal

Fired when the visbility of a representation for the source changes.

Also fired when representationAdded or representationRemoved is fired since that too implies change in source visibility.

◆ dataUpdated

void pqPipelineSource::dataUpdated ( pqPipelineSource * source )

signal

Fired right after the underlying algorithm updates (executes).

This can be used to update data information and other similar tasks.

◆ selectionChanged

void pqPipelineSource::selectionChanged ( pqOutputPort * port )

signal

Fired when the selection on a port has changed.

◆ onRepresentationVisibilityChanged

void pqPipelineSource::onRepresentationVisibilityChanged ( )

protectedslot

Called when the visibility of any representation for this source changes.

◆ removeConsumer()

void pqPipelineSource::removeConsumer	(	int	outputport,
		pqPipelineSource *
	)

protected

called by pqPipelineFilter when the connections change.

◆ addConsumer()

void pqPipelineSource::addConsumer	(	int	outputport,
		pqPipelineSource *
	)

protected

Friends And Related Function Documentation

◆ pqPipelineFilter

friend class pqPipelineFilter

friend

Definition at line 201 of file pqPipelineSource.h.

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

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

Signals

Public Member Functions

Protected Slots

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ pqPipelineSource()

◆ ~pqPipelineSource()

Member Function Documentation

◆ getNumberOfOutputPorts()

◆ getOutputPort() [1/2]

◆ getOutputPort() [2/2]

◆ getOutputPorts()

◆ getNumberOfConsumers() [1/2]

◆ getNumberOfConsumers() [2/2]

◆ getConsumer() [1/2]

◆ getConsumer() [2/2]

◆ getAllConsumers()

◆ getRepresentations() [1/2]

◆ getRepresentations() [2/2]

◆ getRepresentation() [1/2]

◆ getRepresentation() [2/2]

◆ getViews()

◆ renderAllViews()

◆ updatePipeline()

◆ getSourceProxy()

◆ connectionAdded

◆ preConnectionAdded

◆ connectionRemoved

◆ preConnectionRemoved

◆ representationAdded

◆ representationRemoved

◆ visibilityChanged

◆ dataUpdated

◆ selectionChanged

◆ onRepresentationVisibilityChanged

◆ removeConsumer()

◆ addConsumer()

Friends And Related Function Documentation

◆ pqPipelineFilter