ParaView
Signals | Public Member Functions | Protected Slots | Protected Member Functions
pqDataRepresentation Class Reference

pqDataRepresentation is the superclass for a display for a pqPipelineSource i.e. More...

#include <pqDataRepresentation.h>

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

List of all members.

Signals

void dataUpdated ()
 Fired when the representation proxy fires the vtkCommand::UpdateDataEvent.

Public Member Functions

 pqDataRepresentation (const QString &group, const QString &name, vtkSMProxy *display, pqServer *server, QObject *parent=0)
virtual ~pqDataRepresentation ()
pqPipelineSourcegetInput () const
 Get the source/filter of which this is a display.
pqOutputPortgetOutputPortFromInput () const
 Returns the input pqPipelineSource's output port to which this representation is connected.
vtkPVDataInformationgetInputDataInformation () const
 Returns the data information for the data coming into the representation as input.
vtkPVTemporalDataInformationgetInputTemporalDataInformation () const
 Returns the temporal data information for the input.
vtkPVDataInformationgetRepresentedDataInformation (bool update=true) const
 Returns the represented data information.
bool getDataBounds (double bounds[6])
 Get the data bounds for the input of this display.
virtual vtkSMProxygetLookupTableProxy ()
 Returns the lookuptable proxy, if any.
virtual pqScalarsToColorsgetLookupTable ()
 Returns the pqScalarsToColors object for the lookup table proxy if any.
virtual vtkSMProxygetScalarOpacityFunctionProxy ()
 Returns the proxy for the piecewise function used to map scalars to opacity.
virtual pqScalarOpacityFunctiongetScalarOpacityFunction ()
 Returns the pqScalarOpacityFunction object for the piecewise function used to map scalars to opacity.
virtual void setDefaultPropertyValues ()
 Sets default values for the underlying proxy.
unsigned long getFullResMemorySize ()
 Returns the data size for the full-res data.
pqDataRepresentationgetRepresentationForUpstreamSource () const
 This is convienience method to return first representation for the upstream stream filter/source in the same view as this representation.
virtual int getProxyScalarMode ()
virtual int getNumberOfComponents (const char *arrayname, int fieldType)
virtual QString getComponentName (const char *arrayname, int fieldtype, int component)

Protected Slots

virtual void onInputChanged ()
 called when input property on display changes.

Protected Member Functions

virtual void initialize ()
 Use this method to initialize the pqObject state using the underlying vtkSMProxy.
virtual vtkPVArrayInformationgetArrayInformation (const char *arrayname, const int &fieldType)

Detailed Description

pqDataRepresentation is the superclass for a display for a pqPipelineSource i.e.

the input for this display proxy is a pqPiplineSource. This class manages the linking between the pqPiplineSource and pqDataRepresentation.

Definition at line 52 of file pqDataRepresentation.h.


Constructor & Destructor Documentation

pqDataRepresentation::pqDataRepresentation ( const QString &  group,
const QString &  name,
vtkSMProxy display,
pqServer server,
QObject *  parent = 0 
)
virtual pqDataRepresentation::~pqDataRepresentation ( ) [virtual]

Member Function Documentation

pqPipelineSource* pqDataRepresentation::getInput ( ) const

Get the source/filter of which this is a display.

pqOutputPort* pqDataRepresentation::getOutputPortFromInput ( ) const

Returns the input pqPipelineSource's output port to which this representation is connected.

vtkPVDataInformation* pqDataRepresentation::getInputDataInformation ( ) const

Returns the data information for the data coming into the representation as input.

vtkPVTemporalDataInformation* pqDataRepresentation::getInputTemporalDataInformation ( ) const

Returns the temporal data information for the input.

This can be a very slow process. Use with extreme caution!!!

vtkPVDataInformation* pqDataRepresentation::getRepresentedDataInformation ( bool  update = true) const

Returns the represented data information.

Depending on the representation this may differ from the input data information eg. if the representation shows an outline of the data, the this method will return the information about the polydata forming the outline not the input dataset.

bool pqDataRepresentation::getDataBounds ( double  bounds[6])

Get the data bounds for the input of this display.

Returns if the operation was successful.

virtual vtkSMProxy* pqDataRepresentation::getLookupTableProxy ( ) [virtual]

Returns the lookuptable proxy, if any.

Most consumer displays take a lookup table. This method provides access to the Lookup table, if one exists.

virtual pqScalarsToColors* pqDataRepresentation::getLookupTable ( ) [virtual]

Returns the pqScalarsToColors object for the lookup table proxy if any.

Most consumer displays take a lookup table. This method provides access to the Lookup table, if one exists.

virtual vtkSMProxy* pqDataRepresentation::getScalarOpacityFunctionProxy ( ) [inline, virtual]

Returns the proxy for the piecewise function used to map scalars to opacity.

Reimplemented in pqPipelineRepresentation.

Definition at line 100 of file pqDataRepresentation.h.

virtual pqScalarOpacityFunction* pqDataRepresentation::getScalarOpacityFunction ( ) [inline, virtual]

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

Reimplemented in pqPipelineRepresentation.

Definition at line 104 of file pqDataRepresentation.h.

virtual void pqDataRepresentation::setDefaultPropertyValues ( ) [virtual]

Sets default values for the underlying proxy.

This is during the initialization stage of the pqProxy for proxies created by the GUI itself i.e. for proxies loaded through state or created by python client this method won't be called. The default implementation iterates over all properties of the proxy and sets them to default values.

Reimplemented from pqProxy.

Reimplemented in pqPipelineRepresentation, pqScatterPlotRepresentation, pqChartRepresentation, and pqTextRepresentation.

unsigned long pqDataRepresentation::getFullResMemorySize ( )

Returns the data size for the full-res data.

This may trigger a pipeline update to obtain correct data sizes.

pqDataRepresentation* pqDataRepresentation::getRepresentationForUpstreamSource ( ) const

This is convienience method to return first representation for the upstream stream filter/source in the same view as this representation.

This is only applicable, if this representation is connected to a data-filter which has a valid input.

virtual int pqDataRepresentation::getProxyScalarMode ( ) [virtual]
virtual int pqDataRepresentation::getNumberOfComponents ( const char *  arrayname,
int  fieldType 
) [virtual]

Reimplemented in pqPipelineRepresentation.

virtual QString pqDataRepresentation::getComponentName ( const char *  arrayname,
int  fieldtype,
int  component 
) [virtual]

Reimplemented in pqPipelineRepresentation.

void pqDataRepresentation::dataUpdated ( ) [signal]

Fired when the representation proxy fires the vtkCommand::UpdateDataEvent.

virtual void pqDataRepresentation::onInputChanged ( ) [protected, virtual, slot]

called when input property on display changes.

We must detect if (and when) the display is connected to a new proxy.

Reimplemented from pqServerManagerModelItem.

Reimplemented in pqPipelineRepresentation.

virtual void pqDataRepresentation::initialize ( ) [inline, protected, virtual]

Use this method to initialize the pqObject state using the underlying vtkSMProxy.

This needs to be done only once, after the object has been created.

Reimplemented from pqProxy.

Definition at line 142 of file pqDataRepresentation.h.

virtual vtkPVArrayInformation* pqDataRepresentation::getArrayInformation ( const char *  arrayname,
const int fieldType 
) [protected, virtual]

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