container for a matrix of charts. More...

#include <vtkChartMatrix.h>

Inheritance diagram for vtkChartMatrix:

Collaboration diagram for vtkChartMatrix:

Public Types
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.

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

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

Protected Attributes
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

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

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.

Online Examples:

ChartMatrix

Tests:: vtkChartMatrix (Tests)

Definition at line 51 of file vtkChartMatrix.h.

Member Typedef Documentation

◆ Superclass

typedef vtkAbstractContextItem vtkChartMatrix::Superclass

Definition at line 54 of file vtkChartMatrix.h.

Member Enumeration Documentation

◆ StretchType

enum class vtkChartMatrix::StretchType : unsigned int

strong

Enumerator
SCENE
CUSTOM

Definition at line 278 of file vtkChartMatrix.h.

Constructor & Destructor Documentation

◆ vtkChartMatrix()

vtkChartMatrix::vtkChartMatrix ( )

protected

◆ ~vtkChartMatrix()

vtkChartMatrix::~vtkChartMatrix ( )

overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

static

◆ IsA()

virtual vtkTypeBool vtkChartMatrix::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 vtkAbstractContextItem.

Reimplemented in vtkScatterPlotMatrix, and vtkOTScatterPlotMatrix.

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkChartMatrix::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkAbstractContextItem.

Reimplemented in vtkScatterPlotMatrix, and vtkOTScatterPlotMatrix.

◆ NewInstance()

vtkChartMatrix * vtkChartMatrix::NewInstance ( ) const

◆ PrintSelf()

void vtkChartMatrix::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 vtkAbstractContextItem.

Reimplemented in vtkScatterPlotMatrix, and vtkOTScatterPlotMatrix.

◆ New()

static vtkChartMatrix * vtkChartMatrix::New ( )

static

Creates a new object.

◆ Update()

void vtkChartMatrix::Update ( )

overridevirtual

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

Reimplemented from vtkAbstractContextItem.

Reimplemented in vtkScatterPlotMatrix.

◆ Paint()

bool vtkChartMatrix::Paint ( vtkContext2D * painter )

overridevirtual

Paint event for the chart matrix.

Reimplemented from vtkAbstractContextItem.

Reimplemented in vtkScatterPlotMatrix.

◆ SetSize()

virtual void vtkChartMatrix::SetSize ( const vtkVector2i & size )

virtual

Set the width and height of the chart matrix.

This will cause an immediate resize of the chart matrix, the default size is 0x0 (no charts). No chart objects are created until Allocate is called.

Reimplemented in vtkScatterPlotMatrix.

◆ GetSize()

virtual vtkVector2i vtkChartMatrix::GetSize ( ) const

inlinevirtual

Get the width and height of the chart matrix.

Definition at line 82 of file vtkChartMatrix.h.