Abstract class for 3D plots. More...

#include <vtkPlot3D.h>

Inheritance diagram for vtkPlot3D:

Collaboration diagram for vtkPlot3D:

Public Types
typedef vtkContextItem	Superclass

Public Types inherited from vtkContextItem
typedef vtkAbstractContextItem	Superclass

Public Types inherited from vtkAbstractContextItem
typedef vtkObject	Superclass

Public Types inherited from vtkObject
typedef vtkObjectBase	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 ()

Public Member Functions inherited from vtkContextItem
vtkContextItem *	NewInstance () const

virtual double	GetOpacity ()

virtual void	SetOpacity (double)

Public Member Functions inherited from vtkAbstractContextItem
vtkAbstractContextItem *	NewInstance () const

virtual void	Update ()

virtual bool	Paint (vtkContext2D *painter)

virtual bool	PaintChildren (vtkContext2D *painter)

virtual void	ReleaseGraphicsResources ()

unsigned int	AddItem (vtkAbstractContextItem *item)

bool	RemoveItem (vtkAbstractContextItem *item)

bool	RemoveItem (unsigned int index)

vtkAbstractContextItem *	GetItem (unsigned int index)

unsigned int	GetItemIndex (vtkAbstractContextItem *item)

unsigned int	GetNumberOfItems ()

void	ClearItems ()

unsigned int	Raise (unsigned int index)

unsigned int	Lower (unsigned int index)

virtual bool	Hit (const vtkContextMouseEvent &mouse)

virtual vtkAbstractContextItem *	GetPickedItem (const vtkContextMouseEvent &mouse)

virtual bool	MouseEnterEvent (const vtkContextMouseEvent &mouse)

virtual bool	MouseMoveEvent (const vtkContextMouseEvent &mouse)

virtual bool	MouseLeaveEvent (const vtkContextMouseEvent &mouse)

virtual bool	MouseButtonPressEvent (const vtkContextMouseEvent &mouse)

virtual bool	MouseButtonReleaseEvent (const vtkContextMouseEvent &mouse)

virtual bool	MouseDoubleClickEvent (const vtkContextMouseEvent &mouse)

virtual bool	MouseWheelEvent (const vtkContextMouseEvent &mouse, int delta)

virtual bool	KeyPressEvent (const vtkContextKeyEvent &key)

virtual void	SetScene (vtkContextScene *scene)

virtual void	SetParent (vtkAbstractContextItem *parent)

virtual vtkVector2f	MapToParent (const vtkVector2f &point)

virtual vtkVector2f	MapFromParent (const vtkVector2f &point)

virtual vtkVector2f	MapToScene (const vtkVector2f &point)

virtual vtkVector2f	MapFromScene (const vtkVector2f &point)

virtual unsigned int	StackAbove (unsigned int index, unsigned int under)

virtual unsigned int	StackUnder (unsigned int child, unsigned int above)

virtual bool	KeyReleaseEvent (const vtkContextKeyEvent &key)

vtkContextScene *	GetScene ()

vtkAbstractContextItem *	GetParent ()

virtual bool	GetVisible ()

virtual void	SetVisible (bool)

virtual bool	GetInteractive ()

virtual void	SetInteractive (bool)

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual unsigned long	GetMTime ()

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

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

static vtkPlot3D *	SafeDownCast (vtkObjectBase *o)

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

static vtkContextItem *	SafeDownCast (vtkObjectBase *o)

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

static vtkAbstractContextItem *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkPlot3D ()

	~vtkPlot3D ()

virtual void	ComputeDataBounds ()

Protected Member Functions inherited from vtkContextItem
	vtkContextItem ()

	~vtkContextItem ()

Protected Member Functions inherited from vtkAbstractContextItem
	vtkAbstractContextItem ()

	~vtkAbstractContextItem ()

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

virtual void	RegisterInternal (vtkObjectBase *, int check)

virtual void	UnRegisterInternal (vtkObjectBase *, int check)

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

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< 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

Protected Attributes inherited from vtkContextItem
double	Opacity

Protected Attributes inherited from vtkAbstractContextItem
vtkContextScene *	Scene

vtkAbstractContextItem *	Parent

vtkContextScenePrivate *	Children

bool	Visible

bool	Interactive

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

Member Typedef Documentation

typedef vtkContextItem vtkPlot3D::Superclass

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 * type )

static

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

virtual vtkObjectBase* vtkPlot3D::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkContextItem.

Reimplemented in vtkPlotLine3D, vtkPlotPoints3D, and vtkPlotSurface.

vtkPlot3D* vtkPlot3D::NewInstance ( ) const

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.

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 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 ( )

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

vtkSmartPointer<vtkPen> vtkPlot3D::SelectionPen

protected

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

Definition at line 122 of file vtkPlot3D.h.

vtkNew<vtkUnsignedCharArray> vtkPlot3D::Colors

protected

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

Definition at line 125 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 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.

vtkTimeStamp vtkPlot3D::PointsBuildTime

protected

When the points were last built.

Definition at line 145 of file vtkPlot3D.h.

vtkChartXYZ* vtkPlot3D::Chart

protected

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.

vtkSmartPointer<vtkIdTypeArray> vtkPlot3D::Selection

protected

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:

/home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Charts/Core/vtkPlot3D.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation