VTK
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 = 0, CROSS, PLUS, SQUARE,
  CIRCLE, DIAMOND
}
 
- 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 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)
 
- Public Member Functions inherited from vtkPlot
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 ()
 
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 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])
 
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
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 vtkPlotPointsSafeDownCast (vtkObject *o)
 
static vtkPlotPointsNew ()
 
- 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

 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 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
 
vtkIdTypeArrayBadPoints
 
vtkTimeStamp BuildTime
 
bool LogX
 
bool LogY
 
VectorPIMPL * Sorted
 
int MarkerStyle
 
float MarkerSize
 
vtkImageDataMarker
 
vtkImageDataHighlightMarker
 
vtkScalarsToColorsLookupTable
 
vtkUnsignedCharArrayColors
 
int ScalarVisibility
 
vtkStdString ColorArrayName
 
- 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 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.

Member Typedef Documentation

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 *  type)
static
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
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.

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

vtkPoints2D* vtkPlotPoints::Points
protected

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.

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

vtkTimeStamp vtkPlotPoints::BuildTime
protected

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.

vtkImageData* vtkPlotPoints::Marker
protected

The marker style that should be used

Definition at line 195 of file vtkPlotPoints.h.

vtkImageData* vtkPlotPoints::HighlightMarker
protected

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.

vtkScalarsToColors* vtkPlotPoints::LookupTable
protected

Lookup Table for coloring points by scalar value

Definition at line 203 of file vtkPlotPoints.h.

vtkUnsignedCharArray* vtkPlotPoints::Colors
protected

Lookup Table for coloring points by scalar value

Definition at line 204 of file vtkPlotPoints.h.

int vtkPlotPoints::ScalarVisibility
protected

Lookup Table for coloring points by scalar value

Definition at line 205 of file vtkPlotPoints.h.

vtkStdString vtkPlotPoints::ColorArrayName
protected

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: