ParaView
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkPVPlotMatrixRepresentation Class Reference

vtkChartRepresentation subclass for scatter-plot-matrix representation. More...

#include <vtkPVPlotMatrixRepresentation.h>

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

Public Types

typedef vtkChartRepresentation Superclass
 
- Public Types inherited from vtkChartRepresentation
typedef vtkPVDataRepresentation Superclass
 
- Public Types inherited from vtkPVDataRepresentation
typedef vtkDataRepresentation Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void SetVisibility (bool visible)
 Sets the visibility for the plot matrix representation. More...
 
void SetColor (double r, double g, double b)
 Sets the color for the scatter plots in the plot matrix. More...
 
void SetActivePlotColor (double r, double g, double b)
 Sets the color for the active plot. More...
 
void SetHistogramColor (double r, double g, double b)
 Sets the color for the histograms. More...
 
void SetMarkerStyle (int style)
 Sets the marker style for the scatter plots. More...
 
void SetActivePlotMarkerStyle (int style)
 Sets the marker style for the active plot. More...
 
void SetMarkerSize (double size)
 Sets the marker size for the scatter plots. More...
 
void SetActivePlotMarkerSize (double size)
 Sets the marker size for the active plots. More...
 
vtkScatterPlotMatrix * GetPlotMatrix () const
 Returns the scatter plot matrix. More...
 
void SetSeriesVisibility (const char *series, bool visibility)
 Set series visibility given its name. More...
 
void ClearSeriesVisibilities ()
 Set series visibility given its name. More...
 
- Public Member Functions inherited from vtkChartRepresentation
void PrintSelf (ostream &os, vtkIndent indent)
 
void SetSelectionRepresentation (vtkChartSelectionRepresentation *)
 These must only be set during initialization before adding the representation to any views or calling Update(). More...
 
virtual void MarkModified ()
 This needs to be called on all instances of vtkGeometryRepresentation when the input is modified. More...
 
void SetCompositeDataSetIndex (unsigned int)
 
void AddCompositeDataSetIndex (unsigned int)
 
void ResetCompositeDataSetIndices ()
 
virtual unsigned int Initialize (unsigned int minIdAvailable, unsigned int maxIdAvailable)
 Override because of internal selection representations that need to be initialized as well. More...
 
virtual int ProcessViewRequest (vtkInformationRequestKey *request_type, vtkInformation *inInfo, vtkInformation *outInfo)
 vtkAlgorithm::ProcessRequest() equivalent for rendering passes. More...
 
virtual vtkStdString GetDefaultSeriesLabel (const vtkStdString &tableName, const vtkStdString &columnName)
 Method to provide the default name given the name of a table and a column in that table. More...
 
virtual bool MapSelectionToInput (vtkSelection *sel)
 This method is called on the client-side by the vtkPVContextView whenever a new selection is made on all the visible representations in that view. More...
 
virtual bool MapSelectionToView (vtkSelection *sel)
 This is the inverse of MapSelectionToInput(). More...
 
virtual bool Export (vtkCSVExporter *vtkNotUsed(exporter))
 Called by vtkPVContextView::Export() to export the representation's data to a CSV file. More...
 
void SetFieldAssociation (int)
 Set the field association for arrays to use. More...
 
virtual int GetFieldAssociation ()
 Set the field association for arrays to use. More...
 
virtual void SetFlattenTable (int)
 Flatten the table, i.e. More...
 
virtual int GetFlattenTable ()
 Flatten the table, i.e. More...
 
- Public Member Functions inherited from vtkPVDataRepresentation
void PrintSelf (ostream &os, vtkIndent indent)
 
unsigned int GetUniqueIdentifier ()
 Return 0 if the Initialize() method was not called otherwise a unique ID that will be shared across the processes for that same object. More...
 
virtual bool GetVisibility ()
 
virtual vtkDataObject * GetRenderedDataObject (int vtkNotUsed(port))
 Returns the data object that is rendered from the given input port. More...
 
virtual void SetForcedCacheKey (double val)
 Typically a representation decides whether to use cache based on the view's values for UseCache and CacheKey. More...
 
virtual void SetForceUseCache (bool val)
 
bool GetUsingCacheForUpdate ()
 Called by vtkPVDataRepresentationPipeline to see if using cache is valid and will be used for the update. More...
 
virtual bool GetNeedUpdate ()
 
virtual vtkAlgorithmOutput * GetInternalOutputPort ()
 Retrieves an output port for the input data object at the specified port and connection index. More...
 
virtual vtkAlgorithmOutput * GetInternalOutputPort (int port)
 
virtual vtkAlgorithmOutput * GetInternalOutputPort (int port, int conn)
 
vtkView * GetView () const
 Provides access to the view. More...
 
virtual void SetUpdateTime (double time)
 Set the update time. More...
 
virtual double GetUpdateTime ()
 Set the update time. More...
 
virtual bool GetUpdateTimeValid ()
 Set whether the UpdateTime is valid. More...
 
virtual void SetUseCache (bool)
 
virtual void SetCacheKey (double val)
 
virtual double GetCacheKey ()
 Returns whether caching is used and what key to use when caching is enabled. More...
 
virtual bool GetUseCache ()
 Returns whether caching is used and what key to use when caching is enabled. More...
 

Static Public Member Functions

static vtkPVPlotMatrixRepresentationNew ()
 
static int IsTypeOf (const char *type)
 
static vtkPVPlotMatrixRepresentationSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkChartRepresentation
static vtkChartRepresentationNew ()
 
static int IsTypeOf (const char *type)
 
static vtkChartRepresentationSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkPVDataRepresentation
static int IsTypeOf (const char *type)
 
static vtkPVDataRepresentationSafeDownCast (vtkObject *o)
 

Protected Member Functions

 vtkPVPlotMatrixRepresentation ()
 
 ~vtkPVPlotMatrixRepresentation ()
 
virtual void PrepareForRendering ()
 Overridden to pass information about changes to series visibility etc. More...
 
virtual bool AddToView (vtkView *view)
 Add the plot matrix representation to the view. More...
 
virtual bool RemoveFromView (vtkView *view)
 Remove the plot matrix representation from the view. More...
 
- Protected Member Functions inherited from vtkChartRepresentation
 vtkChartRepresentation ()
 
 ~vtkChartRepresentation ()
 
virtual int FillInputPortInformation (int port, vtkInformation *info)
 Fill input port information. More...
 
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 Subclasses should override this to connect inputs to the internal pipeline as necessary. More...
 
virtual bool IsCached (double cache_key)
 Overridden to check with the vtkPVCacheKeeper to see if the key is cached. More...
 
vtkTable * GetLocalOutput ()
 Convenience method to get the first vtkTable from LocalOutput, if any. More...
 
virtual vtkDataObject * TransformInputData (vtkInformationVector **inputVector, vtkDataObject *data)
 Method to be overrided to transform input data to a vtkTable. More...
 
bool GetLocalOutput (MapOfTables &tables)
 Convenience method to get all vtkTable instances with their associated names. More...
 
- Protected Member Functions inherited from vtkPVDataRepresentation
 vtkPVDataRepresentation ()
 
 ~vtkPVDataRepresentation ()
 
virtual vtkExecutive * CreateDefaultExecutive ()
 Create a default executive. More...
 
virtual int RequestUpdateExtent (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
virtual int RequestUpdateTime (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 

Additional Inherited Members

- Protected Types inherited from vtkChartRepresentation
typedef std::map< std::string, vtkSmartPointer< vtkTable > > MapOfTables
 
- Protected Attributes inherited from vtkChartRepresentation
int FieldAssociation
 
vtkPVCacheKeeperCacheKeeper
 
vtkWeakPointer< vtkPVContextViewContextView
 
bool EnableServerSideRendering
 
int FlattenTable
 
vtkSmartPointer< vtkMultiBlockDataSet > LocalOutput
 
std::set< unsigned int > CompositeIndices
 
vtkWeakPointer< vtkChartSelectionRepresentationSelectionRepresentation
 
- Protected Attributes inherited from vtkPVDataRepresentation
double UpdateTime
 
bool UpdateTimeValid
 
unsigned int UniqueIdentifier
 

Detailed Description

vtkChartRepresentation subclass for scatter-plot-matrix representation.

vtkPVPlotMatrixRepresentation manages representations in a vtkScatterPlotMatrix view. It exposes API that affects how the matrix is rendered as well as API to control which of the columns in the input vtkTable are to be plotted in the matrix.

vtkPVPlotMatrixRepresentation currently does not support multiblock of tables and only the first table is rendered.

Definition at line 56 of file vtkPVPlotMatrixRepresentation.h.

Member Typedef Documentation

◆ Superclass

Definition at line 61 of file vtkPVPlotMatrixRepresentation.h.

Constructor & Destructor Documentation

◆ vtkPVPlotMatrixRepresentation()

vtkPVPlotMatrixRepresentation::vtkPVPlotMatrixRepresentation ( )
protected

◆ ~vtkPVPlotMatrixRepresentation()

vtkPVPlotMatrixRepresentation::~vtkPVPlotMatrixRepresentation ( )
protected

Member Function Documentation

◆ New()

static vtkPVPlotMatrixRepresentation* vtkPVPlotMatrixRepresentation::New ( )
static

◆ GetClassName()

virtual const char* vtkPVPlotMatrixRepresentation::GetClassName ( )
virtual

Reimplemented from vtkChartRepresentation.

◆ IsTypeOf()

static int vtkPVPlotMatrixRepresentation::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual int vtkPVPlotMatrixRepresentation::IsA ( const char *  type)
virtual

Reimplemented from vtkChartRepresentation.

◆ SafeDownCast()

static vtkPVPlotMatrixRepresentation* vtkPVPlotMatrixRepresentation::SafeDownCast ( vtkObject *  o)
static

◆ PrintSelf()

void vtkPVPlotMatrixRepresentation::PrintSelf ( ostream &  os,
vtkIndent  indent 
)

◆ SetVisibility()

virtual void vtkPVPlotMatrixRepresentation::SetVisibility ( bool  visible)
virtual

Sets the visibility for the plot matrix representation.

Reimplemented from vtkChartRepresentation.

◆ SetSeriesVisibility()

void vtkPVPlotMatrixRepresentation::SetSeriesVisibility ( const char *  series,
bool  visibility 
)

Set series visibility given its name.

The order in which SetSeriesVisibility is called is used to determine the order for each of the plots in the grid.

◆ ClearSeriesVisibilities()

void vtkPVPlotMatrixRepresentation::ClearSeriesVisibilities ( )

Set series visibility given its name.

The order in which SetSeriesVisibility is called is used to determine the order for each of the plots in the grid.

◆ SetColor()

void vtkPVPlotMatrixRepresentation::SetColor ( double  r,
double  g,
double  b 
)

Sets the color for the scatter plots in the plot matrix.

◆ SetActivePlotColor()

void vtkPVPlotMatrixRepresentation::SetActivePlotColor ( double  r,
double  g,
double  b 
)

Sets the color for the active plot.

◆ SetHistogramColor()

void vtkPVPlotMatrixRepresentation::SetHistogramColor ( double  r,
double  g,
double  b 
)

Sets the color for the histograms.

◆ SetMarkerStyle()

void vtkPVPlotMatrixRepresentation::SetMarkerStyle ( int  style)

Sets the marker style for the scatter plots.

◆ SetActivePlotMarkerStyle()

void vtkPVPlotMatrixRepresentation::SetActivePlotMarkerStyle ( int  style)

Sets the marker style for the active plot.

◆ SetMarkerSize()

void vtkPVPlotMatrixRepresentation::SetMarkerSize ( double  size)

Sets the marker size for the scatter plots.

◆ SetActivePlotMarkerSize()

void vtkPVPlotMatrixRepresentation::SetActivePlotMarkerSize ( double  size)

Sets the marker size for the active plots.

◆ GetPlotMatrix()

vtkScatterPlotMatrix* vtkPVPlotMatrixRepresentation::GetPlotMatrix ( ) const

Returns the scatter plot matrix.

◆ PrepareForRendering()

virtual void vtkPVPlotMatrixRepresentation::PrepareForRendering ( )
protectedvirtual

Overridden to pass information about changes to series visibility etc.

to the plot-matrix.

Reimplemented from vtkChartRepresentation.

◆ AddToView()

virtual bool vtkPVPlotMatrixRepresentation::AddToView ( vtkView *  view)
protectedvirtual

Add the plot matrix representation to the view.

Reimplemented from vtkChartRepresentation.

◆ RemoveFromView()

virtual bool vtkPVPlotMatrixRepresentation::RemoveFromView ( vtkView *  view)
protectedvirtual

Remove the plot matrix representation from the view.

Reimplemented from vtkChartRepresentation.


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