VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
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]

Public Types

typedef vtkAbstractContextItem Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkChartMatrixNewInstance () const
 
virtual void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void Update ()
 
virtual bool Paint (vtkContext2D *painter)
 
virtual void SetSize (const vtkVector2i &size)
 
virtual vtkVector2i GetSize () const
 
virtual void SetGutter (const vtkVector2f &gutter)
 
virtual vtkVector2f GetGutter () const
 
virtual void Allocate ()
 
virtual bool SetChart (const vtkVector2i &position, vtkChart *chart)
 
virtual vtkChartGetChart (const vtkVector2i &position)
 
virtual vtkVector2i GetChartSpan (const vtkVector2i &position)
 
virtual vtkVector2i GetChartIndex (const vtkVector2f &position)
 
virtual void SetBorders (int left, int bottom, int right, int top)
 
virtual void GetBorders (int borders[4])
 
virtual bool SetChartSpan (const vtkVector2i &position, const vtkVector2i &span)
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkChartMatrixSafeDownCast (vtkObjectBase *o)
 
static vtkChartMatrixNew ()
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkChartMatrix ()
 
 ~vtkChartMatrix ()
 

Protected Attributes

PIMPL * Private
 
vtkVector2i Size
 
vtkVector2f Gutter
 
int Borders [4]
 
bool LayoutIsDirty
 

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:
vtkChartMatrix (Tests)

Definition at line 37 of file vtkChartMatrix.h.

Member Typedef Documentation

typedef vtkAbstractContextItem vtkChartMatrix::Superclass

Definition at line 40 of file vtkChartMatrix.h.

Constructor & Destructor Documentation

vtkChartMatrix::vtkChartMatrix ( )
protected
vtkChartMatrix::~vtkChartMatrix ( )
protected

Member Function Documentation

static int vtkChartMatrix::IsTypeOf ( const char *  type)
static
virtual int vtkChartMatrix::IsA ( const char *  type)
virtual

Reimplemented in vtkScatterPlotMatrix.

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

Reimplemented in vtkScatterPlotMatrix.

vtkChartMatrix* vtkChartMatrix::NewInstance ( ) const
virtual void vtkChartMatrix::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual

Reimplemented in vtkScatterPlotMatrix.

static vtkChartMatrix* vtkChartMatrix::New ( )
static

Creates a new object.

virtual void vtkChartMatrix::Update ( )
virtual

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

Reimplemented in vtkScatterPlotMatrix.

virtual bool vtkChartMatrix::Paint ( vtkContext2D *  painter)
virtual

Paint event for the chart matrix.

Reimplemented in vtkScatterPlotMatrix.

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.

virtual vtkVector2i vtkChartMatrix::GetSize ( ) const
inlinevirtual

Get the width and height of the chart matrix.

Definition at line 59 of file vtkChartMatrix.h.

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

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

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

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

virtual vtkVector2f vtkChartMatrix::GetGutter ( ) const
inlinevirtual

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

Definition at line 78 of file vtkChartMatrix.h.

virtual void vtkChartMatrix::Allocate ( )
virtual

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

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.
virtual vtkChart* vtkChartMatrix::GetChart ( const vtkVector2i &  position)
virtual

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

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.
virtual vtkVector2i vtkChartMatrix::GetChartSpan ( const vtkVector2i &  position)
virtual

Get the span of the specified chart.

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

PIMPL* vtkChartMatrix::Private
protected

Definition at line 113 of file vtkChartMatrix.h.

vtkVector2i vtkChartMatrix::Size
protected

Definition at line 117 of file vtkChartMatrix.h.

vtkVector2f vtkChartMatrix::Gutter
protected

Definition at line 120 of file vtkChartMatrix.h.

int vtkChartMatrix::Borders[4]
protected

Definition at line 121 of file vtkChartMatrix.h.

bool vtkChartMatrix::LayoutIsDirty
protected

Definition at line 122 of file vtkChartMatrix.h.


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