Reaction to rescale the active lookup table's range to match the active representation. More...

#include <pqRescaleScalarRangeReaction.h>

Inheritance diagram for pqRescaleScalarRangeReaction:

Collaboration diagram for pqRescaleScalarRangeReaction:

Public Types
enum	Modes { DATA, CUSTOM, TEMPORAL, VISIBLE }

Public Slots
void	updateEnableState () override
	Updates the enabled state. More...


void	setRepresentation (pqDataRepresentation *repr, int selectedPropertiesType)
	Set the data representation explicitly when track_active_objects is false. More...

void	setRepresentation (pqDataRepresentation *repr)
	Set the data representation explicitly when track_active_objects is false. More...

void	setActiveRepresentation ()
	Set the data representation explicitly when track_active_objects is false. More...

Public Member Functions
	pqRescaleScalarRangeReaction (QAction *parent, bool track_active_objects=true, Modes mode=DATA)
	if `track_active_objects` is false, then the reaction will not track pqActiveObjects automatically. More...

	~pqRescaleScalarRangeReaction () override

Public Member Functions inherited from pqReaction
	pqReaction (QAction *parent, Qt::ConnectionType type=Qt::AutoConnection)
	Constructor. More...

	~pqReaction () override

QAction *	parentAction () const
	Provides access to the parent action. More...

Static Public Member Functions
static bool	rescaleScalarRangeToData (pqPipelineRepresentation *repr=nullptr, int selectedPropertiesType=0)
	Rescale to current data range. More...

static pqRescaleScalarRangeToCustomDialog *	rescaleScalarRangeToCustom (pqPipelineRepresentation *repr=nullptr, int selectedPropertiesType=0)
	Rescale range to a custom range. More...

static pqRescaleScalarRangeToCustomDialog *	rescaleScalarRangeToCustom (std::vector< vtkSMProxy *> tfProxies, bool separateOpacity=false, int selectedPropertiesType=0)
	Rescale range to a custom range. More...

static pqRescaleScalarRangeToCustomDialog *	rescaleScalarRangeToCustom (vtkSMProxy *tfProxy, bool separateOpacity=false, int selectedPropertiesType=0)
	Rescale range to a custom range. More...

static pqRescaleScalarRangeToDataOverTimeDialog *	rescaleScalarRangeToDataOverTime (pqPipelineRepresentation *repr=nullptr, int selectedPropertiesType=0)
	Rescale range to data range over time. More...

static bool	rescaleScalarRangeToVisible (pqPipelineRepresentation *repr=nullptr)
	Rescale range to data range for data visible in the view. More...

Protected Slots
virtual void	onServerAdded (pqServer *server)

virtual void	onAboutToRemoveServer (pqServer *server)

Protected Slots inherited from pqReaction
virtual void	updateEnableState ()

virtual void	updateMasterEnableState (bool)

Protected Member Functions
void	onTriggered () override
	Called when the action is triggered. More...

Additional Inherited Members
Protected Attributes inherited from pqReaction
bool	IsMaster

Detailed Description

Reaction to rescale the active lookup table's range to match the active representation.

You can disable tracking of the active representation, instead explicitly provide one using setRepresentation() by pass track_active_objects as false to the constructor.

Definition at line 27 of file pqRescaleScalarRangeReaction.h.

Member Enumeration Documentation

◆ Modes

enum pqRescaleScalarRangeReaction::Modes

Enumerator
DATA
CUSTOM
TEMPORAL
VISIBLE

Definition at line 33 of file pqRescaleScalarRangeReaction.h.

Constructor & Destructor Documentation

◆ pqRescaleScalarRangeReaction()

pqRescaleScalarRangeReaction::pqRescaleScalarRangeReaction	(	QAction *	parent,
		bool	track_active_objects = `true`,
		Modes	mode = `DATA`
	)

if track_active_objects is false, then the reaction will not track pqActiveObjects automatically.

◆ ~pqRescaleScalarRangeReaction()

pqRescaleScalarRangeReaction::~pqRescaleScalarRangeReaction ( )

override

Member Function Documentation

◆ rescaleScalarRangeToData()

static bool pqRescaleScalarRangeReaction::rescaleScalarRangeToData	(	pqPipelineRepresentation *	repr = `nullptr`,
		int	selectedPropertiesType = `0`
	)

static

Rescale to current data range.

Parameters

[in]	repr	The data representation to use to determine the data range. If `nullptr`, then the active representation is used, if available.
[in]	selectedPropertiesType	The selected properties type to use.

Returns: true if the operation was successful, otherwise false.

◆ rescaleScalarRangeToCustom() [1/3]

static pqRescaleScalarRangeToCustomDialog* pqRescaleScalarRangeReaction::rescaleScalarRangeToCustom	(	pqPipelineRepresentation *	repr = `nullptr`,
		int	selectedPropertiesType = `0`
	)

static

Rescale range to a custom range.

Parameters

[in]	repr	The representation used to determine the transfer function to change range on. If `repr` is `nullptr`, then the active representation is used, if available.
[in]	selectedPropertiesType	The selected properties type to use.

Returns: a pointer to the dialog if the operation was successful, otherwise nullptr.

◆ rescaleScalarRangeToCustom() [2/3]

static pqRescaleScalarRangeToCustomDialog* pqRescaleScalarRangeReaction::rescaleScalarRangeToCustom	(	std::vector< vtkSMProxy *>	tfProxies,
		bool	separateOpacity = `false`,
		int	selectedPropertiesType = `0`
	)

static

Rescale range to a custom range.

Parameters

[in]	tfProxies	The transfer function proxies to rescale the range on.
[in]	separateOpacity	Show controls for setting the opacity function range separately from the color transfer function.
[in]	selectedPropertiesType	The selected properties type to use.

Returns: a pointer to the dialog if the operation was successful, otherwise nullptr.

◆ rescaleScalarRangeToCustom() [3/3]

static pqRescaleScalarRangeToCustomDialog* pqRescaleScalarRangeReaction::rescaleScalarRangeToCustom	(	vtkSMProxy *	tfProxy,
		bool	separateOpacity = `false`,
		int	selectedPropertiesType = `0`
	)

inlinestatic

Rescale range to a custom range.

Parameters

[in]	tfProxy	The transfer function proxy to rescale the range on.
[in]	separateOpacity	Show controls for setting the opacity function range separately from the color transfer function.
[in]	selectedPropertiesType	The selected properties type to use.

Returns: a pointer to the dialog if the operation was successful, otherwise nullptr.

Definition at line 99 of file pqRescaleScalarRangeReaction.h.

◆ rescaleScalarRangeToDataOverTime()

static pqRescaleScalarRangeToDataOverTimeDialog* pqRescaleScalarRangeReaction::rescaleScalarRangeToDataOverTime	(	pqPipelineRepresentation *	repr = `nullptr`,
		int	selectedPropertiesType = `0`
	)

static

Rescale range to data range over time.

Parameters

[in]	repr	The data representation to use to determine the data range. If `nullptr`, then the active representation is used, if available.
[in]	selectedPropertiesType	The selected properties type to use.

Returns: true if the operation was successful, otherwise false.

◆ rescaleScalarRangeToVisible()

static bool pqRescaleScalarRangeReaction::rescaleScalarRangeToVisible ( pqPipelineRepresentation * repr = nullptr )

static

Rescale range to data range for data visible in the view.

Parameters

[in] repr The data representation to use to determine the data range. If nullptr, then the active representation is used, if available.

Returns: true if the operation was successful, otherwise false.

◆ updateEnableState

void pqRescaleScalarRangeReaction::updateEnableState ( )

overrideslot

Updates the enabled state.

Applications need not explicitly call this.

◆ setRepresentation [1/2]

void pqRescaleScalarRangeReaction::setRepresentation	(	pqDataRepresentation *	repr,
		int	selectedPropertiesType
	)

slot

Set the data representation explicitly when track_active_objects is false.

◆ setRepresentation [2/2]

void pqRescaleScalarRangeReaction::setRepresentation ( pqDataRepresentation * repr )

inlineslot

Set the data representation explicitly when track_active_objects is false.

Definition at line 141 of file pqRescaleScalarRangeReaction.h.

◆ setActiveRepresentation

void pqRescaleScalarRangeReaction::setActiveRepresentation ( )

slot

Set the data representation explicitly when track_active_objects is false.

◆ onTriggered()

void pqRescaleScalarRangeReaction::onTriggered ( )

overrideprotectedvirtual

Called when the action is triggered.

Reimplemented from pqReaction.

◆ onServerAdded

virtual void pqRescaleScalarRangeReaction::onServerAdded ( pqServer * server )

protectedvirtualslot

◆ onAboutToRemoveServer

virtual void pqRescaleScalarRangeReaction::onAboutToRemoveServer ( pqServer * server )

protectedvirtualslot

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

/builds/gitlab-kitware-sciviz-ci/Qt/ApplicationComponents/pqRescaleScalarRangeReaction.h

Public Types

Public Slots

Public Member Functions

Static Public Member Functions

Protected Slots

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ Modes

Constructor & Destructor Documentation

◆ pqRescaleScalarRangeReaction()

◆ ~pqRescaleScalarRangeReaction()

Member Function Documentation

◆ rescaleScalarRangeToData()

◆ rescaleScalarRangeToCustom() [1/3]

◆ rescaleScalarRangeToCustom() [2/3]

◆ rescaleScalarRangeToCustom() [3/3]

◆ rescaleScalarRangeToDataOverTime()

◆ rescaleScalarRangeToVisible()

◆ updateEnableState

◆ setRepresentation [1/2]

◆ setRepresentation [2/2]

◆ setActiveRepresentation

◆ onTriggered()

◆ onServerAdded

◆ onAboutToRemoveServer