VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
vtkPlot3D Class Reference

Abstract class for 3D plots. More...

#include <vtkPlot3D.h>

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

List of all members.

Public Types

typedef vtkContextItem Superclass

Public Member Functions

virtual int IsA (const char *type)
vtkPlot3D * NewInstance () const
virtual void PrintSelf (ostream &os, vtkIndent indent)
virtual void SetColors (vtkDataArray *colorArr)
std::vector< vtkVector3f > GetPoints ()
std::string GetXAxisLabel ()
std::string GetYAxisLabel ()
std::string GetZAxisLabel ()
std::vector< vtkVector3f > GetDataBounds ()
void SetPen (vtkPen *pen)
vtkPen * GetPen ()
void SetSelectionPen (vtkPen *pen)
vtkPen * GetSelectionPen ()
virtual void SetInputData (vtkTable *input)
virtual void SetInputData (vtkTable *input, const vtkStdString &xName, const vtkStdString &yName, const vtkStdString &zName)
virtual void SetInputData (vtkTable *input, const vtkStdString &xName, const vtkStdString &yName, const vtkStdString &zName, const vtkStdString &colorName)
virtual void SetInputData (vtkTable *input, vtkIdType xColumn, vtkIdType yColumn, vtkIdType zColumn)
virtual vtkChartXYZ * GetChart ()
virtual void SetChart (vtkChartXYZ *chart)
virtual void SetSelection (vtkIdTypeArray *id)
virtual vtkIdTypeArray * GetSelection ()

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkPlot3D * SafeDownCast (vtkObjectBase *o)

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 vtkPlot3D ()
 ~vtkPlot3D ()
virtual void ComputeDataBounds ()

Protected Attributes

vtkSmartPointer< vtkPen > Pen
vtkSmartPointer< vtkPen > SelectionPen
vtkNew< vtkUnsignedCharArray > Colors
int NumberOfComponents
std::string XAxisLabel
std::string YAxisLabel
std::string ZAxisLabel
std::vector< vtkVector3f > Points
vtkTimeStamp PointsBuildTime
vtkChartXYZ * Chart
std::vector< vtkVector3f > DataBounds
vtkSmartPointer< vtkIdTypeArray > Selection

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 43 of file vtkPlot3D.h.


Member Typedef Documentation

Reimplemented from vtkContextItem.

Reimplemented in vtkPlotLine3D, vtkPlotPoints3D, and vtkPlotSurface.

Definition at line 46 of file vtkPlot3D.h.


Constructor & Destructor Documentation

vtkPlot3D::vtkPlot3D ( ) [protected]
vtkPlot3D::~vtkPlot3D ( ) [protected]

Member Function Documentation

static int vtkPlot3D::IsTypeOf ( const char *  name) [static]

Return 1 if this class type 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.

virtual int 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]

Reimplemented from vtkContextItem.

Reimplemented in vtkPlotLine3D, vtkPlotPoints3D, and vtkPlotSurface.

virtual vtkObjectBase* vtkPlot3D::NewInstanceInternal ( ) const [protected, virtual]

Reimplemented from vtkContextItem.

Reimplemented in vtkPlotLine3D, vtkPlotPoints3D, and vtkPlotSurface.

Reimplemented from vtkContextItem.

Reimplemented in vtkPlotLine3D, vtkPlotPoints3D, and vtkPlotSurface.

virtual void vtkPlot3D::PrintSelf ( ostream &  os,
vtkIndent  indent 
) [virtual]

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 vtkPlotLine3D, vtkPlotPoints3D, and vtkPlotSurface.

void vtkPlot3D::SetPen ( vtkPen *  pen)

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

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

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

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.

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 102 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 ( ) [protected, virtual]

Generate a bounding cube for our data.


Member Data Documentation

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

Definition at line 119 of file vtkPlot3D.h.

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

Definition at line 122 of file vtkPlot3D.h.

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

Reimplemented in vtkPlotSurface.

Definition at line 125 of file vtkPlot3D.h.

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 130 of file vtkPlot3D.h.

std::string vtkPlot3D::XAxisLabel [protected]

The label for the X Axis.

Definition at line 133 of file vtkPlot3D.h.

std::string vtkPlot3D::YAxisLabel [protected]

The label for the Y Axis.

Definition at line 136 of file vtkPlot3D.h.

std::string vtkPlot3D::ZAxisLabel [protected]

The label for the Z Axis.

Definition at line 139 of file vtkPlot3D.h.

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

The data points read in during SetInputData().

Definition at line 142 of file vtkPlot3D.h.

When the points were last built.

Definition at line 145 of file vtkPlot3D.h.

The chart containing this plot.

Definition at line 148 of file vtkPlot3D.h.

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

A bounding cube surrounding the currently rendered data points.

Definition at line 151 of file vtkPlot3D.h.

Selected indices for the table the plot is rendering

Definition at line 154 of file vtkPlot3D.h.


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