Abstract class for 2D plots. More...

#include <vtkPlot.h>

Inheritance diagram for vtkPlot:

Collaboration diagram for vtkPlot:

Public Types
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.

vtkPlot *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

void	Update () override
	Perform any updates to the item that may be necessary before rendering.

virtual bool	PaintLegend (vtkContext2D *painter, const vtkRectf &rect, int legendIndex)
	Paint legend event for the plot, called whenever the legend needs the plot items symbol/mark/line drawn.

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.

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.

virtual bool	SelectPoints (const vtkVector2f &min, const vtkVector2f &max)
	Select all points in the specified rectangle.

virtual bool	SelectPointsInPolygon (const vtkContextPolygon &polygon)
	Select all points in the specified polygon.

virtual void	SetColor (unsigned char r, unsigned char g, unsigned char b, unsigned char a)
	Set the plot color with integer values (comprised between 0 and 255)

virtual void	SetLabel (const vtkStdString &label)
	Set the label of this plot.

virtual vtkStdString	GetLabel ()
	Get the label of this plot.

virtual void	SetLabels (vtkStringArray *labels)
	Set the plot labels, these are used for stacked chart variants, with the index referring to the stacking index.

virtual vtkStringArray *	GetLabels ()
	Get the plot labels.

virtual int	GetNumberOfLabels ()
	Get the number of labels associated with this plot.

vtkStdString	GetLabel (vtkIdType index)
	Get the label at the specified index.

void	SetIndexedLabels (vtkStringArray *labels)
	Set indexed labels for the plot.

virtual vtkStringArray *	GetIndexedLabels ()
	Get the indexed labels array.

vtkContextMapper2D *	GetData ()
	Get the data object that the plot will draw.

virtual vtkTable *	GetInput ()
	Get the input table used by the plot.

vtkAlgorithmOutput *	GetInputConnection ()
	Get the input connection used by the plot.

virtual void	SetInputArray (int index, const vtkStdString &name)
	Convenience function to set the input arrays.

virtual void	GetBounds (double bounds[4])
	Get the bounds for this plot as (Xmin, Xmax, Ymin, Ymax).

virtual void	GetUnscaledInputBounds (double bounds[4])
	Provide un-log-scaled bounds for the plot inputs.

bool	Hit (const vtkContextMouseEvent &mouse) override
	Returns true if the supplied x, y coordinate is inside the item.

virtual bool	UpdateCache ()
	Update the internal cache.


virtual void	SetLegendVisibility (bool)
	Set whether the plot renders an entry in the legend.

virtual bool	GetLegendVisibility ()
	Set whether the plot renders an entry in the legend.

virtual void	LegendVisibilityOn ()
	Set whether the plot renders an entry in the legend.

virtual void	LegendVisibilityOff ()
	Set whether the plot renders an entry in the legend.


virtual void	SetTooltipLabelFormat (const vtkStdString &label)
	Sets/gets a printf-style string to build custom tooltip labels from.

virtual vtkStdString	GetTooltipLabelFormat ()
	Sets/gets a printf-style string to build custom tooltip labels from.


virtual void	SetTooltipNotation (int notation)
	Sets/gets the tooltip notation style.

virtual int	GetTooltipNotation ()
	Sets/gets the tooltip notation style.


virtual void	SetTooltipPrecision (int precision)
	Sets/gets the tooltip precision.

virtual int	GetTooltipPrecision ()
	Sets/gets the tooltip precision.


virtual void	SetColorF (double r, double g, double b, double a)
	Set the plot color with floating values (comprised between 0.0 and 1.0)

virtual void	SetColorF (double r, double g, double b)
	Set the plot color with floating values (comprised between 0.0 and 1.0)

virtual void	SetColor (double r, double g, double b)
	Set the plot color with floating values (comprised between 0.0 and 1.0)


void	GetColor (unsigned char rgb[3])
	Get the plot color as integer rgb values (comprised between 0 and 255)

void	GetColorRGBA (unsigned char rgba[4])
	Get the plot color as integer rgb values (comprised between 0 and 255)


virtual void	GetColorF (double rgb[3])
	Get the plot color as floating rgb values (comprised between 0.0 and 1.0)

virtual void	GetColor (double rgb[3])
	Get the plot color as floating rgb values (comprised between 0.0 and 1.0)

virtual void	SetWidth (float width)
	@

virtual float	GetWidth ()
	Get the width of the line.

void	SetPen (vtkPen *pen)
	Set/get the vtkPen object that controls how this plot draws (out)lines.

vtkPen *	GetPen ()
	Get the plot color as floating rgb values (comprised between 0.0 and 1.0)


void	SetBrush (vtkBrush *brush)
	Set/get the vtkBrush object that controls how this plot fills shapes.

vtkBrush *	GetBrush ()
	Set/get the vtkBrush object that controls how this plot fills shapes.


void	SetSelectionPen (vtkPen *pen)
	Set/get the vtkBrush object that controls how this plot fills selected shapes.

vtkPen *	GetSelectionPen ()
	Set/get the vtkBrush object that controls how this plot fills selected shapes.


void	SetSelectionBrush (vtkBrush *brush)
	Set/get the vtkBrush object that controls how this plot fills selected shapes.

vtkBrush *	GetSelectionBrush ()
	Set/get the vtkBrush object that controls how this plot fills selected shapes.


virtual bool	GetUseIndexForXSeries ()
	Use the Y array index for the X value.


virtual void	SetUseIndexForXSeries (bool)
	Use the Y array index for the X value.


virtual void	SetInputData (vtkTable *table)
	This is a convenience function to set the input table and the x, y column for the plot.

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.

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.


virtual void	SetInputConnection (vtkAlgorithmOutput *input)
	This is a convenience function to set the input connection for the plot.


void	SetXAxisInputArrayToProcess (const std::string &name)
	Convenient function to directly set/get the names of columns used for X and Y axis respectively.

std::string	GetXAxisInputArrayToProcess ()
	Convenient function to directly set/get the names of columns used for X and Y axis respectively.

void	SetYAxisInputArrayToProcess (const std::string &name)
	Convenient function to directly set/get the names of columns used for X and Y axis respectively.

std::string	GetYAxisInputArrayToProcess ()
	Convenient function to directly set/get the names of columns used for X and Y axis respectively.


virtual void	SetSelectable (bool)
	Set whether the plot can be selected.

virtual bool	GetSelectable ()
	Set whether the plot can be selected.

virtual void	SelectableOn ()
	Set whether the plot can be selected.

virtual void	SelectableOff ()
	Set whether the plot can be selected.


virtual void	SetSelection (vtkIdTypeArray *id)
	Sets the list of points that must be selected.

virtual vtkIdTypeArray *	GetSelection ()
	Sets the list of points that must be selected.


virtual vtkAxis *	GetXAxis ()
	Get/set the X axis associated with this plot.

virtual void	SetXAxis (vtkAxis *axis)
	Get/set the X axis associated with this plot.


virtual vtkAxis *	GetYAxis ()
	Get/set the Y axis associated with this plot.

virtual void	SetYAxis (vtkAxis *axis)
	Get/set the Y axis associated with this plot.


void	SetShiftScale (const vtkRectd &shiftScale)
	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.

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.


virtual void	SetProperty (const vtkStdString &property, const vtkVariant &var)
	A General setter/getter that should be overridden.

virtual vtkVariant	GetProperty (const vtkStdString &property)
	A General setter/getter that should be overridden.

Public Member Functions inherited from vtkContextItem
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkContextItem *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

virtual void	SetTransform (vtkContextTransform *)
	Set the transform of the item.

virtual double	GetOpacity ()
	Get the opacity of the item.

virtual void	SetOpacity (double)
	Set the opacity of the item.

Public Member Functions inherited from vtkAbstractContextItem
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkAbstractContextItem *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

virtual void	Update ()
	Perform any updates to the item that may be necessary before rendering.

virtual bool	Paint (vtkContext2D *painter)
	Paint event for the item, called whenever the item needs to be drawn.

virtual bool	PaintChildren (vtkContext2D *painter)
	Paint the children of the item, should be called whenever the children need to be rendered.

virtual void	ReleaseGraphicsResources ()
	Release graphics resources hold by the item.

vtkIdType	AddItem (vtkAbstractContextItem *item)
	Add child items to this item.

bool	RemoveItem (vtkAbstractContextItem *item)
	Remove child item from this item.

bool	RemoveItem (vtkIdType index)
	Remove child item from this item.

vtkAbstractContextItem *	GetItem (vtkIdType index)
	Get the item at the specified index.

vtkIdType	GetItemIndex (vtkAbstractContextItem *item)
	Get the index of the specified item in itemIndex.

vtkIdType	GetNumberOfItems ()
	Get the number of child items.

void	ClearItems ()
	Remove all child items from this item.

vtkIdType	Raise (vtkIdType index)
	Raises the child to the top of the item's stack.

virtual vtkIdType	StackAbove (vtkIdType index, vtkIdType under)
	Raises the child above the under sibling.

vtkIdType	Lower (vtkIdType index)
	Lowers the child to the bottom of the item's stack.

virtual vtkIdType	StackUnder (vtkIdType child, vtkIdType above)
	Lowers the child under the above sibling.

virtual bool	Hit (const vtkContextMouseEvent &mouse)
	Return true if the supplied x, y coordinate is inside the item.

virtual vtkAbstractContextItem *	GetPickedItem (const vtkContextMouseEvent &mouse)
	Return the item under the mouse.

virtual bool	MouseEnterEvent (const vtkContextMouseEvent &mouse)
	Mouse enter event.

virtual bool	MouseMoveEvent (const vtkContextMouseEvent &mouse)
	Mouse move event.

virtual bool	MouseLeaveEvent (const vtkContextMouseEvent &mouse)
	Mouse leave event.

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.

virtual bool	MouseButtonReleaseEvent (const vtkContextMouseEvent &mouse)
	Mouse button release event.

virtual bool	MouseDoubleClickEvent (const vtkContextMouseEvent &mouse)
	Mouse button double click event.

virtual bool	MouseWheelEvent (const vtkContextMouseEvent &mouse, int delta)
	Mouse wheel event, positive delta indicates forward movement of the wheel.

virtual bool	KeyPressEvent (const vtkContextKeyEvent &key)
	Key press event.

virtual bool	KeyReleaseEvent (const vtkContextKeyEvent &key)
	Key release event.

virtual void	SetScene (vtkContextScene *scene)
	Set the vtkContextScene for the item, always set for an item in a scene.

vtkContextScene *	GetScene ()
	Get the vtkContextScene for the item, always set for an item in a scene.

virtual void	SetParent (vtkAbstractContextItem *parent)
	Set the parent item.

vtkAbstractContextItem *	GetParent ()
	Get the parent item.

virtual vtkVector2f	MapToParent (const vtkVector2f &point)
	Maps the point to the parent coordinate system.

virtual vtkVector2f	MapFromParent (const vtkVector2f &point)
	Maps the point from the parent coordinate system.

virtual vtkVector2f	MapToScene (const vtkVector2f &point)
	Maps the point to the scene coordinate system.

virtual vtkVector2f	MapFromScene (const vtkVector2f &point)
	Maps the point from the scene coordinate system.

virtual bool	GetVisible ()
	Get the visibility of the item (should it be drawn).

virtual void	SetVisible (bool)
	Set the visibility of the item (should it be drawn).

virtual bool	GetInteractive ()
	Get if the item is interactive (should respond to mouse events).

virtual void	SetInteractive (bool)
	Set if the item is interactive (should respond to mouse events).

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on.

virtual void	DebugOff ()
	Turn debugging output off.

bool	GetDebug ()
	Get the value of the debug flag.

void	SetDebug (bool debugFlag)
	Set the value of the debug flag.

virtual void	Modified ()
	Update the modification time for this object.

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

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)

vtkTypeBool	InvokeEvent (unsigned long event)

vtkTypeBool	InvokeEvent (const char *event)

std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

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.

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.

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.

vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.

vtkTypeBool	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not.

virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.

virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.

virtual std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.

virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

virtual void	Delete ()
	Delete a VTK object.

virtual void	FastDelete ()
	Delete a reference to this object.

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream.

void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).

int	GetReferenceCount ()
	Return the current reference count of this object.

void	SetReferenceCount (int)
	Sets the reference count.

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses `vtkGarbageCollector` or not.

Static Public Member Functions
static vtkTypeBool	IsTypeOf (const char *type)

static vtkPlot *	SafeDownCast (vtkObjectBase *o)

static void	FilterSelectedPoints (vtkDataArray points, vtkDataArray selectedPoints, vtkIdTypeArray *selectedIds)
	Utility function that fills up `selectedPoints` with tuples from `points`.

Static Public Member Functions inherited from vtkContextItem
static vtkTypeBool	IsTypeOf (const char *type)

static vtkContextItem *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkAbstractContextItem
static vtkTypeBool	IsTypeOf (const char *type)

static vtkAbstractContextItem *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.

static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

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.

static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkPlot ()

	~vtkPlot () override

vtkStdString	GetNumber (double position, vtkAxis *axis)
	Get the properly formatted number for the supplied position and axis.

virtual bool	CacheRequiresUpdate ()
	Test if the internal cache requires an update.


virtual void	TransformScreenToData (const vtkVector2f &in, vtkVector2f &out)
	Transform the mouse event in the control-points space.

virtual void	TransformDataToScreen (const vtkVector2f &in, vtkVector2f &out)
	Transform the mouse event in the control-points space.

virtual void	TransformScreenToData (double inX, double inY, double &outX, double &outY)
	Transform the mouse event in the control-points space.

virtual void	TransformDataToScreen (double inX, double inY, double &outX, double &outY)
	Transform the mouse event in the control-points space.

Protected Member Functions inherited from vtkContextItem
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkContextItem ()=default

	~vtkContextItem () override

Protected Member Functions inherited from vtkAbstractContextItem
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkAbstractContextItem ()

	~vtkAbstractContextItem () override

virtual void	ReleaseGraphicsCache ()
	Release cache entries created by this context item.

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.

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

virtual void	ObjectFinalize ()

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkTimeStamp	BuildTime
	The point cache is marked dirty until it has been initialized.

vtkSmartPointer< vtkPen >	Pen
	This object stores the vtkPen that controls how the plot is drawn.

vtkSmartPointer< vtkBrush >	Brush
	This object stores the vtkBrush that controls how the plot is drawn.

vtkSmartPointer< vtkPen >	SelectionPen
	This object stores the vtkPen that controls how the selected elements of the plot are drawn.

vtkSmartPointer< vtkBrush >	SelectionBrush
	This object stores the vtkBrush that controls how the selected elements of the plot are drawn.

vtkSmartPointer< vtkStringArray >	Labels
	Plot labels, used by legend.

vtkSmartPointer< vtkStringArray >	AutoLabels
	Holds Labels when they're auto-created.

vtkSmartPointer< vtkStringArray >	IndexedLabels
	Holds Labels when they're auto-created.

bool	UseIndexForXSeries
	Use the Y array index for the X value.

vtkSmartPointer< vtkContextMapper2D >	Data
	This data member contains the data that will be plotted, it inherits from vtkAlgorithm.

bool	Selectable
	Whether plot points can be selected or not.

vtkIdTypeArray *	Selection
	Selected indices for the table the plot is rendering.

vtkAxis *	XAxis
	The X axis associated with this plot.

vtkAxis *	YAxis
	The X axis associated with this plot.

vtkStdString	TooltipLabelFormat
	A printf-style string to build custom tooltip labels from.

vtkStdString	TooltipDefaultLabelFormat
	The default printf-style string to build custom tooltip labels from.

int	TooltipNotation

int	TooltipPrecision

vtkRectd	ShiftScale
	The current shift in origin and scaling factor applied to the plot.

bool	LegendVisibility

Protected Attributes inherited from vtkContextItem
double	Opacity = 1.0

vtkContextTransform *	Transform = nullptr

Protected Attributes inherited from vtkAbstractContextItem
vtkContextScene *	Scene
	Point to the scene the item is on - can be null.

vtkAbstractContextItem *	Parent
	Point to the parent item - can be null.

vtkContextScenePrivate *	Children
	This structure provides a list of children, along with convenience functions to paint the children etc.

bool	Visible
	Store the visibility of the item (default is true).

bool	Interactive
	Store whether the item should respond to interactions (default is true).

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

std::string	ObjectName

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

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.

virtual bool	ClampPos (double pos[2])
	Clamp the given 2D pos into the provided bounds Return true if the pos has been clamped, false otherwise.

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Detailed Description

Abstract class for 2D plots.

The base class for all plot types used in vtkChart derived charts.

See also: vtkPlotPoints vtkPlotLine vtkPlotBar vtkChart vtkChartXY

Examples:: vtkPlot (Examples)

Online Examples:

KDTreeTimingDemo

ModifiedBSPTreeTimingDemo

Tests:: vtkPlot (Tests)

Definition at line 153 of file vtkPlot.h.

Member Typedef Documentation

◆ Superclass

typedef vtkContextItem vtkPlot::Superclass

Definition at line 156 of file vtkPlot.h.

Constructor & Destructor Documentation

◆ vtkPlot()

vtkPlot::vtkPlot ( )

protected

◆ ~vtkPlot()

vtkPlot::~vtkPlot ( )

overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

static

◆ IsA()

virtual vtkTypeBool vtkPlot::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 vtkContextItem.

Reimplemented in vtkColorTransferControlPointsItem, vtkColorTransferFunctionItem, vtkCompositeControlPointsItem, vtkCompositeTransferFunctionItem, vtkControlPointsItem, vtkLookupTableItem, vtkPiecewiseControlPointsItem, vtkPiecewiseFunctionItem, vtkPlotArea, vtkPlotBag, vtkPlotBar, vtkPlotBarRangeHandlesItem, vtkPlotBox, vtkPlotFunctionalBag, vtkPlotHistogram2D, vtkPlotLine, vtkPlotParallelCoordinates, vtkPlotPie, vtkPlotPoints, vtkPlotRangeHandlesItem, vtkPlotStacked, vtkRangeHandlesItem, and vtkScalarsToColorsItem.

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkPlot::NewInstanceInternal ( ) const

protectedvirtual

◆ NewInstance()

vtkPlot * vtkPlot::NewInstance ( ) const

◆ PrintSelf()

void vtkPlot::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 vtkContextItem.

Reimplemented in vtkPlotArea, vtkPlotBag, vtkPlotBar, vtkPlotBarRangeHandlesItem, vtkPlotBox, vtkPlotFunctionalBag, vtkPlotHistogram2D, vtkPlotLine, vtkPlotParallelCoordinates, vtkPlotPie, vtkPlotPoints, vtkPlotRangeHandlesItem, vtkPlotStacked, vtkRangeHandlesItem, and vtkScalarsToColorsItem.

◆ Update()

void vtkPlot::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.

Reimplemented in vtkPlotHistogram2D.

◆ SetLegendVisibility()

virtual void vtkPlot::SetLegendVisibility ( bool )

virtual

Set whether the plot renders an entry in the legend.

Default is true. vtkPlot::PaintLegend will get called to render the legend marker on when this is true.

◆ GetLegendVisibility()

virtual bool vtkPlot::GetLegendVisibility ( )

virtual

Set whether the plot renders an entry in the legend.

Default is true. vtkPlot::PaintLegend will get called to render the legend marker on when this is true.

◆ LegendVisibilityOn()

virtual void vtkPlot::LegendVisibilityOn ( )

virtual

Set whether the plot renders an entry in the legend.

Default is true. vtkPlot::PaintLegend will get called to render the legend marker on when this is true.

◆ LegendVisibilityOff()

virtual void vtkPlot::LegendVisibilityOff ( )

virtual

Set whether the plot renders an entry in the legend.

Default is true. vtkPlot::PaintLegend will get called to render the legend marker on when this is true.

◆ PaintLegend()

virtual bool vtkPlot::PaintLegend	(	vtkContext2D *	painter,
		const vtkRectf &	rect,
		int	legendIndex
	)

virtual

Paint legend event for the 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. The index is used by Plots that return more than one label.

Reimplemented in vtkPlotArea, vtkPlotBag, vtkPlotBar, vtkPlotBox, vtkPlotFunctionalBag, vtkPlotLine, vtkPlotParallelCoordinates, vtkPlotPie, vtkPlotPoints, and vtkPlotStacked.

◆ SetTooltipLabelFormat()

virtual void vtkPlot::SetTooltipLabelFormat ( const vtkStdString & label )

virtual

Sets/gets a printf-style string to build custom tooltip labels from.

An empty string generates the default tooltip labels. The following case-sensitive format tags (without quotes) are recognized: 'x' The X value of the plot element 'y' The Y value of the plot element 'i' The IndexedLabels entry for the plot element 'l' The value of the plot's GetLabel() function 's' (vtkPlotBar only) The Labels entry for the bar segment Any other characters or unrecognized format tags are printed in the tooltip label verbatim.

◆ GetTooltipLabelFormat()

virtual vtkStdString vtkPlot::GetTooltipLabelFormat ( )

virtual

Sets/gets a printf-style string to build custom tooltip labels from.

An empty string generates the default tooltip labels. The following case-sensitive format tags (without quotes) are recognized: 'x' The X value of the plot element 'y' The Y value of the plot element 'i' The IndexedLabels entry for the plot element 'l' The value of the plot's GetLabel() function 's' (vtkPlotBar only) The Labels entry for the bar segment Any other characters or unrecognized format tags are printed in the tooltip label verbatim.

◆ SetTooltipNotation()

virtual void vtkPlot::SetTooltipNotation ( int notation )

virtual

Sets/gets the tooltip notation style.

◆ GetTooltipNotation()

virtual int vtkPlot::GetTooltipNotation ( )

virtual

Sets/gets the tooltip notation style.

◆ SetTooltipPrecision()

virtual void vtkPlot::SetTooltipPrecision ( int precision )

virtual

Sets/gets the tooltip precision.

◆ GetTooltipPrecision()

virtual int vtkPlot::GetTooltipPrecision ( )

virtual

Sets/gets the tooltip precision.

◆ GetTooltipLabel()

virtual vtkStdString vtkPlot::GetTooltipLabel	(	const vtkVector2d &	plotPos,
		vtkIdType	seriesIndex,
		vtkIdType	segmentIndex
	)

virtual

Generate and return the tooltip label string for this plot The segmentIndex parameter is ignored, except for vtkPlotBar.

Reimplemented in vtkPlotArea, vtkPlotBag, vtkPlotBar, vtkPlotHistogram2D, and vtkScalarsToColorsItem.

◆ GetNearestPoint()

virtual vtkIdType vtkPlot::GetNearestPoint	(	const vtkVector2f &	point,
		const vtkVector2f &	tolerance,
		vtkVector2f *	location,
		vtkIdType *	segmentId
	)

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

Reimplemented in vtkPlotBar, vtkScalarsToColorsItem, vtkPlotArea, vtkPlotBar, vtkPlotBox, vtkPlotFunctionalBag, vtkPlotHistogram2D, vtkPlotPie, vtkPlotPoints, vtkPlotStacked, vtkScalarsToColorsItem, vtkPlotArea, vtkPlotBox, vtkPlotFunctionalBag, vtkPlotHistogram2D, vtkPlotPie, vtkPlotPoints, and vtkPlotStacked.

◆ SelectPoints()

virtual bool vtkPlot::SelectPoints	(	const vtkVector2f &	min,
		const vtkVector2f &	max
	)

virtual

Select all points in the specified rectangle.

Reimplemented in vtkControlPointsItem, vtkPlotBar, vtkPlotFunctionalBag, vtkPlotPoints, and vtkPlotStacked.

◆ SelectPointsInPolygon()

virtual bool vtkPlot::SelectPointsInPolygon ( const vtkContextPolygon & polygon )

virtual

Select all points in the specified polygon.

Reimplemented in vtkPlotFunctionalBag, and vtkPlotPoints.

◆ SetColor() [1/2]

virtual void vtkPlot::SetColor	(	unsigned char	r,
		unsigned char	g,
		unsigned char	b,
		unsigned char	a
	)

virtual

Set the plot color with integer values (comprised between 0 and 255)

Reimplemented in vtkPlotArea, vtkPlotBar, and vtkPlotStacked.

◆ SetColorF() [1/2]

virtual void vtkPlot::SetColorF	(	double	r,
		double	g,
		double	b,
		double	a
	)

virtual

Set the plot color with floating values (comprised between 0.0 and 1.0)

Reimplemented in vtkPlotArea, vtkPlotBar, and vtkPlotStacked.

◆ SetColorF() [2/2]

virtual void vtkPlot::SetColorF	(	double	r,
		double	g,
		double	b
	)

virtual

Set the plot color with floating values (comprised between 0.0 and 1.0)

Reimplemented in vtkPlotArea, vtkPlotBar, and vtkPlotStacked.

◆ SetColor() [2/2]

virtual void vtkPlot::SetColor	(	double	r,
		double	g,
		double	b
	)

inlinevirtual

Set the plot color with floating values (comprised between 0.0 and 1.0)

Reimplemented in vtkPlotArea, vtkPlotBar, and vtkPlotStacked.

Definition at line 264 of file vtkPlot.h.

◆ GetColor() [1/2]

void vtkPlot::GetColor ( unsigned char rgb[3] )

Get the plot color as integer rgb values (comprised between 0 and 255)

◆ GetColorRGBA()

void vtkPlot::GetColorRGBA ( unsigned char rgba[4] )

Get the plot color as integer rgb values (comprised between 0 and 255)

◆ GetColorF()

virtual void vtkPlot::GetColorF ( double rgb[3] )

virtual

Get the plot color as floating rgb values (comprised between 0.0 and 1.0)

Reimplemented in vtkPlotBar, and vtkPlotStacked.

◆ GetColor() [2/2]

virtual void vtkPlot::GetColor ( double rgb[3] )

inlinevirtual

Get the plot color as floating rgb values (comprised between 0.0 and 1.0)

Reimplemented in vtkPlotBar, and vtkPlotStacked.

Definition at line 286 of file vtkPlot.h.

◆ SetWidth()

virtual void vtkPlot::SetWidth ( float width )

virtual

@

Set the width of the line.

Reimplemented in vtkPlotBar.

◆ GetWidth()

virtual float vtkPlot::GetWidth ( )

virtual

Get the width of the line.

Reimplemented in vtkPlotBar.

◆ SetPen()

void vtkPlot::SetPen ( vtkPen * pen )

Set/get the vtkPen object that controls how this plot draws (out)lines.

◆ GetPen()

vtkPen * vtkPlot::GetPen ( )

Get the plot color as floating rgb values (comprised between 0.0 and 1.0)

◆ SetBrush()

void vtkPlot::SetBrush ( vtkBrush * brush )

Set/get the vtkBrush object that controls how this plot fills shapes.

◆ GetBrush()

vtkBrush * vtkPlot::GetBrush ( )

Set/get the vtkBrush object that controls how this plot fills shapes.

◆ SetSelectionPen()

void vtkPlot::SetSelectionPen ( vtkPen * pen )

Set/get the vtkBrush object that controls how this plot fills selected shapes.

◆ GetSelectionPen()

vtkPen * vtkPlot::GetSelectionPen ( )

Set/get the vtkBrush object that controls how this plot fills selected shapes.

◆ SetSelectionBrush()

void vtkPlot::SetSelectionBrush ( vtkBrush * brush )

Set/get the vtkBrush object that controls how this plot fills selected shapes.

◆ GetSelectionBrush()

vtkBrush * vtkPlot::GetSelectionBrush ( )

Set/get the vtkBrush object that controls how this plot fills selected shapes.

◆ SetLabel()

virtual void vtkPlot::SetLabel ( const vtkStdString & label )

virtual

Set the label of this plot.

◆ GetLabel() [1/2]

virtual vtkStdString vtkPlot::GetLabel ( )

virtual

Get the label of this plot.

◆ SetLabels()

virtual void vtkPlot::SetLabels ( vtkStringArray * labels )

virtual

Set the plot labels, these are used for stacked chart variants, with the index referring to the stacking index.

◆ GetLabels()

virtual vtkStringArray * vtkPlot::GetLabels ( )

virtual

Get the plot labels.

If this array has a length greater than 1 the index refers to the stacked objects in the plot. See vtkPlotBar for example.

Reimplemented in vtkPlotBag, vtkPlotBar, vtkPlotBox, and vtkPlotStacked.

◆ GetNumberOfLabels()

virtual int vtkPlot::GetNumberOfLabels ( )

virtual

Get the number of labels associated with this plot.

◆ GetLabel() [2/2]

vtkStdString vtkPlot::GetLabel ( vtkIdType index )

Get the label at the specified index.

◆ SetIndexedLabels()

void vtkPlot::SetIndexedLabels ( vtkStringArray * labels )

Set indexed labels for the plot.

If set, this array can be used to provide custom labels for each point in a plot. This array should be the same length as the points array. Default is null (no indexed labels).

◆ GetIndexedLabels()

virtual vtkStringArray * vtkPlot::GetIndexedLabels ( )

virtual

Get the indexed labels array.

◆ GetData()

vtkContextMapper2D * vtkPlot::GetData ( )

Get the data object that the plot will draw.

◆ GetUseIndexForXSeries()

virtual bool vtkPlot::GetUseIndexForXSeries ( )

virtual

Use the Y array index for the X value.

If true any X column setting will be ignored, and the X values will simply be the index of the Y column.

◆ SetUseIndexForXSeries()

virtual void vtkPlot::SetUseIndexForXSeries ( bool )

virtual

Use the Y array index for the X value.

If true any X column setting will be ignored, and the X values will simply be the index of the Y column.

◆ SetInputData() [1/3]

virtual void vtkPlot::SetInputData ( vtkTable * table )

virtual

This is a convenience function to set the input table and the x, y column for the plot.

Reimplemented in vtkPlotHistogram2D, vtkPlotBag, vtkPlotBox, and vtkPlotParallelCoordinates.

◆ SetInputData() [2/3]

virtual void vtkPlot::SetInputData	(	vtkTable *	table,
		const vtkStdString &	xColumn,
		const vtkStdString &	yColumn
	)

virtual

This is a convenience function to set the input table and the x, y column for the plot.

Reimplemented in vtkPlotHistogram2D, vtkPlotBox, vtkPlotParallelCoordinates, and vtkPlotBag.

◆ SetInputData() [3/3]

void vtkPlot::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.

◆ SetInputConnection()

virtual void vtkPlot::SetInputConnection ( vtkAlgorithmOutput * input )

virtual

This is a convenience function to set the input connection for the plot.

◆ GetInput()

virtual vtkTable * vtkPlot::GetInput ( )

virtual

Get the input table used by the plot.

◆ GetInputConnection()

vtkAlgorithmOutput * vtkPlot::GetInputConnection ( )

Get the input connection used by the plot.

◆ SetInputArray()

virtual void vtkPlot::SetInputArray	(	int	index,
		const vtkStdString &	name
	)

virtual

Convenience function to set the input arrays.

For most plots index 0 is the x axis, and index 1 is the y axis. The name is the name of the column in the vtkTable.

Reimplemented in vtkPlotArea, vtkPlotBar, and vtkPlotStacked.

◆ SetXAxisInputArrayToProcess()

void vtkPlot::SetXAxisInputArrayToProcess ( const std::string & name )

Convenient function to directly set/get the names of columns used for X and Y axis respectively.

◆ GetXAxisInputArrayToProcess()

std::string vtkPlot::GetXAxisInputArrayToProcess ( )

Convenient function to directly set/get the names of columns used for X and Y axis respectively.

◆ SetYAxisInputArrayToProcess()

void vtkPlot::SetYAxisInputArrayToProcess ( const std::string & name )

Convenient function to directly set/get the names of columns used for X and Y axis respectively.

◆ GetYAxisInputArrayToProcess()

std::string vtkPlot::GetYAxisInputArrayToProcess ( )

Convenient function to directly set/get the names of columns used for X and Y axis respectively.

◆ SetSelectable()

virtual void vtkPlot::SetSelectable ( bool )

virtual

Set whether the plot can be selected.

True by default. If not, then SetSelection(), SelectPoints() or SelectPointsInPolygon() won't have any effect.

See also: SetSelection(), SelectPoints(), SelectPointsInPolygon()

◆ GetSelectable()

virtual bool vtkPlot::GetSelectable ( )

virtual

Set whether the plot can be selected.

True by default. If not, then SetSelection(), SelectPoints() or SelectPointsInPolygon() won't have any effect.

See also: SetSelection(), SelectPoints(), SelectPointsInPolygon()

◆ SelectableOn()

virtual void vtkPlot::SelectableOn ( )

virtual

Set whether the plot can be selected.

True by default. If not, then SetSelection(), SelectPoints() or SelectPointsInPolygon() won't have any effect.

See also: SetSelection(), SelectPoints(), SelectPointsInPolygon()

◆ SelectableOff()

virtual void vtkPlot::SelectableOff ( )

virtual

Set whether the plot can be selected.

True by default. If not, then SetSelection(), SelectPoints() or SelectPointsInPolygon() won't have any effect.

See also: SetSelection(), SelectPoints(), SelectPointsInPolygon()

◆ SetSelection()

virtual void vtkPlot::SetSelection ( vtkIdTypeArray * id )

virtual

Sets the list of points that must be selected.

If Selectable is false, then this method does nothing.

See also: SetSelectable()

◆ GetSelection()

virtual vtkIdTypeArray * vtkPlot::GetSelection ( )

virtual

Sets the list of points that must be selected.

If Selectable is false, then this method does nothing.

See also: SetSelectable()

◆ GetXAxis()

virtual vtkAxis * vtkPlot::GetXAxis ( )

virtual

Get/set the X axis associated with this plot.

◆ SetXAxis()

virtual void vtkPlot::SetXAxis ( vtkAxis * axis )

virtual

Get/set the X axis associated with this plot.

◆ GetYAxis()

virtual vtkAxis * vtkPlot::GetYAxis ( )

virtual

Get/set the Y axis associated with this plot.

◆ SetYAxis()

virtual void vtkPlot::SetYAxis ( vtkAxis * axis )

virtual

Get/set the Y axis associated with this plot.

◆ SetShiftScale()

void vtkPlot::SetShiftScale ( const vtkRectd & shiftScale )

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.

The chart that owns the plot should set this and ensure the appropriate matrix is used when rendering the plot.

◆ GetShiftScale()

vtkRectd vtkPlot::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.

The chart that owns the plot should set this and ensure the appropriate matrix is used when rendering the plot.

◆ GetBounds()

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

inlinevirtual

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

See GetUnscaledInputBounds for more information.

Reimplemented in vtkControlPointsItem, vtkPlotArea, vtkPlotBar, vtkPlotBarRangeHandlesItem, vtkPlotFunctionalBag, vtkPlotHistogram2D, vtkPlotParallelCoordinates, vtkPlotPoints, vtkPlotRangeHandlesItem, vtkPlotStacked, vtkRangeHandlesItem, and vtkScalarsToColorsItem.

Definition at line 502 of file vtkPlot.h.

◆ GetUnscaledInputBounds()

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

inlinevirtual

Provide un-log-scaled bounds for the plot inputs.

This function is analogous to GetBounds() with 2 exceptions:

It will never return log-scaled bounds even when the x- and/or y-axes are log-scaled.
It will always return the bounds along the input axes rather than the output chart coordinates. Thus GetXAxis() returns the axis associated with the first 2 bounds entries and GetYAxis() returns the axis associated with the next 2 bounds entries.

For example, vtkPlotBar's GetBounds() method will swap axis bounds when its orientation is vertical while its GetUnscaledInputBounds() will not swap axis bounds.

This method is provided so user interfaces can determine whether or not to allow log-scaling of a particular vtkAxis.

Subclasses of vtkPlot are responsible for implementing this function to transform input plot data.

The returned bounds are stored as (Xmin, Xmax, Ymin, Ymax).

Reimplemented in vtkPlotBar, vtkPlotFunctionalBag, vtkPlotPoints, and vtkPlotStacked.

Definition at line 528 of file vtkPlot.h.

◆ SetProperty()

virtual void vtkPlot::SetProperty	(	const vtkStdString &	property,
		const vtkVariant &	var
	)

virtual

A General setter/getter that should be overridden.

It can silently drop options, case is important

◆ GetProperty()

virtual vtkVariant vtkPlot::GetProperty ( const vtkStdString & property )

virtual

A General setter/getter that should be overridden.

It can silently drop options, case is important

◆ ClampPos() [1/2]

static bool vtkPlot::ClampPos	(	double	pos[2],
		double	bounds[4]
	)

static

Clamp the given 2D pos into the provided bounds Return true if the pos has been clamped, false otherwise.

◆ ClampPos() [2/2]

virtual bool vtkPlot::ClampPos ( double pos[2] )

virtual

Clamp the given 2D pos into the provided bounds Return true if the pos has been clamped, false otherwise.

◆ Hit()

bool vtkPlot::Hit ( const vtkContextMouseEvent & mouse )

overridevirtual

Returns true if the supplied x, y coordinate is inside the item.

Reimplemented from vtkAbstractContextItem.

Reimplemented in vtkPlotRangeHandlesItem.

◆ UpdateCache()

virtual bool vtkPlot::UpdateCache ( )

inlinevirtual

Update the internal cache.

Returns true if cache was successfully updated. Default does nothing. This method is called by Update() when either the plot's data has changed or CacheRequiresUpdate() returns true. It is not necessary to call this method explicitly.

Reimplemented in vtkPlotArea, vtkPlotBag, vtkPlotBar, vtkPlotBox, vtkPlotFunctionalBag, vtkPlotHistogram2D, vtkPlotParallelCoordinates, vtkPlotPie, vtkPlotPoints, and vtkPlotStacked.

Definition at line 564 of file vtkPlot.h.

◆ FilterSelectedPoints()

static void vtkPlot::FilterSelectedPoints	(	vtkDataArray *	points,
		vtkDataArray *	selectedPoints,
		vtkIdTypeArray *	selectedIds
	)

static

Utility function that fills up selectedPoints with tuples from points.

Indices from selectedIds are used to index into points.

◆ GetNumber()

vtkStdString vtkPlot::GetNumber	(	double	position,
		vtkAxis *	axis
	)

protected

Get the properly formatted number for the supplied position and axis.

◆ TransformScreenToData() [1/2]

virtual void vtkPlot::TransformScreenToData	(	const vtkVector2f &	in,
		vtkVector2f &	out
	)

protectedvirtual

Transform the mouse event in the control-points space.

This is needed when using logScale or shiftscale.

Reimplemented in vtkPlotRangeHandlesItem.

◆ TransformDataToScreen() [1/2]

virtual void vtkPlot::TransformDataToScreen	(	const vtkVector2f &	in,
		vtkVector2f &	out
	)

protectedvirtual

Transform the mouse event in the control-points space.

This is needed when using logScale or shiftscale.

Reimplemented in vtkPlotRangeHandlesItem.

◆ TransformScreenToData() [2/2]

virtual void vtkPlot::TransformScreenToData	(	double	inX,
		double	inY,
		double &	outX,
		double &	outY
	)

protectedvirtual

Transform the mouse event in the control-points space.

This is needed when using logScale or shiftscale.

Reimplemented in vtkPlotRangeHandlesItem, and vtkPlotRangeHandlesItem.

◆ TransformDataToScreen() [2/2]

virtual void vtkPlot::TransformDataToScreen	(	double	inX,
		double	inY,
		double &	outX,
		double &	outY
	)

protectedvirtual

Transform the mouse event in the control-points space.

This is needed when using logScale or shiftscale.

Reimplemented in vtkPlotRangeHandlesItem, and vtkPlotRangeHandlesItem.

◆ CacheRequiresUpdate()

virtual bool vtkPlot::CacheRequiresUpdate ( )

protectedvirtual

Test if the internal cache requires an update.

Reimplemented in vtkPlotBar, vtkPlotFunctionalBag, vtkPlotPoints, and vtkPlotStacked.

Member Data Documentation

◆ BuildTime

vtkTimeStamp vtkPlot::BuildTime

protected

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

Definition at line 601 of file vtkPlot.h.

◆ Pen

vtkSmartPointer<vtkPen> vtkPlot::Pen

protected

This object stores the vtkPen that controls how the plot is drawn.

Definition at line 606 of file vtkPlot.h.

◆ Brush

vtkSmartPointer<vtkBrush> vtkPlot::Brush

protected

This object stores the vtkBrush that controls how the plot is drawn.

Definition at line 611 of file vtkPlot.h.

◆ SelectionPen

vtkSmartPointer<vtkPen> vtkPlot::SelectionPen

protected

This object stores the vtkPen that controls how the selected elements of the plot are drawn.

Definition at line 617 of file vtkPlot.h.

◆ SelectionBrush

vtkSmartPointer<vtkBrush> vtkPlot::SelectionBrush

protected

This object stores the vtkBrush that controls how the selected elements of the plot are drawn.

Definition at line 623 of file vtkPlot.h.

◆ Labels

vtkSmartPointer<vtkStringArray> vtkPlot::Labels

protected

Plot labels, used by legend.

Definition at line 628 of file vtkPlot.h.

◆ AutoLabels

vtkSmartPointer<vtkStringArray> vtkPlot::AutoLabels

protected

Holds Labels when they're auto-created.

Definition at line 633 of file vtkPlot.h.

◆ IndexedLabels

vtkSmartPointer<vtkStringArray> vtkPlot::IndexedLabels

protected

Holds Labels when they're auto-created.

Definition at line 638 of file vtkPlot.h.

◆ UseIndexForXSeries

bool vtkPlot::UseIndexForXSeries

protected

Use the Y array index for the X value.

If true any X column setting will be ignored, and the X values will simply be the index of the Y column.

Definition at line 644 of file vtkPlot.h.

◆ Data

vtkSmartPointer<vtkContextMapper2D> vtkPlot::Data

protected

This data member contains the data that will be plotted, it inherits from vtkAlgorithm.

Definition at line 650 of file vtkPlot.h.

◆ Selectable

bool vtkPlot::Selectable

protected

Whether plot points can be selected or not.

Definition at line 655 of file vtkPlot.h.

◆ Selection

vtkIdTypeArray* vtkPlot::Selection

protected

Selected indices for the table the plot is rendering.

Definition at line 660 of file vtkPlot.h.

◆ XAxis

vtkAxis* vtkPlot::XAxis

protected

The X axis associated with this plot.

Definition at line 665 of file vtkPlot.h.

◆ YAxis

vtkAxis* vtkPlot::YAxis

protected

The X axis associated with this plot.

Definition at line 670 of file vtkPlot.h.

◆ TooltipLabelFormat

vtkStdString vtkPlot::TooltipLabelFormat

protected

A printf-style string to build custom tooltip labels from.

See the accessor/mutator functions for full documentation.

Definition at line 676 of file vtkPlot.h.

◆ TooltipDefaultLabelFormat

vtkStdString vtkPlot::TooltipDefaultLabelFormat

protected

The default printf-style string to build custom tooltip labels from.

See the accessor/mutator functions for full documentation.

Definition at line 682 of file vtkPlot.h.

◆ TooltipNotation

int vtkPlot::TooltipNotation

protected

Definition at line 684 of file vtkPlot.h.

◆ TooltipPrecision

int vtkPlot::TooltipPrecision

protected

Definition at line 685 of file vtkPlot.h.

◆ ShiftScale

vtkRectd vtkPlot::ShiftScale

protected

The current shift in origin and scaling factor applied to the plot.

Definition at line 690 of file vtkPlot.h.

◆ LegendVisibility

bool vtkPlot::LegendVisibility

protected

Definition at line 692 of file vtkPlot.h.

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

Charts/Core/vtkPlot.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkPlot()

◆ ~vtkPlot()

Member Function Documentation

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ Update()

◆ SetLegendVisibility()

◆ GetLegendVisibility()

◆ LegendVisibilityOn()

◆ LegendVisibilityOff()

◆ PaintLegend()

◆ SetTooltipLabelFormat()

◆ GetTooltipLabelFormat()

◆ SetTooltipNotation()

◆ GetTooltipNotation()

◆ SetTooltipPrecision()

◆ GetTooltipPrecision()

◆ GetTooltipLabel()

◆ GetNearestPoint()

◆ SelectPoints()

◆ SelectPointsInPolygon()

◆ SetColor() [1/2]

◆ SetColorF() [1/2]

◆ SetColorF() [2/2]

◆ SetColor() [2/2]

◆ GetColor() [1/2]

◆ GetColorRGBA()

◆ GetColorF()

◆ GetColor() [2/2]

◆ SetWidth()

◆ GetWidth()

◆ SetPen()

◆ GetPen()

◆ SetBrush()

◆ GetBrush()

◆ SetSelectionPen()

◆ GetSelectionPen()

◆ SetSelectionBrush()

◆ GetSelectionBrush()

◆ SetLabel()

◆ GetLabel() [1/2]

◆ SetLabels()

◆ GetLabels()

◆ GetNumberOfLabels()

◆ GetLabel() [2/2]

◆ SetIndexedLabels()

◆ GetIndexedLabels()

◆ GetData()

◆ GetUseIndexForXSeries()

◆ SetUseIndexForXSeries()

◆ SetInputData() [1/3]

◆ SetInputData() [2/3]

◆ SetInputData() [3/3]

◆ SetInputConnection()

◆ GetInput()

◆ GetInputConnection()

◆ SetInputArray()

◆ SetXAxisInputArrayToProcess()

◆ GetXAxisInputArrayToProcess()

◆ SetYAxisInputArrayToProcess()

◆ GetYAxisInputArrayToProcess()

◆ SetSelectable()

◆ GetSelectable()

◆ SelectableOn()

◆ SelectableOff()

◆ SetSelection()