VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
vtkChartMatrix Class Reference

container for a matrix of charts. More...

#include <vtkChartMatrix.h>

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

List of all members.

Public Types

typedef vtkAbstractContextItem Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
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 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 (vtkObject *o)
static vtkChartMatrixNew ()

Protected Member Functions

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


Member Typedef Documentation

Reimplemented from vtkAbstractContextItem.

Reimplemented in vtkScatterPlotMatrix.

Definition at line 39 of file vtkChartMatrix.h.


Constructor & Destructor Documentation

vtkChartMatrix::vtkChartMatrix ( ) [protected]
vtkChartMatrix::~vtkChartMatrix ( ) [protected]

Member Function Documentation

virtual const char* vtkChartMatrix::GetClassName ( ) [virtual]

Reimplemented from vtkAbstractContextItem.

Reimplemented in vtkScatterPlotMatrix.

static int vtkChartMatrix::IsTypeOf ( const char *  name) [static]

Return 1 if this class type 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.

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

static vtkChartMatrix* vtkChartMatrix::SafeDownCast ( vtkObject o) [static]

Reimplemented from vtkAbstractContextItem.

Reimplemented in vtkScatterPlotMatrix.

virtual void vtkChartMatrix::PrintSelf ( ostream &  os,
vtkIndent  indent 
) [virtual]

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.

static vtkChartMatrix* vtkChartMatrix::New ( ) [static]

Creates a new object.

Reimplemented from vtkObject.

Reimplemented in vtkScatterPlotMatrix.

virtual void vtkChartMatrix::Update ( ) [virtual]

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

Reimplemented from vtkAbstractContextItem.

Reimplemented in vtkScatterPlotMatrix.

virtual bool vtkChartMatrix::Paint ( vtkContext2D painter) [virtual]

Paint event for the chart matrix.

Reimplemented from vtkAbstractContextItem.

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 [inline, virtual]

Get the width and height of the chart matrix.

Definition at line 58 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 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]) [inline, virtual]

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

Definition at line 67 of file vtkChartMatrix.h.

virtual vtkVector2f vtkChartMatrix::GetGutter ( ) const [inline, virtual]

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

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


Member Data Documentation

PIMPL* vtkChartMatrix::Private [protected]

Reimplemented in vtkScatterPlotMatrix.

Definition at line 108 of file vtkChartMatrix.h.

Definition at line 112 of file vtkChartMatrix.h.

Definition at line 115 of file vtkChartMatrix.h.

int vtkChartMatrix::Borders[4] [protected]

Definition at line 116 of file vtkChartMatrix.h.

Definition at line 117 of file vtkChartMatrix.h.


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