VTK
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

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 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)
 
void SetBorderBottom (int value)
 
void SetBorderRight (int value)
 
void SetBorderTop (int value)
 
virtual void GetBorders (int borders[4])
 
virtual void SetGutter (const vtkVector2f &gutter)
 Set the gutter that should be left between the charts in the matrix. More...
 
void SetGutterX (float value)
 
void SetGutterY (float value)
 
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 ()
 
virtual vtkVector2f GetGutter () const
 Get the gutter that should be left between the charts in the matrix. More...
 
virtual void Allocate ()
 Allocate the charts, this will cause any null chart to be allocated. More...
 
virtual bool SetChart (const vtkVector2i &position, vtkChart *chart)
 Set the chart element, note that the chart matrix must be large enough to accommodate the element being set. More...
 
virtual vtkChartGetChart (const vtkVector2i &position)
 Get the specified chart element, if the element does not exist nullptr will be returned. More...
 
virtual bool SetChartSpan (const vtkVector2i &position, const vtkVector2i &span)
 Set the span of a chart in the matrix. More...
 
virtual vtkVector2i GetChartSpan (const vtkVector2i &position)
 Get the span of the specified chart. More...
 
virtual vtkVector2i GetChartIndex (const vtkVector2f &position)
 Get the position of the chart in the matrix at the specified location. More...
 
- 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...
 
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)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
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)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

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 (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkChartMatrix ()
 
 ~vtkChartMatrix () override
 
- Protected Member Functions inherited from vtkAbstractContextItem
 vtkAbstractContextItem ()
 
 ~vtkAbstractContextItem () override
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

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

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.

Definition at line 38 of file vtkChartMatrix.h.

Member Typedef Documentation

◆ Superclass

Definition at line 41 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 vtkObjectBase.

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

◆ SetBorderBottom()

void vtkChartMatrix::SetBorderBottom ( int  value)

◆ SetBorderRight()

void vtkChartMatrix::SetBorderRight ( int  value)

◆ SetBorderTop()

void vtkChartMatrix::SetBorderTop ( int  value)

◆ GetBorders()

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

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

◆ SetGutterY()

void vtkChartMatrix::SetGutterY ( float  value)

◆ 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

◆ GetGutter()

virtual vtkVector2f vtkChartMatrix::GetGutter ( ) const
inlinevirtual

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

Definition at line 109 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 a chart 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 chart.

◆ GetChartIndex()

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

Get the position of the chart in the matrix at the specified location.

The position should be specified in scene coordinates.

Member Data Documentation

◆ Size

vtkVector2i vtkChartMatrix::Size
protected

Definition at line 154 of file vtkChartMatrix.h.

◆ Gutter

vtkVector2f vtkChartMatrix::Gutter
protected

Definition at line 157 of file vtkChartMatrix.h.

◆ SpecificResize

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

Definition at line 158 of file vtkChartMatrix.h.

◆ Borders

int vtkChartMatrix::Borders[4]
protected

Definition at line 159 of file vtkChartMatrix.h.

◆ LayoutIsDirty

bool vtkChartMatrix::LayoutIsDirty
protected

Definition at line 160 of file vtkChartMatrix.h.


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