vtkPlotLine Class Reference

#include <vtkPlotLine.h>

Inheritance diagram for vtkPlotLine:

Inheritance graph
[legend]
Collaboration diagram for vtkPlotLine:

Collaboration graph
[legend]

List of all members.


Detailed Description

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

Definition at line 35 of file vtkPlotLine.h.


Public Types

typedef vtkPlot Superclass
enum  {
  NONE = 0, CROSS, PLUS, SQUARE,
  CIRCLE, DIAMOND
}

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 bool PaintLegend (vtkContext2D *painter, float rect[4])
virtual void GetBounds (double bounds[4])
virtual bool GetNearestPoint (const vtkVector2f &point, const vtkVector2f &tolerance, vtkVector2f *location)
virtual int GetMarkerStyle ()
virtual void SetMarkerStyle (int)

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkPlotLineSafeDownCast (vtkObject *o)
static vtkPlotLineNew ()

Protected Member Functions

 vtkPlotLine ()
 ~vtkPlotLine ()
void GeneraterMarker (int width, bool highlight=false)
bool UpdateTableCache (vtkTable *table)
void CalculateLogSeries ()
void FindBadPoints ()
void CalculateBounds (double bounds[4])

Protected Attributes

vtkPoints2DPoints
vtkPoints2DSorted
vtkIdTypeArrayBadPoints
vtkTimeStamp BuildTime
bool LogX
bool LogY
int MarkerStyle
vtkImageDataMarker
vtkImageDataHighlightMarker

Member Typedef Documentation

Reimplemented from vtkPlot.

Definition at line 38 of file vtkPlotLine.h.


Member Enumeration Documentation

anonymous enum

Enum containing various marker styles that can be used in a plot.

Enumerator:
NONE 
CROSS 
PLUS 
SQUARE 
CIRCLE 
DIAMOND 

Definition at line 76 of file vtkPlotLine.h.


Constructor & Destructor Documentation

vtkPlotLine::vtkPlotLine (  )  [protected]

vtkPlotLine::~vtkPlotLine (  )  [protected]


Member Function Documentation

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

Reimplemented from vtkPlot.

static int vtkPlotLine::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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkPlot.

virtual int vtkPlotLine::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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkPlot.

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

Reimplemented from vtkPlot.

virtual void vtkPlotLine::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 vtkPlotLine* vtkPlotLine::New (  )  [static]

Creates a 2D Chart object.

Reimplemented from vtkObject.

virtual void vtkPlotLine::Update (  )  [virtual]

Perform any updates to the item that may be necessary before rendering. The scene should take care of calling this on all items before their Paint function is invoked.

Reimplemented from vtkContextItem.

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

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

Implements vtkContextItem.

virtual bool vtkPlotLine::PaintLegend ( vtkContext2D painter,
float  rect[4] 
) [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 vtkPlotLine::GetBounds ( double  bounds[4]  )  [virtual]

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

Reimplemented from vtkPlot.

virtual bool vtkPlotLine::GetNearestPoint ( const vtkVector2f point,
const vtkVector2f tolerance,
vtkVector2f location 
) [virtual]

Function to query a plot for the nearest point to the specified coordinate.

Reimplemented from vtkPlot.

virtual int vtkPlotLine::GetMarkerStyle (  )  [virtual]

Get/set the marker style that should be used. The default is none, the enum in this class is used as a parameter.

virtual void vtkPlotLine::SetMarkerStyle ( int   )  [virtual]

Get/set the marker style that should be used. The default is none, the enum in this class is used as a parameter.

void vtkPlotLine::GeneraterMarker ( int  width,
bool  highlight = false 
) [protected]

Generate the requested symbol for the plot

bool vtkPlotLine::UpdateTableCache ( vtkTable table  )  [protected]

Update the table cache.

void vtkPlotLine::CalculateLogSeries (  )  [protected]

Handle calculating the log of the x or y series if necessary. Should be called by UpdateTableCache once the data has been updated in Points.

void vtkPlotLine::FindBadPoints (  )  [protected]

Find all of the "bad points" in the series. This is mainly used to cache bad points for performance reasons, but could also be used plot the bad points in the future.

void vtkPlotLine::CalculateBounds ( double  bounds[4]  )  [protected]

Calculate the bounds of the plot, ignoring the bad points.


Member Data Documentation

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

Definition at line 119 of file vtkPlotLine.h.

Sorted points, used when searching for the nearest point.

Definition at line 122 of file vtkPlotLine.h.

An array containing the indices of all the "bad points", meaning any x, y pair that has an infinity, -infinity or not a number value.

Definition at line 126 of file vtkPlotLine.h.

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

Definition at line 129 of file vtkPlotLine.h.

int vtkPlotLine::MarkerStyle [protected]

The marker style that should be used

Definition at line 133 of file vtkPlotLine.h.

The marker style that should be used

Definition at line 134 of file vtkPlotLine.h.

The marker style that should be used

Definition at line 135 of file vtkPlotLine.h.

bool vtkPlotLine::LogX [protected]

Definition at line 138 of file vtkPlotLine.h.

bool vtkPlotLine::LogY [protected]

Definition at line 138 of file vtkPlotLine.h.


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

Generated on Fri Apr 9 17:57:57 2010 for VTK by  doxygen 1.5.6