VTK  9.3.20240328
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkChartMatrix Class Reference

container for a matrix of charts. More...

#include <vtkChartMatrix.h>

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

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. More...
 
vtkChartMatrixNewInstance () 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...
 
virtual void SetSize (const vtkVector2i &size)
 Set the width and height of the chart matrix. More...
 
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 an element in the matrix. More...
 
virtual vtkVector2i GetChartSpan (const vtkVector2i &position)
 Get the span of the specified element. More...
 
virtual vtkVector2i GetChartIndex (const vtkVector2f &position)
 Get the position of an element in the matrix at the specified location. More...
 
virtual std::size_t GetFlatIndex (const vtkVector2i &index)
 Get internal 1-D index corresponding to the 2-D element index. More...
 
virtual std::size_t GetNumberOfCharts ()
 Total number of charts within this chart matrix. More...
 
virtual void LabelOuter (const vtkVector2i &leftBottomIdx, const vtkVector2i &rightTopIdx)
 Link all charts in the rectangle from leftBottom to rightTop. More...
 
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. More...
 
virtual vtkChartMatrixGetChartMatrix (const vtkVector2i &position)
 Get the specified chart matrix element. More...
 
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. 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 SetPadding (const float &padding)
 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...
 
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. More...
 
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. More...
 
virtual void LinkAll (const vtkVector2i &index, int axis=1)
 Link a chart to all other charts in this chart matrix for specified axis. More...
 
virtual void LinkAll (const size_t &flatIndex, int axis=1)
 Link a chart to all other charts in this chart matrix for specified axis. More...
 
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. More...
 
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. More...
 
virtual void UnlinkAll (const vtkVector2i &index, int axis=1)
 Unlink all charts from given chart for a specified axis. More...
 
virtual void UnlinkAll (const size_t &flatIndex, int axis=1)
 Unlink all charts from given chart for a specified axis. More...
 
virtual void ResetLinks (int axis=1)
 Unlink every chart from all other charts for a specified axis. More...
 
virtual void ResetLinkedLayout ()
 Unlink every chart from all other charts for a specified axis. More...
 
virtual void SetRect (vtkRecti rect)
 Set the rectangular region that this chart matrix will occupy. More...
 
virtual vtkRecti GetRect ()
 Set the rectangular region that this chart matrix will occupy. More...
 
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. More...
 
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. More...
 
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. More...
 
 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. More...
 
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. 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...
 
vtkIdType AddItem (vtkAbstractContextItem *item)
 Add child items to this item. More...
 
bool RemoveItem (vtkAbstractContextItem *item)
 Remove child item from this item. More...
 
bool RemoveItem (vtkIdType index)
 Remove child item from this item. More...
 
vtkAbstractContextItemGetItem (vtkIdType index)
 Get the item at the specified index. More...
 
vtkIdType GetItemIndex (vtkAbstractContextItem *item)
 Get the index of the specified item in itemIndex. More...
 
vtkIdType GetNumberOfItems ()
 Get the number of child items. More...
 
void ClearItems ()
 Remove all child items from this item. More...
 
vtkIdType Raise (vtkIdType index)
 Raises the child to the top of the item's stack. More...
 
virtual vtkIdType StackAbove (vtkIdType index, vtkIdType under)
 Raises the child above the under sibling. More...
 
vtkIdType Lower (vtkIdType index)
 Lowers the child to the bottom of the item's stack. More...
 
virtual vtkIdType StackUnder (vtkIdType child, vtkIdType above)
 Lowers the child under the above sibling. More...
 
virtual bool Hit (const vtkContextMouseEvent &mouse)
 Return true if the supplied x, y coordinate is inside the item. 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 MouseMoveEvent (const vtkContextMouseEvent &mouse)
 Mouse move event. More...
 
virtual bool MouseLeaveEvent (const vtkContextMouseEvent &mouse)
 Mouse leave event. More...
 
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. More...
 
virtual bool MouseButtonReleaseEvent (const vtkContextMouseEvent &mouse)
 Mouse button release 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...
 
virtual void SetScene (vtkContextScene *scene)
 Set the vtkContextScene for the item, always set for an item in a scene. 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 ()
 
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. More...
 
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...
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool 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...
 
vtkTypeBool InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
vtkTypeBool InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
virtual void SetObjectName (const std::string &objectName)
 Set/get the name of this object for reporting purposes. More...
 
virtual std::string GetObjectName () const
 Set/get the name of this object for reporting purposes. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
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). 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...
 
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...
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space. 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...
 
virtual bool UsesGarbageCollector () const
 Indicate whether the class uses vtkGarbageCollector or not. More...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkChartMatrixSafeDownCast (vtkObjectBase *o)
 
static vtkChartMatrixNew ()
 Creates a new object. More...
 
- Static Public Member Functions inherited from vtkAbstractContextItem
static vtkTypeBool 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 (vtkTypeBool 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 vtkTypeBool 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 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). More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
 
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. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkChartMatrix ()
 
 ~vtkChartMatrix () override
 
virtual void SynchronizeAxisRanges (vtkObject *caller, unsigned long eventId, void *calldata)
 
- Protected Member Functions inherited from vtkAbstractContextItem
 vtkAbstractContextItem ()
 
 ~vtkAbstractContextItem () override
 
virtual void ReleaseGraphicsCache ()
 Release cache entries created by this context item. More...
 
- 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 ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkVector2i Size
 
vtkVector2f Gutter
 
float Padding
 
std::map< vtkVector2i, vtkVector2fSpecificResize
 
int Borders [4]
 
bool LayoutIsDirty
 
vtkRecti Rect = { 0, 0, 100, 100 }
 
StretchType FillStrategy = StretchType::SCENE
 
- 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
 
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:

Tests:
vtkChartMatrix (Tests)

Definition at line 50 of file vtkChartMatrix.h.

Member Typedef Documentation

◆ Superclass

Definition at line 53 of file vtkChartMatrix.h.

Member Enumeration Documentation

◆ StretchType

enum vtkChartMatrix::StretchType : unsigned int
strong
Enumerator
SCENE 
CUSTOM 

Definition at line 277 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 vtkOTScatterPlotMatrix, and vtkScatterPlotMatrix.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkChartMatrix::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkAbstractContextItem.

Reimplemented in vtkOTScatterPlotMatrix, and vtkScatterPlotMatrix.

◆ 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 vtkObjectBase.

Reimplemented in vtkOTScatterPlotMatrix, and vtkScatterPlotMatrix.

◆ 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 81 of file vtkChartMatrix.h.

◆ SetBorders()

virtual void vtkChartMatrix::SetBorders ( int  left,
int  bottom,
int  right,
int  top 
)
virtual

Set/get the borders of the chart matrix (space in pixels around each chart).

◆ SetBorderLeft()

void vtkChartMatrix::SetBorderLeft ( int  value)

Set/get the borders of the chart matrix (space in pixels around each chart).

◆ SetBorderBottom()

void vtkChartMatrix::SetBorderBottom ( int  value)

Set/get the borders of the chart matrix (space in pixels around each chart).

◆ SetBorderRight()

void vtkChartMatrix::SetBorderRight ( int  value)

Set/get the borders of the chart matrix (space in pixels around each chart).

◆ SetBorderTop()

void vtkChartMatrix::SetBorderTop ( int  value)

Set/get the borders of the chart matrix (space in pixels around each chart).

◆ GetBorders()

virtual void vtkChartMatrix::GetBorders ( int  borders[4])
inlinevirtual

Set/get the borders of the chart matrix (space in pixels around each chart).

Definition at line 92 of file vtkChartMatrix.h.

◆ SetGutter()

virtual void vtkChartMatrix::SetGutter ( const vtkVector2f gutter)
virtual

Set the gutter that should be left between the charts in the matrix.

◆ SetGutterX()

void vtkChartMatrix::SetGutterX ( float  value)

Set the gutter that should be left between the charts in the matrix.

◆ SetGutterY()

void vtkChartMatrix::SetGutterY ( float  value)

Set the gutter that should be left between the charts in the matrix.

◆ SetPadding()

virtual void vtkChartMatrix::SetPadding ( const float &  padding)
virtual

Set the gutter that should be left between the charts in the matrix.

◆ SetSpecificResize()

virtual void vtkChartMatrix::SetSpecificResize ( const vtkVector2i index,
const vtkVector2f resize 
)
virtual

Set a specific resize that will move the bottom left point of a chart.

◆ ClearSpecificResizes()

virtual void vtkChartMatrix::ClearSpecificResizes ( )
virtual

Set a specific resize that will move the bottom left point of a chart.

◆ GetGutter()

virtual vtkVector2f vtkChartMatrix::GetGutter ( ) const
inlinevirtual

Get the gutter that should be left between the charts in the matrix.

Definition at line 128 of file vtkChartMatrix.h.

◆ Allocate()

virtual void vtkChartMatrix::Allocate ( )
virtual

Allocate the charts, this will cause any null chart to be allocated.

◆ SetChart()

virtual bool vtkChartMatrix::SetChart ( const vtkVector2i position,
vtkChart chart 
)
virtual

Set the chart element, note that the chart matrix must be large enough to accommodate the element being set.

Note that this class will take ownership of the chart object.

Returns
false if the element cannot be set.

◆ GetChart()

virtual vtkChart* vtkChartMatrix::GetChart ( const vtkVector2i position)
virtual

Get the specified chart element, if the element does not exist nullptr will be returned.

If the chart element has not yet been allocated it will be at this point.

◆ SetChartSpan()

virtual bool vtkChartMatrix::SetChartSpan ( const vtkVector2i position,
const vtkVector2i span 
)
virtual

Set the span of an element in the matrix.

This defaults to 1x1, and cannot exceed the remaining space in x or y.

Returns
false If the span is not possible.

◆ GetChartSpan()

virtual vtkVector2i vtkChartMatrix::GetChartSpan ( const vtkVector2i position)
virtual

Get the span of the specified element.

◆ GetChartIndex()

virtual vtkVector2i vtkChartMatrix::GetChartIndex ( const vtkVector2f position)
virtual

Get the position of an element in the matrix at the specified location.

The position should be specified in scene coordinates.

◆ GetFlatIndex()

virtual std::size_t vtkChartMatrix::GetFlatIndex ( const vtkVector2i index)
virtual

Get internal 1-D index corresponding to the 2-D element index.

◆ GetNumberOfCharts()

virtual std::size_t vtkChartMatrix::GetNumberOfCharts ( )
virtual

Total number of charts within this chart matrix.

◆ LabelOuter()

virtual void vtkChartMatrix::LabelOuter ( const vtkVector2i leftBottomIdx,
const vtkVector2i rightTopIdx 
)
virtual

Link all charts in the rectangle from leftBottom to rightTop.

Label only the outer most y-axis and x-axis. This removes of gutter space between the linked charts.

◆ Link() [1/2]

virtual void vtkChartMatrix::Link ( const vtkVector2i index1,
const vtkVector2i index2,
int  axis = 1 
)
virtual

The chart at index2 will be setup to mimic axis range of chart at index1 for specified axis.

Note: index is a two dimensional chart index. See vtkChartMatrix::GetChartIndex() flatIndex is a one dimensional chart index. See vtkChartMatrix::GetFlatIndex()

◆ Link() [2/2]

virtual void vtkChartMatrix::Link ( const size_t &  flatIndex1,
const size_t &  flatIndex2,
int  axis = 1 
)
virtual

The chart at index2 will be setup to mimic axis range of chart at index1 for specified axis.

Note: index is a two dimensional chart index. See vtkChartMatrix::GetChartIndex() flatIndex is a one dimensional chart index. See vtkChartMatrix::GetFlatIndex()

◆ LinkAll() [1/2]

virtual void vtkChartMatrix::LinkAll ( const vtkVector2i index,
int  axis = 1 
)
virtual

Link a chart to all other charts in this chart matrix for specified axis.

◆ LinkAll() [2/2]

virtual void vtkChartMatrix::LinkAll ( const size_t &  flatIndex,
int  axis = 1 
)
virtual

Link a chart to all other charts in this chart matrix for specified axis.

◆ Unlink() [1/2]

virtual void vtkChartMatrix::Unlink ( const vtkVector2i index1,
const vtkVector2i index2,
int  axis = 1 
)
virtual

Unlink the two charts for specified axis i.e, Chart at index2 will no longer mimic the axis range of chart at index1.

◆ Unlink() [2/2]

virtual void vtkChartMatrix::Unlink ( const size_t &  flatIndex1,
const size_t &  flatIndex2,
int  axis = 1 
)
virtual

Unlink the two charts for specified axis i.e, Chart at index2 will no longer mimic the axis range of chart at index1.

◆ UnlinkAll() [1/2]

virtual void vtkChartMatrix::UnlinkAll ( const vtkVector2i index,
int  axis = 1 
)
virtual

Unlink all charts from given chart for a specified axis.

◆ UnlinkAll() [2/2]

virtual void vtkChartMatrix::UnlinkAll ( const size_t &  flatIndex,
int  axis = 1 
)
virtual

Unlink all charts from given chart for a specified axis.

◆ ResetLinks()

virtual void vtkChartMatrix::ResetLinks ( int  axis = 1)
virtual

Unlink every chart from all other charts for a specified axis.

This effectively removes any linkage in the chart matrix. If vtkChartMatrix::LabelOuter() was used, call ResetLinkedLayout, sot that the gutters that were removed will be put back in place.

◆ ResetLinkedLayout()

virtual void vtkChartMatrix::ResetLinkedLayout ( )
virtual

Unlink every chart from all other charts for a specified axis.

This effectively removes any linkage in the chart matrix. If vtkChartMatrix::LabelOuter() was used, call ResetLinkedLayout, sot that the gutters that were removed will be put back in place.

◆ SetRect()

virtual void vtkChartMatrix::SetRect ( vtkRecti  rect)
virtual

Set the rectangular region that this chart matrix will occupy.

Must also set FillStrategy to StretchType::CUSTOM

◆ GetRect()

virtual vtkRecti vtkChartMatrix::GetRect ( )
virtual

Set the rectangular region that this chart matrix will occupy.

Must also set FillStrategy to StretchType::CUSTOM

◆ SetChartMatrix()

virtual bool vtkChartMatrix::SetChartMatrix ( const vtkVector2i position,
vtkChartMatrix chartMatrix 
)
virtual

Set the element at position to a chart matrix, note that the chart matrix must be large enough to accommodate the element being set.

Note that this class will take ownership of the chart matrix object.

Returns
false if the element cannot be set.

◆ GetChartMatrix()

virtual vtkChartMatrix* vtkChartMatrix::GetChartMatrix ( const vtkVector2i position)
virtual

Get the specified chart matrix element.

if the element does not exist, nullptr will be returned. If the element has not yet been allocated it will be at this point

◆ InitLayoutTraversal()

virtual void vtkChartMatrix::InitLayoutTraversal ( vtkVector2i index,
vtkVector2f offset,
vtkVector2f increment 
)
virtual

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.

◆ GoToNextElement()

virtual void vtkChartMatrix::GoToNextElement ( vtkVector2i index,
vtkVector2f offset 
)
virtual

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.

◆ IsDoneWithTraversal()

virtual bool vtkChartMatrix::IsDoneWithTraversal ( )
virtual

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.

◆ ComputeCurrentElementSceneRect()

virtual vtkRectf vtkChartMatrix::ComputeCurrentElementSceneRect ( const vtkVector2i index,
const vtkVector2f offset,
const vtkVector2f increment 
)
virtual

Override this method if you want to customize layout instead of the default.

The returned rect will be in scene coordinates and suitable for a chart element or chart matrix element.

◆ vtkSetEnumMacro()

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

◆ GetFillStrategy()

StretchType vtkChartMatrix::GetFillStrategy ( )
inline

This specifies whether the chart matrix will fill the entire scene or instead draw itself in a user provided rectangular subset of the scene.

Definition at line 288 of file vtkChartMatrix.h.

◆ SynchronizeAxisRanges()

virtual void vtkChartMatrix::SynchronizeAxisRanges ( vtkObject caller,
unsigned long  eventId,
void *  calldata 
)
protectedvirtual

Member Data Documentation

◆ Size

vtkVector2i vtkChartMatrix::Size
protected

Definition at line 296 of file vtkChartMatrix.h.

◆ Gutter

vtkVector2f vtkChartMatrix::Gutter
protected

Definition at line 299 of file vtkChartMatrix.h.

◆ Padding

float vtkChartMatrix::Padding
protected

Definition at line 302 of file vtkChartMatrix.h.

◆ SpecificResize

std::map<vtkVector2i, vtkVector2f> vtkChartMatrix::SpecificResize
protected

Definition at line 303 of file vtkChartMatrix.h.

◆ Borders

int vtkChartMatrix::Borders[4]
protected

Definition at line 304 of file vtkChartMatrix.h.

◆ LayoutIsDirty

bool vtkChartMatrix::LayoutIsDirty
protected

Definition at line 305 of file vtkChartMatrix.h.

◆ Rect

vtkRecti vtkChartMatrix::Rect = { 0, 0, 100, 100 }
protected

Definition at line 308 of file vtkChartMatrix.h.

◆ FillStrategy

StretchType vtkChartMatrix::FillStrategy = StretchType::SCENE
protected

Definition at line 309 of file vtkChartMatrix.h.


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