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

Class for drawing an XY plot given two columns from a vtkTable. More...

#include <vtkPlotBar.h>

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

Public Types

typedef vtkPlot Superclass
 
enum  { VERTICAL = 0, HORIZONTAL }
 
- Public Types inherited from vtkPlot
typedef vtkContextItem Superclass
 
- Public Types inherited from vtkContextItem
typedef vtkAbstractContextItem Superclass
 
- Public Types inherited from vtkAbstractContextItem
typedef vtkObject Superclass
 
- Public Types inherited from vtkObject
typedef vtkObjectBase Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
virtual void PrintSelf (ostream &os, vtkIndent indent)
 
virtual bool Paint (vtkContext2D *painter)
 
virtual void GetBounds (double bounds[4])
 
virtual void SetInputArray (int index, const vtkStdString &name)
 
void SetColorSeries (vtkColorSeries *colorSeries)
 
vtkColorSeriesGetColorSeries ()
 
virtual vtkStringArrayGetLabels ()
 
virtual void SetGroupName (const vtkStdString &name)
 
virtual vtkStdString GetGroupName ()
 
virtual bool SelectPoints (const vtkVector2f &min, const vtkVector2f &max)
 
virtual bool PaintLegend (vtkContext2D *painter, const vtkRectf &rect, int legendIndex)
 
virtual void SetColor (unsigned char r, unsigned char g, unsigned char b, unsigned char a)
 
virtual void SetColor (double r, double g, double b)
 
virtual void GetColor (double rgb[3])
 
virtual void SetWidth (float)
 
virtual float GetWidth ()
 
virtual void SetOffset (float)
 
virtual float GetOffset ()
 
virtual void SetOrientation (int orientation)
 
virtual int GetOrientation ()
 
virtual vtkStdString GetTooltipLabel (const vtkVector2f &plotPos, vtkIdType seriesIndex, vtkIdType segmentIndex)
 
virtual vtkIdType GetNearestPoint (const vtkVector2f &point, const vtkVector2f &tolerance, vtkVector2f *location)
 
virtual vtkIdType GetNearestPoint (const vtkVector2f &point, const vtkVector2f &, vtkVector2f *location, vtkIdType *segmentIndex)
 
- Public Member Functions inherited from vtkPlot
virtual void SetLabel (const vtkStdString &label)
 
virtual vtkStdString GetLabel ()
 
virtual void SetLabels (vtkStringArray *labels)
 
virtual int GetNumberOfLabels ()
 
vtkStdString GetLabel (vtkIdType index)
 
void SetIndexedLabels (vtkStringArray *labels)
 
virtual vtkStringArrayGetIndexedLabels ()
 
virtual vtkTable * GetInput ()
 
virtual void SetSelection (vtkIdTypeArray *id)
 
virtual vtkIdTypeArrayGetSelection ()
 
virtual void SetTooltipLabelFormat (const vtkStdString &label)
 
virtual vtkStdString GetTooltipLabelFormat ()
 
void GetColor (unsigned char rgb[3])
 
virtual vtkPenGetPen ()
 
virtual vtkBrushGetBrush ()
 
virtual vtkContextMapper2DGetData ()
 
virtual bool GetUseIndexForXSeries ()
 
virtual void SetUseIndexForXSeries (bool)
 
virtual void SetInput (vtkTable *table)
 
virtual void SetInput (vtkTable *table, const vtkStdString &xColumn, const vtkStdString &yColumn)
 
void SetInput (vtkTable *table, vtkIdType xColumn, vtkIdType yColumn)
 
virtual vtkAxisGetXAxis ()
 
virtual void SetXAxis (vtkAxis *axis)
 
virtual vtkAxisGetYAxis ()
 
virtual void SetYAxis (vtkAxis *axis)
 
virtual void SetProperty (const vtkStdString &property, const vtkVariant &var)
 
virtual vtkVariant GetProperty (const vtkStdString &property)
 
- Public Member Functions inherited from vtkContextItem
virtual double GetOpacity ()
 
virtual void SetOpacity (double)
 
- Public Member Functions inherited from vtkAbstractContextItem
virtual void Update ()
 
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 GetNumberOfItems ()
 
void ClearItems ()
 
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 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 bool MouseWheelEvent (const vtkContextMouseEvent &mouse, int delta)
 
vtkContextSceneGetScene ()
 
vtkAbstractContextItemGetParent ()
 
virtual bool GetVisible ()
 
virtual void SetVisible (bool)
 
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
 
virtual void DebugOff ()
 
unsigned char GetDebug ()
 
void SetDebug (unsigned char 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)
 
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 &os)
 
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 vtkPlotBarSafeDownCast (vtkObject *o)
 
static vtkPlotBarNew ()
 
- Static Public Member Functions inherited from vtkPlot
static int IsTypeOf (const char *type)
 
static vtkPlotSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkContextItem
static int IsTypeOf (const char *type)
 
static vtkContextItemSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkAbstractContextItem
static int IsTypeOf (const char *type)
 
static vtkAbstractContextItemSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObjectSafeDownCast (vtkObject *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

 vtkPlotBar ()
 
 ~vtkPlotBar ()
 
bool UpdateTableCache (vtkTable *table)
 
- Protected Member Functions inherited from vtkPlot
 vtkPlot ()
 
 ~vtkPlot ()
 
vtkStdString GetNumber (double position, vtkAxis *axis)
 
- Protected Member Functions inherited from vtkContextItem
 vtkContextItem ()
 
 ~vtkContextItem ()
 
- 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 &os)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkPoints2DPoints
 
float Width
 
float Offset
 
int Orientation
 
vtkTimeStamp BuildTime
 
vtkSmartPointer< vtkColorSeriesColorSeries
 
- Protected Attributes inherited from vtkPlot
vtkPenPen
 
vtkBrushBrush
 
vtkSmartPointer< vtkStringArrayLabels
 
vtkSmartPointer< vtkStringArrayAutoLabels
 
vtkSmartPointer< vtkStringArrayIndexedLabels
 
bool UseIndexForXSeries
 
vtkContextMapper2DData
 
vtkIdTypeArraySelection
 
vtkAxisXAxis
 
vtkAxisYAxis
 
vtkStdString TooltipLabelFormat
 
vtkStdString TooltipDefaultLabelFormat
 
- Protected Attributes inherited from vtkContextItem
double Opacity
 
- Protected Attributes inherited from vtkAbstractContextItem
vtkContextSceneScene
 
vtkAbstractContextItemParent
 
vtkContextScenePrivateChildren
 
bool Visible
 
- Protected Attributes inherited from vtkObject
unsigned char Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
int ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

Class for drawing an XY plot given two columns from a vtkTable.

Tests:
vtkPlotBar (Tests)

Definition at line 41 of file vtkPlotBar.h.

Member Typedef Documentation

Definition at line 44 of file vtkPlotBar.h.

Member Enumeration Documentation

anonymous enum

Enum of bar chart oritentation types

Enumerator
VERTICAL 
HORIZONTAL 

Definition at line 49 of file vtkPlotBar.h.

Constructor & Destructor Documentation

vtkPlotBar::vtkPlotBar ( )
protected
vtkPlotBar::~vtkPlotBar ( )
protected

Member Function Documentation

virtual const char* vtkPlotBar::GetClassName ( )
virtual

Reimplemented from vtkPlot.

static int vtkPlotBar::IsTypeOf ( const char *  type)
static
virtual int vtkPlotBar::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 vtkPlot.

static vtkPlotBar* vtkPlotBar::SafeDownCast ( vtkObject o)
static
virtual void vtkPlotBar::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 vtkPlot.

static vtkPlotBar* vtkPlotBar::New ( )
static

Creates a 2D Chart object.

virtual bool vtkPlotBar::Paint ( vtkContext2D painter)
virtual

Paint event for the XY plot, called whenever the chart needs to be drawn

Reimplemented from vtkAbstractContextItem.

virtual bool vtkPlotBar::PaintLegend ( vtkContext2D painter,
const vtkRectf rect,
int  legendIndex 
)
virtual

Paint legend event for the XY plot, called whenever the legend needs the plot items symbol/mark/line drawn. A rect is supplied with the lower left corner of the rect (elements 0 and 1) and with width x height (elements 2 and 3). The plot can choose how to fill the space supplied.

Reimplemented from vtkPlot.

virtual void vtkPlotBar::SetColor ( unsigned char  r,
unsigned char  g,
unsigned char  b,
unsigned char  a 
)
virtual

Set the plot color

Reimplemented from vtkPlot.

virtual void vtkPlotBar::SetColor ( double  r,
double  g,
double  b 
)
virtual

Set the plot color

Reimplemented from vtkPlot.

virtual void vtkPlotBar::GetColor ( double  rgb[3])
virtual

Set the plot color

Reimplemented from vtkPlot.

virtual void vtkPlotBar::SetWidth ( float  )
virtual

Set the width of the line.

Reimplemented from vtkPlot.

virtual float vtkPlotBar::GetWidth ( )
virtual

Get the width of the line.

Reimplemented from vtkPlot.

virtual void vtkPlotBar::SetOffset ( float  )
virtual

Set/get the horizontal offset of the bars. Positive values move the bars leftward. For HORIZONTAL orientation, offsets bars vertically, with a positive value moving bars downward.

virtual float vtkPlotBar::GetOffset ( )
virtual

Set/get the horizontal offset of the bars. Positive values move the bars leftward. For HORIZONTAL orientation, offsets bars vertically, with a positive value moving bars downward.

virtual void vtkPlotBar::SetOrientation ( int  orientation)
virtual

Set/get the orientation of the bars. Valid orientations are VERTICAL (default) and HORIZONTAL.

virtual int vtkPlotBar::GetOrientation ( )
virtual

Set/get the orientation of the bars. Valid orientations are VERTICAL (default) and HORIZONTAL.

virtual void vtkPlotBar::GetBounds ( double  bounds[4])
virtual

Get the bounds for this mapper as (Xmin,Xmax,Ymin,Ymax).

Reimplemented from vtkPlot.

virtual void vtkPlotBar::SetInputArray ( int  index,
const vtkStdString name 
)
virtual

When used to set additional arrays, stacked bars are created.

Reimplemented from vtkPlot.

void vtkPlotBar::SetColorSeries ( vtkColorSeries colorSeries)

Set the color series to use if this becomes a stacked bar plot.

vtkColorSeries* vtkPlotBar::GetColorSeries ( )

Get the color series used if when this is a stacked bar plot.

virtual vtkStringArray* vtkPlotBar::GetLabels ( )
virtual

Get the plot labels.

Reimplemented from vtkPlot.

virtual void vtkPlotBar::SetGroupName ( const vtkStdString name)
virtual

Set the group name of the bar chart - can be displayed on the X axis.

virtual vtkStdString vtkPlotBar::GetGroupName ( )
virtual

Get the group name of the bar char - can be displayed on the X axis.

virtual vtkStdString vtkPlotBar::GetTooltipLabel ( const vtkVector2f plotPos,
vtkIdType  seriesIndex,
vtkIdType  segmentIndex 
)
virtual

Generate and return the tooltip label string for this plot The segmentIndex is implemented here.

Reimplemented from vtkPlot.

virtual bool vtkPlotBar::SelectPoints ( const vtkVector2f min,
const vtkVector2f max 
)
virtual

Select all points in the specified rectangle.

Reimplemented from vtkPlot.

virtual vtkIdType vtkPlotBar::GetNearestPoint ( const vtkVector2f point,
const vtkVector2f tolerance,
vtkVector2f location 
)
virtual

Function to query a plot for the nearest point to the specified coordinate. Returns the index of the data series with which the point is associated or -1.

Reimplemented from vtkPlot.

virtual vtkIdType vtkPlotBar::GetNearestPoint ( const vtkVector2f point,
const vtkVector2f ,
vtkVector2f location,
vtkIdType segmentIndex 
)
virtual

Function to query a plot for the nearest point to the specified coordinate. Returns the index of the data series with which the point is associated or -1. If a vtkIdType* is passed, its referent will be set to index of the bar segment with which a point is associated, or -1.

bool vtkPlotBar::UpdateTableCache ( vtkTable *  table)
protected

Update the table cache.

Member Data Documentation

vtkPoints2D* vtkPlotBar::Points
protected

Store a well packed set of XY coordinates for this data series.

Definition at line 167 of file vtkPlotBar.h.

float vtkPlotBar::Width
protected

Definition at line 169 of file vtkPlotBar.h.

float vtkPlotBar::Offset
protected

Definition at line 170 of file vtkPlotBar.h.

int vtkPlotBar::Orientation
protected

Definition at line 172 of file vtkPlotBar.h.

vtkTimeStamp vtkPlotBar::BuildTime
protected

The point cache is marked dirty until it has been initialized.

Definition at line 175 of file vtkPlotBar.h.

vtkSmartPointer<vtkColorSeries> vtkPlotBar::ColorSeries
protected

The color series to use if this becomes a stacked bar

Definition at line 178 of file vtkPlotBar.h.


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