ParaView
Public Types | Public Slots | Signals | Public Member Functions | Static Public Member Functions | Protected Slots | Protected Member Functions | Friends
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]

List of all members.

Public Types

enum  Mode { MAGNITUDE = 0, COMPONENT = 1 }
enum  RangeScalingModes { GROW_ON_MODIFIED, GROW_ON_UPDATED }

Public Slots

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

Signals

void scalarBarsChanged ()
 Fired after a new scalar bar is added or removed from this LUT.

Public Member Functions

 pqScalarsToColors (const QString &group, const QString &name, vtkSMProxy *proxy, pqServer *server, QObject *parent=NULL)
virtual ~pqScalarsToColors ()
pqScalarBarRepresentationgetScalarBar (pqRenderViewBase *ren) const
 Returns the first scalar bar visible in the given render module, if any.
bool getScalarRangeLock () const
 Returns if the lookup table's scalar range is locked.
void setWholeScalarRange (double min, double max)
 Set the scalar range if the range specified is greater than the current scalar range.
void setScalarRange (double min, double max)
 Sets the scalar range.
QPair< double, doublegetScalarRange () const
 Returns the current scalar range.
bool getUseLogScale () const
 Returns true if a log scale is being used.
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.

Static Public Member Functions

static void setColorRangeScalingMode (int)
 This merely update the application settings with correct values for the temporal range scaling mode.
static int colorRangeScalingMode (int default_value=GROW_ON_MODIFIED)

Protected Slots

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

Protected Member Functions

void addScalarBar (pqScalarBarRepresentation *)
void removeScalarBar (pqScalarBarRepresentation *)

Friends

class pqScalarBarRepresentation

Detailed Description

pqScalarsToColors is a represents a vtkScalarsToColors proxy.

Definition at line 43 of file pqScalarsToColors.h.


Member Enumeration Documentation

Enumerator:
MAGNITUDE 
COMPONENT 

Definition at line 78 of file pqScalarsToColors.h.

Enumerator:
GROW_ON_MODIFIED 
GROW_ON_UPDATED 

Definition at line 98 of file pqScalarsToColors.h.


Constructor & Destructor Documentation

pqScalarsToColors::pqScalarsToColors ( const QString &  group,
const QString &  name,
vtkSMProxy proxy,
pqServer server,
QObject *  parent = NULL 
)
virtual pqScalarsToColors::~pqScalarsToColors ( ) [virtual]

Member Function Documentation

pqScalarBarRepresentation* pqScalarsToColors::getScalarBar ( pqRenderViewBase ren) const

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

bool pqScalarsToColors::getScalarRangeLock ( ) const

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

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

Set the scalar range if the range specified is greater than the current scalar range.

This call respects the ScalarRangeLock. If the lock is set, then this call has no effect. If ScalarRangeLock is false, then this call will move all control points uniformly to fit the new range.

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.

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).

bool pqScalarsToColors::getUseLogScale ( ) const

Returns true if a log scale is being used.

void pqScalarsToColors::setVectorMode ( Mode  mode,
int  component 
)
Mode pqScalarsToColors::getVectorMode ( ) const
int pqScalarsToColors::getVectorComponent ( ) const
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.

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.

static int pqScalarsToColors::colorRangeScalingMode ( int  default_value = GROW_ON_MODIFIED) [static]
void pqScalarsToColors::hideUnusedScalarBars ( ) [slot]
void pqScalarsToColors::setScalarRangeLock ( bool  lock) [slot]

Set the scalar range lock.

void pqScalarsToColors::build ( ) [slot]

Triggers a build on the lookup table.

void pqScalarsToColors::scalarBarsChanged ( ) [signal]

Fired after a new scalar bar is added or removed from this LUT.

void pqScalarsToColors::addScalarBar ( pqScalarBarRepresentation ) [protected]
void pqScalarsToColors::removeScalarBar ( pqScalarBarRepresentation ) [protected]
void pqScalarsToColors::checkRange ( ) [protected, slot]

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


Friends And Related Function Documentation

friend class pqScalarBarRepresentation [friend]

Definition at line 130 of file pqScalarsToColors.h.


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