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 vtkTypeBool 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...
 
void SetLookupTable (vtkScalarsToColors *lut)
 Specify a lookup table for the mapper to use. More...
 
vtkScalarsToColorsGetLookupTable ()
 
virtual void CreateDefaultLookupTable ()
 Create default lookup table. More...
 
virtual void SetScalarVisibility (vtkTypeBool)
 Turn on/off flag to control whether scalar data is used to color objects. More...
 
virtual vtkTypeBool GetScalarVisibility ()
 
virtual void ScalarVisibilityOn ()
 
virtual void ScalarVisibilityOff ()
 
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)
 
vtkStdString GetColorArrayName ()
 Get the array name to color by. More...
 
vtkIdType GetNearestPoint (const vtkVector2f &point, const vtkVector2f &tolerance, vtkVector2f *location, vtkIdType *segmentId) 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...
 
virtual int GetMarkerStyle ()
 Get/set the marker style that should be used. More...
 
virtual void SetMarkerStyle (int)
 
virtual float GetMarkerSize ()
 Get/set the marker size that should be used. More...
 
virtual void SetMarkerSize (float)
 
virtual vtkStdString GetValidPointMaskName ()
 Get/set the valid point mask array name. More...
 
virtual void SetValidPointMaskName (vtkStdString)
 
virtual vtkIdType GetNearestPoint (const vtkVector2f &point, const vtkVector2f &tolerance, vtkVector2f *location, vtkIdType *segmentId)
 Function to query a plot for the nearest point to the specified coordinate. More...
 
virtual vtkIdType GetNearestPoint (const vtkVector2f &point, const vtkVector2f &tolerance, vtkVector2f *location)
 Function to query a plot for the nearest point to the specified coordinate. More...
 
- Public Member Functions inherited from vtkPlot
vtkPlotNewInstance () const
 
virtual void SetLegendVisibility (bool)
 Set whether the plot renders an entry in the legend. More...
 
virtual bool GetLegendVisibility ()
 
virtual void LegendVisibilityOn ()
 
virtual void LegendVisibilityOff ()
 
virtual void SetTooltipLabelFormat (const vtkStdString &label)
 Sets/gets a printf-style string to build custom tooltip labels from. More...
 
virtual vtkStdString GetTooltipLabelFormat ()
 
virtual void SetTooltipNotation (int notation)
 Sets/gets the tooltip notation style. More...
 
virtual int GetTooltipNotation ()
 
virtual void SetTooltipPrecision (int precision)
 Sets/gets the tooltip precision. More...
 
virtual int GetTooltipPrecision ()
 
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 vtkIdType GetNearestPoint (const vtkVector2f &point, const vtkVector2f &tolerance, vtkVector2f *location)
 Function to query a plot for the nearest point to the specified coordinate. 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)
 
virtual void GetColor (double rgb[3])
 
void GetColor (unsigned char rgb[3])
 
virtual void SetWidth (float width)
 Set the width of the line. More...
 
virtual float GetWidth ()
 Get the width of the line. More...
 
void SetPen (vtkPen *pen)
 Set/get the vtkPen object that controls how this plot draws (out)lines. More...
 
vtkPenGetPen ()
 
void SetBrush (vtkBrush *brush)
 Set/get the vtkBrush object that controls how this plot fills shapes. More...
 
vtkBrushGetBrush ()
 
void SetSelectionPen (vtkPen *pen)
 Set/get the vtkBrush object that controls how this plot fills selected shapes. More...
 
vtkPenGetSelectionPen ()
 
void SetSelectionBrush (vtkBrush *brush)
 Set/get the vtkBrush object that controls how this plot fills selected shapes. More...
 
vtkBrushGetSelectionBrush ()
 
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 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)
 
void SetInputData (vtkTable *table, vtkIdType xColumn, vtkIdType yColumn)
 
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 SetSelectable (bool)
 Set whether the plot can be selected. More...
 
virtual bool GetSelectable ()
 
virtual void SelectableOn ()
 
virtual void SelectableOff ()
 
virtual void SetSelection (vtkIdTypeArray *id)
 Sets the list of points that must be selected. More...
 
virtual vtkIdTypeArrayGetSelection ()
 
virtual vtkAxisGetXAxis ()
 Get/set the X axis associated with this plot. More...
 
virtual void SetXAxis (vtkAxis *axis)
 
virtual vtkAxisGetYAxis ()
 Get/set the Y axis associated with this plot. More...
 
virtual void SetYAxis (vtkAxis *axis)
 
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 ()
 
virtual void UpdateCache ()
 Subclasses that build data caches to speed up painting should override this method to update such caches. 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)
 
virtual bool ClampPos (double pos[2])
 
- 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...
 
vtkIdType AddItem (vtkAbstractContextItem *item)
 Add child items to this item. More...
 
bool RemoveItem (vtkAbstractContextItem *item)
 Remove child item from this item. More...
 
bool RemoveItem (vtkIdType index)
 Remove child item from this item. More...
 
vtkAbstractContextItemGetItem (vtkIdType index)
 Get the item at the specified index. More...
 
vtkIdType GetItemIndex (vtkAbstractContextItem *item)
 Get the index of the specified item in itemIndex. More...
 
vtkIdType GetNumberOfItems ()
 Get the number of child items. More...
 
void ClearItems ()
 Remove all child items from this item. More...
 
vtkIdType Raise (vtkIdType index)
 Raises the child to the top of the item's stack. More...
 
virtual vtkIdType StackAbove (vtkIdType index, vtkIdType under)
 Raises the child above the under sibling. More...
 
vtkIdType Lower (vtkIdType index)
 Lowers the child to the bottom of the item's stack. More...
 
virtual vtkIdType StackUnder (vtkIdType child, vtkIdType 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...
 
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)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
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)
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- 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 PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
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...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkPlotPointsSafeDownCast (vtkObjectBase *o)
 
static vtkPlotPointsNew ()
 Creates a 2D Chart object. More...
 
- Static Public Member Functions inherited from vtkPlot
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkPlotSafeDownCast (vtkObjectBase *o)
 
static bool ClampPos (double pos[2], double bounds[4])
 Clamp the given 2D pos into the provided bounds Return true if the pos has been clamped, false otherwise. More...
 
- Static Public Member Functions inherited from vtkContextItem
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkContextItemSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAbstractContextItem
static vtkTypeBool 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 ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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...
 
virtual void TransformScreenToData (const vtkVector2f &in, vtkVector2f &out)
 Transform the mouse event in the control-points space. More...
 
virtual void TransformDataToScreen (const vtkVector2f &in, vtkVector2f &out)
 
virtual void TransformScreenToData (const double inX, const double inY, double &outX, double &outY)
 
virtual void TransformDataToScreen (const double inX, const double inY, double &outX, double &outY)
 
- 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=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 
- 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

vtkPoints2DPoints
 Store a well packed set of XY coordinates for this data series. More...
 
vtkNew< vtkFloatArraySelectedPoints
 
VectorPIMPL * Sorted
 
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...
 
int MarkerStyle
 The marker style that should be used. More...
 
float MarkerSize
 
bool LogX
 
bool LogY
 
vtkScalarsToColorsLookupTable
 Lookup Table for coloring points by scalar value. More...
 
vtkUnsignedCharArrayColors
 
vtkTypeBool ScalarVisibility
 
vtkStdString ColorArrayName
 
double UnscaledInputBounds [4]
 Cached bounds on the plot input axes. 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
 
bool LegacyRecursionFlag = false
 Flag used by GetNearestPoint legacy implementation to avoid infinite call. More...
 
- 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
std::atomic< int32_t > 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

Definition at line 50 of file vtkPlotPoints.h.

Member Typedef Documentation

◆ Superclass

Definition at line 53 of file vtkPlotPoints.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

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

Enumerator
NONE 
CROSS 
PLUS 
SQUARE 
CIRCLE 
DIAMOND 

Definition at line 159 of file vtkPlotPoints.h.

Constructor & Destructor Documentation

◆ vtkPlotPoints()

vtkPlotPoints::vtkPlotPoints ( )
protected

◆ ~vtkPlotPoints()

vtkPlotPoints::~vtkPlotPoints ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

static vtkTypeBool vtkPlotPoints::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool 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.

◆ SafeDownCast()

static vtkPlotPoints* vtkPlotPoints::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkPlotPoints::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkPlot.

Reimplemented in vtkPlotBag, and vtkPlotLine.

◆ NewInstance()

vtkPlotPoints* vtkPlotPoints::NewInstance ( ) const

◆ PrintSelf()

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.

◆ New()

static vtkPlotPoints* vtkPlotPoints::New ( )
static

Creates a 2D Chart object.

◆ Update()

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.

◆ Paint()

bool vtkPlotPoints::Paint ( vtkContext2D painter)
overridevirtual

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

Reimplemented from vtkAbstractContextItem.

◆ PaintLegend()

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.

◆ GetBounds()

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

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

Reimplemented from vtkPlot.

◆ GetUnscaledInputBounds()

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.

◆ SetLookupTable()

void vtkPlotPoints::SetLookupTable ( vtkScalarsToColors lut)

Specify a lookup table for the mapper to use.

◆ GetLookupTable()

vtkScalarsToColors* vtkPlotPoints::GetLookupTable ( )

◆ CreateDefaultLookupTable()

virtual void vtkPlotPoints::CreateDefaultLookupTable ( )
virtual

Create default lookup table.

Generally used to create one when none is available with the scalar data.

◆ SetScalarVisibility()

virtual void vtkPlotPoints::SetScalarVisibility ( vtkTypeBool  )
virtual

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

◆ GetScalarVisibility()

virtual vtkTypeBool vtkPlotPoints::GetScalarVisibility ( )
virtual

◆ ScalarVisibilityOn()

virtual void vtkPlotPoints::ScalarVisibilityOn ( )
virtual

◆ ScalarVisibilityOff()

virtual void vtkPlotPoints::ScalarVisibilityOff ( )
virtual

◆ SelectColorArray() [1/2]

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.

◆ SelectColorArray() [2/2]

void vtkPlotPoints::SelectColorArray ( const vtkStdString arrayName)

◆ GetColorArrayName()

vtkStdString vtkPlotPoints::GetColorArrayName ( )

Get the array name to color by.

◆ GetNearestPoint() [1/3]

vtkIdType vtkPlotPoints::GetNearestPoint ( const vtkVector2f point,
const vtkVector2f tolerance,
vtkVector2f location,
vtkIdType segmentId 
)
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.

◆ SelectPoints()

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

Select all points in the specified rectangle.

Reimplemented from vtkPlot.

◆ SelectPointsInPolygon()

bool vtkPlotPoints::SelectPointsInPolygon ( const vtkContextPolygon polygon)
overridevirtual

Select all points in the specified polygon.

Reimplemented from vtkPlot.

◆ GetMarkerStyle()

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.

◆ SetMarkerStyle()

virtual void vtkPlotPoints::SetMarkerStyle ( int  )
virtual

◆ GetMarkerSize()

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.

◆ SetMarkerSize()

virtual void vtkPlotPoints::SetMarkerSize ( float  )
virtual

◆ GetValidPointMaskName()

virtual vtkStdString vtkPlotPoints::GetValidPointMaskName ( )
virtual

Get/set the valid point mask array name.

◆ SetValidPointMaskName()

virtual void vtkPlotPoints::SetValidPointMaskName ( vtkStdString  )
virtual

◆ GetDataArrays()

bool vtkPlotPoints::GetDataArrays ( vtkTable table,
vtkDataArray array[2] 
)
protected

Populate the data arrays ready to operate on input data.

◆ UpdateTableCache()

bool vtkPlotPoints::UpdateTableCache ( vtkTable table)
protected

Update the table cache.

◆ CalculateUnscaledInputBounds()

void vtkPlotPoints::CalculateUnscaledInputBounds ( )
protected

Calculate the unscaled input bounds from the input arrays.

◆ CalculateLogSeries()

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.

◆ FindBadPoints()

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.

◆ CalculateBounds()

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

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

◆ CreateSortedPoints()

void vtkPlotPoints::CreateSortedPoints ( )
protected

Create the sorted point list if necessary.

◆ GetNearestPoint() [2/3]

virtual vtkIdType vtkPlot::GetNearestPoint

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 if no point was found.

◆ GetNearestPoint() [3/3]

virtual vtkIdType vtkPlot::GetNearestPoint

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 if no point was found. Deprecated method, uses GetNearestPoint(const vtkVector2f& point, const vtkVector2f& tolerance, vtkVector2f* location, vtkIdType* segmentId); instead.

Member Data Documentation

◆ Points

vtkPoints2D* vtkPlotPoints::Points
protected

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

Definition at line 241 of file vtkPlotPoints.h.

◆ SelectedPoints

vtkNew<vtkFloatArray> vtkPlotPoints::SelectedPoints
protected

Definition at line 242 of file vtkPlotPoints.h.

◆ Sorted

VectorPIMPL* vtkPlotPoints::Sorted
protected

Definition at line 249 of file vtkPlotPoints.h.

◆ BadPoints

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

◆ ValidPointMask

vtkCharArray* vtkPlotPoints::ValidPointMask
protected

Array which marks valid points in the array.

If nullptr (the default), all points in the input array are considered valid.

Definition at line 263 of file vtkPlotPoints.h.

◆ ValidPointMaskName

vtkStdString vtkPlotPoints::ValidPointMaskName
protected

Name of the valid point mask array.

Definition at line 268 of file vtkPlotPoints.h.

◆ BuildTime

vtkTimeStamp vtkPlotPoints::BuildTime
protected

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

Definition at line 273 of file vtkPlotPoints.h.

◆ MarkerStyle

int vtkPlotPoints::MarkerStyle
protected

The marker style that should be used.

Definition at line 279 of file vtkPlotPoints.h.

◆ MarkerSize

float vtkPlotPoints::MarkerSize
protected

Definition at line 280 of file vtkPlotPoints.h.

◆ LogX

bool vtkPlotPoints::LogX
protected

Definition at line 283 of file vtkPlotPoints.h.

◆ LogY

bool vtkPlotPoints::LogY
protected

Definition at line 283 of file vtkPlotPoints.h.

◆ LookupTable

vtkScalarsToColors* vtkPlotPoints::LookupTable
protected

Lookup Table for coloring points by scalar value.

Definition at line 289 of file vtkPlotPoints.h.

◆ Colors

vtkUnsignedCharArray* vtkPlotPoints::Colors
protected

Definition at line 290 of file vtkPlotPoints.h.

◆ ScalarVisibility

vtkTypeBool vtkPlotPoints::ScalarVisibility
protected

Definition at line 291 of file vtkPlotPoints.h.

◆ ColorArrayName

vtkStdString vtkPlotPoints::ColorArrayName
protected

Definition at line 292 of file vtkPlotPoints.h.

◆ UnscaledInputBounds

double vtkPlotPoints::UnscaledInputBounds[4]
protected

Cached bounds on the plot input axes.

Definition at line 298 of file vtkPlotPoints.h.


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