vtkInteractorStyleTreeMapHover Class Reference

An interactor style for a tree map view. More...

#include <vtkInteractorStyleTreeMapHover.h>

Inheritance diagram for vtkInteractorStyleTreeMapHover:

Collaboration diagram for vtkInteractorStyleTreeMapHover:

List of all members.

Public Types
typedef vtkInteractorStyleImage	Superclass
Public Member Functions
virtual int	IsA (const char *type)
vtkInteractorStyleTreeMapHover *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	SetInteractor (vtkRenderWindowInteractor *rwi)
void	SetHighLightColor (double r, double g, double b)
void	SetSelectionLightColor (double r, double g, double b)
void	SetLayout (vtkTreeMapLayout *layout)
virtual vtkTreeMapLayout *	GetLayout ()
void	SetTreeMapToPolyData (vtkTreeMapToPolyData *filter)
virtual vtkTreeMapToPolyData *	GetTreeMapToPolyData ()
virtual void	SetLabelField (const char *)
virtual char *	GetLabelField ()
void	OnMouseMove ()
void	OnLeftButtonUp ()
void	HighLightItem (vtkIdType id)
void	HighLightCurrentSelectedItem ()
void	SetHighLightWidth (double lw)
double	GetHighLightWidth ()
void	SetSelectionWidth (double lw)
double	GetSelectionWidth ()
Static Public Member Functions
static vtkInteractorStyleTreeMapHover *	New ()
static int	IsTypeOf (const char *type)
static vtkInteractorStyleTreeMapHover *	SafeDownCast (vtkObjectBase *o)
Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkInteractorStyleTreeMapHover ()
	~vtkInteractorStyleTreeMapHover ()

---

Detailed Description

An interactor style for a tree map view.

The vtkInteractorStyleTreeMapHover specifically works with pipelines that create a tree map. Such pipelines will have a vtkTreeMapLayout filter and a vtkTreeMapToPolyData filter, both of which must be passed to this interactor style for it to function correctly. This interactor style allows only 2D panning and zooming, and additionally provides a balloon containing the name of the vertex hovered over, and allows the user to highlight a vertex by clicking on it.

Events:

vtkCommand::UserEvent vtkCommand::InteractionEvent

Tests:

vtkInteractorStyleTreeMapHover (Tests)

Definition at line 53 of file vtkInteractorStyleTreeMapHover.h.

---

Member Typedef Documentation

typedef vtkInteractorStyleImage vtkInteractorStyleTreeMapHover::Superclass

Reimplemented from vtkInteractorStyleImage.

Definition at line 57 of file vtkInteractorStyleTreeMapHover.h.

---

Constructor & Destructor Documentation

vtkInteractorStyleTreeMapHover::vtkInteractorStyleTreeMapHover

(

)

[protected]

vtkInteractorStyleTreeMapHover::~vtkInteractorStyleTreeMapHover

(

)

[protected]

---

Member Function Documentation

static vtkInteractorStyleTreeMapHover* vtkInteractorStyleTreeMapHover::New

(

)

[static]

This class must be supplied with a vtkRenderWindowInteractor wrapper or parent. This class should not normally be instantiated by application programmers.

Reimplemented from vtkInteractorStyleImage.

static int vtkInteractorStyleTreeMapHover::IsTypeOf

(

const char *

name

)

[static]

Return 1 if this class type 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 vtkInteractorStyleImage.

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

static vtkInteractorStyleTreeMapHover* vtkInteractorStyleTreeMapHover::SafeDownCast

(

vtkObjectBase *

o

)

[static]

Reimplemented from vtkInteractorStyleImage.

virtual vtkObjectBase* vtkInteractorStyleTreeMapHover::NewInstanceInternal

(

)

const [protected, virtual]

Reimplemented from vtkInteractorStyleImage.

vtkInteractorStyleTreeMapHover* vtkInteractorStyleTreeMapHover::NewInstance

(

)

const

Reimplemented from vtkInteractorStyleImage.

void vtkInteractorStyleTreeMapHover::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 vtkInteractorStyleImage.

void vtkInteractorStyleTreeMapHover::SetLayout

(

vtkTreeMapLayout *

layout

)

Must be set to the vtkTreeMapLayout used to compute the bounds of each vertex for the tree map.

virtual vtkTreeMapLayout* vtkInteractorStyleTreeMapHover::GetLayout

(

)

[virtual]

Must be set to the vtkTreeMapLayout used to compute the bounds of each vertex for the tree map.

void vtkInteractorStyleTreeMapHover::SetTreeMapToPolyData

(

vtkTreeMapToPolyData *

filter

)

Must be set to the vtkTreeMapToPolyData used to convert the tree map into polydata.

virtual vtkTreeMapToPolyData* vtkInteractorStyleTreeMapHover::GetTreeMapToPolyData

(

)

[virtual]

Must be set to the vtkTreeMapToPolyData used to convert the tree map into polydata.

virtual void vtkInteractorStyleTreeMapHover::SetLabelField

(

const char *

)

[virtual]

The name of the field to use when displaying text in the hover balloon.

virtual char* vtkInteractorStyleTreeMapHover::GetLabelField

(

)

[virtual]

The name of the field to use when displaying text in the hover balloon.

void vtkInteractorStyleTreeMapHover::OnMouseMove

(

)

[virtual]

Overridden from vtkInteractorStyleImage to provide the desired interaction behavior.

Reimplemented from vtkInteractorStyleImage.

void vtkInteractorStyleTreeMapHover::OnLeftButtonUp

(

)

[virtual]

Overridden from vtkInteractorStyleImage to provide the desired interaction behavior.

Reimplemented from vtkInteractorStyleImage.

void vtkInteractorStyleTreeMapHover::HighLightItem

(

vtkIdType

id

)

Highlights a specific vertex.

void vtkInteractorStyleTreeMapHover::HighLightCurrentSelectedItem

(

)

Highlights a specific vertex.

virtual void vtkInteractorStyleTreeMapHover::SetInteractor

(

vtkRenderWindowInteractor *

interactor

)

[virtual]

Set/Get the Interactor wrapper being controlled by this object. (Satisfy superclass API.)

Reimplemented from vtkInteractorStyle.

void vtkInteractorStyleTreeMapHover::SetHighLightColor	(	double	r,
		double	g,
		double	b
	)

Set the color used to highlight the hovered vertex.

void vtkInteractorStyleTreeMapHover::SetSelectionLightColor	(	double	r,
		double	g,
		double	b
	)

Set the color used to highlight the selected vertex.

void vtkInteractorStyleTreeMapHover::SetHighLightWidth

(

double

lw

)

The width of the line around the hovered vertex.

double vtkInteractorStyleTreeMapHover::GetHighLightWidth

(

)

The width of the line around the hovered vertex.

void vtkInteractorStyleTreeMapHover::SetSelectionWidth

(

double

lw

)

The width of the line around the selected vertex.

double vtkInteractorStyleTreeMapHover::GetSelectionWidth

(

)

The width of the line around the selected vertex.

---

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

• dox/Views/Infovis/vtkInteractorStyleTreeMapHover.h