vtkInteractorStyleTreeMapHover Class Reference

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

#include <vtkInteractorStyleTreeMapHover.h>

Inheritance diagram for vtkInteractorStyleTreeMapHover:

Collaboration diagram for vtkInteractorStyleTreeMapHover:

Public Types
typedef vtkInteractorStyleImage	Superclass
Public Types inherited from vtkInteractorStyleImage
typedef vtkInteractorStyleTrackballCamera	Superclass
Public Types inherited from vtkInteractorStyleTrackballCamera
typedef vtkInteractorStyle	Superclass
Public Types inherited from vtkInteractorStyle
typedef vtkInteractorObserver	Superclass
Public Types inherited from vtkInteractorObserver
typedef vtkObject	Superclass
Public Types inherited from vtkObject
typedef vtkObjectBase	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 ()
Public Member Functions inherited from vtkInteractorStyleImage
vtkInteractorStyleImage *	NewInstance () const
virtual void	OnChar ()
virtual void	WindowLevel ()
virtual void	Pick ()
virtual void	Slice ()
virtual void	StartWindowLevel ()
virtual void	EndWindowLevel ()
virtual void	StartPick ()
virtual void	EndPick ()
virtual void	StartSlice ()
virtual void	EndSlice ()
virtual int *	GetWindowLevelStartPosition ()
virtual void	GetWindowLevelStartPosition (int &, int &)
virtual void	GetWindowLevelStartPosition (int[2])
virtual int *	GetWindowLevelCurrentPosition ()
virtual void	GetWindowLevelCurrentPosition (int &, int &)
virtual void	GetWindowLevelCurrentPosition (int[2])
virtual void	OnLeftButtonDown ()
virtual void	OnMiddleButtonDown ()
virtual void	OnMiddleButtonUp ()
virtual void	OnRightButtonDown ()
virtual void	OnRightButtonUp ()
virtual void	SetInteractionMode (int)
virtual int	GetInteractionMode ()
void	SetInteractionModeToImage2D ()
void	SetInteractionModeToImage3D ()
void	SetInteractionModeToImageSlicing ()
virtual void	SetXViewRightVector (double, double, double)
virtual void	SetXViewRightVector (double[3])
virtual double *	GetXViewRightVector ()
virtual void	GetXViewRightVector (double &, double &, double &)
virtual void	GetXViewRightVector (double[3])
virtual void	SetXViewUpVector (double, double, double)
virtual void	SetXViewUpVector (double[3])
virtual double *	GetXViewUpVector ()
virtual void	GetXViewUpVector (double &, double &, double &)
virtual void	GetXViewUpVector (double[3])
virtual void	SetYViewRightVector (double, double, double)
virtual void	SetYViewRightVector (double[3])
virtual double *	GetYViewRightVector ()
virtual void	GetYViewRightVector (double &, double &, double &)
virtual void	GetYViewRightVector (double[3])
virtual void	SetYViewUpVector (double, double, double)
virtual void	SetYViewUpVector (double[3])
virtual double *	GetYViewUpVector ()
virtual void	GetYViewUpVector (double &, double &, double &)
virtual void	GetYViewUpVector (double[3])
virtual void	SetZViewRightVector (double, double, double)
virtual void	SetZViewRightVector (double[3])
virtual double *	GetZViewRightVector ()
virtual void	GetZViewRightVector (double &, double &, double &)
virtual void	GetZViewRightVector (double[3])
virtual void	SetZViewUpVector (double, double, double)
virtual void	SetZViewUpVector (double[3])
virtual double *	GetZViewUpVector ()
virtual void	GetZViewUpVector (double &, double &, double &)
virtual void	GetZViewUpVector (double[3])
void	SetImageOrientation (const double leftToRight[3], const double bottomToTop[3])
vtkImageProperty *	GetCurrentImageProperty ()
Public Member Functions inherited from vtkInteractorStyleTrackballCamera
vtkInteractorStyleTrackballCamera *	NewInstance () const
virtual void	Rotate ()
virtual void	Spin ()
virtual void	Pan ()
virtual void	Dolly ()
virtual void	OnMouseWheelForward ()
virtual void	OnMouseWheelBackward ()
virtual void	SetMotionFactor (double)
virtual double	GetMotionFactor ()
Public Member Functions inherited from vtkInteractorStyle
vtkInteractorStyle *	NewInstance () const
virtual void	SetEnabled (int)
void	FindPokedRenderer (int, int)
virtual void	OnKeyDown ()
virtual void	OnKeyUp ()
virtual void	OnKeyPress ()
virtual void	OnKeyRelease ()
virtual void	OnTimer ()
virtual void	SetAutoAdjustCameraClippingRange (int)
virtual int	GetAutoAdjustCameraClippingRange ()
virtual void	AutoAdjustCameraClippingRangeOn ()
virtual void	AutoAdjustCameraClippingRangeOff ()
virtual int	GetState ()
virtual int	GetUseTimers ()
virtual void	SetUseTimers (int)
virtual void	UseTimersOn ()
virtual void	UseTimersOff ()
virtual void	SetTimerDuration (unsigned long)
virtual unsigned long	GetTimerDuration ()
virtual void	SetHandleObservers (int)
virtual int	GetHandleObservers ()
virtual void	HandleObserversOn ()
virtual void	HandleObserversOff ()
virtual void	OnExpose ()
virtual void	OnConfigure ()
virtual void	OnEnter ()
virtual void	OnLeave ()
virtual void	Zoom ()
virtual void	UniformScale ()
virtual void	StartState (int newstate)
virtual void	StopState ()
virtual void	StartAnimate ()
virtual void	StopAnimate ()
virtual void	StartRotate ()
virtual void	EndRotate ()
virtual void	StartZoom ()
virtual void	EndZoom ()
virtual void	StartPan ()
virtual void	EndPan ()
virtual void	StartSpin ()
virtual void	EndSpin ()
virtual void	StartDolly ()
virtual void	EndDolly ()
virtual void	StartUniformScale ()
virtual void	EndUniformScale ()
virtual void	StartTimer ()
virtual void	EndTimer ()
virtual void	StartTwoPointer ()
virtual void	EndTwoPointer ()
virtual void	HighlightProp (vtkProp *prop)
virtual void	HighlightActor2D (vtkActor2D *actor2D)
virtual void	HighlightProp3D (vtkProp3D *prop3D)
virtual void	SetPickColor (double, double, double)
virtual void	SetPickColor (double[3])
virtual double *	GetPickColor ()
virtual void	GetPickColor (double data[3])
virtual void	SetMouseWheelMotionFactor (double)
virtual double	GetMouseWheelMotionFactor ()
virtual vtkTDxInteractorStyle *	GetTDxStyle ()
virtual void	SetTDxStyle (vtkTDxInteractorStyle *tdxStyle)
void	DelegateTDxEvent (unsigned long event, void *calldata)
Public Member Functions inherited from vtkInteractorObserver
vtkInteractorObserver *	NewInstance () const
int	GetEnabled ()
void	EnabledOn ()
void	EnabledOff ()
void	On ()
void	Off ()
virtual vtkRenderWindowInteractor *	GetInteractor ()
virtual void	SetPriority (float)
virtual float	GetPriority ()
virtual void	PickingManagedOn ()
virtual void	PickingManagedOff ()
virtual void	SetPickingManaged (bool)
virtual bool	GetPickingManaged ()
virtual void	SetKeyPressActivation (int)
virtual int	GetKeyPressActivation ()
virtual void	KeyPressActivationOn ()
virtual void	KeyPressActivationOff ()
virtual void	SetKeyPressActivationValue (char)
virtual char	GetKeyPressActivationValue ()
virtual vtkRenderer *	GetDefaultRenderer ()
virtual void	SetDefaultRenderer (vtkRenderer *)
virtual vtkRenderer *	GetCurrentRenderer ()
virtual void	SetCurrentRenderer (vtkRenderer *)
void	GrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void	ReleaseFocus ()
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 vtkInteractorStyleTreeMapHover *	New ()
static int	IsTypeOf (const char *type)
static vtkInteractorStyleTreeMapHover *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkInteractorStyleImage
static vtkInteractorStyleImage *	New ()
static int	IsTypeOf (const char *type)
static vtkInteractorStyleImage *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkInteractorStyleTrackballCamera
static vtkInteractorStyleTrackballCamera *	New ()
static int	IsTypeOf (const char *type)
static vtkInteractorStyleTrackballCamera *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkInteractorStyle
static vtkInteractorStyle *	New ()
static int	IsTypeOf (const char *type)
static vtkInteractorStyle *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkInteractorObserver
static int	IsTypeOf (const char *type)
static vtkInteractorObserver *	SafeDownCast (vtkObjectBase *o)
static void	ComputeDisplayToWorld (vtkRenderer *ren, double x, double y, double z, double worldPt[4])
static void	ComputeWorldToDisplay (vtkRenderer *ren, double x, double y, double z, double displayPt[3])
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
	vtkInteractorStyleTreeMapHover ()
	~vtkInteractorStyleTreeMapHover ()
Protected Member Functions inherited from vtkInteractorStyleImage
	vtkInteractorStyleImage ()
	~vtkInteractorStyleImage ()
void	SetCurrentImageToNthImage (int i)
Protected Member Functions inherited from vtkInteractorStyleTrackballCamera
	vtkInteractorStyleTrackballCamera ()
	~vtkInteractorStyleTrackballCamera ()
virtual void	Dolly (double factor)
Protected Member Functions inherited from vtkInteractorStyle
	vtkInteractorStyle ()
	~vtkInteractorStyle ()
Protected Member Functions inherited from vtkInteractorObserver
	vtkInteractorObserver ()
	~vtkInteractorObserver ()
virtual void	RegisterPickers ()
void	UnRegisterPickers ()
virtual void	PickersModified ()
vtkPickingManager *	GetPickingManager ()
int	RequestCursorShape (int requestedShape)
virtual void	StartInteraction ()
virtual void	EndInteraction ()
void	ComputeDisplayToWorld (double x, double y, double z, double worldPt[4])
void	ComputeWorldToDisplay (double x, double y, double z, double displayPt[3])
vtkAssemblyPath *	GetAssemblyPath (double X, double Y, double Z, vtkAbstractPropPicker *picker)
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 &)

Additional Inherited Members
Static Protected Member Functions inherited from vtkInteractorStyle
static void	ProcessEvents (vtkObject *object, unsigned long event, void *clientdata, void *calldata)
Static Protected Member Functions inherited from vtkInteractorObserver
static void	ProcessEvents (vtkObject *object, unsigned long event, void *clientdata, void *calldata)
Protected Attributes inherited from vtkInteractorStyleImage
int	WindowLevelStartPosition [2]
int	WindowLevelCurrentPosition [2]
double	WindowLevelInitial [2]
vtkImageProperty *	CurrentImageProperty
int	InteractionMode
double	XViewRightVector [3]
double	XViewUpVector [3]
double	YViewRightVector [3]
double	YViewUpVector [3]
double	ZViewRightVector [3]
double	ZViewUpVector [3]
Protected Attributes inherited from vtkInteractorStyleTrackballCamera
double	MotionFactor
Protected Attributes inherited from vtkInteractorStyle
int	State
int	AnimState
int	HandleObservers
int	UseTimers
int	TimerId
int	AutoAdjustCameraClippingRange
vtkOutlineSource *	Outline
vtkPolyDataMapper *	OutlineMapper
vtkActor *	OutlineActor
vtkRenderer *	PickedRenderer
vtkProp *	CurrentProp
vtkActor2D *	PickedActor2D
int	PropPicked
double	PickColor [3]
double	MouseWheelMotionFactor
unsigned long	TimerDuration
vtkEventForwarderCommand *	EventForwarder
vtkTDxInteractorStyle *	TDxStyle
Protected Attributes inherited from vtkInteractorObserver
int	Enabled
vtkCallbackCommand *	EventCallbackCommand
vtkCallbackCommand *	KeyPressCallbackCommand
float	Priority
bool	PickingManaged
int	KeyPressActivation
char	KeyPressActivationValue
vtkRenderWindowInteractor *	Interactor
vtkRenderer *	CurrentRenderer
vtkRenderer *	DefaultRenderer
unsigned long	CharObserverTag
unsigned long	DeleteObserverTag
vtkObserverMediator *	ObserverMediator
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount
vtkWeakPointerBase **	WeakPointers

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

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

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

static

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

virtual vtkObjectBase* vtkInteractorStyleTreeMapHover::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkInteractorStyleImage.

vtkInteractorStyleTreeMapHover* vtkInteractorStyleTreeMapHover::NewInstance

(

)

const

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:

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