vtkPlotFunctionalBag Class Reference

Class for drawing an XY line plot or bag given two columns from a vtkTable. More...

#include <vtkPlotFunctionalBag.h>

Inheritance diagram for vtkPlotFunctionalBag:

Collaboration diagram for vtkPlotFunctionalBag:

Public Types
typedef vtkPlot	Superclass
Public Types inherited from vtkPlot
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)
vtkPlotFunctionalBag *	NewInstance () const
virtual void	PrintSelf (ostream &os, vtkIndent indent)
virtual bool	IsBag ()
virtual bool	GetVisible ()
virtual void	Update ()
virtual bool	Paint (vtkContext2D *painter)
virtual void	GetBounds (double bounds[4])
virtual void	GetUnscaledInputBounds (double bounds[4])
virtual void	CreateDefaultLookupTable ()
virtual bool	SelectPoints (const vtkVector2f &min, const vtkVector2f &max)
virtual bool	PaintLegend (vtkContext2D *painter, const vtkRectf &rect, int legendIndex)
void	SetLookupTable (vtkScalarsToColors *lut)
vtkScalarsToColors *	GetLookupTable ()
virtual vtkIdType	GetNearestPoint (const vtkVector2f &point, const vtkVector2f &tolerance, vtkVector2f *location)
Public Member Functions inherited from vtkPlot
vtkPlot *	NewInstance () const
virtual void	SetWidth (float width)
virtual float	GetWidth ()
virtual void	SetLabel (const vtkStdString &label)
virtual vtkStdString	GetLabel ()
virtual void	SetLabels (vtkStringArray *labels)
virtual vtkStringArray *	GetLabels ()
virtual int	GetNumberOfLabels ()
vtkStdString	GetLabel (vtkIdType index)
void	SetIndexedLabels (vtkStringArray *labels)
virtual vtkStringArray *	GetIndexedLabels ()
vtkContextMapper2D *	GetData ()
virtual vtkTable *	GetInput ()
virtual void	SetInputArray (int index, const vtkStdString &name)
virtual void	UpdateCache ()
virtual void	SetLegendVisibility (bool)
virtual bool	GetLegendVisibility ()
virtual void	LegendVisibilityOn ()
virtual void	LegendVisibilityOff ()
virtual void	SetTooltipLabelFormat (const vtkStdString &label)
virtual vtkStdString	GetTooltipLabelFormat ()
virtual void	SetTooltipNotation (int notation)
virtual int	GetTooltipNotation ()
virtual void	SetTooltipPrecision (int precision)
virtual int	GetTooltipPrecision ()
virtual vtkStdString	GetTooltipLabel (const vtkVector2d &plotPos, vtkIdType seriesIndex, vtkIdType segmentIndex)
virtual void	SetColor (unsigned char r, unsigned char g, unsigned char b, unsigned char a)
virtual void	SetColor (double r, double g, double b)
virtual void	GetColor (double rgb[3])
void	GetColor (unsigned char rgb[3])
void	SetPen (vtkPen *pen)
vtkPen *	GetPen ()
void	SetBrush (vtkBrush *brush)
vtkBrush *	GetBrush ()
void	SetSelectionPen (vtkPen *pen)
vtkPen *	GetSelectionPen ()
void	SetSelectionBrush (vtkBrush *brush)
vtkBrush *	GetSelectionBrush ()
virtual bool	GetUseIndexForXSeries ()
virtual void	SetUseIndexForXSeries (bool)
virtual void	SetInputData (vtkTable *table)
virtual void	SetInputData (vtkTable *table, const vtkStdString &xColumn, const vtkStdString &yColumn)
void	SetInputData (vtkTable *table, vtkIdType xColumn, vtkIdType yColumn)
virtual void	SetSelectable (bool)
virtual bool	GetSelectable ()
virtual void	SelectableOn ()
virtual void	SelectableOff ()
virtual void	SetSelection (vtkIdTypeArray *id)
virtual vtkIdTypeArray *	GetSelection ()
virtual vtkAxis *	GetXAxis ()
virtual void	SetXAxis (vtkAxis *axis)
virtual vtkAxis *	GetYAxis ()
virtual void	SetYAxis (vtkAxis *axis)
void	SetShiftScale (const vtkRectd &scaling)
vtkRectd	GetShiftScale ()
virtual void	SetProperty (const vtkStdString &property, const vtkVariant &var)
virtual vtkVariant	GetProperty (const vtkStdString &property)
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 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 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 vtkPlotFunctionalBag *	SafeDownCast (vtkObjectBase *o)
static vtkPlotFunctionalBag *	New ()
Static Public Member Functions inherited from vtkPlot
static int	IsTypeOf (const char *type)
static vtkPlot *	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
bool	GetDataArrays (vtkTable *table, vtkDataArray *array[2])
bool	UpdateTableCache (vtkTable *)
Protected Member Functions inherited from vtkPlot
	vtkPlot ()
	~vtkPlot ()
vtkStdString	GetNumber (double position, vtkAxis *axis)
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
vtkTimeStamp	BuildTime
vtkScalarsToColors *	LookupTable
vtkNew< vtkPlotLine >	Line
vtkNew< vtkPoints2D >	BagPoints
bool	LogX
bool	LogY
Protected Attributes inherited from vtkPlot
vtkSmartPointer< vtkPen >	Pen
vtkSmartPointer< vtkBrush >	Brush
vtkSmartPointer< vtkPen >	SelectionPen
vtkSmartPointer< vtkBrush >	SelectionBrush
vtkSmartPointer< vtkStringArray >	Labels
vtkSmartPointer< vtkStringArray >	AutoLabels
vtkSmartPointer< vtkStringArray >	IndexedLabels
bool	UseIndexForXSeries
vtkSmartPointer< vtkContextMapper2D >	Data
bool	Selectable
vtkIdTypeArray *	Selection
vtkAxis *	XAxis
vtkAxis *	YAxis
vtkStdString	TooltipLabelFormat
vtkStdString	TooltipDefaultLabelFormat
int	TooltipNotation
int	TooltipPrecision
vtkRectd	ShiftScale
bool	LegendVisibility
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
virtual bool	SelectPointsInPolygon (const vtkContextPolygon &polygon)
	vtkPlotFunctionalBag ()
	~vtkPlotFunctionalBag ()

Detailed Description

Class for drawing an XY line plot or bag given two columns from a vtkTable.

Depending on the number of components, this class will draw either a line plot (for 1 component column) or, for two components columns, a filled polygonal band (the bag) going from the first to the second component on the Y-axis along the X-axis. The filter vtkExtractFunctionalBagPlot is intended to create such "bag" columns.

See also

vtkExtractFunctionalBagPlot

Tests:

vtkPlotFunctionalBag (Tests)

Definition at line 47 of file vtkPlotFunctionalBag.h.

Member Typedef Documentation

typedef vtkPlot vtkPlotFunctionalBag::Superclass

Definition at line 50 of file vtkPlotFunctionalBag.h.

Constructor & Destructor Documentation

vtkPlotFunctionalBag::vtkPlotFunctionalBag ( )

protected

Select all points in the specified polygon.

vtkPlotFunctionalBag::~vtkPlotFunctionalBag ( )

protected

Select all points in the specified polygon.

Member Function Documentation

static int vtkPlotFunctionalBag::IsTypeOf ( const char *  type )

static

virtual int vtkPlotFunctionalBag::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 vtkPlot.

static vtkPlotFunctionalBag* vtkPlotFunctionalBag::SafeDownCast ( vtkObjectBase *  o )

static

virtual vtkObjectBase* vtkPlotFunctionalBag::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkPlot.

vtkPlotFunctionalBag* vtkPlotFunctionalBag::NewInstance

(

)

const

virtual void vtkPlotFunctionalBag::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 vtkPlot.

static vtkPlotFunctionalBag* vtkPlotFunctionalBag::New ( )

static

Creates a functional bag plot object.

virtual bool vtkPlotFunctionalBag::IsBag ( )

virtual

Returns true if the plot is a functional bag, false if it is a simple line.

virtual bool vtkPlotFunctionalBag::GetVisible ( )

virtual

Reimplemented to enforce visibility when selected.

Reimplemented from vtkAbstractContextItem.

virtual void vtkPlotFunctionalBag::Update ( )

virtual

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.

virtual bool vtkPlotFunctionalBag::Paint ( vtkContext2D *  painter )

virtual

Paint event for the plot, called whenever the chart needs to be drawn.

Reimplemented from vtkAbstractContextItem.

virtual bool vtkPlotFunctionalBag::PaintLegend ( vtkContext2D *  painter, const vtkRectf &  rect, int  legendIndex  )

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.

Reimplemented from vtkPlot.

virtual void vtkPlotFunctionalBag::GetBounds ( double  bounds[4] )

virtual

Get the bounds for this plot as (Xmin, Xmax, Ymin, Ymax).

Reimplemented from vtkPlot.

virtual void vtkPlotFunctionalBag::GetUnscaledInputBounds ( double  bounds[4] )

virtual

Get the non-log-scaled bounds on chart inputs for this plot as (Xmin, Xmax, Ymin, Ymax).

Reimplemented from vtkPlot.

void vtkPlotFunctionalBag::SetLookupTable

(

vtkScalarsToColors *

lut

)

Specify a lookup table for the mapper to use.

vtkScalarsToColors* vtkPlotFunctionalBag::GetLookupTable

(

)

Specify a lookup table for the mapper to use.

virtual void vtkPlotFunctionalBag::CreateDefaultLookupTable ( )

virtual

Create default lookup table. Generally used to create one when none is available with the scalar data.

virtual vtkIdType vtkPlotFunctionalBag::GetNearestPoint ( const vtkVector2f &  point, const vtkVector2f &  tolerance, vtkVector2f *  location  )

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.

Reimplemented from vtkPlot.

virtual bool vtkPlotFunctionalBag::SelectPoints ( const vtkVector2f &  min, const vtkVector2f &  max  )

virtual

Select all points in the specified rectangle.

Reimplemented from vtkPlot.

virtual bool vtkPlotFunctionalBag::SelectPointsInPolygon ( const vtkContextPolygon &  polygon )

virtual

Select all points in the specified polygon.

Reimplemented from vtkPlot.

bool vtkPlotFunctionalBag::GetDataArrays ( vtkTable *  table, vtkDataArray *  array[2]  )

protected

Populate the data arrays ready to operate on input data.

bool vtkPlotFunctionalBag::UpdateTableCache ( vtkTable *  )

protected

Update the table cache.

Member Data Documentation

vtkTimeStamp vtkPlotFunctionalBag::BuildTime

protected

The cache is marked dirty until it has been initialized.

Definition at line 127 of file vtkPlotFunctionalBag.h.

vtkScalarsToColors* vtkPlotFunctionalBag::LookupTable

protected

Lookup Table for coloring points by scalar value

Definition at line 130 of file vtkPlotFunctionalBag.h.

vtkNew<vtkPlotLine> vtkPlotFunctionalBag::Line

protected

The plot line delegate for line series

Definition at line 133 of file vtkPlotFunctionalBag.h.

vtkNew<vtkPoints2D> vtkPlotFunctionalBag::BagPoints

protected

The bag points ordered in quadstrip fashion

Definition at line 136 of file vtkPlotFunctionalBag.h.

bool vtkPlotFunctionalBag::LogX

protected

Definition at line 138 of file vtkPlotFunctionalBag.h.

bool vtkPlotFunctionalBag::LogY

protected

Definition at line 138 of file vtkPlotFunctionalBag.h.

---

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

• dox/Charts/Core/vtkPlotFunctionalBag.h