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 Types inherited from vtkObject
typedef vtkObjectBase 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 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)
 
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)
 
void SetGutterX (float value)
 
void SetGutterY (float value)
 
virtual bool SetChartSpan (const vtkVector2i &position, const vtkVector2i &span)
 
- Public Member Functions inherited from vtkAbstractContextItem
vtkAbstractContextItemNewInstance () const
 
virtual bool PaintChildren (vtkContext2D *painter)
 
virtual void ReleaseGraphicsResources ()
 
unsigned int AddItem (vtkAbstractContextItem *item)
 
bool RemoveItem (vtkAbstractContextItem *item)
 
bool RemoveItem (unsigned int index)
 
vtkAbstractContextItemGetItem (unsigned int index)
 
unsigned int GetItemIndex (vtkAbstractContextItem *item)
 
unsigned int GetNumberOfItems ()
 
void ClearItems ()
 
unsigned int Raise (unsigned int index)
 
unsigned int Lower (unsigned int index)
 
virtual bool Hit (const vtkContextMouseEvent &mouse)
 
virtual vtkAbstractContextItemGetPickedItem (const vtkContextMouseEvent &mouse)
 
virtual bool MouseEnterEvent (const vtkContextMouseEvent &mouse)
 
virtual bool MouseMoveEvent (const vtkContextMouseEvent &mouse)
 
virtual bool MouseLeaveEvent (const vtkContextMouseEvent &mouse)
 
virtual bool MouseButtonPressEvent (const vtkContextMouseEvent &mouse)
 
virtual bool MouseButtonReleaseEvent (const vtkContextMouseEvent &mouse)
 
virtual bool MouseDoubleClickEvent (const vtkContextMouseEvent &mouse)
 
virtual bool MouseWheelEvent (const vtkContextMouseEvent &mouse, int delta)
 
virtual bool KeyPressEvent (const vtkContextKeyEvent &key)
 
virtual void SetScene (vtkContextScene *scene)
 
virtual void SetParent (vtkAbstractContextItem *parent)
 
virtual vtkVector2f MapToParent (const vtkVector2f &point)
 
virtual vtkVector2f MapFromParent (const vtkVector2f &point)
 
virtual vtkVector2f MapToScene (const vtkVector2f &point)
 
virtual vtkVector2f MapFromScene (const vtkVector2f &point)
 
virtual unsigned int StackAbove (unsigned int index, unsigned int under)
 
virtual unsigned int StackUnder (unsigned int child, unsigned int above)
 
virtual bool KeyReleaseEvent (const vtkContextKeyEvent &key)
 
vtkContextSceneGetScene ()
 
vtkAbstractContextItemGetParent ()
 
virtual bool GetVisible ()
 
virtual void SetVisible (bool)
 
virtual bool GetInteractive ()
 
virtual void SetInteractive (bool)
 
- Public Member Functions inherited from vtkObject
vtkObjectNewInstance () const
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
bool GetDebug ()
 
void SetDebug (bool debugFlag)
 
virtual void Modified ()
 
virtual unsigned long GetMTime ()
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
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 *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
int HasObserver (unsigned long event)
 
int HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
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)
 
int InvokeEvent (unsigned long event, void *callData)
 
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
 
virtual void Delete ()
 
virtual void FastDelete ()
 
void Print (ostream &os)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
void SetReferenceCount (int)
 
void PrintRevisions (ostream &)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkChartMatrixSafeDownCast (vtkObjectBase *o)
 
static vtkChartMatrixNew ()
 
- Static Public Member Functions inherited from vtkAbstractContextItem
static int IsTypeOf (const char *type)
 
static vtkAbstractContextItemSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObjectSafeDownCast (vtkObjectBase *o)
 
static vtkObjectNew ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static int IsTypeOf (const char *name)
 
static vtkObjectBaseNew ()
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkChartMatrix ()
 
 ~vtkChartMatrix ()
 
- Protected Member Functions inherited from vtkAbstractContextItem
 vtkAbstractContextItem ()
 
 ~vtkAbstractContextItem ()
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
virtual ~vtkObject ()
 
virtual void RegisterInternal (vtkObjectBase *, int check)
 
virtual void UnRegisterInternal (vtkObjectBase *, int check)
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
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

PIMPL * Private
 
vtkVector2i Size
 
vtkVector2f Gutter
 
int Borders [4]
 
bool LayoutIsDirty
 
- Protected Attributes inherited from vtkAbstractContextItem
vtkContextSceneScene
 
vtkAbstractContextItemParent
 
vtkContextScenePrivateChildren
 
bool Visible
 
bool Interactive
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 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.

Tests:
vtkChartMatrix (Tests)

Definition at line 37 of file vtkChartMatrix.h.

Member Typedef Documentation

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 *  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 ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkChartMatrix::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkAbstractContextItem.

Reimplemented in vtkScatterPlotMatrix.

vtkChartMatrix* vtkChartMatrix::NewInstance ( ) const
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.

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

void vtkChartMatrix::SetBorderLeft ( int  value)

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

void vtkChartMatrix::SetBorderBottom ( int  value)

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

void vtkChartMatrix::SetBorderRight ( int  value)

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

void vtkChartMatrix::SetBorderTop ( int  value)

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

void vtkChartMatrix::SetGutterX ( float  value)

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

void vtkChartMatrix::SetGutterY ( float  value)

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

vtkVector2i vtkChartMatrix::Size
protected

Definition at line 125 of file vtkChartMatrix.h.

vtkVector2f vtkChartMatrix::Gutter
protected

Definition at line 128 of file vtkChartMatrix.h.

int vtkChartMatrix::Borders[4]
protected

Definition at line 129 of file vtkChartMatrix.h.

bool vtkChartMatrix::LayoutIsDirty
protected

Definition at line 130 of file vtkChartMatrix.h.


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