vtkScatterPlotMatrix Class Reference

container for a matrix of charts. More...

#include <vtkScatterPlotMatrix.h>

Inheritance diagram for vtkScatterPlotMatrix:

Collaboration diagram for vtkScatterPlotMatrix:

Public Types
enum	{ SCATTERPLOT , HISTOGRAM , ACTIVEPLOT , NOPLOT }
typedef vtkChartMatrix	Superclass
Public Types inherited from vtkChartMatrix
enum class	StretchType : unsigned int { SCENE = 0 , CUSTOM }
typedef vtkAbstractContextItem	Superclass
Public Types inherited from vtkAbstractContextItem
typedef vtkObject	Superclass

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkScatterPlotMatrix *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	Update () override
	Perform any updates to the item that may be necessary before rendering.
bool	Paint (vtkContext2D *painter) override
	Paint event for the chart matrix.
void	SetScene (vtkContextScene *scene) override
	Set the vtkContextScene for the item, always set for an item in a scene.
virtual bool	SetActivePlot (const vtkVector2i &position)
	Set the active plot, the one that will be displayed in the top-right.
void	SetSize (const vtkVector2i &size) override
	Reset ActivePlotSet flag and call superclass method.
virtual vtkVector2i	GetActivePlot ()
	Get the position of the active plot.
vtkAnnotationLink *	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	SetInput (vtkTable *table)
	Set the input table for the scatter plot matrix.
void	SetColumnVisibility (const vtkStdString &name, bool visible)
	Set the visibility of the specified column.
void	InsertVisibleColumn (const vtkStdString &name, int index)
	Insert the specified column at the index position of the visible columns.
bool	GetColumnVisibility (const vtkStdString &name)
	Get the visibility of the specified column.
void	SetColumnVisibilityAll (bool visible)
	Set the visibility of all columns (true will make them all visible, false will remove all visible columns).
virtual vtkStringArray *	GetVisibleColumns ()
	Get a list of the columns, and the order in which they are displayed.
virtual void	SetVisibleColumns (vtkStringArray *visColumns)
	Set the list of visible columns, and the order in which they will be displayed.
virtual void	SetNumberOfBins (int numberOfBins)
	Set the number of bins in the histograms along the central diagonal of the scatter plot matrix.
virtual int	GetNumberOfBins () const
	Get the number of bins the histograms along the central diagonal scatter plot matrix.
void	SetPlotColor (int plotType, const vtkColor4ub &color)
	Set the color for the specified plotType.
void	SetPlotMarkerStyle (int plotType, int style)
	Sets the marker style for the specified plotType.
void	SetPlotMarkerSize (int plotType, float size)
	Sets the marker size for the specified plotType.
bool	Hit (const vtkContextMouseEvent &mouse) override
	Return true if the supplied x, y coordinate is inside the item.
bool	MouseMoveEvent (const vtkContextMouseEvent &mouse) override
	Mouse move event.
bool	MouseButtonPressEvent (const vtkContextMouseEvent &mouse) override
	Mouse button down event.
bool	MouseButtonReleaseEvent (const vtkContextMouseEvent &mouse) override
	Mouse button release event.
void	SetTooltip (vtkTooltipItem *tooltip)
	Set the vtkTooltipItem object that will be displayed by the active chart.
vtkTooltipItem *	GetTooltip () const
	Get the vtkTooltipItem object that will be displayed by the active chart.
void	SetIndexedLabels (vtkStringArray *labels)
	Set indexed labels array.
vtkStringArray *	GetIndexedLabels () const
	Get the indexed labels array.
void	UpdateSettings ()
	Convenient method to update all the chart settings.
void	UpdateChartSettings (int plotType)
	Update charts based on settings given the plot type.
vtkStdString	GetColumnName (int column)
	Get the column name for the supplied index.
vtkStdString	GetRowName (int row)
	Get the column name for the supplied index.
void	SetNumberOfFrames (int frames)
	Set the number of animation frames in each transition.
int	GetNumberOfFrames ()
	Get the number of animation frames in each transition.
void	ClearAnimationPath ()
	Clear the animation path.
bool	AddAnimationPath (const vtkVector2i &move)
	Add a move to the animation path.
vtkIdType	GetNumberOfAnimationPathElements ()
	Get the number of elements (transitions) in the animation path.
vtkVector2i	GetAnimationPathElement (vtkIdType i)
	Get the element specified from the animation path.
bool	BeginAnimationPath (vtkRenderWindowInteractor *interactor)
	Trigger the animation of the scatter plot matrix to begin.
virtual void	AdvanceAnimation ()
	Advance the animation in response to the timer events.
virtual vtkChart *	GetMainChart ()
	Get the main plot (the one in the top-right of the matrix.
int	GetPlotType (const vtkVector2i &pos)
	Returns the type of the plot at the given position.
int	GetPlotType (int row, int column)
	Returns the type of the plot at the given position.
void	SetTitle (const vtkStdString &title)
	Set/get the scatter plot title.
vtkStdString	GetTitle ()
	Set/get the scatter plot title.
void	SetTitleProperties (vtkTextProperty *prop)
	Set/get the text properties for the chart title, i.e.
vtkTextProperty *	GetTitleProperties ()
	Set/get the text properties for the chart title, i.e.
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}.
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}.
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}.
vtkColor4ub	GetBackgroundColor (int plotType)
	Sets the background color for the chart given a plot type, which refers to vtkScatterPlotMatrix::{SCATTERPLOT, HISTOGRAM, ACTIVEPLOT}.
void	SetAxisColor (int plotType, const vtkColor4ub &color)
	Sets the color for the axes given a plot type, which refers to vtkScatterPlotMatrix::{SCATTERPLOT, HISTOGRAM, ACTIVEPLOT}.
vtkColor4ub	GetAxisColor (int plotType)
	Sets the color for the axes given a plot type, which refers to vtkScatterPlotMatrix::{SCATTERPLOT, HISTOGRAM, ACTIVEPLOT}.
void	SetGridColor (int plotType, const vtkColor4ub &color)
	Sets the color for the axes given a plot type, which refers to vtkScatterPlotMatrix::{SCATTERPLOT, HISTOGRAM, ACTIVEPLOT}.
vtkColor4ub	GetGridColor (int plotType)
	Sets the color for the axes given a plot type, which refers to vtkScatterPlotMatrix::{SCATTERPLOT, HISTOGRAM, ACTIVEPLOT}.
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}.
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}.
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}.
vtkTextProperty *	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	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	GetAxisLabelNotation (int plotType)
	Sets the axis label notation for the axes given a plot type, which refers to vtkScatterPlotMatrix::{SCATTERPLOT, HISTOGRAM, ACTIVEPLOT}.
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}.
int	GetAxisLabelPrecision (int plotType)
	Sets the axis label precision for the axes given a plot type, which refers to vtkScatterPlotMatrix::{SCATTERPLOT, HISTOGRAM, ACTIVEPLOT}.
void	SetTooltipNotation (int plotType, int notation)
	Set chart's tooltip notation and precision, given a plot type, which refers to vtkScatterPlotMatrix::{SCATTERPLOT, HISTOGRAM, ACTIVEPLOT}.
void	SetTooltipPrecision (int plotType, int precision)
	Set chart's tooltip notation and precision, given a plot type, which refers to vtkScatterPlotMatrix::{SCATTERPLOT, HISTOGRAM, ACTIVEPLOT}.
int	GetTooltipNotation (int plotType)
	Set chart's tooltip notation and precision, given a plot type, which refers to vtkScatterPlotMatrix::{SCATTERPLOT, HISTOGRAM, ACTIVEPLOT}.
int	GetTooltipPrecision (int plotType)
	Set chart's tooltip notation and precision, given a plot type, which refers to vtkScatterPlotMatrix::{SCATTERPLOT, HISTOGRAM, ACTIVEPLOT}.
void	SetScatterPlotSelectedRowColumnColor (const vtkColor4ub &color)
	Set the scatter plot selected row/column charts' background color.
vtkColor4ub	GetScatterPlotSelectedRowColumnColor ()
	Set the scatter plot selected row/column charts' background color.
void	SetScatterPlotSelectedActiveColor (const vtkColor4ub &color)
	Set the scatter plot selected active chart background color.
vtkColor4ub	GetScatterPlotSelectedActiveColor ()
	Set the scatter plot selected active chart background color.
virtual void	SetSelectionMode (int)
	Set/get the Selection Mode that will be used by the chart while doing selection.
virtual int	GetSelectionMode ()
	Set/get the Selection Mode that will be used by the chart while doing selection.
Public Member Functions inherited from vtkChartMatrix
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkChartMatrix *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	Update () override
	Perform any updates to the item that may be necessary before rendering.
bool	Paint (vtkContext2D *painter) override
	Paint event for the chart matrix.
virtual void	SetSize (const vtkVector2i &size)
	Set the width and height of the chart matrix.
virtual vtkVector2i	GetSize () const
	Get the width and height of the chart matrix.
virtual vtkVector2f	GetGutter () const
	Get the gutter that should be left between the charts in the matrix.
virtual void	Allocate ()
	Allocate the charts, this will cause any null chart to be allocated.
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.
virtual vtkChart *	GetChart (const vtkVector2i &position)
	Get the specified chart element, if the element does not exist nullptr will be returned.
virtual bool	SetChartSpan (const vtkVector2i &position, const vtkVector2i &span)
	Set the span of an element in the matrix.
virtual vtkVector2i	GetChartSpan (const vtkVector2i &position)
	Get the span of the specified element.
virtual vtkVector2i	GetChartIndex (const vtkVector2f &position)
	Get the position of an element in the matrix at the specified location.
virtual std::size_t	GetFlatIndex (const vtkVector2i &index)
	Get internal 1-D index corresponding to the 2-D element index.
virtual std::size_t	GetNumberOfCharts ()
	Total number of charts within this chart matrix.
virtual void	LabelOuter (const vtkVector2i &leftBottomIdx, const vtkVector2i &rightTopIdx)
	Link all charts in the rectangle from leftBottom to rightTop.
virtual bool	SetChartMatrix (const vtkVector2i &position, vtkChartMatrix *chartMatrix)
	Set the element at position to a chart matrix, note that the chart matrix must be large enough to accommodate the element being set.
virtual vtkChartMatrix *	GetChartMatrix (const vtkVector2i &position)
	Get the specified chart matrix element.
virtual vtkRectf	ComputeCurrentElementSceneRect (const vtkVector2i &index, const vtkVector2f &offset, const vtkVector2f &increment)
	Override this method if you want to customize layout instead of the default.
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).
void	SetBorderLeft (int value)
	Set/get the borders of the chart matrix (space in pixels around each chart).
void	SetBorderBottom (int value)
	Set/get the borders of the chart matrix (space in pixels around each chart).
void	SetBorderRight (int value)
	Set/get the borders of the chart matrix (space in pixels around each chart).
void	SetBorderTop (int value)
	Set/get the borders of the chart matrix (space in pixels around each chart).
virtual void	GetBorders (int borders[4])
	Set/get the borders of the chart matrix (space in pixels around each chart).
virtual void	SetGutter (const vtkVector2f &gutter)
	Set the gutter that should be left between the charts in the matrix.
void	SetGutterX (float value)
	Set the gutter that should be left between the charts in the matrix.
void	SetGutterY (float value)
	Set the gutter that should be left between the charts in the matrix.
virtual void	SetPadding (const float &padding)
	Set the gutter that should be left between the charts in the matrix.
virtual void	SetSpecificResize (const vtkVector2i &index, const vtkVector2f &resize)
	Set a specific resize that will move the bottom left point of a chart.
virtual void	ClearSpecificResizes ()
	Set a specific resize that will move the bottom left point of a chart.
virtual void	Link (const vtkVector2i &index1, const vtkVector2i &index2, int axis=1)
	The chart at index2 will be setup to mimic axis range of chart at index1 for specified axis.
virtual void	Link (const size_t &flatIndex1, const size_t &flatIndex2, int axis=1)
	The chart at index2 will be setup to mimic axis range of chart at index1 for specified axis.
virtual void	LinkAll (const vtkVector2i &index, int axis=1)
	Link a chart to all other charts in this chart matrix for specified axis.
virtual void	LinkAll (const size_t &flatIndex, int axis=1)
	Link a chart to all other charts in this chart matrix for specified axis.
virtual void	Unlink (const vtkVector2i &index1, const vtkVector2i &index2, int axis=1)
	Unlink the two charts for specified axis i.e, Chart at index2 will no longer mimic the axis range of chart at index1.
virtual void	Unlink (const size_t &flatIndex1, const size_t &flatIndex2, int axis=1)
	Unlink the two charts for specified axis i.e, Chart at index2 will no longer mimic the axis range of chart at index1.
virtual void	UnlinkAll (const vtkVector2i &index, int axis=1)
	Unlink all charts from given chart for a specified axis.
virtual void	UnlinkAll (const size_t &flatIndex, int axis=1)
	Unlink all charts from given chart for a specified axis.
virtual void	ResetLinks (int axis=1)
	Unlink every chart from all other charts for a specified axis.
virtual void	ResetLinkedLayout ()
	Unlink every chart from all other charts for a specified axis.
virtual void	SetRect (vtkRecti rect)
	Set the rectangular region that this chart matrix will occupy.
virtual vtkRecti	GetRect ()
	Set the rectangular region that this chart matrix will occupy.
virtual void	InitLayoutTraversal (vtkVector2i &index, vtkVector2f &offset, vtkVector2f &increment)
	These methods offer an API to iterate over the layout and obtain the offset of each child element (chart or chart matrix) within the scene, the index and the increment b/w each element.
virtual void	GoToNextElement (vtkVector2i &index, vtkVector2f &offset)
	These methods offer an API to iterate over the layout and obtain the offset of each child element (chart or chart matrix) within the scene, the index and the increment b/w each element.
virtual bool	IsDoneWithTraversal ()
	These methods offer an API to iterate over the layout and obtain the offset of each child element (chart or chart matrix) within the scene, the index and the increment b/w each element.
	vtkSetEnumMacro (FillStrategy, StretchType)
	This specifies whether the chart matrix will fill the entire scene or instead draw itself in a user provided rectangular subset of the scene.
StretchType	GetFillStrategy ()
	This specifies whether the chart matrix will fill the entire scene or instead draw itself in a user provided rectangular subset of the scene.
Public Member Functions inherited from vtkAbstractContextItem
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkAbstractContextItem *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
virtual void	Update ()
	Perform any updates to the item that may be necessary before rendering.
virtual bool	Paint (vtkContext2D *painter)
	Paint event for the item, called whenever the item needs to be drawn.
virtual bool	PaintChildren (vtkContext2D *painter)
	Paint the children of the item, should be called whenever the children need to be rendered.
virtual void	ReleaseGraphicsResources ()
	Release graphics resources hold by the item.
vtkIdType	AddItem (vtkAbstractContextItem *item)
	Add child items to this item.
bool	RemoveItem (vtkAbstractContextItem *item)
	Remove child item from this item.
bool	RemoveItem (vtkIdType index)
	Remove child item from this item.
vtkAbstractContextItem *	GetItem (vtkIdType index)
	Get the item at the specified index.
vtkIdType	GetItemIndex (vtkAbstractContextItem *item)
	Get the index of the specified item in itemIndex.
vtkIdType	GetNumberOfItems ()
	Get the number of child items.
void	ClearItems ()
	Remove all child items from this item.
vtkIdType	Raise (vtkIdType index)
	Raises the child to the top of the item's stack.
virtual vtkIdType	StackAbove (vtkIdType index, vtkIdType under)
	Raises the child above the under sibling.
vtkIdType	Lower (vtkIdType index)
	Lowers the child to the bottom of the item's stack.
virtual vtkIdType	StackUnder (vtkIdType child, vtkIdType above)
	Lowers the child under the above sibling.
virtual bool	Hit (const vtkContextMouseEvent &mouse)
	Return true if the supplied x, y coordinate is inside the item.
virtual vtkAbstractContextItem *	GetPickedItem (const vtkContextMouseEvent &mouse)
	Return the item under the mouse.
virtual bool	MouseEnterEvent (const vtkContextMouseEvent &mouse)
	Mouse enter event.
virtual bool	MouseMoveEvent (const vtkContextMouseEvent &mouse)
	Mouse move event.
virtual bool	MouseLeaveEvent (const vtkContextMouseEvent &mouse)
	Mouse leave event.
virtual bool	MouseButtonPressEvent (const vtkContextMouseEvent &mouse)
	Mouse button down event Return true if the item holds the event, false if the event can be propagated to other items.
virtual bool	MouseButtonReleaseEvent (const vtkContextMouseEvent &mouse)
	Mouse button release event.
virtual bool	MouseDoubleClickEvent (const vtkContextMouseEvent &mouse)
	Mouse button double click event.
virtual bool	MouseWheelEvent (const vtkContextMouseEvent &mouse, int delta)
	Mouse wheel event, positive delta indicates forward movement of the wheel.
virtual bool	KeyPressEvent (const vtkContextKeyEvent &key)
	Key press event.
virtual bool	KeyReleaseEvent (const vtkContextKeyEvent &key)
	Key release event.
virtual void	SetScene (vtkContextScene *scene)
	Set the vtkContextScene for the item, always set for an item in a scene.
vtkContextScene *	GetScene ()
	Get the vtkContextScene for the item, always set for an item in a scene.
virtual void	SetParent (vtkAbstractContextItem *parent)
	Set the parent item.
vtkAbstractContextItem *	GetParent ()
	Get the parent item.
virtual vtkVector2f	MapToParent (const vtkVector2f &point)
	Maps the point to the parent coordinate system.
virtual vtkVector2f	MapFromParent (const vtkVector2f &point)
	Maps the point from the parent coordinate system.
virtual vtkVector2f	MapToScene (const vtkVector2f &point)
	Maps the point to the scene coordinate system.
virtual vtkVector2f	MapFromScene (const vtkVector2f &point)
	Maps the point from the scene coordinate system.
virtual bool	GetVisible ()
	Get the visibility of the item (should it be drawn).
virtual void	SetVisible (bool)
	Set the visibility of the item (should it be drawn).
virtual bool	GetInteractive ()
	Get if the item is interactive (should respond to mouse events).
virtual void	SetInteractive (bool)
	Set if the item is interactive (should respond to mouse events).
Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
	Turn debugging output on.
virtual void	DebugOff ()
	Turn debugging output off.
bool	GetDebug ()
	Get the value of the debug flag.
void	SetDebug (bool debugFlag)
	Set the value of the debug flag.
virtual void	Modified ()
	Update the modification time for this object.
virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
vtkTypeBool	HasObserver (unsigned long event)
vtkTypeBool	HasObserver (const char *event)
vtkTypeBool	InvokeEvent (unsigned long event)
vtkTypeBool	InvokeEvent (const char *event)
std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
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.
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.
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.
vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
vtkTypeBool	InvokeEvent (const char *event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.
virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.
virtual std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.
virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.
virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
virtual void	Delete ()
	Delete a VTK object.
virtual void	FastDelete ()
	Delete a reference to this object.
void	InitializeObjectBase ()
void	Print (ostream &os)
	Print an object to an ostream.
void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).
virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).
int	GetReferenceCount ()
	Return the current reference count of this object.
void	SetReferenceCount (int)
	Sets the reference count.
bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.
virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses vtkGarbageCollector or not.

Static Public Member Functions
static vtkTypeBool	IsTypeOf (const char *type)
static vtkScatterPlotMatrix *	SafeDownCast (vtkObjectBase *o)
static vtkScatterPlotMatrix *	New ()
	Creates a new object.
Static Public Member Functions inherited from vtkChartMatrix
static vtkTypeBool	IsTypeOf (const char *type)
static vtkChartMatrix *	SafeDownCast (vtkObjectBase *o)
static vtkChartMatrix *	New ()
	Creates a new object.
Static Public Member Functions inherited from vtkAbstractContextItem
static vtkTypeBool	IsTypeOf (const char *type)
static vtkAbstractContextItem *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.
static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
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.
static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkScatterPlotMatrix ()
	~vtkScatterPlotMatrix () override
void	UpdateLayout ()
	Internal helper to do the layout of the charts in the scatter plot matrix.
void	ResizeBigChart ()
	Compute and set big chart resize.
void	BigChartSelectionCallback (vtkObject *, unsigned long, void *)
	The callback function when SelectionChangedEvent is invoked from the Big chart.
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.
virtual void	StartAnimation (vtkRenderWindowInteractor *interactor)
	Given the render window interactor, start animation of the animation path calculated above.
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.
void	AttachAxisRangeListener (vtkAxis *)
	Attach axis range listener so we can forward to dependent axes in matrix.
void	AxisRangeForwarderCallback (vtkObject *, unsigned long, void *)
	Attach axis range listener so we can forward to dependent axes in matrix.
Protected Member Functions inherited from vtkChartMatrix
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkChartMatrix ()
	~vtkChartMatrix () override
virtual void	SynchronizeAxisRanges (vtkObject *caller, unsigned long eventId, void *calldata)
Protected Member Functions inherited from vtkAbstractContextItem
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkAbstractContextItem ()
	~vtkAbstractContextItem () override
virtual void	ReleaseGraphicsCache ()
	Release cache entries created by this context item.
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.
void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	ReportReferences (vtkGarbageCollector *)
virtual void	ObjectFinalize ()
	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.
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()
static vtkReallocingFunction	GetCurrentReallocFunction ()
static vtkFreeingFunction	GetCurrentFreeFunction ()
static vtkFreeingFunction	GetAlternateFreeFunction ()

Protected Attributes
vtkVector2i	ActivePlot
bool	ActivePlotValid
vtkSmartPointer< vtkTable >	Input
vtkNew< vtkStringArray >	VisibleColumns
int	NumberOfBins
vtkStdString	Title
vtkSmartPointer< vtkTextProperty >	TitleProperties
int	SelectionMode
int	NumberOfFrames
bool	Animating
Protected Attributes inherited from vtkChartMatrix
vtkVector2i	Size
vtkVector2f	Gutter
float	Padding
std::map< vtkVector2i, vtkVector2f >	SpecificResize
int	Borders [4]
bool	LayoutIsDirty
vtkRecti	Rect = { 0, 0, 100, 100 }
StretchType	FillStrategy = StretchType::SCENE
Protected Attributes inherited from vtkAbstractContextItem
vtkContextScene *	Scene
	Point to the scene the item is on - can be null.
vtkAbstractContextItem *	Parent
	Point to the parent item - can be null.
vtkContextScenePrivate *	Children
	This structure provides a list of children, along with convenience functions to paint the children etc.
bool	Visible
	Store the visibility of the item (default is true).
bool	Interactive
	Store whether the item should respond to interactions (default is true).
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
std::string	ObjectName
Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	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 38 of file vtkScatterPlotMatrix.h.

Member Typedef Documentation

Superclass

typedef vtkChartMatrix vtkScatterPlotMatrix::Superclass

Definition at line 49 of file vtkScatterPlotMatrix.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
SCATTERPLOT
HISTOGRAM
ACTIVEPLOT
NOPLOT

Definition at line 41 of file vtkScatterPlotMatrix.h.

Constructor & Destructor Documentation

vtkScatterPlotMatrix()

vtkScatterPlotMatrix::vtkScatterPlotMatrix ( )

protected

~vtkScatterPlotMatrix()

vtkScatterPlotMatrix::~vtkScatterPlotMatrix ( )

overrideprotected

Member Function Documentation

IsTypeOf()

static vtkTypeBool vtkScatterPlotMatrix::IsTypeOf ( const char *  type )

static

IsA()

virtual vtkTypeBool 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.

SafeDownCast()

static vtkScatterPlotMatrix * vtkScatterPlotMatrix::SafeDownCast ( vtkObjectBase *  o )

static

NewInstanceInternal()

virtual vtkObjectBase * vtkScatterPlotMatrix::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkChartMatrix.

Reimplemented in vtkOTScatterPlotMatrix.

NewInstance()

vtkScatterPlotMatrix * vtkScatterPlotMatrix::NewInstance

(

)

const

PrintSelf()

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.

New()

static vtkScatterPlotMatrix * vtkScatterPlotMatrix::New ( )

static

Creates a new object.

Update()

void vtkScatterPlotMatrix::Update ( )

overridevirtual

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

Reimplemented from vtkChartMatrix.

Paint()

bool vtkScatterPlotMatrix::Paint ( vtkContext2D *  painter )

overridevirtual

Paint event for the chart matrix.

Reimplemented from vtkChartMatrix.

SetScene()

void vtkScatterPlotMatrix::SetScene ( vtkContextScene *  scene )

overridevirtual

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

Reimplemented from vtkAbstractContextItem.

SetActivePlot()

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.

SetSize()

void vtkScatterPlotMatrix::SetSize ( const vtkVector2i &  size )

overridevirtual

Reset ActivePlotSet flag and call superclass method.

Reimplemented from vtkChartMatrix.

GetActivePlot()

virtual vtkVector2i vtkScatterPlotMatrix::GetActivePlot ( )

virtual

Get the position of the active plot.

GetAnnotationLink()

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.

SetInput()

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.

SetColumnVisibility()

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

Set the visibility of the specified column.

InsertVisibleColumn()

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

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

GetColumnVisibility()

bool vtkScatterPlotMatrix::GetColumnVisibility

(

const vtkStdString &

name

)

Get the visibility of the specified column.

SetColumnVisibilityAll()

void vtkScatterPlotMatrix::SetColumnVisibilityAll

(

bool

visible

)

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

GetVisibleColumns()

virtual vtkStringArray * vtkScatterPlotMatrix::GetVisibleColumns ( )

virtual

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

SetVisibleColumns()

virtual void vtkScatterPlotMatrix::SetVisibleColumns ( vtkStringArray *  visColumns )

virtual

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

SetNumberOfBins()

virtual void vtkScatterPlotMatrix::SetNumberOfBins ( int  numberOfBins )

virtual

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

GetNumberOfBins()

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

SetPlotColor()

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

Set the color for the specified plotType.

SetPlotMarkerStyle()

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

Sets the marker style for the specified plotType.

SetPlotMarkerSize()

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

Sets the marker size for the specified plotType.

Hit()

bool vtkScatterPlotMatrix::Hit ( const vtkContextMouseEvent &  mouse )

overridevirtual

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

Reimplemented from vtkAbstractContextItem.

MouseMoveEvent()

bool vtkScatterPlotMatrix::MouseMoveEvent ( const vtkContextMouseEvent &  mouse )

overridevirtual

Mouse move event.

Reimplemented from vtkAbstractContextItem.

MouseButtonPressEvent()

bool vtkScatterPlotMatrix::MouseButtonPressEvent ( const vtkContextMouseEvent &  mouse )

overridevirtual

Mouse button down event.

Reimplemented from vtkAbstractContextItem.

MouseButtonReleaseEvent()

bool vtkScatterPlotMatrix::MouseButtonReleaseEvent ( const vtkContextMouseEvent &  mouse )

overridevirtual

Mouse button release event.

Reimplemented from vtkAbstractContextItem.

GetPlotType() [1/2]

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.

GetPlotType() [2/2]

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.

SetTitle()

void vtkScatterPlotMatrix::SetTitle

(

const vtkStdString &

title

)

Set/get the scatter plot title.

GetTitle()

vtkStdString vtkScatterPlotMatrix::GetTitle

(

)

Set/get the scatter plot title.

SetTitleProperties()

void vtkScatterPlotMatrix::SetTitleProperties

(

vtkTextProperty *

prop

)

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

color, font, size.

GetTitleProperties()

vtkTextProperty * vtkScatterPlotMatrix::GetTitleProperties

(

)

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

color, font, size.

SetGridVisibility()

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

GetGridVisibility()

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

SetBackgroundColor()

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

GetBackgroundColor()

vtkColor4ub vtkScatterPlotMatrix::GetBackgroundColor

(

int

plotType

)

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

SetAxisColor()

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

GetAxisColor()

vtkColor4ub vtkScatterPlotMatrix::GetAxisColor

(

int

plotType

)

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

SetGridColor()

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

GetGridColor()

vtkColor4ub vtkScatterPlotMatrix::GetGridColor

(

int

plotType

)

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

SetAxisLabelVisibility()

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

GetAxisLabelVisibility()

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

SetAxisLabelProperties()

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

GetAxisLabelProperties()

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

SetAxisLabelNotation()

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

GetAxisLabelNotation()

int vtkScatterPlotMatrix::GetAxisLabelNotation

(

int

plotType

)

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

SetAxisLabelPrecision()

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

GetAxisLabelPrecision()

int vtkScatterPlotMatrix::GetAxisLabelPrecision

(

int

plotType

)

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

SetTooltipNotation()

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

SetTooltipPrecision()

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

GetTooltipNotation()

int vtkScatterPlotMatrix::GetTooltipNotation

(

int

plotType

)

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

GetTooltipPrecision()

int vtkScatterPlotMatrix::GetTooltipPrecision

(

int

plotType

)

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

SetTooltip()

void vtkScatterPlotMatrix::SetTooltip

(

vtkTooltipItem *

tooltip

)

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

GetTooltip()

vtkTooltipItem * vtkScatterPlotMatrix::GetTooltip

(

)

const

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

SetIndexedLabels()

void vtkScatterPlotMatrix::SetIndexedLabels

(

vtkStringArray *

labels

)

Set indexed labels array.

GetIndexedLabels()

vtkStringArray * vtkScatterPlotMatrix::GetIndexedLabels

(

)

const

Get the indexed labels array.

SetScatterPlotSelectedRowColumnColor()

void vtkScatterPlotMatrix::SetScatterPlotSelectedRowColumnColor

(

const vtkColor4ub &

color

)

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

GetScatterPlotSelectedRowColumnColor()

vtkColor4ub vtkScatterPlotMatrix::GetScatterPlotSelectedRowColumnColor

(

)

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

SetScatterPlotSelectedActiveColor()

void vtkScatterPlotMatrix::SetScatterPlotSelectedActiveColor

(

const vtkColor4ub &

color

)

Set the scatter plot selected active chart background color.

GetScatterPlotSelectedActiveColor()

vtkColor4ub vtkScatterPlotMatrix::GetScatterPlotSelectedActiveColor

(

)

Set the scatter plot selected active chart background color.

UpdateSettings()

void vtkScatterPlotMatrix::UpdateSettings

(

)

Convenient method to update all the chart settings.

UpdateChartSettings()

void vtkScatterPlotMatrix::UpdateChartSettings

(

int

plotType

)

Update charts based on settings given the plot type.

SetSelectionMode()

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

GetSelectionMode()

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

GetColumnName()

vtkStdString vtkScatterPlotMatrix::GetColumnName

(

int

column

)

Get the column name for the supplied index.

GetRowName()

vtkStdString vtkScatterPlotMatrix::GetRowName

(

int

row

)

Get the column name for the supplied index.

SetNumberOfFrames()

void vtkScatterPlotMatrix::SetNumberOfFrames

(

int

frames

)

Set the number of animation frames in each transition.

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

GetNumberOfFrames()

int vtkScatterPlotMatrix::GetNumberOfFrames

(

)

Get the number of animation frames in each transition.

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

ClearAnimationPath()

void vtkScatterPlotMatrix::ClearAnimationPath

(

)

Clear the animation path.

AddAnimationPath()

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.

GetNumberOfAnimationPathElements()

vtkIdType vtkScatterPlotMatrix::GetNumberOfAnimationPathElements

(

)

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

GetAnimationPathElement()

vtkVector2i vtkScatterPlotMatrix::GetAnimationPathElement

(

vtkIdType

i

)

Get the element specified from the animation path.

BeginAnimationPath()

bool vtkScatterPlotMatrix::BeginAnimationPath

(

vtkRenderWindowInteractor *

interactor

)

Trigger the animation of the scatter plot matrix to begin.

AdvanceAnimation()

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

GetMainChart()

virtual vtkChart * vtkScatterPlotMatrix::GetMainChart ( )

virtual

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

UpdateLayout()

void vtkScatterPlotMatrix::UpdateLayout ( )

protected

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

ResizeBigChart()

void vtkScatterPlotMatrix::ResizeBigChart ( )

protected

Compute and set big chart resize.

AttachAxisRangeListener()

void vtkScatterPlotMatrix::AttachAxisRangeListener ( vtkAxis *  )

protected

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

AxisRangeForwarderCallback()

void vtkScatterPlotMatrix::AxisRangeForwarderCallback ( vtkObject *  , unsigned long  , void *    )

protected

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

BigChartSelectionCallback()

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.

UpdateAnimationPath()

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.

StartAnimation()

virtual void vtkScatterPlotMatrix::StartAnimation ( vtkRenderWindowInteractor *  interactor )

protectedvirtual

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

ProcessEvents()

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

staticprotected

Process events and dispatch to the appropriate member functions.

AddSupplementaryPlot()

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

Friends And Related Symbol Documentation

PIMPL

friend class PIMPL

friend

Definition at line 492 of file vtkScatterPlotMatrix.h.

Member Data Documentation

ActivePlot

vtkVector2i vtkScatterPlotMatrix::ActivePlot

protected

Definition at line 459 of file vtkScatterPlotMatrix.h.

ActivePlotValid

bool vtkScatterPlotMatrix::ActivePlotValid

protected

Definition at line 462 of file vtkScatterPlotMatrix.h.

Input

vtkSmartPointer<vtkTable> vtkScatterPlotMatrix::Input

protected

Definition at line 465 of file vtkScatterPlotMatrix.h.

VisibleColumns

vtkNew<vtkStringArray> vtkScatterPlotMatrix::VisibleColumns

protected

Definition at line 468 of file vtkScatterPlotMatrix.h.

NumberOfBins

int vtkScatterPlotMatrix::NumberOfBins

protected

Definition at line 471 of file vtkScatterPlotMatrix.h.

Title

vtkStdString vtkScatterPlotMatrix::Title

protected

Definition at line 474 of file vtkScatterPlotMatrix.h.

TitleProperties

vtkSmartPointer<vtkTextProperty> vtkScatterPlotMatrix::TitleProperties

protected

Definition at line 475 of file vtkScatterPlotMatrix.h.

SelectionMode

int vtkScatterPlotMatrix::SelectionMode

protected

Definition at line 478 of file vtkScatterPlotMatrix.h.

NumberOfFrames

int vtkScatterPlotMatrix::NumberOfFrames

protected

Definition at line 481 of file vtkScatterPlotMatrix.h.

Animating

bool vtkScatterPlotMatrix::Animating

protected

Definition at line 484 of file vtkScatterPlotMatrix.h.

---

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

• Charts/Core/vtkScatterPlotMatrix.h