This is PQ representation for a single display. More...
#include <pqScatterPlotRepresentation.h>
Public Slots | |
| void | resetLookupTableScalarRange () |
| void | updateLookupTableScalarRange () |
| If color lookuptable is set up and coloring is enabled, the this ensure that the lookuptable scalar range is greater than than the color array's scalar range. | |
Signals | |
| void | colorChanged () |
| Returns the proxy for the piecewise function used to map scalars to opacity. | |
Public Member Functions | |
| pqScatterPlotRepresentation (const QString &group, const QString &name, vtkSMProxy *repr, pqServer *server, QObject *parent=NULL) | |
| virtual | ~pqScatterPlotRepresentation () |
| vtkSMScatterPlotRepresentationProxy * | getRepresentationProxy () const |
| virtual void | setDefaultPropertyValues () |
| Sets the default color mapping for the display. | |
| QPair< double, double > | getColorFieldRange (const QString &array) const |
| Utility function that returns the data range for a particular array. | |
| QPair< double, double > | getColorFieldRange () const |
| Returns the range for the currently selected color field i.e. | |
| bool | isPartial (const QString &array) const |
| Utility function that returns if the array is a partial array or not. | |
| void | setColorField (const QString &field) |
| Set the array to color. | |
| QString | getColorField () const |
| get the array the part is colored by. | |
| bool | getDataBounds (double bounds[6]) const |
| Get the data bounds for the input of this display. | |
Protected Types | |
| enum | AttributeTypes { POINT_DATA = 0, CELL_DATA = 1, FIELD_DATA = 2, COORD_DATA = 3 } |
Protected Slots | |
| void | onColorArrayNameChanged () |
| Called when the "ColorArrayName" property changes. | |
| void | updateScalarBarVisibility (bool visible) |
| called when this representations visibility changes. | |
Protected Member Functions | |
| void | colorByArray (const char *array) |
| Call to select the coloring array. | |
| QString | GetArrayName (const QString &) const |
| Utility function that extracts the name of the color field: Returns <arrayname> from a string of format: "(coord|point|cell|field),<arrayname>(,[0-9]+)". | |
| int | GetArrayType (const QString &) const |
| Utility function that extracts the name of the color field: Returns POINT_DATA, CELL_DATA, FIELD_DATA or COORD_DATA from a string of format: "({coord|point|cell|field},)<arrayname>(,[0-9]+)". | |
| int | GetArrayComponent (const QString &) const |
| Utility function that extracts the component of the color field: Returns -1 if there is no component. | |
| int | GetArrayNumberOfComponents (const QString &) const |
| Utility function that retrieve the number of components of an array. | |
Detailed Description
This is PQ representation for a single display.
A pqRepresentation represents a single vtkSMScatterPlotRepresentationProxy. The display can be added to only one render module or more (of course on the same server, this class doesn't worry about that.
Definition at line 56 of file pqScatterPlotRepresentation.h.
Member Enumeration Documentation
enum pqScatterPlotRepresentation::AttributeTypes [protected] |
Definition at line 158 of file pqScatterPlotRepresentation.h.
Constructor & Destructor Documentation
| pqScatterPlotRepresentation::pqScatterPlotRepresentation | ( | const QString & | group, |
| const QString & | name, | ||
| vtkSMProxy * | repr, | ||
| pqServer * | server, | ||
| QObject * | parent = NULL |
||
| ) |
| virtual pqScatterPlotRepresentation::~pqScatterPlotRepresentation | ( | ) | [virtual] |
Member Function Documentation
| vtkSMScatterPlotRepresentationProxy* pqScatterPlotRepresentation::getRepresentationProxy | ( | ) | const |
| virtual void pqScatterPlotRepresentation::setDefaultPropertyValues | ( | ) | [virtual] |
Sets the default color mapping for the display.
The ColorArrayName property is used to color the data. The name contains the type (point, cell, coord), and the element to use to map the colors. If no element is given or if element == -1, the magnitude of the array is used. ColorArrayName = ({coord|point|cell},)<arrayname>(,<element>)
Reimplemented from pqDataRepresentation.
| QPair<double, double> pqScatterPlotRepresentation::getColorFieldRange | ( | const QString & | array | ) | const |
Utility function that returns the data range for a particular array.
The array must match the expression: ({coord|point|cell},)<arrayname>(,<element>). If the array component == -1, range for the vector magnitude is returned.
Returns the range for the currently selected color field i.e.
the range for the array component (or magnitude) of the array by which this display is being colored, if at all. Returns 0,1 if no array is selected or the current array is invalid.
| bool pqScatterPlotRepresentation::isPartial | ( | const QString & | array | ) | const |
Utility function that returns if the array is a partial array or not.
The array must match the expression: ({coord|point|cell},)<arrayname>(,<element>).
| void pqScatterPlotRepresentation::setColorField | ( | const QString & | field | ) |
Set the array to color.
field is a string of format: "({coord|point|cell|field},)<arrayname>(,[0-9]+)". Dangerous, please set the Property "ColorArrayName" instead.
| QString pqScatterPlotRepresentation::getColorField | ( | ) | const |
get the array the part is colored by.
Warning: the returned array matches the format: ({coord|point|cell|field},)<arrayname>(,[0-9]+)
| bool pqScatterPlotRepresentation::getDataBounds | ( | double | bounds[6] | ) | const |
Get the data bounds for the input of this display.
Returns if the operation was successful. It propagates the computation to the vtkSMRepresentationProxy
| void pqScatterPlotRepresentation::colorChanged | ( | ) | [signal] |
Returns the proxy for the piecewise function used to map scalars to opacity.
Returns the pqScalarOpacityFunction object for the piecewise function used to map scalars to opacity. Returns the opacity. This is fire when any property that affects the color mode for the display changes.
| void pqScatterPlotRepresentation::resetLookupTableScalarRange | ( | ) | [slot] |
| void pqScatterPlotRepresentation::updateLookupTableScalarRange | ( | ) | [slot] |
If color lookuptable is set up and coloring is enabled, the this ensure that the lookuptable scalar range is greater than than the color array's scalar range.
It also updates the scalar range on the scalar-opacity function, if any. Both the ColorLUT and the ScalarOpacityFunction may choose to ignore the set scalar range based on value ScalePointsWithRange.
| void pqScatterPlotRepresentation::onColorArrayNameChanged | ( | ) | [protected, slot] |
Called when the "ColorArrayName" property changes.
We have to ensure that the color field is initialized
| void pqScatterPlotRepresentation::updateScalarBarVisibility | ( | bool | visible | ) | [protected, slot] |
called when this representations visibility changes.
We check if the LUT used to color this repr is being used by any other repr. If not, we turn off the scalar bar.
| void pqScatterPlotRepresentation::colorByArray | ( | const char * | array | ) | [protected] |
Call to select the coloring array.
The user indirectly calls this function by changing the ColorArrayName property
| QString pqScatterPlotRepresentation::GetArrayName | ( | const QString & | ) | const [protected] |
Utility function that extracts the name of the color field: Returns <arrayname> from a string of format: "(coord|point|cell|field),<arrayname>(,[0-9]+)".
| int pqScatterPlotRepresentation::GetArrayType | ( | const QString & | ) | const [protected] |
Utility function that extracts the name of the color field: Returns POINT_DATA, CELL_DATA, FIELD_DATA or COORD_DATA from a string of format: "({coord|point|cell|field},)<arrayname>(,[0-9]+)".
Returns -1 if none of the type can be found
| int pqScatterPlotRepresentation::GetArrayComponent | ( | const QString & | ) | const [protected] |
Utility function that extracts the component of the color field: Returns -1 if there is no component.
The string must be of format: "({coord|point|cell|field},)<arrayname>(,[0-9]+)".
| int pqScatterPlotRepresentation::GetArrayNumberOfComponents | ( | const QString & | ) | const [protected] |
Utility function that retrieve the number of components of an array.
The documentation for this class was generated from the following file:
- /home/kitware/Dashboards/My Tests/ParaView/Qt/Core/pqScatterPlotRepresentation.h
