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

#include <vtkHeatmapItem.h>

Inheritance diagram for vtkHeatmapItem:

Collaboration diagram for vtkHeatmapItem:

Public Types
enum	{ LEFT_TO_RIGHT , UP_TO_DOWN , RIGHT_TO_LEFT , DOWN_TO_UP }
	Enum for Orientation. More...

typedef vtkContextItem	Superclass

Public Types inherited from vtkContextItem
typedef vtkAbstractContextItem	Superclass

Public Types inherited from vtkAbstractContextItem
typedef vtkObject	Superclass

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkHeatmapItem *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

virtual void	SetTable (vtkTable *table)
	Set the table that this item draws.

vtkTable *	GetTable ()
	Get the table that this item draws.

vtkStringArray *	GetRowNames ()
	Get the table that this item draws.

void	SetOrientation (int orientation)
	Set which way the table should face within the visualization.

int	GetOrientation ()
	Get the current heatmap orientation.

double	GetTextAngleForOrientation (int orientation)
	Get the angle that row labels should be rotated for the corresponding heatmap orientation.

virtual void	GetBounds (double bounds[4])
	Get the bounds for this item as (Xmin,Xmax,Ymin,Ymax).

void	MarkRowAsBlank (const std::string &rowName)
	Mark a row as blank, meaning that no cells will be drawn for it.

bool	Paint (vtkContext2D *painter) override
	Paints the table as a heatmap.

bool	Hit (const vtkContextMouseEvent &mouse) override
	Returns true if the transform is interactive, false otherwise.

bool	MouseMoveEvent (const vtkContextMouseEvent &event) override
	Display a tooltip when the user mouses over a cell in the heatmap.

bool	MouseDoubleClickEvent (const vtkContextMouseEvent &event) override
	Display a legend for a column of data.


virtual vtkStdString	GetNameColumn ()
	Get/Set the name of the column that specifies the name of this table's rows.

virtual void	SetNameColumn (vtkStdString)
	Get/Set the name of the column that specifies the name of this table's rows.


virtual void	SetPosition (float, float)
	Set the position of the heatmap.

void	SetPosition (float[2])
	Set the position of the heatmap.

void	SetPosition (const vtkVector2f &pos)
	Set the position of the heatmap.


virtual float *	GetPosition ()
	Get position of the heatmap.

virtual void	GetPosition (float &, float &)
	Get position of the heatmap.

virtual void	GetPosition (float[2])
	Get position of the heatmap.

vtkVector2f	GetPositionVector ()
	Get position of the heatmap.


virtual double	GetCellHeight ()
	Get/Set the height of the cells in our heatmap.

virtual void	SetCellHeight (double)
	Get/Set the height of the cells in our heatmap.


virtual double	GetCellWidth ()
	Get/Set the width of the cells in our heatmap.

virtual void	SetCellWidth (double)
	Get/Set the width of the cells in our heatmap.


virtual float	GetRowLabelWidth ()
	Get the width of the largest row or column label drawn by this heatmap.

virtual float	GetColumnLabelWidth ()
	Get the width of the largest row or column label drawn by this heatmap.

Public Member Functions inherited from vtkContextItem
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkContextItem *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

virtual void	SetTransform (vtkContextTransform *)
	Set the transform of the item.

virtual double	GetOpacity ()
	Get the opacity of the item.

virtual void	SetOpacity (double)
	Set the opacity of the item.

Public Member Functions inherited from vtkAbstractContextItem
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkAbstractContextItem *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

virtual void	Update ()
	Perform any updates to the item that may be necessary before rendering.

virtual bool	Paint (vtkContext2D *painter)
	Paint event for the item, called whenever the item needs to be drawn.

virtual bool	PaintChildren (vtkContext2D *painter)
	Paint the children of the item, should be called whenever the children need to be rendered.

virtual void	ReleaseGraphicsResources ()
	Release graphics resources hold by the item.

vtkIdType	AddItem (vtkAbstractContextItem *item)
	Add child items to this item.

bool	RemoveItem (vtkAbstractContextItem *item)
	Remove child item from this item.

bool	RemoveItem (vtkIdType index)
	Remove child item from this item.

vtkAbstractContextItem *	GetItem (vtkIdType index)
	Get the item at the specified index.

vtkIdType	GetItemIndex (vtkAbstractContextItem *item)
	Get the index of the specified item in itemIndex.

vtkIdType	GetNumberOfItems ()
	Get the number of child items.

void	ClearItems ()
	Remove all child items from this item.

vtkIdType	Raise (vtkIdType index)
	Raises the child to the top of the item's stack.

virtual vtkIdType	StackAbove (vtkIdType index, vtkIdType under)
	Raises the child above the under sibling.

vtkIdType	Lower (vtkIdType index)
	Lowers the child to the bottom of the item's stack.

virtual vtkIdType	StackUnder (vtkIdType child, vtkIdType above)
	Lowers the child under the above sibling.

virtual bool	Hit (const vtkContextMouseEvent &mouse)
	Return true if the supplied x, y coordinate is inside the item.

virtual vtkAbstractContextItem *	GetPickedItem (const vtkContextMouseEvent &mouse)
	Return the item under the mouse.

virtual bool	MouseEnterEvent (const vtkContextMouseEvent &mouse)
	Mouse enter event.

virtual bool	MouseMoveEvent (const vtkContextMouseEvent &mouse)
	Mouse move event.

virtual bool	MouseLeaveEvent (const vtkContextMouseEvent &mouse)
	Mouse leave event.

virtual bool	MouseButtonPressEvent (const vtkContextMouseEvent &mouse)
	Mouse button down event Return true if the item holds the event, false if the event can be propagated to other items.

virtual bool	MouseButtonReleaseEvent (const vtkContextMouseEvent &mouse)
	Mouse button release event.

virtual bool	MouseDoubleClickEvent (const vtkContextMouseEvent &mouse)
	Mouse button double click event.

virtual bool	MouseWheelEvent (const vtkContextMouseEvent &mouse, int delta)
	Mouse wheel event, positive delta indicates forward movement of the wheel.

virtual bool	KeyPressEvent (const vtkContextKeyEvent &key)
	Key press event.

virtual bool	KeyReleaseEvent (const vtkContextKeyEvent &key)
	Key release event.

virtual void	SetScene (vtkContextScene *scene)
	Set the vtkContextScene for the item, always set for an item in a scene.

vtkContextScene *	GetScene ()
	Get the vtkContextScene for the item, always set for an item in a scene.

virtual void	SetParent (vtkAbstractContextItem *parent)
	Set the parent item.

vtkAbstractContextItem *	GetParent ()
	Get the parent item.

virtual vtkVector2f	MapToParent (const vtkVector2f &point)
	Maps the point to the parent coordinate system.

virtual vtkVector2f	MapFromParent (const vtkVector2f &point)
	Maps the point from the parent coordinate system.

virtual vtkVector2f	MapToScene (const vtkVector2f &point)
	Maps the point to the scene coordinate system.

virtual vtkVector2f	MapFromScene (const vtkVector2f &point)
	Maps the point from the scene coordinate system.

virtual bool	GetVisible ()
	Get the visibility of the item (should it be drawn).

virtual void	SetVisible (bool)
	Set the visibility of the item (should it be drawn).

virtual bool	GetInteractive ()
	Get if the item is interactive (should respond to mouse events).

virtual void	SetInteractive (bool)
	Set if the item is interactive (should respond to mouse events).

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on.

virtual void	DebugOff ()
	Turn debugging output off.

bool	GetDebug ()
	Get the value of the debug flag.

void	SetDebug (bool debugFlag)
	Set the value of the debug flag.

virtual void	Modified ()
	Update the modification time for this object.

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

vtkTypeBool	HasObserver (unsigned long event)

vtkTypeBool	HasObserver (const char *event)

vtkTypeBool	InvokeEvent (unsigned long event)

vtkTypeBool	InvokeEvent (const char *event)

std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method.

vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.

vtkTypeBool	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not.

virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.

virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.

virtual std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.

virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

virtual void	Delete ()
	Delete a VTK object.

virtual void	FastDelete ()
	Delete a reference to this object.

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream.

void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).

int	GetReferenceCount ()
	Return the current reference count of this object.

void	SetReferenceCount (int)
	Sets the reference count.

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses `vtkGarbageCollector` or not.

Static Public Member Functions
static vtkHeatmapItem *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkHeatmapItem *	SafeDownCast (vtkObjectBase *o)

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

static vtkContextItem *	SafeDownCast (vtkObjectBase *o)

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

static vtkAbstractContextItem *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.

static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class.

static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkHeatmapItem ()

	~vtkHeatmapItem () override

virtual void	RebuildBuffers ()
	Generate some data needed for painting.

virtual void	PaintBuffers (vtkContext2D *painter)
	This function does the bulk of the actual work in rendering our heatmap.

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

void	InitializeLookupTables ()
	Generate a separate vtkLookupTable for each column in the table.

void	AccumulateProminentCategoricalDataValues (vtkIdType column)
	Helper function.

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

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

std::string	GetTooltipText (float x, float y)
	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	UpdateVisibleSceneExtent (vtkContext2D *painter)
	Calculate the extent of the data that is visible within the window.

bool	LineIsVisible (double x0, double y0, double x1, double y1)
	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.

void	ComputeBounds ()
	Compute the extent of the heatmap.

void	ComputeLabelWidth (vtkContext2D *painter)
	Compute the width of our longest row label and the width of our longest column label.

void	PositionColorLegend (int orientation)

void	PositionLegends (int orientation)

Protected Member Functions inherited from vtkContextItem
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkContextItem ()=default

	~vtkContextItem () override

Protected Member Functions inherited from vtkAbstractContextItem
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkAbstractContextItem ()

	~vtkAbstractContextItem () override

virtual void	ReleaseGraphicsCache ()
	Release cache entries created by this context item.

Protected Member Functions inherited from vtkObject
	vtkObject ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events.

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

virtual void	ObjectFinalize ()

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

vtkContextTransform *	Transform = nullptr

Protected Attributes inherited from vtkAbstractContextItem
vtkContextScene *	Scene
	Point to the scene the item is on - can be null.

vtkAbstractContextItem *	Parent
	Point to the parent item - can be null.

vtkContextScenePrivate *	Children
	This structure provides a list of children, along with convenience functions to paint the children etc.

bool	Visible
	Store the visibility of the item (default is true).

bool	Interactive
	Store whether the item should respond to interactions (default is true).

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

std::string	ObjectName

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

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 41 of file vtkHeatmapItem.h.

Member Typedef Documentation

◆ Superclass

typedef vtkContextItem vtkHeatmapItem::Superclass

Definition at line 45 of file vtkHeatmapItem.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enum for Orientation.

Enumerator
LEFT_TO_RIGHT
UP_TO_DOWN
RIGHT_TO_LEFT
DOWN_TO_UP

Definition at line 155 of file vtkHeatmapItem.h.

Constructor & Destructor Documentation

◆ vtkHeatmapItem()

vtkHeatmapItem::vtkHeatmapItem ( )

protected

◆ ~vtkHeatmapItem()

vtkHeatmapItem::~vtkHeatmapItem ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkHeatmapItem * vtkHeatmapItem::New ( )

static

◆ IsTypeOf()

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

static

◆ IsA()

virtual vtkTypeBool 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.

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkHeatmapItem::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkContextItem.

◆ NewInstance()

vtkHeatmapItem * vtkHeatmapItem::NewInstance ( ) const

◆ PrintSelf()

void vtkHeatmapItem::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

overridevirtual

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.

◆ SetTable()

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.

◆ GetTable()

vtkTable * vtkHeatmapItem::GetTable ( )

Get the table that this item draws.

◆ GetRowNames()

vtkStringArray * vtkHeatmapItem::GetRowNames ( )

Get the table that this item draws.

◆ GetNameColumn()

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.

◆ SetNameColumn()

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.

◆ SetOrientation()

void vtkHeatmapItem::SetOrientation ( int orientation )

Set which way the table should face within the visualization.

◆ GetOrientation()

int vtkHeatmapItem::GetOrientation ( )

Get the current heatmap orientation.

◆ GetTextAngleForOrientation()

double vtkHeatmapItem::GetTextAngleForOrientation ( int orientation )

Get the angle that row labels should be rotated for the corresponding heatmap orientation.

For the default orientation (LEFT_TO_RIGHT), this is 0 degrees.

◆ SetPosition() [1/3]

virtual void vtkHeatmapItem::SetPosition	(	float	,
		float
	)

virtual

Set the position of the heatmap.

◆ SetPosition() [2/3]

void vtkHeatmapItem::SetPosition ( float [2] )

Set the position of the heatmap.

◆ SetPosition() [3/3]

void vtkHeatmapItem::SetPosition ( const vtkVector2f & pos )

Set the position of the heatmap.

◆ GetPosition() [1/3]

virtual float * vtkHeatmapItem::GetPosition ( )

virtual

Get position of the heatmap.

◆ GetPosition() [2/3]

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

virtual

Get position of the heatmap.

◆ GetPosition() [3/3]

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

virtual

Get position of the heatmap.

◆ GetPositionVector()

vtkVector2f vtkHeatmapItem::GetPositionVector ( )

Get position of the heatmap.

◆ GetCellHeight()

virtual double vtkHeatmapItem::GetCellHeight ( )

virtual

Get/Set the height of the cells in our heatmap.

Default is 18 pixels.

◆ SetCellHeight()

virtual void vtkHeatmapItem::SetCellHeight ( double )

virtual

Get/Set the height of the cells in our heatmap.

Default is 18 pixels.

◆ GetCellWidth()

virtual double vtkHeatmapItem::GetCellWidth ( )

virtual

Get/Set the width of the cells in our heatmap.

Default is 36 pixels.

◆ SetCellWidth()

virtual void vtkHeatmapItem::SetCellWidth ( double )

virtual

Get/Set the width of the cells in our heatmap.

Default is 36 pixels.

◆ GetBounds()

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

virtual

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

◆ MarkRowAsBlank()

void vtkHeatmapItem::MarkRowAsBlank ( const std::string & rowName )

Mark a row as blank, meaning that no cells will be drawn for it.

Used by vtkTreeHeatmapItem to represent missing data.

◆ Paint()

bool vtkHeatmapItem::Paint ( vtkContext2D * painter )

overridevirtual

Paints the table as a heatmap.

Reimplemented from vtkAbstractContextItem.

◆ GetRowLabelWidth()

virtual float vtkHeatmapItem::GetRowLabelWidth ( )

virtual

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

◆ GetColumnLabelWidth()

virtual float vtkHeatmapItem::GetColumnLabelWidth ( )

virtual

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

◆ Hit()

bool vtkHeatmapItem::Hit ( const vtkContextMouseEvent & mouse )

overridevirtual

Returns true if the transform is interactive, false otherwise.

Reimplemented from vtkAbstractContextItem.

◆ MouseMoveEvent()

bool vtkHeatmapItem::MouseMoveEvent ( const vtkContextMouseEvent & event )

overridevirtual

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

Reimplemented from vtkAbstractContextItem.

◆ MouseDoubleClickEvent()

bool vtkHeatmapItem::MouseDoubleClickEvent ( const vtkContextMouseEvent & event )

overridevirtual

Display a legend for a column of data.

Reimplemented from vtkAbstractContextItem.

◆ RebuildBuffers()

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.

◆ PaintBuffers()

virtual void vtkHeatmapItem::PaintBuffers ( vtkContext2D * painter )

protectedvirtual

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

◆ IsDirty()

virtual bool vtkHeatmapItem::IsDirty ( )

protectedvirtual

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

◆ InitializeLookupTables()

void vtkHeatmapItem::InitializeLookupTables ( )

protected

Generate a separate vtkLookupTable for each column in the table.

◆ AccumulateProminentCategoricalDataValues()

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.

◆ GenerateContinuousDataLookupTable()

void vtkHeatmapItem::GenerateContinuousDataLookupTable ( )

protected

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

◆ GenerateCategoricalDataLookupTable()

void vtkHeatmapItem::GenerateCategoricalDataLookupTable ( )

protected

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

◆ GetTooltipText()

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.

◆ UpdateVisibleSceneExtent()

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.

◆ LineIsVisible()

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.

◆ ComputeBounds()

void vtkHeatmapItem::ComputeBounds ( )

protected

Compute the extent of the heatmap.

This does not include the text labels.

◆ ComputeLabelWidth()

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

◆ PositionColorLegend()

void vtkHeatmapItem::PositionColorLegend ( int orientation )

protected

◆ PositionLegends()

void vtkHeatmapItem::PositionLegends ( int orientation )

protected

Member Data Documentation

◆ PositionVector

vtkVector2f vtkHeatmapItem::PositionVector

protected

Definition at line 182 of file vtkHeatmapItem.h.

◆ Position

float* vtkHeatmapItem::Position

protected

Definition at line 183 of file vtkHeatmapItem.h.

◆ Table

vtkSmartPointer<vtkTable> vtkHeatmapItem::Table

protected

Definition at line 269 of file vtkHeatmapItem.h.

◆ RowNames

vtkStringArray* vtkHeatmapItem::RowNames

protected

Definition at line 270 of file vtkHeatmapItem.h.

◆ NameColumn

vtkStdString vtkHeatmapItem::NameColumn

protected

Definition at line 271 of file vtkHeatmapItem.h.

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

Views/Infovis/vtkHeatmapItem.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ vtkHeatmapItem()

◆ ~vtkHeatmapItem()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ SetTable()

◆ GetTable()

◆ GetRowNames()

◆ GetNameColumn()

◆ SetNameColumn()

◆ SetOrientation()

◆ GetOrientation()

◆ GetTextAngleForOrientation()

◆ SetPosition() [1/3]

◆ SetPosition() [2/3]

◆ SetPosition() [3/3]

◆ GetPosition() [1/3]

◆ GetPosition() [2/3]

◆ GetPosition() [3/3]

◆ GetPositionVector()

◆ GetCellHeight()

◆ SetCellHeight()

◆ GetCellWidth()

◆ SetCellWidth()

◆ GetBounds()

◆ MarkRowAsBlank()

◆ Paint()

◆ GetRowLabelWidth()

◆ GetColumnLabelWidth()

◆ Hit()

◆ MouseMoveEvent()

◆ MouseDoubleClickEvent()

◆ RebuildBuffers()

◆ PaintBuffers()

◆ IsDirty()

◆ InitializeLookupTables()

◆ AccumulateProminentCategoricalDataValues()

◆ GenerateContinuousDataLookupTable()

◆ GenerateCategoricalDataLookupTable()

◆ GetTooltipText()

◆ UpdateVisibleSceneExtent()

◆ LineIsVisible()

◆ ComputeBounds()

◆ ComputeLabelWidth()

◆ PositionColorLegend()

◆ PositionLegends()

Member Data Documentation

◆ PositionVector

◆ Position

◆ Table

◆ RowNames

◆ NameColumn