vtkPlotPoints Class Reference

#include <vtkPlotPoints.h>

Inheritance diagram for vtkPlotPoints:

Inheritance graph
[legend]
Collaboration diagram for vtkPlotPoints:

Collaboration graph
[legend]

List of all members.


Detailed Description

Class for drawing an points given two columns from a vtkTable.

This class draws points in a plot given two columns from a table. If you need a line as well you should use vtkPlotLine which derives from vtkPlotPoints and is capable of drawing both points and a line.

See also:
vtkPlotLine
Tests:
vtkPlotPoints (Tests)

Definition at line 47 of file vtkPlotPoints.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 void GetBounds (double bounds[4])
virtual void CreateDefaultLookupTable ()
vtkStdString GetColorArrayName ()
virtual bool SelectPoints (const vtkVector2f &min, const vtkVector2f &max)
virtual bool PaintLegend (vtkContext2D *painter, const vtkRectf &rect, int legendIndex)
void SetLookupTable (vtkScalarsToColors *lut)
vtkScalarsToColorsGetLookupTable ()
virtual void SetScalarVisibility (int)
virtual int GetScalarVisibility ()
virtual void ScalarVisibilityOn ()
virtual void ScalarVisibilityOff ()
void SelectColorArray (vtkIdType arrayNum)
void SelectColorArray (const vtkStdString &arrayName)
virtual vtkIdType GetNearestPoint (const vtkVector2f &point, const vtkVector2f &tolerance, vtkVector2f *location)
virtual int GetMarkerStyle ()
virtual void SetMarkerStyle (int)
virtual float GetMarkerSize ()
virtual void SetMarkerSize (float)

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkPlotPointsSafeDownCast (vtkObject *o)
static vtkPlotPointsNew ()

Protected Member Functions

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

Protected Attributes

vtkPoints2DPoints
vtkIdTypeArrayBadPoints
vtkTimeStamp BuildTime
bool LogX
bool LogY
VectorPIMPL * Sorted
int MarkerStyle
float MarkerSize
vtkImageDataMarker
vtkImageDataHighlightMarker
vtkScalarsToColorsLookupTable
vtkUnsignedCharArrayColors
int ScalarVisibility
vtkStdString ColorArrayName

Member Typedef Documentation

Reimplemented from vtkPlot.

Reimplemented in vtkPlotLine.

Definition at line 50 of file vtkPlotPoints.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 122 of file vtkPlotPoints.h.


Constructor & Destructor Documentation

vtkPlotPoints::vtkPlotPoints (  )  [protected]

vtkPlotPoints::~vtkPlotPoints (  )  [protected]


Member Function Documentation

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

Reimplemented from vtkPlot.

Reimplemented in vtkPlotLine.

static int vtkPlotPoints::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 vtkPlot.

Reimplemented in vtkPlotLine.

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

Reimplemented in vtkPlotLine.

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

Reimplemented from vtkPlot.

Reimplemented in vtkPlotLine.

virtual void vtkPlotPoints::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.

Reimplemented in vtkPlotLine.

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

Creates a 2D Chart object.

Reimplemented from vtkObject.

Reimplemented in vtkPlotLine.

virtual void vtkPlotPoints::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 vtkAbstractContextItem.

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

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

Reimplemented from vtkAbstractContextItem.

Reimplemented in vtkPlotLine.

virtual bool vtkPlotPoints::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.

Reimplemented in vtkPlotLine.

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

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

Reimplemented from vtkPlot.

void vtkPlotPoints::SetLookupTable ( vtkScalarsToColors lut  ) 

Specify a lookup table for the mapper to use.

vtkScalarsToColors* vtkPlotPoints::GetLookupTable (  ) 

Specify a lookup table for the mapper to use.

virtual void vtkPlotPoints::CreateDefaultLookupTable (  )  [virtual]

Create default lookup table. Generally used to create one when none is available with the scalar data.

virtual void vtkPlotPoints::SetScalarVisibility ( int   )  [virtual]

Turn on/off flag to control whether scalar data is used to color objects.

virtual int vtkPlotPoints::GetScalarVisibility (  )  [virtual]

Turn on/off flag to control whether scalar data is used to color objects.

virtual void vtkPlotPoints::ScalarVisibilityOn (  )  [virtual]

Turn on/off flag to control whether scalar data is used to color objects.

virtual void vtkPlotPoints::ScalarVisibilityOff (  )  [virtual]

Turn on/off flag to control whether scalar data is used to color objects.

void vtkPlotPoints::SelectColorArray ( vtkIdType  arrayNum  ) 

When ScalarMode is set to UsePointFieldData or UseCellFieldData, you can specify which array to use for coloring using these methods. The lookup table will decide how to convert vectors to colors.

void vtkPlotPoints::SelectColorArray ( const vtkStdString arrayName  ) 

When ScalarMode is set to UsePointFieldData or UseCellFieldData, you can specify which array to use for coloring using these methods. The lookup table will decide how to convert vectors to colors.

vtkStdString vtkPlotPoints::GetColorArrayName (  ) 

Get the array name to color by.

virtual vtkIdType vtkPlotPoints::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 bool vtkPlotPoints::SelectPoints ( const vtkVector2f min,
const vtkVector2f max 
) [virtual]

Select all points in the specified rectangle.

Reimplemented from vtkPlot.

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

virtual float vtkPlotPoints::GetMarkerSize (  )  [virtual]

Get/set the marker size that should be used. The default is negative, and in that case it is 2.3 times the pen width, if less than 8 will be used.

virtual void vtkPlotPoints::SetMarkerSize ( float   )  [virtual]

Get/set the marker size that should be used. The default is negative, and in that case it is 2.3 times the pen width, if less than 8 will be used.

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

Generate the requested symbol for the plot

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

Update the table cache.

void vtkPlotPoints::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 vtkPlotPoints::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 vtkPlotPoints::CalculateBounds ( double  bounds[4]  )  [protected]

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

void vtkPlotPoints::CreateSortedPoints (  )  [protected]

Create the sorted point list if necessary.


Member Data Documentation

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

Definition at line 176 of file vtkPlotPoints.h.

VectorPIMPL* vtkPlotPoints::Sorted [protected]

Definition at line 180 of file vtkPlotPoints.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 186 of file vtkPlotPoints.h.

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

Definition at line 189 of file vtkPlotPoints.h.

int vtkPlotPoints::MarkerStyle [protected]

The marker style that should be used

Definition at line 193 of file vtkPlotPoints.h.

float vtkPlotPoints::MarkerSize [protected]

The marker style that should be used

Definition at line 194 of file vtkPlotPoints.h.

The marker style that should be used

Definition at line 195 of file vtkPlotPoints.h.

The marker style that should be used

Definition at line 196 of file vtkPlotPoints.h.

bool vtkPlotPoints::LogX [protected]

Definition at line 199 of file vtkPlotPoints.h.

bool vtkPlotPoints::LogY [protected]

Definition at line 199 of file vtkPlotPoints.h.

Lookup Table for coloring points by scalar value

Definition at line 203 of file vtkPlotPoints.h.

Lookup Table for coloring points by scalar value

Definition at line 204 of file vtkPlotPoints.h.

Lookup Table for coloring points by scalar value

Definition at line 205 of file vtkPlotPoints.h.

Lookup Table for coloring points by scalar value

Definition at line 206 of file vtkPlotPoints.h.


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

Generated on Wed Aug 24 11:55:51 2011 for VTK by  doxygen 1.5.6