VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkPlotPoints Class Reference

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

#include <vtkPlotPoints.h>

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

Public Types

typedef vtkPlot Superclass
 
enum  {
  NONE = VTK_MARKER_NONE, CROSS = VTK_MARKER_CROSS, PLUS = VTK_MARKER_PLUS, SQUARE = VTK_MARKER_SQUARE,
  CIRCLE = VTK_MARKER_CIRCLE, DIAMOND = VTK_MARKER_DIAMOND
}
 
- Public Types inherited from vtkPlot
typedef vtkContextItem Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkPlotPointsNewInstance () const
 
virtual void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void Update ()
 
virtual bool Paint (vtkContext2D *painter)
 
virtual void GetBounds (double bounds[4])
 
virtual void GetUnscaledInputBounds (double bounds[4])
 
virtual void CreateDefaultLookupTable ()
 
vtkStdString GetColorArrayName ()
 
virtual bool SelectPoints (const vtkVector2f &min, const vtkVector2f &max)
 
virtual bool SelectPointsInPolygon (const vtkContextPolygon &polygon)
 
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)
 
virtual vtkStdString GetValidPointMaskName ()
 
virtual void SetValidPointMaskName (vtkStdString)
 
- Public Member Functions inherited from vtkPlot
vtkPlotNewInstance () const
 
virtual void SetWidth (float width)
 
virtual float GetWidth ()
 
virtual void SetLabel (const vtkStdString &label)
 
virtual vtkStdString GetLabel ()
 
virtual void SetLabels (vtkStringArray *labels)
 
virtual vtkStringArrayGetLabels ()
 
virtual int GetNumberOfLabels ()
 
vtkStdString GetLabel (vtkIdType index)
 
void SetIndexedLabels (vtkStringArray *labels)
 
virtual vtkStringArrayGetIndexedLabels ()
 
vtkContextMapper2D * GetData ()
 
virtual vtkTable * GetInput ()
 
virtual void SetInputArray (int index, const vtkStdString &name)
 
virtual void SetSelection (vtkIdTypeArray *id)
 
virtual vtkIdTypeArrayGetSelection ()
 
virtual void SetTooltipLabelFormat (const vtkStdString &label)
 
virtual vtkStdString GetTooltipLabelFormat ()
 
virtual void SetTooltipNotation (int notation)
 
virtual int GetTooltipNotation ()
 
virtual void SetTooltipPrecision (int precision)
 
virtual int GetTooltipPrecision ()
 
virtual vtkStdString GetTooltipLabel (const vtkVector2f &plotPos, vtkIdType seriesIndex, vtkIdType segmentIndex)
 
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])
 
void GetColor (unsigned char rgb[3])
 
void SetPen (vtkPen *pen)
 
vtkPen * GetPen ()
 
void SetBrush (vtkBrush *brush)
 
vtkBrush * GetBrush ()
 
virtual bool GetUseIndexForXSeries ()
 
virtual void SetUseIndexForXSeries (bool)
 
virtual void SetInputData (vtkTable *table)
 
virtual void SetInputData (vtkTable *table, const vtkStdString &xColumn, const vtkStdString &yColumn)
 
void SetInputData (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)
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkPlotPointsSafeDownCast (vtkObjectBase *o)
 
static vtkPlotPointsNew ()
 
- Static Public Member Functions inherited from vtkPlot
static int IsTypeOf (const char *type)
 
static vtkPlotSafeDownCast (vtkObjectBase *o)
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkPlotPoints ()
 
 ~vtkPlotPoints ()
 
bool UpdateTableCache (vtkTable *table)
 
void CalculateLogSeries ()
 
void FindBadPoints ()
 
void CalculateBounds (double bounds[4])
 
void CreateSortedPoints ()
 
- Protected Member Functions inherited from vtkPlot
 vtkPlot ()
 
 ~vtkPlot ()
 
vtkStdString GetNumber (double position, vtkAxis *axis)
 

Protected Attributes

vtkIdTypeArrayBadPoints
 
vtkCharArrayValidPointMask
 
vtkStdString ValidPointMaskName
 
vtkTimeStamp BuildTime
 
bool LogX
 
bool LogY
 
double UnscaledInputBounds [4]
 
vtkPoints2DPoints
 
vtkNew< vtkFloatArraySelectedPoints
 
VectorPIMPL * Sorted
 
int MarkerStyle
 
float MarkerSize
 
vtkScalarsToColorsLookupTable
 
vtkUnsignedCharArrayColors
 
int ScalarVisibility
 
vtkStdString ColorArrayName
 
- Protected Attributes inherited from vtkPlot
vtkSmartPointer< vtkPen > Pen
 
vtkSmartPointer< vtkBrush > Brush
 
vtkSmartPointer< vtkStringArrayLabels
 
vtkSmartPointer< vtkStringArrayAutoLabels
 
vtkSmartPointer< vtkStringArrayIndexedLabels
 
bool UseIndexForXSeries
 
vtkSmartPointer
< vtkContextMapper2D > 
Data
 
vtkIdTypeArraySelection
 
vtkAxisXAxis
 
vtkAxisYAxis
 
vtkStdString TooltipLabelFormat
 
vtkStdString TooltipDefaultLabelFormat
 
int TooltipNotation
 
int TooltipPrecision
 

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 52 of file vtkPlotPoints.h.

Member Typedef Documentation

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

Constructor & Destructor Documentation

vtkPlotPoints::vtkPlotPoints ( )
protected
vtkPlotPoints::~vtkPlotPoints ( )
protected

Member Function Documentation

static int vtkPlotPoints::IsTypeOf ( const char *  type)
static
virtual int vtkPlotPoints::IsA ( const char *  type)
virtual

Reimplemented from vtkPlot.

Reimplemented in vtkPlotLine.

static vtkPlotPoints* vtkPlotPoints::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkPlotPoints::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkPlot.

Reimplemented in vtkPlotLine.

vtkPlotPoints* vtkPlotPoints::NewInstance ( ) const
virtual void vtkPlotPoints::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual

Reimplemented from vtkPlot.

Reimplemented in vtkPlotLine.

static vtkPlotPoints* vtkPlotPoints::New ( )
static

Creates a 2D Chart object.

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.

virtual bool vtkPlotPoints::Paint ( vtkContext2D *  painter)
virtual

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

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.

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

Get the non-log-scaled bounds on chart inputs 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 bool vtkPlotPoints::SelectPointsInPolygon ( const vtkContextPolygon polygon)
virtual

Select all points in the specified polygon.

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.

virtual vtkStdString vtkPlotPoints::GetValidPointMaskName ( )
virtual

Get/set the valid point mask array name.

virtual void vtkPlotPoints::SetValidPointMaskName ( vtkStdString  )
virtual

Get/set the valid point mask array name.

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

vtkPoints2D* vtkPlotPoints::Points
protected

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

Definition at line 192 of file vtkPlotPoints.h.

vtkNew<vtkFloatArray> vtkPlotPoints::SelectedPoints
protected

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

Definition at line 193 of file vtkPlotPoints.h.

VectorPIMPL* vtkPlotPoints::Sorted
protected

Definition at line 198 of file vtkPlotPoints.h.

vtkIdTypeArray* vtkPlotPoints::BadPoints
protected

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 204 of file vtkPlotPoints.h.

vtkCharArray* vtkPlotPoints::ValidPointMask
protected

Array which marks valid points in the array. If NULL (the default), all points in the input array are considered valid.

Definition at line 208 of file vtkPlotPoints.h.

vtkStdString vtkPlotPoints::ValidPointMaskName
protected

Name of the valid point mask array.

Definition at line 211 of file vtkPlotPoints.h.

vtkTimeStamp vtkPlotPoints::BuildTime
protected

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

Definition at line 214 of file vtkPlotPoints.h.

int vtkPlotPoints::MarkerStyle
protected

The marker style that should be used

Definition at line 218 of file vtkPlotPoints.h.

float vtkPlotPoints::MarkerSize
protected

The marker style that should be used

Definition at line 219 of file vtkPlotPoints.h.

bool vtkPlotPoints::LogX
protected

Definition at line 222 of file vtkPlotPoints.h.

bool vtkPlotPoints::LogY
protected

Definition at line 222 of file vtkPlotPoints.h.

vtkScalarsToColors* vtkPlotPoints::LookupTable
protected

Lookup Table for coloring points by scalar value

Definition at line 226 of file vtkPlotPoints.h.

vtkUnsignedCharArray* vtkPlotPoints::Colors
protected

Lookup Table for coloring points by scalar value

Definition at line 227 of file vtkPlotPoints.h.

int vtkPlotPoints::ScalarVisibility
protected

Lookup Table for coloring points by scalar value

Definition at line 228 of file vtkPlotPoints.h.

vtkStdString vtkPlotPoints::ColorArrayName
protected

Lookup Table for coloring points by scalar value

Definition at line 229 of file vtkPlotPoints.h.

double vtkPlotPoints::UnscaledInputBounds[4]
protected

Cached bounds on the plot input axes

Definition at line 233 of file vtkPlotPoints.h.


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