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

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
}
 Enum containing various marker styles that can be used in a plot. More...
 
typedef vtkPlot Superclass
 
- 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 Member Functions

virtual int IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkPlotPointsNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void Update () override
 Perform any updates to the item that may be necessary before rendering. More...
 
bool Paint (vtkContext2D *painter) override
 Paint event for the XY plot, called whenever the chart needs to be drawn. More...
 
bool PaintLegend (vtkContext2D *painter, const vtkRectf &rect, int legendIndex) override
 Paint legend event for the XY plot, called whenever the legend needs the plot items symbol/mark/line drawn. More...
 
void GetBounds (double bounds[4]) override
 Get the bounds for this plot as (Xmin, Xmax, Ymin, Ymax). More...
 
void GetUnscaledInputBounds (double bounds[4]) override
 Get the non-log-scaled bounds on chart inputs for this plot as (Xmin, Xmax, Ymin, Ymax). More...
 
virtual void CreateDefaultLookupTable ()
 Create default lookup table. More...
 
vtkStdString GetColorArrayName ()
 Get the array name to color by. More...
 
vtkIdType GetNearestPoint (const vtkVector2f &point, const vtkVector2f &tolerance, vtkVector2f *location) override
 Function to query a plot for the nearest point to the specified coordinate. More...
 
bool SelectPoints (const vtkVector2f &min, const vtkVector2f &max) override
 Select all points in the specified rectangle. More...
 
bool SelectPointsInPolygon (const vtkContextPolygon &polygon) override
 Select all points in the specified polygon. More...
 
void SetLookupTable (vtkScalarsToColors *lut)
 Specify a lookup table for the mapper to use. More...
 
vtkScalarsToColorsGetLookupTable ()
 Specify a lookup table for the mapper to use. More...
 
virtual void SetScalarVisibility (int)
 Turn on/off flag to control whether scalar data is used to color objects. More...
 
virtual int GetScalarVisibility ()
 Turn on/off flag to control whether scalar data is used to color objects. More...
 
virtual void ScalarVisibilityOn ()
 Turn on/off flag to control whether scalar data is used to color objects. More...
 
virtual void ScalarVisibilityOff ()
 Turn on/off flag to control whether scalar data is used to color objects. More...
 
void SelectColorArray (vtkIdType arrayNum)
 When ScalarMode is set to UsePointFieldData or UseCellFieldData, you can specify which array to use for coloring using these methods. More...
 
void SelectColorArray (const vtkStdString &arrayName)
 When ScalarMode is set to UsePointFieldData or UseCellFieldData, you can specify which array to use for coloring using these methods. More...
 
virtual int GetMarkerStyle ()
 Get/set the marker style that should be used. More...
 
virtual void SetMarkerStyle (int)
 Get/set the marker style that should be used. More...
 
virtual float GetMarkerSize ()
 Get/set the marker size that should be used. More...
 
virtual void SetMarkerSize (float)
 Get/set the marker size that should be used. More...
 
virtual vtkStdString GetValidPointMaskName ()
 Get/set the valid point mask array name. More...
 
virtual void SetValidPointMaskName (vtkStdString)
 Get/set the valid point mask array name. More...
 
- Public Member Functions inherited from vtkPlot
vtkPlotNewInstance () const
 
virtual vtkStdString GetTooltipLabel (const vtkVector2d &plotPos, vtkIdType seriesIndex, vtkIdType segmentIndex)
 Generate and return the tooltip label string for this plot The segmentIndex parameter is ignored, except for vtkPlotBar. More...
 
virtual void SetWidth (float width)
 Set the width of the line. More...
 
virtual float GetWidth ()
 Get the width of the line. More...
 
virtual void SetLabel (const vtkStdString &label)
 Set the label of this plot. More...
 
virtual vtkStdString GetLabel ()
 Get the label of this plot. More...
 
virtual void SetLabels (vtkStringArray *labels)
 Set the plot labels, these are used for stacked chart variants, with the index referring to the stacking index. More...
 
virtual vtkStringArrayGetLabels ()
 Get the plot labels. More...
 
virtual int GetNumberOfLabels ()
 Get the number of labels associated with this plot. More...
 
vtkStdString GetLabel (vtkIdType index)
 Get the label at the specified index. More...
 
void SetIndexedLabels (vtkStringArray *labels)
 Set indexed labels for the plot. More...
 
virtual vtkStringArrayGetIndexedLabels ()
 Get the indexed labels array. More...
 
vtkContextMapper2DGetData ()
 Get the data object that the plot will draw. More...
 
virtual vtkTableGetInput ()
 Get the input table used by the plot. More...
 
virtual void SetInputArray (int index, const vtkStdString &name)
 Convenience function to set the input arrays. More...
 
virtual void UpdateCache ()
 Subclasses that build data caches to speed up painting should override this method to update such caches. More...
 
virtual void SetLegendVisibility (bool)
 Set whether the plot renders an entry in the legend. More...
 
virtual bool GetLegendVisibility ()
 Set whether the plot renders an entry in the legend. More...
 
virtual void LegendVisibilityOn ()
 Set whether the plot renders an entry in the legend. More...
 
virtual void LegendVisibilityOff ()
 Set whether the plot renders an entry in the legend. More...
 
virtual void SetTooltipLabelFormat (const vtkStdString &label)
 Sets/gets a printf-style string to build custom tooltip labels from. More...
 
virtual vtkStdString GetTooltipLabelFormat ()
 Sets/gets a printf-style string to build custom tooltip labels from. More...
 
virtual void SetTooltipNotation (int notation)
 Sets/gets the tooltip notation style. More...
 
virtual int GetTooltipNotation ()
 Sets/gets the tooltip notation style. More...
 
virtual void SetTooltipPrecision (int precision)
 Sets/gets the tooltip precision. More...
 
virtual int GetTooltipPrecision ()
 Sets/gets the tooltip precision. More...
 
virtual void SetColor (unsigned char r, unsigned char g, unsigned char b, unsigned char a)
 Set the plot color. More...
 
virtual void SetColor (double r, double g, double b)
 Set the plot color. More...
 
virtual void GetColor (double rgb[3])
 Set the plot color. More...
 
void GetColor (unsigned char rgb[3])
 Set the plot color. More...
 
void SetPen (vtkPen *pen)
 Set/get the vtkPen object that controls how this plot draws (out)lines. More...
 
vtkPenGetPen ()
 Set/get the vtkPen object that controls how this plot draws (out)lines. More...
 
void SetBrush (vtkBrush *brush)
 Set/get the vtkBrush object that controls how this plot fills shapes. More...
 
vtkBrushGetBrush ()
 Set/get the vtkBrush object that controls how this plot fills shapes. More...
 
void SetSelectionPen (vtkPen *pen)
 Set/get the vtkBrush object that controls how this plot fills selected shapes. More...
 
vtkPenGetSelectionPen ()
 Set/get the vtkBrush object that controls how this plot fills selected shapes. More...
 
void SetSelectionBrush (vtkBrush *brush)
 Set/get the vtkBrush object that controls how this plot fills selected shapes. More...
 
vtkBrushGetSelectionBrush ()
 Set/get the vtkBrush object that controls how this plot fills selected shapes. More...
 
virtual bool GetUseIndexForXSeries ()
 Use the Y array index for the X value. More...
 
virtual void SetUseIndexForXSeries (bool)
 Use the Y array index for the X value. More...
 
virtual void SetInputData (vtkTable *table)
 This is a convenience function to set the input table and the x, y column for the plot. More...
 
virtual void SetInputData (vtkTable *table, const vtkStdString &xColumn, const vtkStdString &yColumn)
 This is a convenience function to set the input table and the x, y column for the plot. More...
 
void SetInputData (vtkTable *table, vtkIdType xColumn, vtkIdType yColumn)
 This is a convenience function to set the input table and the x, y column for the plot. More...
 
virtual void SetSelectable (bool)
 Set whether the plot can be selected. More...
 
virtual bool GetSelectable ()
 Set whether the plot can be selected. More...
 
virtual void SelectableOn ()
 Set whether the plot can be selected. More...
 
virtual void SelectableOff ()
 Set whether the plot can be selected. More...
 
virtual void SetSelection (vtkIdTypeArray *id)
 Sets the list of points that must be selected. More...
 
virtual vtkIdTypeArrayGetSelection ()
 Sets the list of points that must be selected. More...
 
virtual vtkAxisGetXAxis ()
 Get/set the X axis associated with this plot. More...
 
virtual void SetXAxis (vtkAxis *axis)
 Get/set the X axis associated with this plot. More...
 
virtual vtkAxisGetYAxis ()
 Get/set the Y axis associated with this plot. More...
 
virtual void SetYAxis (vtkAxis *axis)
 Get/set the Y axis associated with this plot. More...
 
void SetShiftScale (const vtkRectd &scaling)
 Get/set the origin shift and scaling factor used by the plot, this is normally 0.0 offset and 1.0 scaling, but can be used to render data outside of the single precision range. More...
 
vtkRectd GetShiftScale ()
 Get/set the origin shift and scaling factor used by the plot, this is normally 0.0 offset and 1.0 scaling, but can be used to render data outside of the single precision range. More...
 
virtual void SetProperty (const vtkStdString &property, const vtkVariant &var)
 A General setter/getter that should be overridden. More...
 
virtual vtkVariant GetProperty (const vtkStdString &property)
 A General setter/getter that should be overridden. More...
 
- Public Member Functions inherited from vtkContextItem
vtkContextItemNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual double GetOpacity ()
 Get the opacity of the item. More...
 
virtual void SetOpacity (double)
 Set the opacity of the item. More...
 
- Public Member Functions inherited from vtkAbstractContextItem
vtkAbstractContextItemNewInstance () const
 
virtual bool PaintChildren (vtkContext2D *painter)
 Paint the children of the item, should be called whenever the children need to be rendered. More...
 
virtual void ReleaseGraphicsResources ()
 Release graphics resources hold by the item. More...
 
unsigned int AddItem (vtkAbstractContextItem *item)
 Add child items to this item. More...
 
bool RemoveItem (vtkAbstractContextItem *item)
 Remove child item from this item. More...
 
bool RemoveItem (unsigned int index)
 Remove child item from this item. More...
 
vtkAbstractContextItemGetItem (unsigned int index)
 Get the item at the specified index. More...
 
unsigned int GetItemIndex (vtkAbstractContextItem *item)
 Get the index of the specified item. More...
 
unsigned int GetNumberOfItems ()
 Get the number of child items. More...
 
void ClearItems ()
 Remove all child items from this item. More...
 
unsigned int Raise (unsigned int index)
 Raises the child to the top of the item's stack. More...
 
virtual unsigned int StackAbove (unsigned int index, unsigned int under)
 Raises the child above the under sibling. More...
 
unsigned int Lower (unsigned int index)
 Lowers the child to the bottom of the item's stack. More...
 
virtual unsigned int StackUnder (unsigned int child, unsigned int above)
 Lowers the child under the above sibling. More...
 
virtual bool Hit (const vtkContextMouseEvent &mouse)
 Return true if the supplied x, y coordinate is inside the item. More...
 
virtual vtkAbstractContextItemGetPickedItem (const vtkContextMouseEvent &mouse)
 Return the item under the mouse. More...
 
virtual bool MouseEnterEvent (const vtkContextMouseEvent &mouse)
 Mouse enter event. More...
 
virtual bool MouseMoveEvent (const vtkContextMouseEvent &mouse)
 Mouse move event. More...
 
virtual bool MouseLeaveEvent (const vtkContextMouseEvent &mouse)
 Mouse leave event. More...
 
virtual bool MouseButtonPressEvent (const vtkContextMouseEvent &mouse)
 Mouse button down event Return true if the item holds the event, false if the event can be propagated to other items. More...
 
virtual bool MouseButtonReleaseEvent (const vtkContextMouseEvent &mouse)
 Mouse button release event. More...
 
virtual bool MouseDoubleClickEvent (const vtkContextMouseEvent &mouse)
 Mouse button double click event. More...
 
virtual bool MouseWheelEvent (const vtkContextMouseEvent &mouse, int delta)
 Mouse wheel event, positive delta indicates forward movement of the wheel. More...
 
virtual bool KeyPressEvent (const vtkContextKeyEvent &key)
 Key press event. More...
 
virtual bool KeyReleaseEvent (const vtkContextKeyEvent &key)
 Key release event. More...
 
virtual void SetScene (vtkContextScene *scene)
 Set the vtkContextScene for the item, always set for an item in a scene. More...
 
vtkContextSceneGetScene ()
 Get the vtkContextScene for the item, always set for an item in a scene. More...
 
virtual void SetParent (vtkAbstractContextItem *parent)
 Set the parent item. More...
 
vtkAbstractContextItemGetParent ()
 Get the parent item. More...
 
virtual vtkVector2f MapToParent (const vtkVector2f &point)
 Maps the point to the parent coordinate system. More...
 
virtual vtkVector2f MapFromParent (const vtkVector2f &point)
 Maps the point from the parent coordinate system. More...
 
virtual vtkVector2f MapToScene (const vtkVector2f &point)
 Maps the point to the scene coordinate system. More...
 
virtual vtkVector2f MapFromScene (const vtkVector2f &point)
 Maps the point from the scene coordinate system. More...
 
virtual bool GetVisible ()
 Get the visibility of the item (should it be drawn). More...
 
virtual void SetVisible (bool)
 Set the visibility of the item (should it be drawn). More...
 
virtual bool GetInteractive ()
 Get if the item is interactive (should respond to mouse events). More...
 
virtual void SetInteractive (bool)
 Set if the item is interactive (should respond to mouse events). More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
int HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
int HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkPlotPointsSafeDownCast (vtkObjectBase *o)
 
static vtkPlotPointsNew ()
 Creates a 2D Chart object. More...
 
- Static Public Member Functions inherited from vtkPlot
static int IsTypeOf (const char *type)
 
static vtkPlotSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkContextItem
static int IsTypeOf (const char *type)
 
static vtkContextItemSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAbstractContextItem
static int IsTypeOf (const char *type)
 
static vtkAbstractContextItemSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkPlotPoints ()
 
 ~vtkPlotPoints () override
 
bool GetDataArrays (vtkTable *table, vtkDataArray *array[2])
 Populate the data arrays ready to operate on input data. More...
 
bool UpdateTableCache (vtkTable *table)
 Update the table cache. More...
 
void CalculateUnscaledInputBounds ()
 Calculate the unscaled input bounds from the input arrays. More...
 
void CalculateLogSeries ()
 Handle calculating the log of the x or y series if necessary. More...
 
void FindBadPoints ()
 Find all of the "bad points" in the series. More...
 
void CalculateBounds (double bounds[4])
 Calculate the bounds of the plot, ignoring the bad points. More...
 
void CreateSortedPoints ()
 Create the sorted point list if necessary. More...
 
- Protected Member Functions inherited from vtkPlot
 vtkPlot ()
 
 ~vtkPlot () override
 
vtkStdString GetNumber (double position, vtkAxis *axis)
 Get the properly formatted number for the supplied position and axis. More...
 
- Protected Member Functions inherited from vtkContextItem
 vtkContextItem ()
 
 ~vtkContextItem () override
 
- Protected Member Functions inherited from vtkAbstractContextItem
 vtkAbstractContextItem ()
 
 ~vtkAbstractContextItem () override
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events. More...
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkIdTypeArrayBadPoints
 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. More...
 
vtkCharArrayValidPointMask
 Array which marks valid points in the array. More...
 
vtkStdString ValidPointMaskName
 Name of the valid point mask array. More...
 
vtkTimeStamp BuildTime
 The point cache is marked dirty until it has been initialized. More...
 
bool LogX
 
bool LogY
 
double UnscaledInputBounds [4]
 Cached bounds on the plot input axes. More...
 
vtkPoints2DPoints
 Store a well packed set of XY coordinates for this data series. More...
 
vtkNew< vtkFloatArraySelectedPoints
 Store a well packed set of XY coordinates for this data series. More...
 
VectorPIMPL * Sorted
 
int MarkerStyle
 The marker style that should be used. More...
 
float MarkerSize
 The marker style that should be used. More...
 
vtkScalarsToColorsLookupTable
 Lookup Table for coloring points by scalar value. More...
 
vtkUnsignedCharArrayColors
 Lookup Table for coloring points by scalar value. More...
 
int ScalarVisibility
 Lookup Table for coloring points by scalar value. More...
 
vtkStdString ColorArrayName
 Lookup Table for coloring points by scalar value. More...
 
- Protected Attributes inherited from vtkPlot
vtkSmartPointer< vtkPenPen
 This object stores the vtkPen that controls how the plot is drawn. More...
 
vtkSmartPointer< vtkBrushBrush
 This object stores the vtkBrush that controls how the plot is drawn. More...
 
vtkSmartPointer< vtkPenSelectionPen
 This object stores the vtkPen that controls how the selected elements of the plot are drawn. More...
 
vtkSmartPointer< vtkBrushSelectionBrush
 This object stores the vtkBrush that controls how the selected elements of the plot are drawn. More...
 
vtkSmartPointer< vtkStringArrayLabels
 Plot labels, used by legend. More...
 
vtkSmartPointer< vtkStringArrayAutoLabels
 Holds Labels when they're auto-created. More...
 
vtkSmartPointer< vtkStringArrayIndexedLabels
 Holds Labels when they're auto-created. More...
 
bool UseIndexForXSeries
 Use the Y array index for the X value. More...
 
vtkSmartPointer< vtkContextMapper2DData
 This data member contains the data that will be plotted, it inherits from vtkAlgorithm. More...
 
bool Selectable
 Whether plot points can be selected or not. More...
 
vtkIdTypeArraySelection
 Selected indices for the table the plot is rendering. More...
 
vtkAxisXAxis
 The X axis associated with this plot. More...
 
vtkAxisYAxis
 The X axis associated with this plot. More...
 
vtkStdString TooltipLabelFormat
 A printf-style string to build custom tooltip labels from. More...
 
vtkStdString TooltipDefaultLabelFormat
 The default printf-style string to build custom tooltip labels from. More...
 
int TooltipNotation
 
int TooltipPrecision
 
vtkRectd ShiftScale
 The current shift in origin and scaling factor applied to the plot. More...
 
bool LegendVisibility
 
- Protected Attributes inherited from vtkContextItem
double Opacity
 
- Protected Attributes inherited from vtkAbstractContextItem
vtkContextSceneScene
 Point to the scene the item is on - can be null. More...
 
vtkAbstractContextItemParent
 Point to the parent item - can be null. More...
 
vtkContextScenePrivateChildren
 This structure provides a list of children, along with convenience functions to paint the children etc. More...
 
bool Visible
 Store the visibility of the item (default is true). More...
 
bool Interactive
 Store whether the item should respond to interactions (default is true). More...
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 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 53 of file vtkPlotPoints.h.

Member Typedef Documentation

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

Constructor & Destructor Documentation

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

Member Function Documentation

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 vtkPlotBag, and vtkPlotLine.

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

Reimplemented from vtkPlot.

Reimplemented in vtkPlotBag, and vtkPlotLine.

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

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 vtkPlotPoints* vtkPlotPoints::New ( )
static

Creates a 2D Chart object.

void vtkPlotPoints::Update ( )
overridevirtual

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.

bool vtkPlotPoints::Paint ( vtkContext2D painter)
overridevirtual

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

Reimplemented from vtkAbstractContextItem.

bool vtkPlotPoints::PaintLegend ( vtkContext2D painter,
const vtkRectf rect,
int  legendIndex 
)
overridevirtual

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.

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

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

Reimplemented from vtkPlot.

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

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.

vtkIdType vtkPlotPoints::GetNearestPoint ( const vtkVector2f point,
const vtkVector2f tolerance,
vtkVector2f location 
)
overridevirtual

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.

bool vtkPlotPoints::SelectPoints ( const vtkVector2f min,
const vtkVector2f max 
)
overridevirtual

Select all points in the specified rectangle.

Reimplemented from vtkPlot.

bool vtkPlotPoints::SelectPointsInPolygon ( const vtkContextPolygon polygon)
overridevirtual

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::GetDataArrays ( vtkTable table,
vtkDataArray array[2] 
)
protected

Populate the data arrays ready to operate on input data.

bool vtkPlotPoints::UpdateTableCache ( vtkTable table)
protected

Update the table cache.

void vtkPlotPoints::CalculateUnscaledInputBounds ( )
protected

Calculate the unscaled input bounds from the input arrays.

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

vtkNew<vtkFloatArray> vtkPlotPoints::SelectedPoints
protected

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

Definition at line 237 of file vtkPlotPoints.h.

VectorPIMPL* vtkPlotPoints::Sorted
protected

Definition at line 244 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 252 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 258 of file vtkPlotPoints.h.

vtkStdString vtkPlotPoints::ValidPointMaskName
protected

Name of the valid point mask array.

Definition at line 263 of file vtkPlotPoints.h.

vtkTimeStamp vtkPlotPoints::BuildTime
protected

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

Definition at line 268 of file vtkPlotPoints.h.

int vtkPlotPoints::MarkerStyle
protected

The marker style that should be used.

Definition at line 274 of file vtkPlotPoints.h.

float vtkPlotPoints::MarkerSize
protected

The marker style that should be used.

Definition at line 275 of file vtkPlotPoints.h.

bool vtkPlotPoints::LogX
protected

Definition at line 278 of file vtkPlotPoints.h.

bool vtkPlotPoints::LogY
protected

Definition at line 278 of file vtkPlotPoints.h.

vtkScalarsToColors* vtkPlotPoints::LookupTable
protected

Lookup Table for coloring points by scalar value.

Definition at line 284 of file vtkPlotPoints.h.

vtkUnsignedCharArray* vtkPlotPoints::Colors
protected

Lookup Table for coloring points by scalar value.

Definition at line 285 of file vtkPlotPoints.h.

int vtkPlotPoints::ScalarVisibility
protected

Lookup Table for coloring points by scalar value.

Definition at line 286 of file vtkPlotPoints.h.

vtkStdString vtkPlotPoints::ColorArrayName
protected

Lookup Table for coloring points by scalar value.

Definition at line 287 of file vtkPlotPoints.h.

double vtkPlotPoints::UnscaledInputBounds[4]
protected

Cached bounds on the plot input axes.

Definition at line 293 of file vtkPlotPoints.h.


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