VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkPlot3D Class Reference

Abstract class for 3D plots. More...

#include <vtkPlot3D.h>

Inheritance diagram for vtkPlot3D:
[legend]
Collaboration diagram for vtkPlot3D:
[legend]

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. More...
 
vtkPlot3DNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void SetColors (vtkDataArray *colorArr)
 Set the color of each point in the plot. More...
 
std::vector< vtkVector3fGetPoints ()
 Get all the data points within this plot. More...
 
std::string GetXAxisLabel ()
 Get the label for the X axis. More...
 
std::string GetYAxisLabel ()
 Get the label for the Y axis. More...
 
std::string GetZAxisLabel ()
 Get the label for the Z axis. More...
 
std::vector< vtkVector3fGetDataBounds ()
 Get the bounding cube surrounding the currently rendered data points. More...
 
void SetPen (vtkPen *pen)
 Set/get the vtkPen object that controls how this plot draws (out)lines. More...
 
vtkPenGetPen ()
 Set/get the vtkPen object that controls how this plot draws (out)lines. More...
 
void SetSelectionPen (vtkPen *pen)
 Set/get the vtkPen object that controls how this plot draws (out)lines. More...
 
vtkPenGetSelectionPen ()
 Set/get the vtkPen object that controls how this plot draws (out)lines. More...
 
virtual void SetInputData (vtkTable *input)
 Set the input to the plot. More...
 
virtual void SetInputData (vtkTable *input, const vtkStdString &xName, const vtkStdString &yName, const vtkStdString &zName)
 Set the input to the plot. More...
 
virtual void SetInputData (vtkTable *input, const vtkStdString &xName, const vtkStdString &yName, const vtkStdString &zName, const vtkStdString &colorName)
 Set the input to the plot. More...
 
virtual void SetInputData (vtkTable *input, vtkIdType xColumn, vtkIdType yColumn, vtkIdType zColumn)
 Set the input to the plot. More...
 
virtual vtkChartXYZGetChart ()
 Get/set the chart for this plot. More...
 
virtual void SetChart (vtkChartXYZ *chart)
 Get/set the chart for this plot. More...
 
virtual void SetSelection (vtkIdTypeArray *id)
 Set/get the selection array for the plot. More...
 
virtual vtkIdTypeArrayGetSelection ()
 Set/get the selection array for the plot. More...
 
- Public Member Functions inherited from vtkContextItem
vtkContextItemNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual double GetOpacity ()
 Get the opacity of the item. More...
 
virtual void SetOpacity (double)
 Set the opacity of the item. More...
 
- Public Member Functions inherited from vtkAbstractContextItem
vtkAbstractContextItemNewInstance () const
 
virtual void Update ()
 Perform any updates to the item that may be necessary before rendering. More...
 
virtual bool Paint (vtkContext2D *painter)
 Paint event for the item, called whenever the item needs to be drawn. More...
 
virtual bool PaintChildren (vtkContext2D *painter)
 Paint the children of the item, should be called whenever the children need to be rendered. More...
 
virtual void ReleaseGraphicsResources ()
 Release graphics resources hold by the item. More...
 
vtkIdType AddItem (vtkAbstractContextItem *item)
 Add child items to this item. More...
 
bool RemoveItem (vtkAbstractContextItem *item)
 Remove child item from this item. More...
 
bool RemoveItem (vtkIdType index)
 Remove child item from this item. More...
 
vtkAbstractContextItemGetItem (vtkIdType index)
 Get the item at the specified index. More...
 
vtkIdType GetItemIndex (vtkAbstractContextItem *item)
 Get the index of the specified item in itemIndex. More...
 
vtkIdType GetNumberOfItems ()
 Get the number of child items. More...
 
void ClearItems ()
 Remove all child items from this item. More...
 
vtkIdType Raise (vtkIdType index)
 Raises the child to the top of the item's stack. More...
 
virtual vtkIdType StackAbove (vtkIdType index, vtkIdType under)
 Raises the child above the under sibling. More...
 
vtkIdType Lower (vtkIdType index)
 Lowers the child to the bottom of the item's stack. More...
 
virtual vtkIdType StackUnder (vtkIdType child, vtkIdType above)
 Lowers the child under the above sibling. More...
 
virtual bool Hit (const vtkContextMouseEvent &mouse)
 Return true if the supplied x, y coordinate is inside the item. More...
 
virtual vtkAbstractContextItemGetPickedItem (const vtkContextMouseEvent &mouse)
 Return the item under the mouse. More...
 
virtual bool MouseEnterEvent (const vtkContextMouseEvent &mouse)
 Mouse enter event. More...
 
virtual bool MouseMoveEvent (const vtkContextMouseEvent &mouse)
 Mouse move event. More...
 
virtual bool MouseLeaveEvent (const vtkContextMouseEvent &mouse)
 Mouse leave event. More...
 
virtual bool MouseButtonPressEvent (const vtkContextMouseEvent &mouse)
 Mouse button down event Return true if the item holds the event, false if the event can be propagated to other items. More...
 
virtual bool MouseButtonReleaseEvent (const vtkContextMouseEvent &mouse)
 Mouse button release event. More...
 
virtual bool MouseDoubleClickEvent (const vtkContextMouseEvent &mouse)
 Mouse button double click event. More...
 
virtual bool MouseWheelEvent (const vtkContextMouseEvent &mouse, int delta)
 Mouse wheel event, positive delta indicates forward movement of the wheel. More...
 
virtual bool KeyPressEvent (const vtkContextKeyEvent &key)
 Key press event. More...
 
virtual bool KeyReleaseEvent (const vtkContextKeyEvent &key)
 Key release event. More...
 
virtual void SetScene (vtkContextScene *scene)
 Set the vtkContextScene for the item, always set for an item in a scene. More...
 
vtkContextSceneGetScene ()
 Get the vtkContextScene for the item, always set for an item in a scene. More...
 
virtual void SetParent (vtkAbstractContextItem *parent)
 Set the parent item. More...
 
vtkAbstractContextItemGetParent ()
 Get the parent item. More...
 
virtual vtkVector2f MapToParent (const vtkVector2f &point)
 Maps the point to the parent coordinate system. More...
 
virtual vtkVector2f MapFromParent (const vtkVector2f &point)
 Maps the point from the parent coordinate system. More...
 
virtual vtkVector2f MapToScene (const vtkVector2f &point)
 Maps the point to the scene coordinate system. More...
 
virtual vtkVector2f MapFromScene (const vtkVector2f &point)
 Maps the point from the scene coordinate system. More...
 
virtual bool GetVisible ()
 Get the visibility of the item (should it be drawn). More...
 
virtual void SetVisible (bool)
 Set the visibility of the item (should it be drawn). More...
 
virtual bool GetInteractive ()
 Get if the item is interactive (should respond to mouse events). More...
 
virtual void SetInteractive (bool)
 Set if the item is interactive (should respond to mouse events). More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
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. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 

Static Public Member Functions

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

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkPlot3D ()
 
 ~vtkPlot3D () override
 
virtual void ComputeDataBounds ()
 Generate a bounding cube for our data. More...
 
- Protected Member Functions inherited from vtkContextItem
 vtkContextItem ()
 
 ~vtkContextItem () override
 
- Protected Member Functions inherited from vtkAbstractContextItem
 vtkAbstractContextItem ()
 
 ~vtkAbstractContextItem () override
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events. More...
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkSmartPointer< vtkPenPen
 This object stores the vtkPen that controls how the plot is drawn. More...
 
vtkSmartPointer< vtkPenSelectionPen
 This object stores the vtkPen that controls how the plot is drawn. More...
 
vtkNew< vtkUnsignedCharArrayColors
 This array assigns a color to each datum in the plot. More...
 
int NumberOfComponents
 Number of components in our color vectors. More...
 
std::string XAxisLabel
 The label for the X Axis. More...
 
std::string YAxisLabel
 The label for the Y Axis. More...
 
std::string ZAxisLabel
 The label for the Z Axis. More...
 
std::vector< vtkVector3fPoints
 The data points read in during SetInputData(). More...
 
vtkTimeStamp PointsBuildTime
 When the points were last built. More...
 
vtkChartXYZChart
 The chart containing this plot. More...
 
std::vector< vtkVector3fDataBounds
 A bounding cube surrounding the currently rendered data points. More...
 
vtkSmartPointer< vtkIdTypeArraySelection
 Selected indices for the table the plot is rendering. More...
 
- Protected Attributes inherited from vtkContextItem
double Opacity
 
- Protected Attributes inherited from vtkAbstractContextItem
vtkContextSceneScene
 Point to the scene the item is on - can be null. More...
 
vtkAbstractContextItemParent
 Point to the parent item - can be null. More...
 
vtkContextScenePrivateChildren
 This structure provides a list of children, along with convenience functions to paint the children etc. More...
 
bool Visible
 Store the visibility of the item (default is true). More...
 
bool Interactive
 Store whether the item should respond to interactions (default is true). More...
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

Abstract class for 3D plots.

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

See also
vtkPlot3DPoints vtkPlot3DLine vtkPlot3DBar vtkChart vtkChartXY

Definition at line 44 of file vtkPlot3D.h.

Member Typedef Documentation

Definition at line 47 of file vtkPlot3D.h.

Constructor & Destructor Documentation

vtkPlot3D::vtkPlot3D ( )
protected
vtkPlot3D::~vtkPlot3D ( )
overrideprotected

Member Function Documentation

static vtkTypeBool vtkPlot3D::IsTypeOf ( const char *  type)
static
virtual vtkTypeBool vtkPlot3D::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 vtkPlotLine3D, vtkPlotPoints3D, and vtkPlotSurface.

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

Reimplemented from vtkContextItem.

Reimplemented in vtkPlotLine3D, vtkPlotPoints3D, and vtkPlotSurface.

vtkPlot3D* vtkPlot3D::NewInstance ( ) const
void vtkPlot3D::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 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 void vtkPlot3D::SetInputData ( vtkTable input)
virtual

Set the input to the plot.

Reimplemented in vtkPlotSurface.

virtual void vtkPlot3D::SetInputData ( vtkTable input,
const vtkStdString xName,
const vtkStdString yName,
const vtkStdString zName 
)
virtual

Set the input to the plot.

Reimplemented in vtkPlotSurface.

virtual void vtkPlot3D::SetInputData ( vtkTable input,
const vtkStdString xName,
const vtkStdString yName,
const vtkStdString zName,
const vtkStdString colorName 
)
virtual

Set the input to the plot.

Reimplemented in vtkPlotSurface.

virtual void vtkPlot3D::SetInputData ( vtkTable input,
vtkIdType  xColumn,
vtkIdType  yColumn,
vtkIdType  zColumn 
)
virtual

Set the input to the plot.

Reimplemented in vtkPlotSurface.

virtual void vtkPlot3D::SetColors ( vtkDataArray colorArr)
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 vtkChartXYZ* vtkPlot3D::GetChart ( )
virtual

Get/set the chart for this plot.

virtual void vtkPlot3D::SetChart ( vtkChartXYZ chart)
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.

std::vector<vtkVector3f> vtkPlot3D::GetDataBounds ( )
inline

Get the bounding cube surrounding the currently rendered data points.

Definition at line 120 of file vtkPlot3D.h.

virtual void vtkPlot3D::SetSelection ( vtkIdTypeArray id)
virtual

Set/get the selection array for the plot.

virtual vtkIdTypeArray* vtkPlot3D::GetSelection ( )
virtual

Set/get the selection array for the plot.

virtual void vtkPlot3D::ComputeDataBounds ( )
protectedvirtual

Generate a bounding cube for our data.

Member Data Documentation

vtkSmartPointer<vtkPen> vtkPlot3D::Pen
protected

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

Definition at line 142 of file vtkPlot3D.h.

vtkSmartPointer<vtkPen> vtkPlot3D::SelectionPen
protected

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

Definition at line 147 of file vtkPlot3D.h.

vtkNew<vtkUnsignedCharArray> vtkPlot3D::Colors
protected

This array assigns a color to each datum in the plot.

Definition at line 152 of file vtkPlot3D.h.

int vtkPlot3D::NumberOfComponents
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 158 of file vtkPlot3D.h.

std::string vtkPlot3D::XAxisLabel
protected

The label for the X Axis.

Definition at line 163 of file vtkPlot3D.h.

std::string vtkPlot3D::YAxisLabel
protected

The label for the Y Axis.

Definition at line 168 of file vtkPlot3D.h.

std::string vtkPlot3D::ZAxisLabel
protected

The label for the Z Axis.

Definition at line 173 of file vtkPlot3D.h.

std::vector<vtkVector3f> vtkPlot3D::Points
protected

The data points read in during SetInputData().

Definition at line 178 of file vtkPlot3D.h.

vtkTimeStamp vtkPlot3D::PointsBuildTime
protected

When the points were last built.

Definition at line 183 of file vtkPlot3D.h.

vtkChartXYZ* vtkPlot3D::Chart
protected

The chart containing this plot.

Definition at line 188 of file vtkPlot3D.h.

std::vector<vtkVector3f> vtkPlot3D::DataBounds
protected

A bounding cube surrounding the currently rendered data points.

Definition at line 193 of file vtkPlot3D.h.

vtkSmartPointer<vtkIdTypeArray> vtkPlot3D::Selection
protected

Selected indices for the table the plot is rendering.

Definition at line 198 of file vtkPlot3D.h.


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