VTK
9.4.20241108
|
Abstract class for 2D plots. More...
#include <vtkPlot.h>
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 () |
Abstract class for 2D plots.
The base class for all plot types used in vtkChart derived charts.
typedef vtkContextItem vtkPlot::Superclass |
|
protected |
|
overrideprotected |
|
static |
|
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.
|
static |
|
protectedvirtual |
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.
vtkPlot * vtkPlot::NewInstance | ( | ) | const |
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
virtual |
Sets/gets the tooltip notation style.
|
virtual |
Sets/gets the tooltip notation style.
|
virtual |
Sets/gets the tooltip precision.
|
virtual |
Sets/gets the tooltip precision.
|
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.
|
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.
|
virtual |
Select all points in the specified rectangle.
Reimplemented in vtkControlPointsItem, vtkPlotBar, vtkPlotFunctionalBag, vtkPlotPoints, and vtkPlotStacked.
|
virtual |
Select all points in the specified polygon.
Reimplemented in vtkPlotFunctionalBag, and vtkPlotPoints.
|
virtual |
Set the plot color with integer values (comprised between 0 and 255)
Reimplemented in vtkPlotArea, vtkPlotBar, and vtkPlotStacked.
|
virtual |
Set the plot color with floating values (comprised between 0.0 and 1.0)
Reimplemented in vtkPlotArea, vtkPlotBar, and vtkPlotStacked.
|
virtual |
Set the plot color with floating values (comprised between 0.0 and 1.0)
Reimplemented in vtkPlotArea, vtkPlotBar, and vtkPlotStacked.
|
inlinevirtual |
Set the plot color with floating values (comprised between 0.0 and 1.0)
Reimplemented in vtkPlotArea, vtkPlotBar, and vtkPlotStacked.
void vtkPlot::GetColor | ( | unsigned char | rgb[3] | ) |
Get the plot color as integer rgb values (comprised between 0 and 255)
void vtkPlot::GetColorRGBA | ( | unsigned char | rgba[4] | ) |
Get the plot color as integer rgb values (comprised between 0 and 255)
|
virtual |
Get the plot color as floating rgb values (comprised between 0.0 and 1.0)
Reimplemented in vtkPlotBar, and vtkPlotStacked.
|
inlinevirtual |
Get the plot color as floating rgb values (comprised between 0.0 and 1.0)
Reimplemented in vtkPlotBar, and vtkPlotStacked.
|
virtual |
|
virtual |
Get the width of the line.
Reimplemented in vtkPlotBar.
void vtkPlot::SetPen | ( | vtkPen * | pen | ) |
Set/get the vtkPen object that controls how this plot draws (out)lines.
vtkPen * vtkPlot::GetPen | ( | ) |
Get the plot color as floating rgb values (comprised between 0.0 and 1.0)
void vtkPlot::SetBrush | ( | vtkBrush * | brush | ) |
Set/get the vtkBrush object that controls how this plot fills shapes.
vtkBrush * vtkPlot::GetBrush | ( | ) |
Set/get the vtkBrush object that controls how this plot fills shapes.
void vtkPlot::SetSelectionPen | ( | vtkPen * | pen | ) |
Set/get the vtkBrush object that controls how this plot fills selected shapes.
vtkPen * vtkPlot::GetSelectionPen | ( | ) |
Set/get the vtkBrush object that controls how this plot fills selected shapes.
void vtkPlot::SetSelectionBrush | ( | vtkBrush * | brush | ) |
Set/get the vtkBrush object that controls how this plot fills selected shapes.
vtkBrush * vtkPlot::GetSelectionBrush | ( | ) |
Set/get the vtkBrush object that controls how this plot fills selected shapes.
|
virtual |
Set the label of this plot.
|
virtual |
Get the label of this plot.
|
virtual |
Set the plot labels, these are used for stacked chart variants, with the index referring to the stacking index.
|
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.
|
virtual |
Get the number of labels associated with this plot.
vtkStdString vtkPlot::GetLabel | ( | vtkIdType | index | ) |
Get the label at the specified index.
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).
|
virtual |
Get the indexed labels array.
vtkContextMapper2D * vtkPlot::GetData | ( | ) |
Get the data object that the plot will draw.
|
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.
|
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.
|
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.
|
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.
This is a convenience function to set the input table and the x, y column for the plot.
|
virtual |
This is a convenience function to set the input connection for the plot.
|
virtual |
Get the input table used by the plot.
vtkAlgorithmOutput * vtkPlot::GetInputConnection | ( | ) |
Get the input connection used by the plot.
|
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.
void vtkPlot::SetXAxisInputArrayToProcess | ( | const std::string & | name | ) |
Convenient function to directly set/get the names of columns used for X and Y axis respectively.
std::string vtkPlot::GetXAxisInputArrayToProcess | ( | ) |
Convenient function to directly set/get the names of columns used for X and Y axis respectively.
void vtkPlot::SetYAxisInputArrayToProcess | ( | const std::string & | name | ) |
Convenient function to directly set/get the names of columns used for X and Y axis respectively.
std::string vtkPlot::GetYAxisInputArrayToProcess | ( | ) |
Convenient function to directly set/get the names of columns used for X and Y axis respectively.
|
virtual |
Set whether the plot can be selected.
True by default. If not, then SetSelection(), SelectPoints() or SelectPointsInPolygon() won't have any effect.
|
virtual |
Set whether the plot can be selected.
True by default. If not, then SetSelection(), SelectPoints() or SelectPointsInPolygon() won't have any effect.
|
virtual |
Set whether the plot can be selected.
True by default. If not, then SetSelection(), SelectPoints() or SelectPointsInPolygon() won't have any effect.
|
virtual |
Set whether the plot can be selected.
True by default. If not, then SetSelection(), SelectPoints() or SelectPointsInPolygon() won't have any effect.
|
virtual |
Sets the list of points that must be selected.
If Selectable is false, then this method does nothing.
|
virtual |
Sets the list of points that must be selected.
If Selectable is false, then this method does nothing.
|
virtual |
Get/set the X axis associated with this plot.
|
virtual |
Get/set the X axis associated with this plot.
|
virtual |
Get/set the Y axis associated with this plot.
|
virtual |
Get/set the Y axis associated with this plot.
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.
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.
|
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.
|
inlinevirtual |
Provide un-log-scaled bounds for the plot inputs.
This function is analogous to GetBounds() with 2 exceptions:
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.
|
virtual |
A General setter/getter that should be overridden.
It can silently drop options, case is important
|
virtual |
A General setter/getter that should be overridden.
It can silently drop options, case is important
|
static |
Clamp the given 2D pos into the provided bounds Return true if the pos has been clamped, false otherwise.
|
virtual |
Clamp the given 2D pos into the provided bounds Return true if the pos has been clamped, false otherwise.
|
overridevirtual |
Returns true if the supplied x, y coordinate is inside the item.
Reimplemented from vtkAbstractContextItem.
Reimplemented in vtkPlotRangeHandlesItem.
|
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.
|
static |
Utility function that fills up selectedPoints
with tuples from points
.
Indices from selectedIds
are used to index into points
.
|
protected |
Get the properly formatted number for the supplied position and axis.
|
protectedvirtual |
Transform the mouse event in the control-points space.
This is needed when using logScale or shiftscale.
Reimplemented in vtkPlotRangeHandlesItem.
|
protectedvirtual |
Transform the mouse event in the control-points space.
This is needed when using logScale or shiftscale.
Reimplemented in vtkPlotRangeHandlesItem.
|
protectedvirtual |
Transform the mouse event in the control-points space.
This is needed when using logScale or shiftscale.
Reimplemented in vtkPlotRangeHandlesItem, and vtkPlotRangeHandlesItem.
|
protectedvirtual |
Transform the mouse event in the control-points space.
This is needed when using logScale or shiftscale.
Reimplemented in vtkPlotRangeHandlesItem, and vtkPlotRangeHandlesItem.
|
protectedvirtual |
Test if the internal cache requires an update.
Reimplemented in vtkPlotBar, vtkPlotFunctionalBag, vtkPlotPoints, and vtkPlotStacked.
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
This data member contains the data that will be plotted, it inherits from vtkAlgorithm.
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |