VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Friends
vtkScatterPlotMatrix Class Reference

container for a matrix of charts. More...

#include <vtkScatterPlotMatrix.h>

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

List of all members.

Public Types

enum  { SCATTERPLOT, HISTOGRAM, ACTIVEPLOT, NOPLOT }
typedef vtkChartMatrix Superclass

Public Member Functions

virtual int IsA (const char *type)
vtkScatterPlotMatrixNewInstance () const
virtual void PrintSelf (ostream &os, vtkIndent indent)
virtual void Update ()
virtual bool Paint (vtkContext2D *painter)
virtual bool SetActivePlot (const vtkVector2i &position)
virtual vtkVector2i GetActivePlot ()
vtkAnnotationLinkGetActiveAnnotationLink ()
vtkAnnotationLinkGetAnnotationLink ()
virtual void SetInput (vtkTable *table)
void SetColumnVisibility (const vtkStdString &name, bool visible)
void InsertVisibleColumn (const vtkStdString &name, int index)
bool GetColumnVisibility (const vtkStdString &name)
void SetColumnVisibilityAll (bool visible)
virtual vtkStringArrayGetVisibleColumns ()
virtual void SetVisibleColumns (vtkStringArray *visColumns)
virtual void SetNumberOfBins (int numberOfBins)
virtual int GetNumberOfBins () const
void SetPlotColor (int plotType, const vtkColor4ub &color)
void SetPlotMarkerStyle (int plotType, int style)
void SetPlotMarkerSize (int plotType, float size)
bool Hit (const vtkContextMouseEvent &mouse)
bool MouseMoveEvent (const vtkContextMouseEvent &mouse)
bool MouseButtonPressEvent (const vtkContextMouseEvent &mouse)
bool MouseButtonReleaseEvent (const vtkContextMouseEvent &mouse)
void SetTooltip (vtkTooltipItem *tooltip)
vtkTooltipItemGetTooltip () const
void SetIndexedLabels (vtkStringArray *labels)
vtkStringArrayGetIndexedLabels () const
void UpdateSettings ()
void UpdateChartSettings (int plotType)
vtkStdString GetColumnName (int column)
vtkStdString GetRowName (int row)
void SetNumberOfFrames (int frames)
int GetNumberOfFrames ()
void ClearAnimationPath ()
bool AddAnimationPath (const vtkVector2i &move)
vtkIdType GetNumberOfAnimationPathElements ()
vtkVector2i GetAnimationPathElement (vtkIdType i)
bool BeginAnimationPath (vtkRenderWindowInteractor *interactor)
virtual void AdvanceAnimation ()
virtual vtkChartGetMainChart ()
int GetPlotType (const vtkVector2i &pos)
int GetPlotType (int row, int column)
void SetTitle (const vtkStdString &title)
vtkStdString GetTitle ()
void SetTitleProperties (vtkTextProperty *prop)
vtkTextPropertyGetTitleProperties ()
void SetGridVisibility (int plotType, bool visible)
bool GetGridVisibility (int plotType)
void SetBackgroundColor (int plotType, const vtkColor4ub &color)
vtkColor4ub GetBackgroundColor (int plotType)
void SetAxisColor (int plotType, const vtkColor4ub &color)
vtkColor4ub GetAxisColor (int plotType)
void SetGridColor (int plotType, const vtkColor4ub &color)
vtkColor4ub GetGridColor (int plotType)
void SetAxisLabelVisibility (int plotType, bool visible)
bool GetAxisLabelVisibility (int plotType)
void SetAxisLabelProperties (int plotType, vtkTextProperty *prop)
vtkTextPropertyGetAxisLabelProperties (int plotType)
void SetAxisLabelNotation (int plotType, int notation)
int GetAxisLabelNotation (int plotType)
void SetAxisLabelPrecision (int plotType, int precision)
int GetAxisLabelPrecision (int plotType)
void SetTooltipNotation (int plotType, int notation)
void SetTooltipPrecision (int plotType, int precision)
int GetTooltipNotation (int plotType)
int GetTooltipPrecision (int plotType)
void SetScatterPlotSelectedRowColumnColor (const vtkColor4ub &color)
vtkColor4ub GetScatterPlotSelectedRowColumnColor ()
void SetScatterPlotSelectedActiveColor (const vtkColor4ub &color)
vtkColor4ub GetScatterPlotSelectedActiveColor ()
virtual void SetSelectionMode (int)
virtual int GetSelectionMode ()

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkScatterPlotMatrixSafeDownCast (vtkObjectBase *o)
static vtkScatterPlotMatrixNew ()

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 vtkScatterPlotMatrix ()
 ~vtkScatterPlotMatrix ()
void UpdateLayout ()
void BigChartSelectionCallback (vtkObject *, unsigned long, void *)
virtual void UpdateAnimationPath (const vtkVector2i &newActivePos)
virtual void StartAnimation (vtkRenderWindowInteractor *interactor)
void AttachAxisRangeListener (vtkAxis *)
void AxisRangeForwarderCallback (vtkObject *, unsigned long, void *)

Static Protected Member Functions

static void ProcessEvents (vtkObject *caller, unsigned long event, void *clientData, void *callerData)

Protected Attributes

vtkVector2i ActivePlot
vtkSmartPointer< vtkTableInput
vtkNew< vtkStringArrayVisibleColumns
int NumberOfBins
vtkStdString Title
vtkSmartPointer< vtkTextPropertyTitleProperties
int SelectionMode
int NumberOfFrames

Friends

class PIMPL

Detailed Description

container for a matrix of charts.

This class contains a matrix of charts. These charts will be of type vtkChartXY by default, but this can be overridden. The class will manage their layout and object lifetime.

Tests:
vtkScatterPlotMatrix (Tests)

Definition at line 46 of file vtkScatterPlotMatrix.h.


Member Typedef Documentation

Reimplemented from vtkChartMatrix.

Definition at line 56 of file vtkScatterPlotMatrix.h.


Member Enumeration Documentation

anonymous enum
Enumerator:
SCATTERPLOT 
HISTOGRAM 
ACTIVEPLOT 
NOPLOT 

Definition at line 49 of file vtkScatterPlotMatrix.h.


Constructor & Destructor Documentation


Member Function Documentation

static int vtkScatterPlotMatrix::IsTypeOf ( const char *  name) [static]

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkChartMatrix.

virtual int vtkScatterPlotMatrix::IsA ( const char *  name) [virtual]

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkChartMatrix.

Reimplemented from vtkChartMatrix.

virtual vtkObjectBase* vtkScatterPlotMatrix::NewInstanceInternal ( ) const [protected, virtual]

Reimplemented from vtkChartMatrix.

Reimplemented from vtkChartMatrix.

virtual void vtkScatterPlotMatrix::PrintSelf ( ostream &  os,
vtkIndent  indent 
) [virtual]

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkChartMatrix.

Creates a new object.

Reimplemented from vtkChartMatrix.

virtual void vtkScatterPlotMatrix::Update ( ) [virtual]

Perform any updates to the item that may be necessary before rendering.

Reimplemented from vtkChartMatrix.

virtual bool vtkScatterPlotMatrix::Paint ( vtkContext2D painter) [virtual]

Paint event for the chart matrix.

Reimplemented from vtkChartMatrix.

virtual bool vtkScatterPlotMatrix::SetActivePlot ( const vtkVector2i position) [virtual]

Set the active plot, the one that will be displayed in the top-right. This defaults to (0, n-2), the plot below the first histogram on the left.

Returns:
false is the position specified is not valid.

Get the position of the active plot.

Get the active AnnotationLink from the big chart, which is the only active AnnotationLink in the matrix.

Deprecated:
Replaced by GetAnnotationLink(), never in a VTK release.

Get the AnnotationLink for the scatter plot matrix, this gives you access to the currently selected points in the scatter plot matrix.

virtual void vtkScatterPlotMatrix::SetInput ( vtkTable table) [virtual]

Set the input table for the scatter plot matrix. This will cause all columns to be plotted against each other - a square scatter plot matrix.

void vtkScatterPlotMatrix::SetColumnVisibility ( const vtkStdString name,
bool  visible 
)

Set the visibility of the specified column.

void vtkScatterPlotMatrix::InsertVisibleColumn ( const vtkStdString name,
int  index 
)

Insert the specified column at the index position of the visible columns.

Get the visibility of the specified column.

Set the visibility of all columns (true will make them all visible, false will remove all visible columns).

Get a list of the columns, and the order in which they are displayed.

virtual void vtkScatterPlotMatrix::SetVisibleColumns ( vtkStringArray visColumns) [virtual]

Set the list of visible columns, and the order in which they will be displayed.

virtual void vtkScatterPlotMatrix::SetNumberOfBins ( int  numberOfBins) [virtual]

Set the number of bins in the histograms along the central diagonal of the scatter plot matrix.

virtual int vtkScatterPlotMatrix::GetNumberOfBins ( ) const [inline, virtual]

Get the number of bins the histograms along the central diagonal scatter plot matrix. The default value is 10.

Definition at line 118 of file vtkScatterPlotMatrix.h.

void vtkScatterPlotMatrix::SetPlotColor ( int  plotType,
const vtkColor4ub color 
)

Set the color for the specified plotType.

void vtkScatterPlotMatrix::SetPlotMarkerStyle ( int  plotType,
int  style 
)

Sets the marker style for the specified plotType.

void vtkScatterPlotMatrix::SetPlotMarkerSize ( int  plotType,
float  size 
)

Sets the marker size for the specified plotType.

bool vtkScatterPlotMatrix::Hit ( const vtkContextMouseEvent mouse) [virtual]

Return true if the supplied x, y coordinate is inside the item.

Reimplemented from vtkAbstractContextItem.

Mouse move event.

Reimplemented from vtkAbstractContextItem.

Mouse button down event

Reimplemented from vtkAbstractContextItem.

Mouse button release event.

Reimplemented from vtkAbstractContextItem.

Returns the type of the plot at the given position. The return value is one of: SCATTERPLOT, HISTOGRAM, ACTIVEPLOT, or NOPLOT.

Returns the type of the plot at the given position. The return value is one of: SCATTERPLOT, HISTOGRAM, ACTIVEPLOT, or NOPLOT.

Set/get the scatter plot title.

Set/get the scatter plot title.

Set/get the text properties for the chart title, i.e. color, font, size.

Set/get the text properties for the chart title, i.e. color, font, size.

void vtkScatterPlotMatrix::SetGridVisibility ( int  plotType,
bool  visible 
)

Sets whether or not the grid for the given axis is visible given a plot type, which refers to vtkScatterPlotMatrix::{SCATTERPLOT, HISTOGRAM, ACTIVEPLOT}.

Sets whether or not the grid for the given axis is visible given a plot type, which refers to vtkScatterPlotMatrix::{SCATTERPLOT, HISTOGRAM, ACTIVEPLOT}.

void vtkScatterPlotMatrix::SetBackgroundColor ( int  plotType,
const vtkColor4ub color 
)

Sets the background color for the chart given a plot type, which refers to vtkScatterPlotMatrix::{SCATTERPLOT, HISTOGRAM, ACTIVEPLOT}.

Sets the background color for the chart given a plot type, which refers to vtkScatterPlotMatrix::{SCATTERPLOT, HISTOGRAM, ACTIVEPLOT}.

void vtkScatterPlotMatrix::SetAxisColor ( int  plotType,
const vtkColor4ub color 
)

Sets the color for the axes given a plot type, which refers to vtkScatterPlotMatrix::{SCATTERPLOT, HISTOGRAM, ACTIVEPLOT}.

Sets the color for the axes given a plot type, which refers to vtkScatterPlotMatrix::{SCATTERPLOT, HISTOGRAM, ACTIVEPLOT}.

void vtkScatterPlotMatrix::SetGridColor ( int  plotType,
const vtkColor4ub color 
)

Sets the color for the axes given a plot type, which refers to vtkScatterPlotMatrix::{SCATTERPLOT, HISTOGRAM, ACTIVEPLOT}.

Sets the color for the axes given a plot type, which refers to vtkScatterPlotMatrix::{SCATTERPLOT, HISTOGRAM, ACTIVEPLOT}.

void vtkScatterPlotMatrix::SetAxisLabelVisibility ( int  plotType,
bool  visible 
)

Sets whether or not the labels for the axes are visible, given a plot type, which refers to vtkScatterPlotMatrix::{SCATTERPLOT, HISTOGRAM, ACTIVEPLOT}.

Sets whether or not the labels for the axes are visible, given a plot type, which refers to vtkScatterPlotMatrix::{SCATTERPLOT, HISTOGRAM, ACTIVEPLOT}.

Set/get the text property for the axis labels of the given plot type, possible types are vtkScatterPlotMatrix::{SCATTERPLOT, HISTOGRAM, ACTIVEPLOT}.

Set/get the text property for the axis labels of the given plot type, possible types are vtkScatterPlotMatrix::{SCATTERPLOT, HISTOGRAM, ACTIVEPLOT}.

void vtkScatterPlotMatrix::SetAxisLabelNotation ( int  plotType,
int  notation 
)

Sets the axis label notation for the axes given a plot type, which refers to vtkScatterPlotMatrix::{SCATTERPLOT, HISTOGRAM, ACTIVEPLOT}.

Sets the axis label notation for the axes given a plot type, which refers to vtkScatterPlotMatrix::{SCATTERPLOT, HISTOGRAM, ACTIVEPLOT}.

void vtkScatterPlotMatrix::SetAxisLabelPrecision ( int  plotType,
int  precision 
)

Sets the axis label precision for the axes given a plot type, which refers to vtkScatterPlotMatrix::{SCATTERPLOT, HISTOGRAM, ACTIVEPLOT}.

Sets the axis label precision for the axes given a plot type, which refers to vtkScatterPlotMatrix::{SCATTERPLOT, HISTOGRAM, ACTIVEPLOT}.

void vtkScatterPlotMatrix::SetTooltipNotation ( int  plotType,
int  notation 
)

Set chart's tooltip notation and precision, given a plot type, which refers to vtkScatterPlotMatrix::{SCATTERPLOT, HISTOGRAM, ACTIVEPLOT}.

void vtkScatterPlotMatrix::SetTooltipPrecision ( int  plotType,
int  precision 
)

Set chart's tooltip notation and precision, given a plot type, which refers to vtkScatterPlotMatrix::{SCATTERPLOT, HISTOGRAM, ACTIVEPLOT}.

Set chart's tooltip notation and precision, given a plot type, which refers to vtkScatterPlotMatrix::{SCATTERPLOT, HISTOGRAM, ACTIVEPLOT}.

Set chart's tooltip notation and precision, given a plot type, which refers to vtkScatterPlotMatrix::{SCATTERPLOT, HISTOGRAM, ACTIVEPLOT}.

Set the vtkTooltipItem object that will be displayed by the active chart.

Get the vtkTooltipItem object that will be displayed by the active chart.

Set indexed labels array.

Get the indexed labels array.

Set the scatter plot selected row/column charts' background color.

Set the scatter plot selected row/column charts' background color.

Set the scatter plot selected active chart background color.

Set the scatter plot selected active chart background color.

Convenient method to update all the chart settings

Update charts based on settings given the plot type

virtual void vtkScatterPlotMatrix::SetSelectionMode ( int  ) [virtual]

Set/get the Selection Mode that will be used by the chart while doing selection. The only valid enums are vtkContextScene::SELECTION_NONE, SELECTION_DEFAULT, SELECTION_ADDITION, SELECTION_SUBTRACTION, SELECTION_TOGGLE

Set/get the Selection Mode that will be used by the chart while doing selection. The only valid enums are vtkContextScene::SELECTION_NONE, SELECTION_DEFAULT, SELECTION_ADDITION, SELECTION_SUBTRACTION, SELECTION_TOGGLE

Get the column name for the supplied index.

Get the column name for the supplied index.

Set the number of animation frames in each transition. Default is 25, and 0 means to animations between axes.

Get the number of animation frames in each transition. Default is 25, and 0 means to animations between axes.

Clear the animation path.

Add a move to the animation path. Note that a move can only change i or j, not both. If the proposed move does not satisfy those criteria it will be rejected and the animation path will not be extended.

Get the number of elements (transitions) in the animation path.

Get the element specified from the animation path.

Trigger the animation of the scatter plot matrix to begin.

virtual void vtkScatterPlotMatrix::AdvanceAnimation ( ) [virtual]

Advance the animation in response to the timer events. This is public to allow the animation to be manually advanced when timers are not a

Get the main plot (the one in the top-right of the matrix.

void vtkScatterPlotMatrix::UpdateLayout ( ) [protected]

Internal helper to do the layout of the charts in the scatter plot matrix.

Attach axis range listener so we can forward to dependent axes in matrix.

void vtkScatterPlotMatrix::AxisRangeForwarderCallback ( vtkObject ,
unsigned  long,
void *   
) [protected]

Attach axis range listener so we can forward to dependent axes in matrix.

void vtkScatterPlotMatrix::BigChartSelectionCallback ( vtkObject ,
unsigned  long,
void *   
) [protected]

The callback function when SelectionChangedEvent is invoked from the Big chart. This class will just forward the event.

virtual void vtkScatterPlotMatrix::UpdateAnimationPath ( const vtkVector2i newActivePos) [protected, virtual]

Given a new position for the active plot, calculate a an animation path from the old active plot to the new active plot.

virtual void vtkScatterPlotMatrix::StartAnimation ( vtkRenderWindowInteractor interactor) [protected, virtual]

Given the render window interactor, start animation of the animation path calculated above.

static void vtkScatterPlotMatrix::ProcessEvents ( vtkObject caller,
unsigned long  event,
void *  clientData,
void *  callerData 
) [static, protected]

Process events and dispatch to the appropriate member functions.


Friends And Related Function Documentation

friend class PIMPL [friend]

Definition at line 369 of file vtkScatterPlotMatrix.h.


Member Data Documentation

Definition at line 342 of file vtkScatterPlotMatrix.h.

Definition at line 345 of file vtkScatterPlotMatrix.h.

Definition at line 348 of file vtkScatterPlotMatrix.h.

Definition at line 351 of file vtkScatterPlotMatrix.h.

Definition at line 354 of file vtkScatterPlotMatrix.h.

Definition at line 355 of file vtkScatterPlotMatrix.h.

Definition at line 358 of file vtkScatterPlotMatrix.h.

Definition at line 361 of file vtkScatterPlotMatrix.h.


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