VTK
9.1.0
|
Abstract class for 3D plots. More...
#include <vtkPlot3D.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. | |
vtkPlot3D * | NewInstance () const |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. | |
virtual void | SetColors (vtkDataArray *colorArr) |
Set the color of each point in the plot. | |
std::vector< vtkVector3f > | GetPoints () |
Get all the data points within this plot. | |
std::string | GetXAxisLabel () |
Get the label for the X axis. | |
std::string | GetYAxisLabel () |
Get the label for the Y axis. | |
std::string | GetZAxisLabel () |
Get the label for the Z axis. | |
std::vector< vtkVector3f > | GetDataBounds () |
Get the bounding cube surrounding the currently rendered data points. | |
void | SetPen (vtkPen *pen) |
Set/get the vtkPen object that controls how this plot draws (out)lines. | |
vtkPen * | GetPen () |
Set/get the vtkPen object that controls how this plot draws (out)lines. | |
void | SetSelectionPen (vtkPen *pen) |
Set/get the vtkPen object that controls how this plot draws (out)lines. | |
vtkPen * | GetSelectionPen () |
Set/get the vtkPen object that controls how this plot draws (out)lines. | |
virtual void | SetInputData (vtkTable *input) |
Set the input to the plot. | |
virtual void | SetInputData (vtkTable *input, const vtkStdString &xName, const vtkStdString &yName, const vtkStdString &zName) |
Set the input to the plot. | |
virtual void | SetInputData (vtkTable *input, const vtkStdString &xName, const vtkStdString &yName, const vtkStdString &zName, const vtkStdString &colorName) |
Set the input to the plot. | |
virtual void | SetInputData (vtkTable *input, vtkIdType xColumn, vtkIdType yColumn, vtkIdType zColumn) |
Set the input to the plot. | |
virtual vtkChartXYZ * | GetChart () |
Get/set the chart for this plot. | |
virtual void | SetChart (vtkChartXYZ *chart) |
Get/set the chart for this plot. | |
virtual void | SetSelection (vtkIdTypeArray *id) |
Set/get the selection array for the plot. | |
virtual vtkIdTypeArray * | GetSelection () |
Set/get the selection array for the plot. | |
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) |
int | InvokeEvent (unsigned long event) |
int | InvokeEvent (const char *event) |
unsigned long | AddObserver (unsigned long event, vtkCommand *, float priority=0.0f) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
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. | |
int | InvokeEvent (unsigned long event, void *callData) |
This method invokes an event and return whether the event was aborted or not. | |
int | InvokeEvent (const char *event, void *callData) |
This method invokes an event and return whether the event was aborted or not. | |
Public Member Functions inherited from vtkObjectBase | |
const char * | GetClassName () const |
Return the class name as a string. | |
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. | |
virtual 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. | |
Static Public Member Functions | |
static vtkTypeBool | IsTypeOf (const char *type) |
static vtkPlot3D * | SafeDownCast (vtkObjectBase *o) |
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 (int 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 int | 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 |
vtkPlot3D () | |
~vtkPlot3D () override | |
virtual void | ComputeDataBounds () |
Generate a bounding cube for our data. | |
Protected Member Functions inherited from vtkContextItem | |
virtual vtkObjectBase * | NewInstanceInternal () const |
vtkContextItem ()=default | |
~vtkContextItem () override=default | |
Protected Member Functions inherited from vtkAbstractContextItem | |
virtual vtkObjectBase * | NewInstanceInternal () const |
vtkAbstractContextItem () | |
~vtkAbstractContextItem () override | |
Protected Member Functions inherited from vtkObject | |
vtkObject () | |
~vtkObject () override | |
void | RegisterInternal (vtkObjectBase *, vtkTypeBool check) override |
void | UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override |
void | InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr) |
These methods allow a command to exclusively grab all events. | |
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 *) |
vtkObjectBase (const vtkObjectBase &) | |
void | operator= (const vtkObjectBase &) |
Protected Attributes | |
vtkSmartPointer< vtkPen > | Pen |
This object stores the vtkPen that controls how the plot is drawn. | |
vtkSmartPointer< vtkPen > | SelectionPen |
This object stores the vtkPen that controls how the plot is drawn. | |
vtkNew< vtkUnsignedCharArray > | Colors |
This array assigns a color to each datum in the plot. | |
int | NumberOfComponents |
Number of components in our color vectors. | |
std::string | XAxisLabel |
The label for the X Axis. | |
std::string | YAxisLabel |
The label for the Y Axis. | |
std::string | ZAxisLabel |
The label for the Z Axis. | |
std::vector< vtkVector3f > | Points |
The data points read in during SetInputData(). | |
vtkTimeStamp | PointsBuildTime |
When the points were last built. | |
vtkChartXYZ * | Chart |
The chart containing this plot. | |
std::vector< vtkVector3f > | DataBounds |
A bounding cube surrounding the currently rendered data points. | |
vtkSmartPointer< vtkIdTypeArray > | Selection |
Selected indices for the table the plot is rendering. | |
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 |
Protected Attributes inherited from vtkObjectBase | |
std::atomic< int32_t > | ReferenceCount |
vtkWeakPointerBase ** | WeakPointers |
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 3D plots.
The base class for all plot types used in vtkChart derived charts.
Definition at line 44 of file vtkPlot3D.h.
typedef vtkContextItem vtkPlot3D::Superclass |
Definition at line 47 of file vtkPlot3D.h.
|
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 vtkPlotLine3D, vtkPlotPoints3D, and vtkPlotSurface.
|
static |
|
protectedvirtual |
Reimplemented from vtkContextItem.
Reimplemented in vtkPlotLine3D, vtkPlotPoints3D, and vtkPlotSurface.
vtkPlot3D * vtkPlot3D::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 vtkObjectBase.
Reimplemented in vtkPlotLine3D, vtkPlotPoints3D, and vtkPlotSurface.
void vtkPlot3D::SetPen | ( | vtkPen * | pen | ) |
Set/get the vtkPen object that controls how this plot draws (out)lines.
vtkPen * vtkPlot3D::GetPen | ( | ) |
Set/get the vtkPen object that controls how this plot draws (out)lines.
void vtkPlot3D::SetSelectionPen | ( | vtkPen * | pen | ) |
Set/get the vtkPen object that controls how this plot draws (out)lines.
vtkPen * vtkPlot3D::GetSelectionPen | ( | ) |
Set/get the vtkPen object that controls how this plot draws (out)lines.
|
virtual |
Set the input to the plot.
Reimplemented in vtkPlotSurface.
|
virtual |
Set the input to the plot.
Reimplemented in vtkPlotSurface.
|
virtual |
Set the input to the plot.
Reimplemented in vtkPlotSurface.
|
virtual |
Set the input to the plot.
Reimplemented in vtkPlotSurface.
|
virtual |
Set the color of each point in the plot.
The input is a single component scalar array. The values of this array will be passed through a lookup table to generate the color for each data point in the plot.
std::vector< vtkVector3f > vtkPlot3D::GetPoints | ( | ) |
Get all the data points within this plot.
|
virtual |
Get/set the chart for this plot.
|
virtual |
Get/set the chart for this plot.
std::string vtkPlot3D::GetXAxisLabel | ( | ) |
Get the label for the X axis.
std::string vtkPlot3D::GetYAxisLabel | ( | ) |
Get the label for the Y axis.
std::string vtkPlot3D::GetZAxisLabel | ( | ) |
Get the label for the Z axis.
|
inline |
Get the bounding cube surrounding the currently rendered data points.
Definition at line 117 of file vtkPlot3D.h.
|
virtual |
Set/get the selection array for the plot.
|
virtual |
Set/get the selection array for the plot.
|
protectedvirtual |
Generate a bounding cube for our data.
|
protected |
This object stores the vtkPen that controls how the plot is drawn.
Definition at line 139 of file vtkPlot3D.h.
|
protected |
This object stores the vtkPen that controls how the plot is drawn.
Definition at line 144 of file vtkPlot3D.h.
|
protected |
This array assigns a color to each datum in the plot.
Definition at line 149 of file vtkPlot3D.h.
|
protected |
Number of components in our color vectors.
This value is initialized to zero. It's typically set to 3 or 4 if the points are to be colored.
Definition at line 155 of file vtkPlot3D.h.
|
protected |
The label for the X Axis.
Definition at line 160 of file vtkPlot3D.h.
|
protected |
The label for the Y Axis.
Definition at line 165 of file vtkPlot3D.h.
|
protected |
The label for the Z Axis.
Definition at line 170 of file vtkPlot3D.h.
|
protected |
The data points read in during SetInputData().
Definition at line 175 of file vtkPlot3D.h.
|
protected |
When the points were last built.
Definition at line 180 of file vtkPlot3D.h.
|
protected |
The chart containing this plot.
Definition at line 185 of file vtkPlot3D.h.
|
protected |
A bounding cube surrounding the currently rendered data points.
Definition at line 190 of file vtkPlot3D.h.
|
protected |
Selected indices for the table the plot is rendering.
Definition at line 195 of file vtkPlot3D.h.