pqDataRepresentation is the superclass for a display for a pqPipelineSource i.e. More...

#include <pqDataRepresentation.h>

Inheritance diagram for pqDataRepresentation:

[legend]

Collaboration diagram for pqDataRepresentation:

Public Slots
virtual void	updateLookupTable ()
	Slot to update the lookup table if the application setting to reset it on visibility changes is on. More...

virtual void	resetAllTransferFunctionRangesUsingCurrentData ()

void	onVisibilityChanged () override
	Overridden to set the VisibilityChangedSinceLastUpdate flag. More...

Public Slots inherited from pqRepresentation
void	renderView (bool force)
	Renders the view to which this representation has been added if any. More...

void	renderViewEventually ()
	Simply calls renderView(false);. More...

Signals
void	dataUpdated ()
	Fired when the representation proxy fires the vtkCommand::UpdateDataEvent. More...

void	attrArrayNameModified ()
	Signal fired to indicate that the rendering attribute arrays properties (Normals, TCoords, Tangents) were modified. More...

void	representationTypeModified ()
	Signal fired to indicate the representation type has changed. More...

void	useSeparateOpacityArrayModified ()
	Signal fired to indicate the use separate opacity array property has changed. More...

void	useTransfer2DModified ()
	Signal fired to indicate the use 2D transfer function property has changed. More...


void	colorTransferFunctionModified ()
	Fired to indicate that the "LookupTable" property (if any) on the representation was modified. More...

void	blockColorTransferFunctionModified ()
	Fired to indicate that the "LookupTable" property (if any) on the representation was modified. More...


void	colorArrayNameModified ()
	Signal fired to indicate that the "ColorArrayName" property (if any) on the representation was modified. More...

void	blockColorArrayNameModified ()
	Signal fired to indicate that the "ColorArrayName" property (if any) on the representation was modified. More...

Signals inherited from pqRepresentation
void	visibilityChanged (bool visible)
	Fired when the visibility property of the underlying display changes. More...

void	updated ()
	Fired whenever Update() is called on the underlying display proxy. 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
	pqDataRepresentation (const QString &group, const QString &name, vtkSMProxy display, pqServer server, QObject *parent=nullptr)

	~pqDataRepresentation () override

pqPipelineSource *	getInput () const
	Get the source/filter of which this is a display. More...

pqOutputPort *	getOutputPortFromInput () const
	Returns the input pqPipelineSource's output port to which this representation is connected. More...

vtkPVDataInformation *	getInputDataInformation () const
	Returns the data information for the data coming into the representation as input. More...

vtkPVTemporalDataInformation *	getInputTemporalDataInformation () const
	Returns the temporal data information for the input. More...

vtkPVDataInformation *	getInputRankDataInformation (int rank) const
	Returns rank-specific data information from input. More...

vtkPVDataInformation *	getRepresentedDataInformation (bool update=true) const
	Returns the represented data information. More...

bool	getDataBounds (double bounds[6])
	Get the data bounds for the input of this display. More...

virtual pqScalarsToColors *	getLookupTable (int selectedPropertiesType=0) const
	Returns the pqScalarsToColors object for the lookup table proxy if any. More...

unsigned long	getFullResMemorySize ()
	Returns the data size for the full-res data. More...

pqDataRepresentation *	getRepresentationForUpstreamSource () const
	This is convenience method to return first representation for the upstream stream filter/source in the same view as this representation. More...


virtual std::vector< vtkSMProxy * >	getLookupTableProxies (int selectedPropertiesType=0) const
	Returns the lookuptable proxy, if any. More...

virtual vtkSMProxy *	getLookupTableProxy (int selectedPropertiesType=0) const
	Returns the lookuptable proxy, if any. More...

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

	~pqRepresentation () override

virtual bool	isVisible () const
	Returns if the status of the visbility property of this display. More...

virtual void	setVisible (bool visible)
	Set the visibility. More...

pqView *	getView () const
	Returns the view to which this representation has been added, if any. More...

vtkSMViewProxy *	getViewProxy () const
	Returns the view proxy to which this representation has been added, if any. 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
virtual void	onInputChanged ()
	called when input property on display changes. More...

Protected Slots inherited from pqRepresentation
virtual void	onVisibilityChanged ()
	called when the display visibility property 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...

Protected Member Functions inherited from pqRepresentation
virtual void	setView (pqView *)
	Called by pqView when this representation gets added to / removed from the view. 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 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 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

pqDataRepresentation is the superclass for a display for a pqPipelineSource i.e.

the input for this display proxy is a pqPiplineSource. This class manages the linking between the pqPiplineSource and pqDataRepresentation.

Definition at line 24 of file pqDataRepresentation.h.

Constructor & Destructor Documentation

◆ pqDataRepresentation()

pqDataRepresentation::pqDataRepresentation	(	const QString &	group,
		const QString &	name,
		vtkSMProxy *	display,
		pqServer *	server,
		QObject *	parent = `nullptr`
	)

◆ ~pqDataRepresentation()

pqDataRepresentation::~pqDataRepresentation ( )

override

Member Function Documentation

◆ getInput()

pqPipelineSource* pqDataRepresentation::getInput ( ) const

Get the source/filter of which this is a display.

◆ getOutputPortFromInput()

pqOutputPort* pqDataRepresentation::getOutputPortFromInput ( ) const

Returns the input pqPipelineSource's output port to which this representation is connected.

◆ getInputDataInformation()

vtkPVDataInformation* pqDataRepresentation::getInputDataInformation ( ) const

Returns the data information for the data coming into the representation as input.

◆ getInputTemporalDataInformation()

vtkPVTemporalDataInformation* pqDataRepresentation::getInputTemporalDataInformation ( ) const

Returns the temporal data information for the input.

This can be a very slow process. Use with extreme caution!!!

◆ getInputRankDataInformation()

vtkPVDataInformation* pqDataRepresentation::getInputRankDataInformation ( int rank ) const

Returns rank-specific data information from input.

◆ getRepresentedDataInformation()

vtkPVDataInformation* pqDataRepresentation::getRepresentedDataInformation ( bool update = true ) const

Returns the represented data information.

Depending on the representation this may differ from the input data information eg. if the representation shows an outline of the data, the this method will return the information about the polydata forming the outline not the input dataset.

◆ getDataBounds()

bool pqDataRepresentation::getDataBounds ( double bounds[6] )

Get the data bounds for the input of this display.

Returns if the operation was successful.

◆ getLookupTableProxies()

virtual std::vector<vtkSMProxy*> pqDataRepresentation::getLookupTableProxies ( int selectedPropertiesType = 0 ) const

virtual

Returns the lookuptable proxy, if any.

Most consumer displays take a lookup table. This method provides access to the Lookup table, if one exists.

Note: the singular form of this method returns the first lookup table proxy

◆ getLookupTableProxy()

virtual vtkSMProxy* pqDataRepresentation::getLookupTableProxy ( int selectedPropertiesType = 0 ) const

virtual

Returns the lookuptable proxy, if any.

Most consumer displays take a lookup table. This method provides access to the Lookup table, if one exists.

Note: the singular form of this method returns the first lookup table proxy

◆ getLookupTable()

virtual pqScalarsToColors* pqDataRepresentation::getLookupTable ( int selectedPropertiesType = 0 ) const

virtual

Returns the pqScalarsToColors object for the lookup table proxy if any.

Most consumer displays take a lookup table. This method provides access to the Lookup table, if one exists.

Note: returns the first lookup table

◆ getFullResMemorySize()

unsigned long pqDataRepresentation::getFullResMemorySize ( )

Returns the data size for the full-res data.

This may trigger a pipeline update to obtain correct data sizes.

◆ getRepresentationForUpstreamSource()

pqDataRepresentation* pqDataRepresentation::getRepresentationForUpstreamSource ( ) const

This is convenience method to return first representation for the upstream stream filter/source in the same view as this representation.

This is only applicable, if this representation is connected to a data-filter which has a valid input.

◆ dataUpdated

void pqDataRepresentation::dataUpdated ( )

signal

Fired when the representation proxy fires the vtkCommand::UpdateDataEvent.

◆ colorTransferFunctionModified

void pqDataRepresentation::colorTransferFunctionModified ( )

signal

Fired to indicate that the "LookupTable" property (if any) on the representation was modified.

◆ blockColorTransferFunctionModified

void pqDataRepresentation::blockColorTransferFunctionModified ( )

signal

Fired to indicate that the "LookupTable" property (if any) on the representation was modified.

◆ colorArrayNameModified

void pqDataRepresentation::colorArrayNameModified ( )

signal

Signal fired to indicate that the "ColorArrayName" property (if any) on the representation was modified.

This property controls the scalar coloring settings on the representation.

◆ blockColorArrayNameModified

void pqDataRepresentation::blockColorArrayNameModified ( )

signal

Signal fired to indicate that the "ColorArrayName" property (if any) on the representation was modified.

This property controls the scalar coloring settings on the representation.

◆ attrArrayNameModified

void pqDataRepresentation::attrArrayNameModified ( )

signal

Signal fired to indicate that the rendering attribute arrays properties (Normals, TCoords, Tangents) were modified.

These properties control the shading and texture mapping.

◆ representationTypeModified

void pqDataRepresentation::representationTypeModified ( )

signal

Signal fired to indicate the representation type has changed.

("Volume", "Surface", ..)

◆ useSeparateOpacityArrayModified

void pqDataRepresentation::useSeparateOpacityArrayModified ( )

signal

Signal fired to indicate the use separate opacity array property has changed.

◆ useTransfer2DModified

void pqDataRepresentation::useTransfer2DModified ( )

signal

Signal fired to indicate the use 2D transfer function property has changed.

◆ updateLookupTable

virtual void pqDataRepresentation::updateLookupTable ( )

virtualslot

Slot to update the lookup table if the application setting to reset it on visibility changes is on.

◆ resetAllTransferFunctionRangesUsingCurrentData

virtual void pqDataRepresentation::resetAllTransferFunctionRangesUsingCurrentData ( )

virtualslot

◆ onVisibilityChanged

void pqDataRepresentation::onVisibilityChanged ( )

overrideslot

Overridden to set the VisibilityChangedSinceLastUpdate flag.

◆ onInputChanged

virtual void pqDataRepresentation::onInputChanged ( )

protectedvirtualslot

called when input property on display changes.

We must detect if (and when) the display is connected to a new proxy.

◆ initialize()

void pqDataRepresentation::initialize ( )

inlineoverrideprotectedvirtual

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.

Definition at line 187 of file pqDataRepresentation.h.

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

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

Public Slots

Signals

Public Member Functions

Protected Slots

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ pqDataRepresentation()

◆ ~pqDataRepresentation()

Member Function Documentation

◆ getInput()

◆ getOutputPortFromInput()

◆ getInputDataInformation()

◆ getInputTemporalDataInformation()

◆ getInputRankDataInformation()

◆ getRepresentedDataInformation()

◆ getDataBounds()

◆ getLookupTableProxies()

◆ getLookupTableProxy()

◆ getLookupTable()

◆ getFullResMemorySize()

◆ getRepresentationForUpstreamSource()

◆ dataUpdated

◆ colorTransferFunctionModified

◆ blockColorTransferFunctionModified

◆ colorArrayNameModified

◆ blockColorArrayNameModified

◆ attrArrayNameModified

◆ representationTypeModified

◆ useSeparateOpacityArrayModified

◆ useTransfer2DModified

◆ updateLookupTable

◆ resetAllTransferFunctionRangesUsingCurrentData

◆ onVisibilityChanged

◆ onInputChanged

◆ initialize()