vtkPlotHistogram2D Class Reference

#include <vtkPlotHistogram2D.h>

Inheritance diagram for vtkPlotHistogram2D:

Collaboration diagram for vtkPlotHistogram2D:

Public Types
typedef vtkPlot	Superclass
Public Types inherited from vtkPlot
typedef vtkContextItem	Superclass

Public Member Functions
virtual int	IsA (const char *type)
vtkPlotHistogram2D *	NewInstance () const
virtual void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	Update ()
virtual bool	Paint (vtkContext2D *painter)
vtkImageData *	GetInputImageData ()
void	SetTransferFunction (vtkScalarsToColors *transfer)
vtkScalarsToColors *	GetTransferFunction ()
virtual void	GetBounds (double bounds[4])
virtual void	SetPosition (const vtkRectf &pos)
virtual vtkRectf	GetPosition ()
virtual void	SetInputData (vtkImageData *data, vtkIdType z=0)
virtual void	SetInputData (vtkTable *)
virtual void	SetInputData (vtkTable *, const vtkStdString &, const vtkStdString &)
virtual vtkStdString	GetTooltipLabel (const vtkVector2f &plotPos, vtkIdType seriesIndex, vtkIdType segmentIndex)
virtual vtkIdType	GetNearestPoint (const vtkVector2f &point, const vtkVector2f &tolerance, vtkVector2f *location)
Public Member Functions inherited from vtkPlot
vtkPlot *	NewInstance () const
virtual bool	SelectPoints (const vtkVector2f &min, const vtkVector2f &max)
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	SetSelection (vtkIdTypeArray *id)
virtual vtkIdTypeArray *	GetSelection ()
virtual bool	PaintLegend (vtkContext2D *painter, const vtkRectf &rect, int legendIndex)
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 bool	SelectPointsInPolygon (const vtkContextPolygon &polygon)
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 ()
virtual bool	GetUseIndexForXSeries ()
virtual void	SetUseIndexForXSeries (bool)
void	SetInputData (vtkTable *table, vtkIdType xColumn, vtkIdType yColumn)
virtual vtkAxis *	GetXAxis ()
virtual void	SetXAxis (vtkAxis *axis)
virtual vtkAxis *	GetYAxis ()
virtual void	SetYAxis (vtkAxis *axis)
virtual void	GetUnscaledInputBounds (double bounds[4])
virtual void	SetProperty (const vtkStdString &property, const vtkVariant &var)
virtual vtkVariant	GetProperty (const vtkStdString &property)

Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkPlotHistogram2D *	SafeDownCast (vtkObjectBase *o)
static vtkPlotHistogram2D *	New ()
Static Public Member Functions inherited from vtkPlot
static int	IsTypeOf (const char *type)
static vtkPlot *	SafeDownCast (vtkObjectBase *o)

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkPlotHistogram2D ()
	~vtkPlotHistogram2D ()
void	GenerateHistogram ()
Protected Member Functions inherited from vtkPlot
	vtkPlot ()
	~vtkPlot ()
vtkStdString	GetNumber (double position, vtkAxis *axis)

Protected Attributes
vtkSmartPointer< vtkImageData >	Input
vtkSmartPointer< vtkImageData >	Output
vtkSmartPointer < vtkScalarsToColors >	TransferFunction
vtkRectf	Position
Protected Attributes inherited from vtkPlot
vtkSmartPointer< vtkPen >	Pen
vtkSmartPointer< vtkBrush >	Brush
vtkSmartPointer< vtkStringArray >	Labels
vtkSmartPointer< vtkStringArray >	AutoLabels
vtkSmartPointer< vtkStringArray >	IndexedLabels
bool	UseIndexForXSeries
vtkSmartPointer < vtkContextMapper2D >	Data
vtkIdTypeArray *	Selection
vtkAxis *	XAxis
vtkAxis *	YAxis
vtkStdString	TooltipLabelFormat
vtkStdString	TooltipDefaultLabelFormat
int	TooltipNotation
int	TooltipPrecision

Detailed Description

Definition at line 34 of file vtkPlotHistogram2D.h.

Member Typedef Documentation

typedef vtkPlot vtkPlotHistogram2D::Superclass

Definition at line 37 of file vtkPlotHistogram2D.h.

Constructor & Destructor Documentation

vtkPlotHistogram2D::vtkPlotHistogram2D ( )

protected

vtkPlotHistogram2D::~vtkPlotHistogram2D ( )

protected

Member Function Documentation

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

static

virtual int vtkPlotHistogram2D::IsA ( const char *  type )

virtual

Reimplemented from vtkPlot.

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

static

virtual vtkObjectBase* vtkPlotHistogram2D::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkPlot.

vtkPlotHistogram2D* vtkPlotHistogram2D::NewInstance

(

)

const

virtual void vtkPlotHistogram2D::PrintSelf ( ostream &  os, vtkIndent  indent  )

virtual

Reimplemented from vtkPlot.

static vtkPlotHistogram2D* vtkPlotHistogram2D::New ( )

static

Creates a new object.

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

virtual bool vtkPlotHistogram2D::Paint ( vtkContext2D *  painter )

virtual

Paint event for the item, called whenever it needs to be drawn.

virtual void vtkPlotHistogram2D::SetInputData ( vtkImageData *  data, vtkIdType  z = 0  )

virtual

Set the input, we are expecting a vtkImageData with just one component, this would normally be a float or a double. It will be passed to the other functions as a double to generate a color.

virtual void vtkPlotHistogram2D::SetInputData ( vtkTable *  )

inlinevirtual

Set the input, we are expecting a vtkImageData with just one component, this would normally be a float or a double. It will be passed to the other functions as a double to generate a color.

Reimplemented from vtkPlot.

Definition at line 56 of file vtkPlotHistogram2D.h.

virtual void vtkPlotHistogram2D::SetInputData ( vtkTable *  , const vtkStdString &  , const vtkStdString &    )

inlinevirtual

Set the input, we are expecting a vtkImageData with just one component, this would normally be a float or a double. It will be passed to the other functions as a double to generate a color.

Reimplemented from vtkPlot.

Definition at line 57 of file vtkPlotHistogram2D.h.

vtkImageData* vtkPlotHistogram2D::GetInputImageData

(

)

Get the input table used by the plot.

void vtkPlotHistogram2D::SetTransferFunction

(

vtkScalarsToColors *

transfer

)

Set the color transfer function that will be used to generate the 2D histogram.

vtkScalarsToColors* vtkPlotHistogram2D::GetTransferFunction

(

)

Get the color transfer function that is used to generate the histogram.

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

virtual

Get the bounds for this plot as (Xmin, Xmax, Ymin, Ymax). See GetUnscaledInputBounds for more information.

Reimplemented from vtkPlot.

virtual void vtkPlotHistogram2D::SetPosition ( const vtkRectf &  pos )

virtual

virtual vtkRectf vtkPlotHistogram2D::GetPosition ( )

virtual

virtual vtkStdString vtkPlotHistogram2D::GetTooltipLabel ( const vtkVector2f &  plotPos, vtkIdType  seriesIndex, vtkIdType  segmentIndex  )

virtual

Generate and return the tooltip label string for this plot The segmentIndex parameter is ignored. The member variable TooltipLabelFormat can be set as a printf-style string to build custom tooltip labels from, and may contain: An empty string generates the default tooltip labels. The following case-sensitive format tags (without quotes) are recognized: 'x' The X position of the histogram cell 'y' The Y position of the histogram cell 'v' The scalar value of the histogram cell Note: the i and j tags are valid only if there is a 1:1 correspondence between individual histogram cells and axis tick marks 'i' The X axis tick label for the histogram cell 'j' The Y axis tick label for the histogram cell Any other characters or unrecognized format tags are printed in the tooltip label verbatim.

Reimplemented from vtkPlot.

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

virtual

Function to query a plot for the nearest point to the specified coordinate. Returns an index between 0 and (number of histogram cells

• 1), or -1. The index 0 is at cell x=0, y=0 of the histogram, and the index increases in a minor fashon with x and in a major fashon with y. The referent of "location" is set to the x and y integer indices of the histogram cell.

Reimplemented from vtkPlot.

void vtkPlotHistogram2D::GenerateHistogram ( )

protected

Where all the magic happens...

Member Data Documentation

vtkSmartPointer<vtkImageData> vtkPlotHistogram2D::Input

protected

Definition at line 115 of file vtkPlotHistogram2D.h.

vtkSmartPointer<vtkImageData> vtkPlotHistogram2D::Output

protected

Definition at line 116 of file vtkPlotHistogram2D.h.

vtkSmartPointer<vtkScalarsToColors> vtkPlotHistogram2D::TransferFunction

protected

Definition at line 117 of file vtkPlotHistogram2D.h.

vtkRectf vtkPlotHistogram2D::Position

protected

Definition at line 118 of file vtkPlotHistogram2D.h.

---

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

• dox/Charts/Core/vtkPlotHistogram2D.h