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

pqScalarsToColors is a represents a vtkScalarsToColors proxy. More...

#include <pqScalarsToColors.h>

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

Public Types

enum  Mode { MAGNITUDE = 0, COMPONENT = 1 }
 
enum  RangeScalingModes { GROW_ON_MODIFIED, GROW_ON_UPDATED }
 
- Public Types inherited from pqProxy
enum  ModifiedState { UNINITIALIZED, MODIFIED, UNMODIFIED }
 The modification state of this proxy. More...
 

Public Slots

void hideUnusedScalarBars ()
 
void setScalarRangeLock (bool lock)
 Set the scalar range lock. More...
 
void build ()
 Triggers a build on the lookup table. More...
 

Signals

void componentOrModeChanged ()
 signal fired when the "VectorMode" or "VectorComponent" properties are modified. 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

 pqScalarsToColors (const QString &group, const QString &name, vtkSMProxy *proxy, pqServer *server, QObject *parent=nullptr)
 
 ~pqScalarsToColors () override
 
pqScalarBarRepresentationgetScalarBar (pqRenderViewBase *ren) const
 Returns the first scalar bar visible in the given render module, if any. More...
 
bool getScalarRangeLock () const
 Returns if the lookup table's scalar range is locked. More...
 
void setScalarRange (double min, double max)
 Sets the scalar range. More...
 
QPair< double, doublegetScalarRange () const
 Returns the current scalar range. More...
 
bool getUseLogScale () const
 Returns true if a log scale is being used. More...
 
void setVectorMode (Mode mode, int component)
 
Mode getVectorMode () const
 
int getVectorComponent () const
 
void updateScalarBarTitles (const QString &component)
 Convenience method to update the titles for all color legends showing this lookup table. More...
 
- Public Member Functions inherited from pqProxy
 pqProxy (const QString &group, const QString &name, vtkSMProxy *proxy, pqServer *server, QObject *parent=nullptr)
 
 ~pqProxy () override
 
pqServergetServer () 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 ()
 
vtkSMProxygetProxy () 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...
 
vtkPVXMLElementgetHints () 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...
 
vtkSMSessionProxyManagerproxyManager () 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
 

Static Public Member Functions

static void setColorRangeScalingMode (int)
 This merely update the application settings with correct values for the temporal range scaling mode. More...
 
static int colorRangeScalingMode (int default_value=GROW_ON_MODIFIED)
 
- Static Public Member Functions inherited from pqProxy
static pqProxyfindProxyWithHelper (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...
 

Protected Slots

void checkRange ()
 Checks to make sure that the range is compatible with the log flag and adjusts it if necessary. More...
 
- Protected Slots inherited from pqProxy
void onProxyRegistered (const QString &, const QString &, vtkSMProxy *)
 
void onProxyUnRegistered (const QString &, const QString &, vtkSMProxy *)
 

Additional Inherited Members

- 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
vtkEventQtSlotConnectgetConnector ()
 All subclasses generally need some vtkEventQtSlotConnect instance to connect to VTK events. More...
 

Detailed Description

pqScalarsToColors is a represents a vtkScalarsToColors proxy.

Definition at line 47 of file pqScalarsToColors.h.

Member Enumeration Documentation

◆ Mode

Enumerator
MAGNITUDE 
COMPONENT 

Definition at line 83 of file pqScalarsToColors.h.

◆ RangeScalingModes

Enumerator
GROW_ON_MODIFIED 
GROW_ON_UPDATED 

Definition at line 105 of file pqScalarsToColors.h.

Constructor & Destructor Documentation

◆ pqScalarsToColors()

pqScalarsToColors::pqScalarsToColors ( const QString &  group,
const QString &  name,
vtkSMProxy proxy,
pqServer server,
QObject *  parent = nullptr 
)

◆ ~pqScalarsToColors()

pqScalarsToColors::~pqScalarsToColors ( )
override

Member Function Documentation

◆ getScalarBar()

pqScalarBarRepresentation* pqScalarsToColors::getScalarBar ( pqRenderViewBase ren) const

Returns the first scalar bar visible in the given render module, if any.

◆ getScalarRangeLock()

bool pqScalarsToColors::getScalarRangeLock ( ) const

Returns if the lookup table's scalar range is locked.

◆ setScalarRange()

void pqScalarsToColors::setScalarRange ( double  min,
double  max 
)

Sets the scalar range.

Does not consider the ScalarRangeLock. Moves all control points uniformly to fit the new range.

◆ getScalarRange()

QPair<double, double> pqScalarsToColors::getScalarRange ( ) const

Returns the current scalar range.

If number of RGBPoints is 0, then the scalar range is not defined (in which case this method returns (0, 0).

◆ getUseLogScale()

bool pqScalarsToColors::getUseLogScale ( ) const

Returns true if a log scale is being used.

◆ setVectorMode()

void pqScalarsToColors::setVectorMode ( Mode  mode,
int  component 
)

◆ getVectorMode()

Mode pqScalarsToColors::getVectorMode ( ) const

◆ getVectorComponent()

int pqScalarsToColors::getVectorComponent ( ) const

◆ updateScalarBarTitles()

void pqScalarsToColors::updateScalarBarTitles ( const QString &  component)

Convenience method to update the titles for all color legends showing this lookup table.

This only updates the component part of the title.

◆ setColorRangeScalingMode()

static void pqScalarsToColors::setColorRangeScalingMode ( int  )
static

This merely update the application settings with correct values for the temporal range scaling mode.

Components that scale scalar range should look at this setting to determine how the scaling should be done. This provides access to the application settings that controls when color table ranges are updated by the application. Components that scale scalar range should look at this setting to determine how the scaling should be done.

◆ colorRangeScalingMode()

static int pqScalarsToColors::colorRangeScalingMode ( int  default_value = GROW_ON_MODIFIED)
static

◆ componentOrModeChanged

void pqScalarsToColors::componentOrModeChanged ( )
signal

signal fired when the "VectorMode" or "VectorComponent" properties are modified.

◆ hideUnusedScalarBars

void pqScalarsToColors::hideUnusedScalarBars ( )
slot

◆ setScalarRangeLock

void pqScalarsToColors::setScalarRangeLock ( bool  lock)
slot

Set the scalar range lock.

◆ build

void pqScalarsToColors::build ( )
slot

Triggers a build on the lookup table.

◆ checkRange

void pqScalarsToColors::checkRange ( )
protectedslot

Checks to make sure that the range is compatible with the log flag and adjusts it if necessary.


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