This is PQ representation for a single representation. More...

#include <pqRepresentation.h>

Inheritance diagram for pqRepresentation:

[legend]

Collaboration diagram for pqRepresentation:

Public Slots
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	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
	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	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
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	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	pqView

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

This is PQ representation for a single representation.

This class provides API for the Qt layer to access representations.

Definition at line 19 of file pqRepresentation.h.

Constructor & Destructor Documentation

◆ pqRepresentation()

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

◆ ~pqRepresentation()

pqRepresentation::~pqRepresentation ( )

override

Member Function Documentation

◆ isVisible()

virtual bool pqRepresentation::isVisible ( ) const

virtual

Returns if the status of the visbility property of this display.

Note that for a display to be visible in a view, it must be added to that view as well as visibility must be set to 1.

◆ setVisible()

virtual void pqRepresentation::setVisible ( bool visible )

virtual

Set the visibility.

Note that this affects the visibility of the display in the view it has been added to, if any. This method does not call a re-render on the view, caller must call that explicitly.

◆ getView()

pqView* pqRepresentation::getView ( ) const

Returns the view to which this representation has been added, if any.

◆ getViewProxy()

vtkSMViewProxy* pqRepresentation::getViewProxy ( ) const

Returns the view proxy to which this representation has been added, if any.

◆ renderView

void pqRepresentation::renderView ( bool force )

slot

Renders the view to which this representation has been added if any.

If force is true, then the render is triggered immediately, otherwise, it will be called on idle.

◆ renderViewEventually

void pqRepresentation::renderViewEventually ( )

inlineslot

Simply calls renderView(false);.

Definition at line 71 of file pqRepresentation.h.

◆ visibilityChanged

void pqRepresentation::visibilityChanged ( bool visible )

signal

Fired when the visibility property of the underlying display changes.

It must be noted that this is fired on the property change, the property is not pushed yet, hence the visibility of the underlying VTK prop hasn't changed.

◆ updated

void pqRepresentation::updated ( )

signal

Fired whenever Update() is called on the underlying display proxy.

◆ onVisibilityChanged

virtual void pqRepresentation::onVisibilityChanged ( )

protectedvirtualslot

called when the display visibility property changes.

◆ setView()

virtual void pqRepresentation::setView ( pqView * )

protectedvirtual

Called by pqView when this representation gets added to / removed from the view.

Reimplemented in pqPipelineRepresentation.

Friends And Related Function Documentation

◆ pqView

friend class pqView

friend

Definition at line 93 of file pqRepresentation.h.

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

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

Public Slots

Signals

Public Member Functions

Protected Slots

Protected Member Functions

Friends

Additional Inherited Members