ParaView
Public Slots | Public Member Functions | Protected Member Functions
pqLookupTableManager Class Reference

pqLookupTableManager is the manager that manages color lookup objects. More...

#include <pqLookupTableManager.h>

Inheritance diagram for pqLookupTableManager:
Inheritance graph
[legend]

List of all members.

Public Slots

virtual void updateLookupTableScalarRanges ()=0
 Called to update scalar ranges of all lookup tables.

Public Member Functions

 pqLookupTableManager (QObject *parent=NULL)
virtual ~pqLookupTableManager ()
virtual pqScalarsToColorsgetLookupTable (pqServer *server, const QString &arrayname, int number_of_components, int component)=0
 Get a LookupTable for the array with name arrayname and component.
virtual pqScalarOpacityFunctiongetScalarOpacityFunction (pqServer *server, const QString &arrayname, int number_of_components, int component)=0
 Returns the pqScalarOpacityFunction object for the piecewise function used to map scalars to opacity.
virtual void saveLUTAsDefault (pqScalarsToColors *)=0
 Saves the state of the lut/opacity-function so that the next time a new LUT/opacity-function is created, it will have the same state as this one.
virtual void saveOpacityFunctionAsDefault (pqScalarOpacityFunction *)=0
virtual void saveScalarBarAsDefault (pqScalarBarRepresentation *)=0
 save the state of the scalar bar, so that the next time a new scalar bar is created its properties are setup using the defaults specified.
virtual pqScalarBarRepresentationsetScalarBarVisibility (pqDataRepresentation *repr, bool visible)
 Set the scalar bar's visibility for the given lookup table in the given view.
virtual bool getLookupTableProperties (pqScalarsToColors *lut, QString &arrayname, int &numComponents, int &component)=0
 Used to get the array the lut is associated with.

Protected Member Functions

virtual void onAddLookupTable (pqScalarsToColors *lut)=0
 Called when a LUT is added.
virtual void onRemoveLookupTable (pqScalarsToColors *lut)=0
 Called when a LUT is removed.
virtual void onAddOpacityFunction (pqScalarOpacityFunction *)
 Called when a OpactiyFunction is added.
virtual void onRemoveOpacityFunction (pqScalarOpacityFunction *)
 Called when a OpactiyFunction is removed.
virtual void initialize (pqScalarBarRepresentation *)
 called when a new scalar is created so that subclasses have a change to change the default values as needed.

Detailed Description

pqLookupTableManager is the manager that manages color lookup objects.

This is an abstract class that defines the API for any LUT manager. subclasses are free to implement their own policy which can be specific to the application.

Definition at line 49 of file pqLookupTableManager.h.


Constructor & Destructor Documentation

pqLookupTableManager::pqLookupTableManager ( QObject *  parent = NULL)
virtual pqLookupTableManager::~pqLookupTableManager ( ) [virtual]

Member Function Documentation

virtual pqScalarsToColors* pqLookupTableManager::getLookupTable ( pqServer server,
const QString &  arrayname,
int  number_of_components,
int  component 
) [pure virtual]

Get a LookupTable for the array with name arrayname and component.

component = -1 represents magnitude. Subclasses can implemenent their own policy for managing lookup tables.

Implemented in pqPQLookupTableManager.

virtual pqScalarOpacityFunction* pqLookupTableManager::getScalarOpacityFunction ( pqServer server,
const QString &  arrayname,
int  number_of_components,
int  component 
) [pure virtual]

Returns the pqScalarOpacityFunction object for the piecewise function used to map scalars to opacity.

Implemented in pqPQLookupTableManager.

virtual void pqLookupTableManager::saveLUTAsDefault ( pqScalarsToColors ) [pure virtual]

Saves the state of the lut/opacity-function so that the next time a new LUT/opacity-function is created, it will have the same state as this one.

Implemented in pqPQLookupTableManager.

virtual void pqLookupTableManager::saveOpacityFunctionAsDefault ( pqScalarOpacityFunction ) [pure virtual]

Implemented in pqPQLookupTableManager.

virtual void pqLookupTableManager::saveScalarBarAsDefault ( pqScalarBarRepresentation ) [pure virtual]

save the state of the scalar bar, so that the next time a new scalar bar is created its properties are setup using the defaults specified.

Implemented in pqPQLookupTableManager.

virtual pqScalarBarRepresentation* pqLookupTableManager::setScalarBarVisibility ( pqDataRepresentation repr,
bool  visible 
) [virtual]

Set the scalar bar's visibility for the given lookup table in the given view.

This may result in creating of a new scalar bar. This assumes that the pqScalarsToColors passed as an argument is indeed managed by this pqLookupTableManager (that's needed to determine the default labels for the scalar bar if a new scalar bar is created). Returns the scalar bar, if any.

virtual bool pqLookupTableManager::getLookupTableProperties ( pqScalarsToColors lut,
QString &  arrayname,
int numComponents,
int component 
) [pure virtual]

Used to get the array the lut is associated with.

Return false if no such association exists.

Implemented in pqPQLookupTableManager.

virtual void pqLookupTableManager::updateLookupTableScalarRanges ( ) [pure virtual, slot]

Called to update scalar ranges of all lookup tables.

Implemented in pqPQLookupTableManager.

virtual void pqLookupTableManager::onAddLookupTable ( pqScalarsToColors lut) [protected, pure virtual]

Called when a LUT is added.

Implemented in pqPQLookupTableManager.

virtual void pqLookupTableManager::onRemoveLookupTable ( pqScalarsToColors lut) [protected, pure virtual]

Called when a LUT is removed.

Implemented in pqPQLookupTableManager.

virtual void pqLookupTableManager::onAddOpacityFunction ( pqScalarOpacityFunction ) [inline, protected, virtual]

Called when a OpactiyFunction is added.

Reimplemented in pqPQLookupTableManager.

Definition at line 114 of file pqLookupTableManager.h.

virtual void pqLookupTableManager::onRemoveOpacityFunction ( pqScalarOpacityFunction ) [inline, protected, virtual]

Called when a OpactiyFunction is removed.

Reimplemented in pqPQLookupTableManager.

Definition at line 117 of file pqLookupTableManager.h.

virtual void pqLookupTableManager::initialize ( pqScalarBarRepresentation ) [inline, protected, virtual]

called when a new scalar is created so that subclasses have a change to change the default values as needed.

Reimplemented in pqPQLookupTableManager.

Definition at line 121 of file pqLookupTableManager.h.


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