pqScalarBarRepresentation Class Reference

#include <pqScalarBarRepresentation.h>

Inheritance diagram for pqScalarBarRepresentation:

Collaboration diagram for pqScalarBarRepresentation:

List of all members.

Signals
void	begin (const QString &)
	Fired just before the color is changed on the underlying proxy.
void	end ()
	Fired just after the color is changed on the underlying proxy.
void	addToActiveUndoSet (vtkUndoElement *element)
	For undo-stack.
Public Member Functions
	pqScalarBarRepresentation (const QString &group, const QString &name, vtkSMProxy *scalarbar, pqServer *server, QObject *parent=0)
virtual	~pqScalarBarRepresentation ()
pqScalarsToColors *	getLookupTable () const
	Get the lookup table this scalar bar shows, if any.
QPair< QString, QString >	getTitle () const
	A scalar bar title is divided into two parts (any of which can be empty).
void	setTitle (const QString &name, const QString &component)
	Set the title formed by combining two parts.
virtual void	setVisible (bool visible)
	Set the visibility.
void	setAutoHidden (bool h)
	set by pqPipelineRepresentation when it forces the visibility of the scalar bar to be off.
bool	getAutoHidden () const
virtual void	setDefaultPropertyValues ()
	Sets default values for the underlying proxy.
Protected Slots
void	onLookupTableModified ()
void	startInteraction ()
void	endInteraction ()
Protected Attributes
bool	AutoHidden
	flag set to true, when the scalarbar has been hidden by pqPipelineRepresentation and not explicitly by the user.

---

Detailed Description

Definition at line 43 of file pqScalarBarRepresentation.h.

---

Constructor & Destructor Documentation

pqScalarBarRepresentation::pqScalarBarRepresentation	(	const QString &	group,
		const QString &	name,
		vtkSMProxy *	scalarbar,
		pqServer *	server,
		QObject *	parent = 0
	)

virtual pqScalarBarRepresentation::~pqScalarBarRepresentation

(

)

[virtual]

---

Member Function Documentation

pqScalarsToColors* pqScalarBarRepresentation::getLookupTable

(

)

const

Get the lookup table this scalar bar shows, if any.

QPair<QString, QString> pqScalarBarRepresentation::getTitle

(

)

const

A scalar bar title is divided into two parts (any of which can be empty).

Typically the first is the array name and the second is the component. This method returns the pair.

void pqScalarBarRepresentation::setTitle	(	const QString &	name,
		const QString &	component
	)

Set the title formed by combining two parts.

virtual void pqScalarBarRepresentation::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.

Reimplemented from pqRepresentation.

void pqScalarBarRepresentation::setAutoHidden

(

bool

h

)

[inline]

set by pqPipelineRepresentation when it forces the visibility of the scalar bar to be off.

Definition at line 72 of file pqScalarBarRepresentation.h.

bool pqScalarBarRepresentation::getAutoHidden

(

)

const [inline]

Definition at line 74 of file pqScalarBarRepresentation.h.

virtual void pqScalarBarRepresentation::setDefaultPropertyValues

(

)

[virtual]

Sets default values for the underlying proxy.

This is during the initialization stage of the pqProxy for proxies created by the GUI itself i.e. for proxies loaded through state or created by python client this method won't be called. The default implementation iterates over all properties of the proxy and sets them to default values.

Reimplemented from pqProxy.

void pqScalarBarRepresentation::begin

(

const QString &

)

[signal]

Fired just before the color is changed on the underlying proxy.

This must be hooked to an undo stack to record the changes in a undo set.

void pqScalarBarRepresentation::end

(

)

[signal]

Fired just after the color is changed on the underlying proxy.

This must be hooked to an undo stack to record the changes in a undo set.

void pqScalarBarRepresentation::addToActiveUndoSet

(

vtkUndoElement *

element

)

[signal]

For undo-stack.

void pqScalarBarRepresentation::onLookupTableModified

(

)

[protected, slot]

void pqScalarBarRepresentation::startInteraction

(

)

[protected, slot]

void pqScalarBarRepresentation::endInteraction

(

)

[protected, slot]

---

Member Data Documentation

bool pqScalarBarRepresentation::AutoHidden [protected]

flag set to true, when the scalarbar has been hidden by pqPipelineRepresentation and not explicitly by the user.

Used to restore scalar bar visibility when the representation becomes visible.

Definition at line 103 of file pqScalarBarRepresentation.h.

---

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

• /home/kitware/Dashboards/My Tests/ParaView/Qt/Core/pqScalarBarRepresentation.h