abstract superclass for all area layout strategies More...

#include <vtkAreaLayoutStrategy.h>

Inheritance diagram for vtkAreaLayoutStrategy:

Collaboration diagram for vtkAreaLayoutStrategy:

Public Types
typedef vtkObject	Superclass

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkAreaLayoutStrategy *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

virtual void	LayoutEdgePoints (vtkTree inputTree, vtkDataArray areaArray, vtkDataArray sizeArray, vtkTree edgeLayoutTree)

virtual vtkIdType	FindVertex (vtkTree tree, vtkDataArray array, float pnt[2])=0

virtual void	SetShrinkPercentage (double)

virtual double	GetShrinkPercentage ()


virtual void	Layout (vtkTree inputTree, vtkDataArray areaArray, vtkDataArray *sizeArray)=0

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 int	IsTypeOf (const char *type)

static vtkAreaLayoutStrategy *	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

	vtkAreaLayoutStrategy ()

	~vtkAreaLayoutStrategy ()

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
double	ShrinkPercentage

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

abstract superclass for all area layout strategies

All subclasses of this class perform a area layout on a tree. This involves assigning a region to each vertex in the tree, and placing that information in a data array with four components per tuple representing (innerRadius, outerRadius, startAngle, endAngle).

Instances of subclasses of this class may be assigned as the layout strategy to vtkAreaLayout

Thanks:: Thanks to Jason Shepherd from Sandia National Laboratories for help developing this class.

Definition at line 47 of file vtkAreaLayoutStrategy.h.

Member Typedef Documentation

typedef vtkObject vtkAreaLayoutStrategy::Superclass

Definition at line 50 of file vtkAreaLayoutStrategy.h.

Constructor & Destructor Documentation

vtkAreaLayoutStrategy::vtkAreaLayoutStrategy ( )

protected

vtkAreaLayoutStrategy::~vtkAreaLayoutStrategy ( )

protected

Member Function Documentation

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

static

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

Reimplemented in vtkTreeMapLayoutStrategy, vtkSquarifyLayoutStrategy, vtkStackedTreeLayoutStrategy, vtkSliceAndDiceLayoutStrategy, and vtkBoxLayoutStrategy.

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

static

virtual vtkObjectBase* vtkAreaLayoutStrategy::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkObject.

Reimplemented in vtkTreeMapLayoutStrategy, vtkSquarifyLayoutStrategy, vtkStackedTreeLayoutStrategy, vtkSliceAndDiceLayoutStrategy, and vtkBoxLayoutStrategy.

vtkAreaLayoutStrategy* vtkAreaLayoutStrategy::NewInstance ( ) const

void vtkAreaLayoutStrategy::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 vtkObject.

Reimplemented in vtkTreeMapLayoutStrategy, vtkSquarifyLayoutStrategy, vtkStackedTreeLayoutStrategy, vtkSliceAndDiceLayoutStrategy, and vtkBoxLayoutStrategy.

virtual void vtkAreaLayoutStrategy::Layout	(	vtkTree *	inputTree,
		vtkDataArray *	areaArray,
		vtkDataArray *	sizeArray
	)

pure virtual

Perform the layout of the input tree, and store the sector bounds of each vertex as a tuple in a data array. For radial layout, this is (innerRadius, outerRadius, startAngle, endAngle). For rectangular layout, this is (xmin, xmax, ymin, ymax). The sizeArray may be NULL, or may contain the desired size of each vertex in the tree.

Implemented in vtkSquarifyLayoutStrategy, vtkStackedTreeLayoutStrategy, vtkSliceAndDiceLayoutStrategy, and vtkBoxLayoutStrategy.

virtual void vtkAreaLayoutStrategy::LayoutEdgePoints	(	vtkTree *	inputTree,
		vtkDataArray *	areaArray,
		vtkDataArray *	sizeArray,
		vtkTree *	edgeLayoutTree
	)

virtual

Reimplemented in vtkStackedTreeLayoutStrategy.

virtual vtkIdType vtkAreaLayoutStrategy::FindVertex	(	vtkTree *	tree,
		vtkDataArray *	array,
		float	pnt[2]
	)

pure virtual

Returns the vertex id that contains pnt (or -1 if no one contains it)

Implemented in vtkStackedTreeLayoutStrategy, and vtkTreeMapLayoutStrategy.

virtual void vtkAreaLayoutStrategy::SetShrinkPercentage ( double )

virtual

virtual double vtkAreaLayoutStrategy::GetShrinkPercentage ( )

virtual

Member Data Documentation

double vtkAreaLayoutStrategy::ShrinkPercentage

protected

Definition at line 85 of file vtkAreaLayoutStrategy.h.

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

/home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Infovis/Layout/vtkAreaLayoutStrategy.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation