vtkHeatmapItem Class Reference

A 2D graphics item for rendering a heatmap. More...

#include <vtkHeatmapItem.h>

Inheritance diagram for vtkHeatmapItem:

Collaboration diagram for vtkHeatmapItem:

Public Types
typedef vtkContextItem	Superclass
enum	{ LEFT_TO_RIGHT, UP_TO_DOWN, RIGHT_TO_LEFT, DOWN_TO_UP }
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)
vtkHeatmapItem *	NewInstance () const
virtual void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	SetTable (vtkTable *table)
vtkTable *	GetTable ()
vtkStringArray *	GetRowNames ()
void	SetOrientation (int orientation)
int	GetOrientation ()
double	GetTextAngleForOrientation (int orientation)
virtual void	GetBounds (double bounds[4])
void	MarkRowAsBlank (std::string rowName)
virtual bool	Paint (vtkContext2D *painter)
virtual bool	Hit (const vtkContextMouseEvent &mouse)
virtual bool	MouseMoveEvent (const vtkContextMouseEvent &event)
virtual bool	MouseDoubleClickEvent (const vtkContextMouseEvent &event)
virtual vtkStdString	GetNameColumn ()
virtual void	SetNameColumn (vtkStdString)
virtual void	SetPosition (float, float)
void	SetPosition (float[2])
void	SetPosition (const vtkVector2f &pos)
virtual float *	GetPosition ()
virtual void	GetPosition (float &, float &)
virtual void	GetPosition (float[2])
vtkVector2f	GetPositionVector ()
virtual double	GetCellHeight ()
virtual void	SetCellHeight (double)
virtual double	GetCellWidth ()
virtual void	SetCellWidth (double)
virtual float	GetRowLabelWidth ()
virtual float	GetColumnLabelWidth ()
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	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	MouseButtonPressEvent (const vtkContextMouseEvent &mouse)
virtual bool	MouseButtonReleaseEvent (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 vtkHeatmapItem *	New ()
static int	IsTypeOf (const char *type)
static vtkHeatmapItem *	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
	vtkHeatmapItem ()
	~vtkHeatmapItem ()
virtual void	RebuildBuffers ()
virtual void	PaintBuffers (vtkContext2D *painter)
virtual bool	IsDirty ()
void	InitializeLookupTables ()
void	AccumulateProminentCategoricalDataValues (vtkIdType column)
void	GenerateContinuousDataLookupTable ()
void	GenerateCategoricalDataLookupTable ()
std::string	GetTooltipText (float x, float y)
void	UpdateVisibleSceneExtent (vtkContext2D *painter)
bool	LineIsVisible (double x0, double y0, double x1, double y1)
void	ComputeBounds ()
void	ComputeLabelWidth (vtkContext2D *painter)
void	PositionColorLegend (int orientation)
void	PositionLegends (int orientation)
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
vtkVector2f	PositionVector
float *	Position
vtkSmartPointer< vtkTable >	Table
vtkStringArray *	RowNames
vtkStdString	NameColumn
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

A 2D graphics item for rendering a heatmap.

This item draws a heatmap as a part of a vtkContextScene.

.SEE ALSO vtkTable

Tests:

vtkHeatmapItem (Tests)

Definition at line 51 of file vtkHeatmapItem.h.

Member Typedef Documentation

typedef vtkContextItem vtkHeatmapItem::Superclass

Definition at line 55 of file vtkHeatmapItem.h.

Member Enumeration Documentation

anonymous enum

Enum for Orientation.

Enumerator
LEFT_TO_RIGHT
UP_TO_DOWN
RIGHT_TO_LEFT
DOWN_TO_UP

Definition at line 133 of file vtkHeatmapItem.h.

Constructor & Destructor Documentation

vtkHeatmapItem::vtkHeatmapItem ( )

protected

vtkHeatmapItem::~vtkHeatmapItem ( )

protected

Member Function Documentation

static vtkHeatmapItem* vtkHeatmapItem::New ( )

static

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

static

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

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

static

virtual vtkObjectBase* vtkHeatmapItem::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkContextItem.

vtkHeatmapItem* vtkHeatmapItem::NewInstance

(

)

const

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

virtual void vtkHeatmapItem::SetTable ( vtkTable *  table )

virtual

Set the table that this item draws. The first column of the table must contain the names of the rows.

vtkTable* vtkHeatmapItem::GetTable

(

)

Get the table that this item draws.

vtkStringArray* vtkHeatmapItem::GetRowNames

(

)

Get the table that this item draws.

virtual vtkStdString vtkHeatmapItem::GetNameColumn ( )

virtual

Get/Set the name of the column that specifies the name of this table's rows. By default, we assume this column will be named "name". If no such column can be found, we then assume that the 1st column in the table names the rows.

virtual void vtkHeatmapItem::SetNameColumn ( vtkStdString  )

virtual

Get/Set the name of the column that specifies the name of this table's rows. By default, we assume this column will be named "name". If no such column can be found, we then assume that the 1st column in the table names the rows.

void vtkHeatmapItem::SetOrientation

(

int

orientation

)

Set which way the table should face within the visualization.

int vtkHeatmapItem::GetOrientation

(

)

Get the current heatmap orientation.

double vtkHeatmapItem::GetTextAngleForOrientation

(

int

orientation

)

Get the angle that row labels should be rotated for the correponding heatmap orientation. For the default orientation (LEFT_TO_RIGHT), this is 0 degrees.

virtual void vtkHeatmapItem::SetPosition ( float  , float    )

virtual

Set the position of the heatmap.

void vtkHeatmapItem::SetPosition

(

float

[2]

)

Set the position of the heatmap.

void vtkHeatmapItem::SetPosition

(

const vtkVector2f &

pos

)

Set the position of the heatmap.

virtual float* vtkHeatmapItem::GetPosition ( )

virtual

Get position of the heatmap.

virtual void vtkHeatmapItem::GetPosition ( float &  , float &    )

virtual

Get position of the heatmap.

virtual void vtkHeatmapItem::GetPosition ( float  [2] )

virtual

Get position of the heatmap.

vtkVector2f vtkHeatmapItem::GetPositionVector

(

)

Get position of the heatmap.

virtual double vtkHeatmapItem::GetCellHeight ( )

virtual

Get/Set the height of the cells in our heatmap. Default is 18 pixels.

virtual void vtkHeatmapItem::SetCellHeight ( double  )

virtual

Get/Set the height of the cells in our heatmap. Default is 18 pixels.

virtual double vtkHeatmapItem::GetCellWidth ( )

virtual

Get/Set the width of the cells in our heatmap. Default is 36 pixels.

virtual void vtkHeatmapItem::SetCellWidth ( double  )

virtual

Get/Set the width of the cells in our heatmap. Default is 36 pixels.

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

virtual

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

void vtkHeatmapItem::MarkRowAsBlank

(

std::string

rowName

)

Mark a row as blank, meaning that no cells will be drawn for it. Used by vtkTreeHeatmapItem to represent missing data.

virtual bool vtkHeatmapItem::Paint ( vtkContext2D *  painter )

virtual

Paints the table as a heatmap.

Reimplemented from vtkAbstractContextItem.

virtual float vtkHeatmapItem::GetRowLabelWidth ( )

virtual

Get the width of the largest row or column label drawn by this heatmap.

virtual float vtkHeatmapItem::GetColumnLabelWidth ( )

virtual

Get the width of the largest row or column label drawn by this heatmap.

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

virtual

Returns true if the transform is interactive, false otherwise.

Reimplemented from vtkAbstractContextItem.

virtual bool vtkHeatmapItem::MouseMoveEvent ( const vtkContextMouseEvent &  event )

virtual

Display a tooltip when the user mouses over a cell in the heatmap.

Reimplemented from vtkAbstractContextItem.

virtual bool vtkHeatmapItem::MouseDoubleClickEvent ( const vtkContextMouseEvent &  event )

virtual

Display a legend for a column of data.

Reimplemented from vtkAbstractContextItem.

virtual void vtkHeatmapItem::RebuildBuffers ( )

protectedvirtual

Generate some data needed for painting. We cache this information as it only needs to be generated when the input data changes.

virtual void vtkHeatmapItem::PaintBuffers ( vtkContext2D *  painter )

protectedvirtual

This function does the bulk of the actual work in rendering our heatmap.

virtual bool vtkHeatmapItem::IsDirty ( )

protectedvirtual

This function returns a bool indicating whether or not we need to rebuild our cached data before painting.

void vtkHeatmapItem::InitializeLookupTables ( )

protected

Generate a separate vtkLookupTable for each column in the table.

void vtkHeatmapItem::AccumulateProminentCategoricalDataValues ( vtkIdType  column )

protected

Helper function. Find the prominent, distinct values in the specified column of strings and add it to our "master list" of categorical values. This list is then used to generate a vtkLookupTable for all categorical data within the heatmap.

void vtkHeatmapItem::GenerateContinuousDataLookupTable ( )

protected

Setup the default lookup table to use for continuous (not categorical) data.

void vtkHeatmapItem::GenerateCategoricalDataLookupTable ( )

protected

Setup the default lookup table to use for categorical (not continuous) data.

std::string vtkHeatmapItem::GetTooltipText ( float  x, float  y  )

protected

Get the value for the cell of the heatmap located at scene position (x, y) This function assumes the caller has already determined that (x, y) falls within the heatmap.

void vtkHeatmapItem::UpdateVisibleSceneExtent ( vtkContext2D *  painter )

protected

Calculate the extent of the data that is visible within the window. This information is used to ensure that we only draw details that will be seen by the user. This improves rendering speed, particularly for larger data.

bool vtkHeatmapItem::LineIsVisible ( double  x0, double  y0, double  x1, double  y1  )

protected

Returns true if any part of the line segment defined by endpoints (x0, y0), (x1, y1) falls within the extent of the currently visible scene. Returns false otherwise.

void vtkHeatmapItem::ComputeBounds ( )

protected

Compute the extent of the heatmap. This does not include the text labels.

void vtkHeatmapItem::ComputeLabelWidth ( vtkContext2D *  painter )

protected

Compute the width of our longest row label and the width of our longest column label. These values are used by GetBounds().

void vtkHeatmapItem::PositionColorLegend ( int  orientation )

protected

void vtkHeatmapItem::PositionLegends ( int  orientation )

protected

Member Data Documentation

vtkVector2f vtkHeatmapItem::PositionVector

protected

Definition at line 157 of file vtkHeatmapItem.h.

float* vtkHeatmapItem::Position

protected

Definition at line 158 of file vtkHeatmapItem.h.

vtkSmartPointer<vtkTable> vtkHeatmapItem::Table

protected

Definition at line 221 of file vtkHeatmapItem.h.

vtkStringArray* vtkHeatmapItem::RowNames

protected

Definition at line 222 of file vtkHeatmapItem.h.

vtkStdString vtkHeatmapItem::NameColumn

protected

Definition at line 223 of file vtkHeatmapItem.h.

---

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

• /home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Views/Infovis/vtkHeatmapItem.h