Public Types | Public Slots | Public Member Functions | Static Public Member Functions | Protected Slots | Protected Member Functions | List of all members
pqResetScalarRangeReaction Class Reference

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

#include <pqResetScalarRangeReaction.h>

Inheritance diagram for pqResetScalarRangeReaction:
Inheritance graph
[legend]
Collaboration diagram for pqResetScalarRangeReaction:
Collaboration graph
[legend]

Public Types

enum  Modes { DATA, CUSTOM, TEMPORAL, VISIBLE }
 

Public Slots

void updateEnableState () override
 Updates the enabled state. More...
 
void setRepresentation (pqDataRepresentation *repr)
 Set the data representation explicitly when track_active_objects is false. More...
 

Public Member Functions

 pqResetScalarRangeReaction (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...
 
 ~pqResetScalarRangeReaction () 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 void resetScalarRange (pqPipelineRepresentation *repr=NULL)
 
static bool resetScalarRangeToData (pqPipelineRepresentation *repr=NULL)
 Reset to current data range. More...
 
static bool resetScalarRangeToCustom (pqPipelineRepresentation *repr=NULL)
 Reset range to a custom range. More...
 
static bool resetScalarRangeToCustom (vtkSMProxy *tfProxy, bool separateOpacity=false)
 Reset range to a custom range. More...
 
static bool resetScalarRangeToDataOverTime (pqPipelineRepresentation *repr=NULL)
 Reset range to data range over time. More...
 
static bool resetScalarRangeToVisible (pqPipelineRepresentation *repr=NULL)
 Reset 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 reset 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 53 of file pqResetScalarRangeReaction.h.

Member Enumeration Documentation

◆ Modes

Enumerator
DATA 
CUSTOM 
TEMPORAL 
VISIBLE 

Definition at line 59 of file pqResetScalarRangeReaction.h.

Constructor & Destructor Documentation

◆ pqResetScalarRangeReaction()

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

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

◆ ~pqResetScalarRangeReaction()

pqResetScalarRangeReaction::~pqResetScalarRangeReaction ( )
override

Member Function Documentation

◆ resetScalarRange()

static void pqResetScalarRangeReaction::resetScalarRange ( pqPipelineRepresentation repr = NULL)
inlinestatic

◆ resetScalarRangeToData()

static bool pqResetScalarRangeReaction::resetScalarRangeToData ( pqPipelineRepresentation repr = NULL)
static

Reset to current data range.

Parameters
[in]reprThe 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.

◆ resetScalarRangeToCustom() [1/2]

static bool pqResetScalarRangeReaction::resetScalarRangeToCustom ( pqPipelineRepresentation repr = NULL)
static

Reset range to a custom range.

Parameters
[in]reprThe representation used to determine the transfer function to change range on. If repr is nullptr, then the active representation is used, if available.
Returns
true if the operation was successful, otherwise false.

◆ resetScalarRangeToCustom() [2/2]

static bool pqResetScalarRangeReaction::resetScalarRangeToCustom ( vtkSMProxy tfProxy,
bool  separateOpacity = false 
)
static

Reset range to a custom range.

Parameters
[in]tfProxyThe transfer function proxy to reset the range on.
[in]separateOpacityShow controls for setting the opacity function range separately from the color transfer function.
Returns
true if the operation was successful, otherwise false.

◆ resetScalarRangeToDataOverTime()

static bool pqResetScalarRangeReaction::resetScalarRangeToDataOverTime ( pqPipelineRepresentation repr = NULL)
static

Reset range to data range over time.

Parameters
[in]reprThe 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.

◆ resetScalarRangeToVisible()

static bool pqResetScalarRangeReaction::resetScalarRangeToVisible ( pqPipelineRepresentation repr = NULL)
static

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

Parameters
[in]reprThe 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 pqResetScalarRangeReaction::updateEnableState ( )
overrideslot

Updates the enabled state.

Applications need not explicitly call this.

◆ setRepresentation

void pqResetScalarRangeReaction::setRepresentation ( pqDataRepresentation repr)
slot

Set the data representation explicitly when track_active_objects is false.

◆ onTriggered()

void pqResetScalarRangeReaction::onTriggered ( )
overrideprotectedvirtual

Called when the action is triggered.

Reimplemented from pqReaction.

◆ onServerAdded

virtual void pqResetScalarRangeReaction::onServerAdded ( pqServer server)
protectedvirtualslot

◆ onAboutToRemoveServer

virtual void pqResetScalarRangeReaction::onAboutToRemoveServer ( pqServer server)
protectedvirtualslot

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