VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Friends | List of all members
vtkScatterPlotMatrix Class Reference

container for a matrix of charts. More...

#include <vtkScatterPlotMatrix.h>

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

Public Types

enum  { SCATTERPLOT, HISTOGRAM, ACTIVEPLOT, NOPLOT }
 
typedef vtkChartMatrix Superclass
 
- Public Types inherited from vtkChartMatrix
typedef vtkAbstractContextItem Superclass
 
- Public Types inherited from vtkAbstractContextItem
typedef vtkObject Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkScatterPlotMatrixNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void Update () override
 Perform any updates to the item that may be necessary before rendering. More...
 
bool Paint (vtkContext2D *painter) override
 Paint event for the chart matrix. More...
 
void SetScene (vtkContextScene *scene) override
 Set the vtkContextScene for the item, always set for an item in a scene. More...
 
virtual bool SetActivePlot (const vtkVector2i &position)
 Set the active plot, the one that will be displayed in the top-right. More...
 
virtual void SetSize (const vtkVector2i &size) override
 Reset ActivePlotSet flag and call superclass method. More...
 
virtual vtkVector2i GetActivePlot ()
 Get the position of the active plot. More...
 
vtkAnnotationLinkGetAnnotationLink ()
 Get the AnnotationLink for the scatter plot matrix, this gives you access to the currently selected points in the scatter plot matrix. More...
 
virtual void SetInput (vtkTable *table)
 Set the input table for the scatter plot matrix. More...
 
void SetColumnVisibility (const vtkStdString &name, bool visible)
 Set the visibility of the specified column. More...
 
void InsertVisibleColumn (const vtkStdString &name, int index)
 Insert the specified column at the index position of the visible columns. More...
 
bool GetColumnVisibility (const vtkStdString &name)
 Get the visibility of the specified column. More...
 
void SetColumnVisibilityAll (bool visible)
 Set the visibility of all columns (true will make them all visible, false will remove all visible columns). More...
 
virtual vtkStringArrayGetVisibleColumns ()
 Get a list of the columns, and the order in which they are displayed. More...
 
virtual void SetVisibleColumns (vtkStringArray *visColumns)
 Set the list of visible columns, and the order in which they will be displayed. More...
 
virtual void SetNumberOfBins (int numberOfBins)
 Set the number of bins in the histograms along the central diagonal of the scatter plot matrix. More...
 
virtual int GetNumberOfBins () const
 Get the number of bins the histograms along the central diagonal scatter plot matrix. More...
 
void SetPlotColor (int plotType, const vtkColor4ub &color)
 Set the color for the specified plotType. More...
 
void SetPlotMarkerStyle (int plotType, int style)
 Sets the marker style for the specified plotType. More...
 
void SetPlotMarkerSize (int plotType, float size)
 Sets the marker size for the specified plotType. More...
 
bool Hit (const vtkContextMouseEvent &mouse) override
 Return true if the supplied x, y coordinate is inside the item. More...
 
bool MouseMoveEvent (const vtkContextMouseEvent &mouse) override
 Mouse move event. More...
 
bool MouseButtonPressEvent (const vtkContextMouseEvent &mouse) override
 Mouse button down event. More...
 
bool MouseButtonReleaseEvent (const vtkContextMouseEvent &mouse) override
 Mouse button release event. More...
 
void SetTooltip (vtkTooltipItem *tooltip)
 Set the vtkTooltipItem object that will be displayed by the active chart. More...
 
vtkTooltipItemGetTooltip () const
 Get the vtkTooltipItem object that will be displayed by the active chart. More...
 
void SetIndexedLabels (vtkStringArray *labels)
 Set indexed labels array. More...
 
vtkStringArrayGetIndexedLabels () const
 Get the indexed labels array. More...
 
void UpdateSettings ()
 Convenient method to update all the chart settings. More...
 
void UpdateChartSettings (int plotType)
 Update charts based on settings given the plot type. More...
 
vtkStdString GetColumnName (int column)
 Get the column name for the supplied index. More...
 
vtkStdString GetRowName (int row)
 Get the column name for the supplied index. More...
 
void SetNumberOfFrames (int frames)
 Set the number of animation frames in each transition. More...
 
int GetNumberOfFrames ()
 Get the number of animation frames in each transition. More...
 
void ClearAnimationPath ()
 Clear the animation path. More...
 
bool AddAnimationPath (const vtkVector2i &move)
 Add a move to the animation path. More...
 
vtkIdType GetNumberOfAnimationPathElements ()
 Get the number of elements (transitions) in the animation path. More...
 
vtkVector2i GetAnimationPathElement (vtkIdType i)
 Get the element specified from the animation path. More...
 
bool BeginAnimationPath (vtkRenderWindowInteractor *interactor)
 Trigger the animation of the scatter plot matrix to begin. More...
 
virtual void AdvanceAnimation ()
 Advance the animation in response to the timer events. More...
 
virtual vtkChartGetMainChart ()
 Get the main plot (the one in the top-right of the matrix. More...
 
int GetPlotType (const vtkVector2i &pos)
 Returns the type of the plot at the given position. More...
 
int GetPlotType (int row, int column)
 Returns the type of the plot at the given position. More...
 
void SetTitle (const vtkStdString &title)
 Set/get the scatter plot title. More...
 
vtkStdString GetTitle ()
 Set/get the scatter plot title. More...
 
void SetTitleProperties (vtkTextProperty *prop)
 Set/get the text properties for the chart title, i.e. More...
 
vtkTextPropertyGetTitleProperties ()
 Set/get the text properties for the chart title, i.e. More...
 
void 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}. More...
 
bool GetGridVisibility (int plotType)
 Sets whether or not the grid for the given axis is visible given a plot type, which refers to vtkScatterPlotMatrix::{SCATTERPLOT, HISTOGRAM, ACTIVEPLOT}. More...
 
void SetBackgroundColor (int plotType, const vtkColor4ub &color)
 Sets the background color for the chart given a plot type, which refers to vtkScatterPlotMatrix::{SCATTERPLOT, HISTOGRAM, ACTIVEPLOT}. More...
 
vtkColor4ub GetBackgroundColor (int plotType)
 Sets the background color for the chart given a plot type, which refers to vtkScatterPlotMatrix::{SCATTERPLOT, HISTOGRAM, ACTIVEPLOT}. More...
 
void SetAxisColor (int plotType, const vtkColor4ub &color)
 Sets the color for the axes given a plot type, which refers to vtkScatterPlotMatrix::{SCATTERPLOT, HISTOGRAM, ACTIVEPLOT}. More...
 
vtkColor4ub GetAxisColor (int plotType)
 Sets the color for the axes given a plot type, which refers to vtkScatterPlotMatrix::{SCATTERPLOT, HISTOGRAM, ACTIVEPLOT}. More...
 
void SetGridColor (int plotType, const vtkColor4ub &color)
 Sets the color for the axes given a plot type, which refers to vtkScatterPlotMatrix::{SCATTERPLOT, HISTOGRAM, ACTIVEPLOT}. More...
 
vtkColor4ub GetGridColor (int plotType)
 Sets the color for the axes given a plot type, which refers to vtkScatterPlotMatrix::{SCATTERPLOT, HISTOGRAM, ACTIVEPLOT}. More...
 
void 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}. More...
 
bool GetAxisLabelVisibility (int plotType)
 Sets whether or not the labels for the axes are visible, given a plot type, which refers to vtkScatterPlotMatrix::{SCATTERPLOT, HISTOGRAM, ACTIVEPLOT}. More...
 
void SetAxisLabelProperties (int plotType, vtkTextProperty *prop)
 Set/get the text property for the axis labels of the given plot type, possible types are vtkScatterPlotMatrix::{SCATTERPLOT, HISTOGRAM, ACTIVEPLOT}. More...
 
vtkTextPropertyGetAxisLabelProperties (int plotType)
 Set/get the text property for the axis labels of the given plot type, possible types are vtkScatterPlotMatrix::{SCATTERPLOT, HISTOGRAM, ACTIVEPLOT}. More...
 
void SetAxisLabelNotation (int plotType, int notation)
 Sets the axis label notation for the axes given a plot type, which refers to vtkScatterPlotMatrix::{SCATTERPLOT, HISTOGRAM, ACTIVEPLOT}. More...
 
int GetAxisLabelNotation (int plotType)
 Sets the axis label notation for the axes given a plot type, which refers to vtkScatterPlotMatrix::{SCATTERPLOT, HISTOGRAM, ACTIVEPLOT}. More...
 
void SetAxisLabelPrecision (int plotType, int precision)
 Sets the axis label precision for the axes given a plot type, which refers to vtkScatterPlotMatrix::{SCATTERPLOT, HISTOGRAM, ACTIVEPLOT}. More...
 
int GetAxisLabelPrecision (int plotType)
 Sets the axis label precision for the axes given a plot type, which refers to vtkScatterPlotMatrix::{SCATTERPLOT, HISTOGRAM, ACTIVEPLOT}. More...
 
void SetTooltipNotation (int plotType, int notation)
 Set chart's tooltip notation and precision, given a plot type, which refers to vtkScatterPlotMatrix::{SCATTERPLOT, HISTOGRAM, ACTIVEPLOT}. More...
 
void SetTooltipPrecision (int plotType, int precision)
 Set chart's tooltip notation and precision, given a plot type, which refers to vtkScatterPlotMatrix::{SCATTERPLOT, HISTOGRAM, ACTIVEPLOT}. More...
 
int GetTooltipNotation (int plotType)
 Set chart's tooltip notation and precision, given a plot type, which refers to vtkScatterPlotMatrix::{SCATTERPLOT, HISTOGRAM, ACTIVEPLOT}. More...
 
int GetTooltipPrecision (int plotType)
 Set chart's tooltip notation and precision, given a plot type, which refers to vtkScatterPlotMatrix::{SCATTERPLOT, HISTOGRAM, ACTIVEPLOT}. More...
 
void SetScatterPlotSelectedRowColumnColor (const vtkColor4ub &color)
 Set the scatter plot selected row/column charts' background color. More...
 
vtkColor4ub GetScatterPlotSelectedRowColumnColor ()
 Set the scatter plot selected row/column charts' background color. More...
 
void SetScatterPlotSelectedActiveColor (const vtkColor4ub &color)
 Set the scatter plot selected active chart background color. More...
 
vtkColor4ub GetScatterPlotSelectedActiveColor ()
 Set the scatter plot selected active chart background color. More...
 
virtual void SetSelectionMode (int)
 Set/get the Selection Mode that will be used by the chart while doing selection. More...
 
virtual int GetSelectionMode ()
 Set/get the Selection Mode that will be used by the chart while doing selection. More...
 
- Public Member Functions inherited from vtkChartMatrix
vtkChartMatrixNewInstance () const
 
virtual vtkVector2i GetSize () const
 Get the width and height of the chart matrix. More...
 
virtual vtkVector2f GetGutter () const
 Get the gutter that should be left between the charts in the matrix. More...
 
virtual void Allocate ()
 Allocate the charts, this will cause any null chart to be allocated. More...
 
virtual bool SetChart (const vtkVector2i &position, vtkChart *chart)
 Set the chart element, note that the chart matrix must be large enough to accommodate the element being set. More...
 
virtual vtkChartGetChart (const vtkVector2i &position)
 Get the specified chart element, if the element does not exist nullptr will be returned. More...
 
virtual bool SetChartSpan (const vtkVector2i &position, const vtkVector2i &span)
 Set the span of a chart in the matrix. More...
 
virtual vtkVector2i GetChartSpan (const vtkVector2i &position)
 Get the span of the specified chart. More...
 
virtual vtkVector2i GetChartIndex (const vtkVector2f &position)
 Get the position of the chart in the matrix at the specified location. More...
 
virtual void SetBorders (int left, int bottom, int right, int top)
 Set/get the borders of the chart matrix (space in pixels around each chart). More...
 
void SetBorderLeft (int value)
 Set/get the borders of the chart matrix (space in pixels around each chart). More...
 
void SetBorderBottom (int value)
 Set/get the borders of the chart matrix (space in pixels around each chart). More...
 
void SetBorderRight (int value)
 Set/get the borders of the chart matrix (space in pixels around each chart). More...
 
void SetBorderTop (int value)
 Set/get the borders of the chart matrix (space in pixels around each chart). More...
 
virtual void GetBorders (int borders[4])
 Set/get the borders of the chart matrix (space in pixels around each chart). More...
 
virtual void SetGutter (const vtkVector2f &gutter)
 Set the gutter that should be left between the charts in the matrix. More...
 
void SetGutterX (float value)
 Set the gutter that should be left between the charts in the matrix. More...
 
void SetGutterY (float value)
 Set the gutter that should be left between the charts in the matrix. More...
 
virtual void SetSpecificResize (const vtkVector2i &index, const vtkVector2f &resize)
 Set a specific resize that will move the bottom left point of a chart. More...
 
virtual void ClearSpecificResizes ()
 Set a specific resize that will move the bottom left point of a chart. More...
 
- Public Member Functions inherited from vtkAbstractContextItem
vtkAbstractContextItemNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual bool PaintChildren (vtkContext2D *painter)
 Paint the children of the item, should be called whenever the children need to be rendered. More...
 
virtual void ReleaseGraphicsResources ()
 Release graphics resources hold by the item. More...
 
unsigned int AddItem (vtkAbstractContextItem *item)
 Add child items to this item. More...
 
bool RemoveItem (vtkAbstractContextItem *item)
 Remove child item from this item. More...
 
bool RemoveItem (unsigned int index)
 Remove child item from this item. More...
 
vtkAbstractContextItemGetItem (unsigned int index)
 Get the item at the specified index. More...
 
unsigned int GetItemIndex (vtkAbstractContextItem *item)
 Get the index of the specified item. More...
 
unsigned int GetNumberOfItems ()
 Get the number of child items. More...
 
void ClearItems ()
 Remove all child items from this item. More...
 
unsigned int Raise (unsigned int index)
 Raises the child to the top of the item's stack. More...
 
virtual unsigned int StackAbove (unsigned int index, unsigned int under)
 Raises the child above the under sibling. More...
 
unsigned int Lower (unsigned int index)
 Lowers the child to the bottom of the item's stack. More...
 
virtual unsigned int StackUnder (unsigned int child, unsigned int above)
 Lowers the child under the above sibling. More...
 
virtual vtkAbstractContextItemGetPickedItem (const vtkContextMouseEvent &mouse)
 Return the item under the mouse. More...
 
virtual bool MouseEnterEvent (const vtkContextMouseEvent &mouse)
 Mouse enter event. More...
 
virtual bool MouseLeaveEvent (const vtkContextMouseEvent &mouse)
 Mouse leave event. More...
 
virtual bool MouseDoubleClickEvent (const vtkContextMouseEvent &mouse)
 Mouse button double click event. More...
 
virtual bool MouseWheelEvent (const vtkContextMouseEvent &mouse, int delta)
 Mouse wheel event, positive delta indicates forward movement of the wheel. More...
 
virtual bool KeyPressEvent (const vtkContextKeyEvent &key)
 Key press event. More...
 
virtual bool KeyReleaseEvent (const vtkContextKeyEvent &key)
 Key release event. More...
 
vtkContextSceneGetScene ()
 Get the vtkContextScene for the item, always set for an item in a scene. More...
 
virtual void SetParent (vtkAbstractContextItem *parent)
 Set the parent item. More...
 
vtkAbstractContextItemGetParent ()
 Get the parent item. More...
 
virtual vtkVector2f MapToParent (const vtkVector2f &point)
 Maps the point to the parent coordinate system. More...
 
virtual vtkVector2f MapFromParent (const vtkVector2f &point)
 Maps the point from the parent coordinate system. More...
 
virtual vtkVector2f MapToScene (const vtkVector2f &point)
 Maps the point to the scene coordinate system. More...
 
virtual vtkVector2f MapFromScene (const vtkVector2f &point)
 Maps the point from the scene coordinate system. More...
 
virtual bool GetVisible ()
 Get the visibility of the item (should it be drawn). More...
 
virtual void SetVisible (bool)
 Set the visibility of the item (should it be drawn). More...
 
virtual bool GetInteractive ()
 Get if the item is interactive (should respond to mouse events). More...
 
virtual void SetInteractive (bool)
 Set if the item is interactive (should respond to mouse events). More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
int HasObserver (unsigned long event)
 
int HasObserver (const char *event)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
int HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
int HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkScatterPlotMatrixSafeDownCast (vtkObjectBase *o)
 
static vtkScatterPlotMatrixNew ()
 Creates a new object. More...
 
- Static Public Member Functions inherited from vtkChartMatrix
static int IsTypeOf (const char *type)
 
static vtkChartMatrixSafeDownCast (vtkObjectBase *o)
 
static vtkChartMatrixNew ()
 Creates a new object. More...
 
- Static Public Member Functions inherited from vtkAbstractContextItem
static int IsTypeOf (const char *type)
 
static vtkAbstractContextItemSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkScatterPlotMatrix ()
 
 ~vtkScatterPlotMatrix () override
 
void UpdateLayout ()
 Internal helper to do the layout of the charts in the scatter plot matrix. More...
 
void ResizeBigChart ()
 Compute and set big chart resize. More...
 
void BigChartSelectionCallback (vtkObject *, unsigned long, void *)
 The callback function when SelectionChangedEvent is invoked from the Big chart. More...
 
virtual void UpdateAnimationPath (const vtkVector2i &newActivePos)
 Given a new position for the active plot, calculate a an animation path from the old active plot to the new active plot. More...
 
virtual void StartAnimation (vtkRenderWindowInteractor *interactor)
 Given the render window interactor, start animation of the animation path calculated above. More...
 
virtual void AddSupplementaryPlot (vtkChart *vtkNotUsed(chart), int vtkNotUsed(plotType), vtkStdString vtkNotUsed(row), vtkStdString vtkNotUsed(column), int vtkNotUsed(plotCorner)=0)
 Called when drawing a chart, does nothing at this level. More...
 
void AttachAxisRangeListener (vtkAxis *)
 Attach axis range listener so we can forward to dependent axes in matrix. More...
 
void AxisRangeForwarderCallback (vtkObject *, unsigned long, void *)
 Attach axis range listener so we can forward to dependent axes in matrix. More...
 
- Protected Member Functions inherited from vtkChartMatrix
 vtkChartMatrix ()
 
 ~vtkChartMatrix () override
 
- Protected Member Functions inherited from vtkAbstractContextItem
 vtkAbstractContextItem ()
 
 ~vtkAbstractContextItem () override
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events. More...
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Static Protected Member Functions

static void ProcessEvents (vtkObject *caller, unsigned long event, void *clientData, void *callerData)
 Process events and dispatch to the appropriate member functions. More...
 

Protected Attributes

vtkVector2i ActivePlot
 
bool ActivePlotValid
 
vtkSmartPointer< vtkTableInput
 
vtkNew< vtkStringArrayVisibleColumns
 
int NumberOfBins
 
vtkStdString Title
 
vtkSmartPointer< vtkTextPropertyTitleProperties
 
int SelectionMode
 
int NumberOfFrames
 
bool Animating
 
- Protected Attributes inherited from vtkChartMatrix
vtkVector2i Size
 
vtkVector2f Gutter
 
std::map< vtkVector2i, vtkVector2fSpecificResize
 
int Borders [4]
 
bool LayoutIsDirty
 
- Protected Attributes inherited from vtkAbstractContextItem
vtkContextSceneScene
 Point to the scene the item is on - can be null. More...
 
vtkAbstractContextItemParent
 Point to the parent item - can be null. More...
 
vtkContextScenePrivateChildren
 This structure provides a list of children, along with convenience functions to paint the children etc. More...
 
bool Visible
 Store the visibility of the item (default is true). More...
 
bool Interactive
 Store whether the item should respond to interactions (default is true). More...
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

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 48 of file vtkScatterPlotMatrix.h.

Member Typedef Documentation

Definition at line 58 of file vtkScatterPlotMatrix.h.

Member Enumeration Documentation

anonymous enum
Enumerator
SCATTERPLOT 
HISTOGRAM 
ACTIVEPLOT 
NOPLOT 

Definition at line 51 of file vtkScatterPlotMatrix.h.

Constructor & Destructor Documentation

vtkScatterPlotMatrix::vtkScatterPlotMatrix ( )
protected
vtkScatterPlotMatrix::~vtkScatterPlotMatrix ( )
overrideprotected

Member Function Documentation

static int vtkScatterPlotMatrix::IsTypeOf ( const char *  type)
static
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 in vtkOTScatterPlotMatrix.

static vtkScatterPlotMatrix* vtkScatterPlotMatrix::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkScatterPlotMatrix::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkChartMatrix.

Reimplemented in vtkOTScatterPlotMatrix.

vtkScatterPlotMatrix* vtkScatterPlotMatrix::NewInstance ( ) const
void vtkScatterPlotMatrix::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

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.

Reimplemented in vtkOTScatterPlotMatrix.

static vtkScatterPlotMatrix* vtkScatterPlotMatrix::New ( )
static

Creates a new object.

void vtkScatterPlotMatrix::Update ( )
overridevirtual

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

Reimplemented from vtkChartMatrix.

bool vtkScatterPlotMatrix::Paint ( vtkContext2D painter)
overridevirtual

Paint event for the chart matrix.

Reimplemented from vtkChartMatrix.

void vtkScatterPlotMatrix::SetScene ( vtkContextScene scene)
overridevirtual

Set the vtkContextScene for the item, always set for an item in a scene.

Reimplemented from vtkAbstractContextItem.

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.
virtual void vtkScatterPlotMatrix::SetSize ( const vtkVector2i size)
overridevirtual

Reset ActivePlotSet flag and call superclass method.

Reimplemented from vtkChartMatrix.

virtual vtkVector2i vtkScatterPlotMatrix::GetActivePlot ( )
virtual

Get the position of the active plot.

vtkAnnotationLink* vtkScatterPlotMatrix::GetAnnotationLink ( )

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.

bool vtkScatterPlotMatrix::GetColumnVisibility ( const vtkStdString name)

Get the visibility of the specified column.

void vtkScatterPlotMatrix::SetColumnVisibilityAll ( bool  visible)

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

virtual vtkStringArray* vtkScatterPlotMatrix::GetVisibleColumns ( )
virtual

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
inlinevirtual

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

The default value is 10.

Definition at line 149 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)
overridevirtual

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

Reimplemented from vtkAbstractContextItem.

bool vtkScatterPlotMatrix::MouseMoveEvent ( const vtkContextMouseEvent mouse)
overridevirtual

Mouse move event.

Reimplemented from vtkAbstractContextItem.

bool vtkScatterPlotMatrix::MouseButtonPressEvent ( const vtkContextMouseEvent mouse)
overridevirtual

Mouse button down event.

Reimplemented from vtkAbstractContextItem.

bool vtkScatterPlotMatrix::MouseButtonReleaseEvent ( const vtkContextMouseEvent mouse)
overridevirtual

Mouse button release event.

Reimplemented from vtkAbstractContextItem.

int vtkScatterPlotMatrix::GetPlotType ( const vtkVector2i pos)

Returns the type of the plot at the given position.

The return value is one of: SCATTERPLOT, HISTOGRAM, ACTIVEPLOT, or NOPLOT.

int vtkScatterPlotMatrix::GetPlotType ( int  row,
int  column 
)

Returns the type of the plot at the given position.

The return value is one of: SCATTERPLOT, HISTOGRAM, ACTIVEPLOT, or NOPLOT.

void vtkScatterPlotMatrix::SetTitle ( const vtkStdString title)

Set/get the scatter plot title.

vtkStdString vtkScatterPlotMatrix::GetTitle ( )

Set/get the scatter plot title.

void vtkScatterPlotMatrix::SetTitleProperties ( vtkTextProperty prop)

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

color, font, size.

vtkTextProperty* vtkScatterPlotMatrix::GetTitleProperties ( )

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}.

bool vtkScatterPlotMatrix::GetGridVisibility ( int  plotType)

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}.

vtkColor4ub vtkScatterPlotMatrix::GetBackgroundColor ( int  plotType)

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}.

vtkColor4ub vtkScatterPlotMatrix::GetAxisColor ( int  plotType)

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}.

vtkColor4ub vtkScatterPlotMatrix::GetGridColor ( int  plotType)

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}.

bool vtkScatterPlotMatrix::GetAxisLabelVisibility ( int  plotType)

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

void vtkScatterPlotMatrix::SetAxisLabelProperties ( int  plotType,
vtkTextProperty prop 
)

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

vtkTextProperty* vtkScatterPlotMatrix::GetAxisLabelProperties ( int  plotType)

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}.

int vtkScatterPlotMatrix::GetAxisLabelNotation ( int  plotType)

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}.

int vtkScatterPlotMatrix::GetAxisLabelPrecision ( int  plotType)

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}.

int vtkScatterPlotMatrix::GetTooltipNotation ( int  plotType)

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

int vtkScatterPlotMatrix::GetTooltipPrecision ( int  plotType)

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

void vtkScatterPlotMatrix::SetTooltip ( vtkTooltipItem tooltip)

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

vtkTooltipItem* vtkScatterPlotMatrix::GetTooltip ( ) const

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

void vtkScatterPlotMatrix::SetIndexedLabels ( vtkStringArray labels)

Set indexed labels array.

vtkStringArray* vtkScatterPlotMatrix::GetIndexedLabels ( ) const

Get the indexed labels array.

void vtkScatterPlotMatrix::SetScatterPlotSelectedRowColumnColor ( const vtkColor4ub color)

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

vtkColor4ub vtkScatterPlotMatrix::GetScatterPlotSelectedRowColumnColor ( )

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

void vtkScatterPlotMatrix::SetScatterPlotSelectedActiveColor ( const vtkColor4ub color)

Set the scatter plot selected active chart background color.

vtkColor4ub vtkScatterPlotMatrix::GetScatterPlotSelectedActiveColor ( )

Set the scatter plot selected active chart background color.

void vtkScatterPlotMatrix::UpdateSettings ( )

Convenient method to update all the chart settings.

void vtkScatterPlotMatrix::UpdateChartSettings ( int  plotType)

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

virtual int vtkScatterPlotMatrix::GetSelectionMode ( )
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

vtkStdString vtkScatterPlotMatrix::GetColumnName ( int  column)

Get the column name for the supplied index.

vtkStdString vtkScatterPlotMatrix::GetRowName ( int  row)

Get the column name for the supplied index.

void vtkScatterPlotMatrix::SetNumberOfFrames ( int  frames)

Set the number of animation frames in each transition.

Default is 25, and 0 means to animations between axes.

int vtkScatterPlotMatrix::GetNumberOfFrames ( )

Get the number of animation frames in each transition.

Default is 25, and 0 means to animations between axes.

void vtkScatterPlotMatrix::ClearAnimationPath ( )

Clear the animation path.

bool vtkScatterPlotMatrix::AddAnimationPath ( const vtkVector2i move)

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.

vtkIdType vtkScatterPlotMatrix::GetNumberOfAnimationPathElements ( )

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

vtkVector2i vtkScatterPlotMatrix::GetAnimationPathElement ( vtkIdType  i)

Get the element specified from the animation path.

bool vtkScatterPlotMatrix::BeginAnimationPath ( vtkRenderWindowInteractor interactor)

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

virtual vtkChart* vtkScatterPlotMatrix::GetMainChart ( )
virtual

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.

void vtkScatterPlotMatrix::ResizeBigChart ( )
protected

Compute and set big chart resize.

void vtkScatterPlotMatrix::AttachAxisRangeListener ( vtkAxis )
protected

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)
protectedvirtual

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)
protectedvirtual

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 
)
staticprotected

Process events and dispatch to the appropriate member functions.

virtual void vtkScatterPlotMatrix::AddSupplementaryPlot ( vtkChart vtkNotUsedchart,
int   vtkNotUsedplotType,
vtkStdString   vtkNotUsedrow,
vtkStdString   vtkNotUsedcolumn,
int   vtkNotUsedplotCorner = 0 
)
inlineprotectedvirtual

Called when drawing a chart, does nothing at this level.

Definition at line 462 of file vtkScatterPlotMatrix.h.

Friends And Related Function Documentation

friend class PIMPL
friend

Definition at line 500 of file vtkScatterPlotMatrix.h.

Member Data Documentation

vtkVector2i vtkScatterPlotMatrix::ActivePlot
protected

Definition at line 467 of file vtkScatterPlotMatrix.h.

bool vtkScatterPlotMatrix::ActivePlotValid
protected

Definition at line 470 of file vtkScatterPlotMatrix.h.

vtkSmartPointer<vtkTable> vtkScatterPlotMatrix::Input
protected

Definition at line 473 of file vtkScatterPlotMatrix.h.

vtkNew<vtkStringArray> vtkScatterPlotMatrix::VisibleColumns
protected

Definition at line 476 of file vtkScatterPlotMatrix.h.

int vtkScatterPlotMatrix::NumberOfBins
protected

Definition at line 479 of file vtkScatterPlotMatrix.h.

vtkStdString vtkScatterPlotMatrix::Title
protected

Definition at line 482 of file vtkScatterPlotMatrix.h.

vtkSmartPointer<vtkTextProperty> vtkScatterPlotMatrix::TitleProperties
protected

Definition at line 483 of file vtkScatterPlotMatrix.h.

int vtkScatterPlotMatrix::SelectionMode
protected

Definition at line 486 of file vtkScatterPlotMatrix.h.

int vtkScatterPlotMatrix::NumberOfFrames
protected

Definition at line 489 of file vtkScatterPlotMatrix.h.

bool vtkScatterPlotMatrix::Animating
protected

Definition at line 492 of file vtkScatterPlotMatrix.h.


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