vtkChartBox Class Reference

Factory class for drawing box plot charts. More...

#include <vtkChartBox.h>

Inheritance diagram for vtkChartBox:

Collaboration diagram for vtkChartBox:

Public Types
typedef vtkChart	Superclass
Public Types inherited from vtkChart
typedef vtkContextItem	Superclass
enum	{   LINE, POINTS, BAR, STACKED,   BAG, FUNCTIONALBAG, AREA }
enum	{   PAN = 0, ZOOM, ZOOM_AXIS, SELECT,   SELECT_RECTANGLE = SELECT, SELECT_POLYGON, NOTIFY }
enum	EventIds { UpdateRange = 1002 }
enum	{ SELECTION_ROWS, SELECTION_PLOTS, SELECTION_COLUMNS }
enum	{ FILL_SCENE, FILL_RECT, AXES_TO_RECT }
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)
vtkChartBox *	NewInstance () const
virtual void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	Update ()
virtual bool	Paint (vtkContext2D *painter)
void	SetColumnVisibilityAll (bool visible)
vtkIdType	GetColumnId (const vtkStdString &name)
virtual int	GetSelectedColumn ()
virtual void	SetSelectedColumn (int)
virtual vtkPlot *	GetPlot (vtkIdType index)
virtual vtkIdType	GetNumberOfPlots ()
virtual vtkAxis *	GetYAxis ()
virtual float	GetXPosition (int index)
virtual vtkIdType	GetNumberOfVisibleColumns ()
virtual void	SetPlot (vtkPlotBox *plot)
virtual bool	Hit (const vtkContextMouseEvent &mouse)
virtual bool	MouseMoveEvent (const vtkContextMouseEvent &mouse)
virtual bool	MouseButtonPressEvent (const vtkContextMouseEvent &mouse)
virtual bool	MouseButtonReleaseEvent (const vtkContextMouseEvent &mouse)
virtual void	SetTooltip (vtkTooltipItem *tooltip)
virtual vtkTooltipItem *	GetTooltip ()
void	SetColumnVisibility (const vtkStdString &name, bool visible)
void	SetColumnVisibility (vtkIdType column, bool visible)
bool	GetColumnVisibility (const vtkStdString &name)
bool	GetColumnVisibility (vtkIdType column)
virtual vtkStringArray *	GetVisibleColumns ()
Public Member Functions inherited from vtkChart
vtkChart *	NewInstance () const
virtual vtkPlot *	AddPlot (int type)
virtual vtkIdType	AddPlot (vtkPlot *plot)
virtual bool	RemovePlot (vtkIdType index)
virtual bool	RemovePlotInstance (vtkPlot *plot)
virtual void	ClearPlots ()
virtual vtkAxis *	GetAxis (int axisIndex)
virtual vtkIdType	GetNumberOfAxes ()
virtual void	RecalculateBounds ()
virtual void	SetAnnotationLink (vtkAnnotationLink *link)
virtual vtkChartLegend *	GetLegend ()
void	SetBorders (int left, int bottom, int right, int top)
void	SetSize (const vtkRectf &rect)
vtkRectf	GetSize ()
virtual void	SetActionToButton (int action, int button)
virtual int	GetActionToButton (int action)
virtual void	SetClickActionToButton (int action, int button)
virtual int	GetClickActionToButton (int action)
virtual void	SetSelectionMethod (int method)
virtual int	GetSelectionMethod ()
virtual vtkAnnotationLink *	GetAnnotationLink ()
virtual void	SetGeometry (int, int)
void	SetGeometry (int[2])
virtual int *	GetGeometry ()
virtual void	GetGeometry (int &, int &)
virtual void	GetGeometry (int[2])
virtual void	SetPoint1 (int, int)
void	SetPoint1 (int[2])
virtual int *	GetPoint1 ()
virtual void	GetPoint1 (int &, int &)
virtual void	GetPoint1 (int[2])
virtual void	SetPoint2 (int, int)
void	SetPoint2 (int[2])
virtual int *	GetPoint2 ()
virtual void	GetPoint2 (int &, int &)
virtual void	GetPoint2 (int[2])
virtual void	SetShowLegend (bool visible)
virtual bool	GetShowLegend ()
virtual void	SetTitle (const vtkStdString &title)
virtual vtkStdString	GetTitle ()
virtual vtkTextProperty *	GetTitleProperties ()
void	SetBottomBorder (int border)
void	SetTopBorder (int border)
void	SetLeftBorder (int border)
void	SetRightBorder (int border)
virtual void	SetLayoutStrategy (int)
virtual int	GetLayoutStrategy ()
virtual void	SetAutoSize (bool isAutoSized)
virtual bool	GetAutoSize ()
virtual void	SetRenderEmpty (bool)
virtual bool	GetRenderEmpty ()
void	SetBackgroundBrush (vtkBrush *brush)
vtkBrush *	GetBackgroundBrush ()
virtual void	SetSelectionMode (int)
virtual int	GetSelectionMode ()
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 vtkAbstractContextItem *	GetPickedItem (const vtkContextMouseEvent &mouse)
virtual bool	MouseEnterEvent (const vtkContextMouseEvent &mouse)
virtual bool	MouseLeaveEvent (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 vtkChartBox *	SafeDownCast (vtkObjectBase *o)
static vtkChartBox *	New ()
Static Public Member Functions inherited from vtkChart
static int	IsTypeOf (const char *type)
static vtkChart *	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
void	ResetSelection ()
void	UpdateGeometry (vtkContext2D *)
void	CalculatePlotTransform ()
void	SwapAxes (int a1, int a2)
int	LocatePointInPlot (const vtkVector2f &position, const vtkVector2f &tolerance, vtkVector2f &plotPos, vtkPlot *plot, vtkIdType &segmentIndex)
bool	LocatePointInPlots (const vtkContextMouseEvent &mouse, int invokeEvent=-1)
Protected Member Functions inherited from vtkChart
	vtkChart ()
	~vtkChart ()
void	AttachAxisRangeListener (vtkAxis *)
void	AxisRangeForwarderCallback (vtkObject *, unsigned long, void *)
bool	CalculatePlotTransform (vtkAxis *x, vtkAxis *y, vtkTransform2D *transform)
bool	CalculateUnscaledPlotTransform (vtkAxis *x, vtkAxis *y, vtkTransform2D *transform)
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
bool	GeometryValid
vtkIdTypeArray *	Selection
vtkStringArray *	VisibleColumns
vtkTimeStamp	BuildTime
vtkSmartPointer< vtkTooltipItem >	Tooltip
Private *	Storage
int	SelectedColumn
float	SelectedColumnDelta
Protected Attributes inherited from vtkChart
vtkAnnotationLink *	AnnotationLink
int	Geometry [2]
int	Point1 [2]
int	Point2 [2]
bool	ShowLegend
vtkStdString	Title
vtkTextProperty *	TitleProperties
vtkRectf	Size
int	LayoutStrategy
bool	RenderEmpty
vtkSmartPointer< vtkBrush >	BackgroundBrush
int	SelectionMode
int	SelectionMethod
MouseActions	Actions
MouseClickActions	ActionsClick
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 void	SetTooltipInfo (const vtkContextMouseEvent &, const vtkVector2d &, vtkIdType, vtkPlot *, vtkIdType segmentIndex=-1)
	vtkChartBox ()
	~vtkChartBox ()

Detailed Description

Factory class for drawing box plot charts.

This defines the interface for a box plot chart.

Tests:

vtkChartBox (Tests)

Definition at line 38 of file vtkChartBox.h.

Member Typedef Documentation

typedef vtkChart vtkChartBox::Superclass

Definition at line 41 of file vtkChartBox.h.

Constructor & Destructor Documentation

vtkChartBox::vtkChartBox ( )

protected

Set the information passed to the tooltip.

vtkChartBox::~vtkChartBox ( )

protected

Set the information passed to the tooltip.

Member Function Documentation

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

static

virtual int vtkChartBox::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 vtkChart.

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

static

virtual vtkObjectBase* vtkChartBox::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkChart.

vtkChartBox* vtkChartBox::NewInstance

(

)

const

virtual void vtkChartBox::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 vtkChart.

static vtkChartBox* vtkChartBox::New ( )

static

Creates a parallel coordinates chart

virtual void vtkChartBox::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 vtkChartBox::Paint ( vtkContext2D *  painter )

virtual

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

Implements vtkChart.

void vtkChartBox::SetColumnVisibility	(	const vtkStdString &	name,
		bool	visible
	)

Set the visibility of the specified column.

void vtkChartBox::SetColumnVisibility	(	vtkIdType	column,
		bool	visible
	)

Set the visibility of the specified column.

void vtkChartBox::SetColumnVisibilityAll

(

bool

visible

)

Set the visibility of all columns (true will make them all visible, false will remove all visible columns).

bool vtkChartBox::GetColumnVisibility

(

const vtkStdString &

name

)

Get the visibility of the specified column.

bool vtkChartBox::GetColumnVisibility

(

vtkIdType

column

)

Get the visibility of the specified column.

vtkIdType vtkChartBox::GetColumnId

(

const vtkStdString &

name

)

Get the input table column id of a column by its name.

virtual vtkStringArray* vtkChartBox::GetVisibleColumns ( )

virtual

Get a list of the columns, and the order in which they are displayed.

virtual int vtkChartBox::GetSelectedColumn ( )

virtual

virtual void vtkChartBox::SetSelectedColumn ( int  )

virtual

virtual vtkPlot* vtkChartBox::GetPlot ( vtkIdType  index )

virtual

Get the plot at the specified index, returns null if the index is invalid.

Reimplemented from vtkChart.

virtual vtkIdType vtkChartBox::GetNumberOfPlots ( )

virtual

Get the number of plots the chart contains.

Reimplemented from vtkChart.

virtual vtkAxis* vtkChartBox::GetYAxis ( )

virtual

Get the chart Y axis

virtual float vtkChartBox::GetXPosition ( int  index )

virtual

Get the column X position by index in the visible set.

virtual vtkIdType vtkChartBox::GetNumberOfVisibleColumns ( )

virtual

Get the number of visible box plots in the current chart.

virtual void vtkChartBox::SetPlot ( vtkPlotBox *  plot )

virtual

Set plot to use for the chart. Since this type of chart can only contain one plot, this will replace the previous plot.

virtual bool vtkChartBox::Hit ( const vtkContextMouseEvent &  mouse )

virtual

Return true if the supplied x, y coordinate is inside the item.

Reimplemented from vtkAbstractContextItem.

virtual bool vtkChartBox::MouseMoveEvent ( const vtkContextMouseEvent &  mouse )

virtual

Mouse move event.

Reimplemented from vtkAbstractContextItem.

virtual bool vtkChartBox::MouseButtonPressEvent ( const vtkContextMouseEvent &  mouse )

virtual

Mouse button down event

Reimplemented from vtkAbstractContextItem.

virtual bool vtkChartBox::MouseButtonReleaseEvent ( const vtkContextMouseEvent &  mouse )

virtual

Mouse button release event.

Reimplemented from vtkAbstractContextItem.

virtual void vtkChartBox::SetTooltip ( vtkTooltipItem *  tooltip )

virtual

Set the vtkTooltipItem object that will be displayed by the chart.

virtual vtkTooltipItem* vtkChartBox::GetTooltip ( )

virtual

Get the vtkTooltipItem object that will be displayed by the chart.

virtual void vtkChartBox::SetTooltipInfo ( const vtkContextMouseEvent &  , const vtkVector2d &  , vtkIdType  , vtkPlot *  , vtkIdType  segmentIndex = -1  )

virtual

Set the information passed to the tooltip.

void vtkChartBox::ResetSelection ( )

protected

void vtkChartBox::UpdateGeometry ( vtkContext2D *  )

protected

void vtkChartBox::CalculatePlotTransform ( )

protected

void vtkChartBox::SwapAxes ( int  a1, int  a2  )

protected

bool vtkChartBox::LocatePointInPlots ( const vtkContextMouseEvent &  mouse, int  invokeEvent = -1  )

protected

Try to locate a point within the plots to display in a tooltip. If invokeEvent is greater than 0, then an event will be invoked if a point is at that mouse position.

int vtkChartBox::LocatePointInPlot ( const vtkVector2f &  position, const vtkVector2f &  tolerance, vtkVector2f &  plotPos, vtkPlot *  plot, vtkIdType &  segmentIndex  )

protected

Member Data Documentation

Private* vtkChartBox::Storage

protected

Definition at line 139 of file vtkChartBox.h.

bool vtkChartBox::GeometryValid

protected

Definition at line 143 of file vtkChartBox.h.

vtkIdTypeArray* vtkChartBox::Selection

protected

Selected indices for the table the plot is rendering

Definition at line 146 of file vtkChartBox.h.

vtkStringArray* vtkChartBox::VisibleColumns

protected

A list of the visible columns in the chart.

Definition at line 149 of file vtkChartBox.h.

int vtkChartBox::SelectedColumn

protected

Index of the selected column in the visible columns list.

Definition at line 153 of file vtkChartBox.h.

float vtkChartBox::SelectedColumnDelta

protected

Index of the selected column in the visible columns list.

Definition at line 154 of file vtkChartBox.h.

vtkTimeStamp vtkChartBox::BuildTime

protected

The point cache is marked dirty until it has been initialized.

Definition at line 158 of file vtkChartBox.h.

vtkSmartPointer<vtkTooltipItem> vtkChartBox::Tooltip

protected

The tooltip item for the chart - can be used to display extra information.

Definition at line 162 of file vtkChartBox.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/vtkChartBox.h