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

vtkPVBoxChartRepresentation is the vtkChartBox subclass for box plots representation. More...

#include <vtkPVBoxChartRepresentation.h>

Inheritance diagram for vtkPVBoxChartRepresentation:
Inheritance graph
[legend]
Collaboration diagram for vtkPVBoxChartRepresentation:
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)
 Set visibility of the representation. More...
 
void ClearSeriesVisibilities ()
 
void ClearSeriesColors ()
 
vtkChartBox * GetChart ()
 Provides access to the underlying VTK representation. More...
 
void SetSeriesVisibility (const char *series, bool visibility)
 Set/Clear the properties for series/columns. More...
 
void SetSeriesColor (const char *name, double r, double g, double b)
 Set/Clear the properties for series/columns. More...
 
virtual void SetLineThickness (int)
 Sets the line thickness for the plot. More...
 
virtual void SetLineStyle (int)
 Set the line style for the plot. More...
 
virtual void SetColor (double, double, double)
 Sets the color to used for the lines in the plot. More...
 
virtual void SetColor (double [3])
 Sets the color to used for the lines in the plot. More...
 
virtual void SetLegend (bool)
 Set the visibility of the legend (plot labels) 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 vtkPVBoxChartRepresentationNew ()
 
static int IsTypeOf (const char *type)
 
static vtkPVBoxChartRepresentationSafeDownCast (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

 vtkPVBoxChartRepresentation ()
 
 ~vtkPVBoxChartRepresentation ()
 
virtual void PrepareForRendering ()
 Overridden to pass information about changes to series visibility etc. More...
 
virtual bool AddToView (vtkView *view)
 Adds the representation to the view. More...
 
virtual bool RemoveFromView (vtkView *view)
 Removes the representation to 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 *)
 

Protected Attributes

int LineThickness
 
int LineStyle
 
double Color [3]
 
bool Legend
 
- 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
 

Additional Inherited Members

- Protected Types inherited from vtkChartRepresentation
typedef std::map< std::string, vtkSmartPointer< vtkTable > > MapOfTables
 

Detailed Description

vtkPVBoxChartRepresentation is the vtkChartBox subclass for box plots representation.

It exposes API from underlying vtkChartBox.

Definition at line 31 of file vtkPVBoxChartRepresentation.h.

Member Typedef Documentation

◆ Superclass

Definition at line 36 of file vtkPVBoxChartRepresentation.h.

Constructor & Destructor Documentation

◆ vtkPVBoxChartRepresentation()

vtkPVBoxChartRepresentation::vtkPVBoxChartRepresentation ( )
protected

◆ ~vtkPVBoxChartRepresentation()

vtkPVBoxChartRepresentation::~vtkPVBoxChartRepresentation ( )
protected

Member Function Documentation

◆ New()

static vtkPVBoxChartRepresentation* vtkPVBoxChartRepresentation::New ( )
static

◆ GetClassName()

virtual const char* vtkPVBoxChartRepresentation::GetClassName ( )
virtual

Reimplemented from vtkChartRepresentation.

◆ IsTypeOf()

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

◆ IsA()

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

Reimplemented from vtkChartRepresentation.

◆ SafeDownCast()

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

◆ PrintSelf()

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

◆ SetVisibility()

virtual void vtkPVBoxChartRepresentation::SetVisibility ( bool  visible)
virtual

Set visibility of the representation.

Reimplemented from vtkChartRepresentation.

◆ SetSeriesVisibility()

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

Set/Clear the properties for series/columns.

◆ SetSeriesColor()

void vtkPVBoxChartRepresentation::SetSeriesColor ( const char *  name,
double  r,
double  g,
double  b 
)

Set/Clear the properties for series/columns.

◆ ClearSeriesVisibilities()

void vtkPVBoxChartRepresentation::ClearSeriesVisibilities ( )

◆ ClearSeriesColors()

void vtkPVBoxChartRepresentation::ClearSeriesColors ( )

◆ GetChart()

vtkChartBox* vtkPVBoxChartRepresentation::GetChart ( )

Provides access to the underlying VTK representation.

◆ SetLineThickness()

virtual void vtkPVBoxChartRepresentation::SetLineThickness ( int  )
virtual

Sets the line thickness for the plot.

◆ SetLineStyle()

virtual void vtkPVBoxChartRepresentation::SetLineStyle ( int  )
virtual

Set the line style for the plot.

◆ SetColor() [1/2]

virtual void vtkPVBoxChartRepresentation::SetColor ( double  ,
double  ,
double   
)
virtual

Sets the color to used for the lines in the plot.

◆ SetColor() [2/2]

virtual void vtkPVBoxChartRepresentation::SetColor ( double  [3])
virtual

Sets the color to used for the lines in the plot.

◆ SetLegend()

virtual void vtkPVBoxChartRepresentation::SetLegend ( bool  )
virtual

Set the visibility of the legend (plot labels)

◆ PrepareForRendering()

virtual void vtkPVBoxChartRepresentation::PrepareForRendering ( )
protectedvirtual

Overridden to pass information about changes to series visibility etc.

to the plot-matrix.

Reimplemented from vtkChartRepresentation.

◆ AddToView()

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

Adds the representation to the view.

This is called from vtkView::AddRepresentation(). Subclasses should override this method. Returns true if the addition succeeds.

Reimplemented from vtkChartRepresentation.

◆ RemoveFromView()

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

Removes the representation to the view.

This is called from vtkView::RemoveRepresentation(). Subclasses should override this method. Returns true if the removal succeeds.

Reimplemented from vtkChartRepresentation.

Member Data Documentation

◆ LineThickness

int vtkPVBoxChartRepresentation::LineThickness
protected

Definition at line 107 of file vtkPVBoxChartRepresentation.h.

◆ LineStyle

int vtkPVBoxChartRepresentation::LineStyle
protected

Definition at line 108 of file vtkPVBoxChartRepresentation.h.

◆ Color

double vtkPVBoxChartRepresentation::Color[3]
protected

Definition at line 109 of file vtkPVBoxChartRepresentation.h.

◆ Legend

bool vtkPVBoxChartRepresentation::Legend
protected

Definition at line 110 of file vtkPVBoxChartRepresentation.h.


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