vtkTreeMapLayout Class Reference

layout a vtkTree into a tree map More...

#include <vtkTreeMapLayout.h>

Inheritance diagram for vtkTreeMapLayout:

Collaboration diagram for vtkTreeMapLayout:

Public Types
typedef vtkTreeAlgorithm	Superclass
Public Types inherited from vtkTreeAlgorithm
typedef vtkAlgorithm	Superclass
Public Types inherited from vtkAlgorithm
typedef vtkObject	Superclass
enum	DesiredOutputPrecision { SINGLE_PRECISION, DOUBLE_PRECISION, DEFAULT_PRECISION }

Public Member Functions
virtual int	IsA (const char *type)
vtkTreeMapLayout *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
vtkIdType	FindVertex (float pnt[2], float *binfo=0)
void	GetBoundingBox (vtkIdType id, float *binfo)
virtual unsigned long	GetMTime ()
virtual char *	GetRectanglesFieldName ()
virtual void	SetRectanglesFieldName (const char *)
virtual void	SetSizeArrayName (const char *name)
virtual vtkTreeMapLayoutStrategy *	GetLayoutStrategy ()
void	SetLayoutStrategy (vtkTreeMapLayoutStrategy *strategy)
Public Member Functions inherited from vtkTreeAlgorithm
vtkTreeAlgorithm *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
virtual int	ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
vtkTree *	GetOutput ()
vtkTree *	GetOutput (int index)
void	SetInputData (vtkDataObject *obj)
void	SetInputData (int index, vtkDataObject *obj)
Public Member Functions inherited from vtkAlgorithm
vtkAlgorithm *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
int	HasExecutive ()
vtkExecutive *	GetExecutive ()
virtual void	SetExecutive (vtkExecutive *executive)
virtual int	ModifyRequest (vtkInformation *request, int when)
vtkInformation *	GetInputPortInformation (int port)
vtkInformation *	GetOutputPortInformation (int port)
int	GetNumberOfInputPorts ()
int	GetNumberOfOutputPorts ()
void	UpdateProgress (double amount)
vtkInformation *	GetInputArrayInformation (int idx)
void	RemoveAllInputs ()
vtkDataObject *	GetOutputDataObject (int port)
virtual void	RemoveInputConnection (int port, vtkAlgorithmOutput *input)
virtual void	RemoveInputConnection (int port, int idx)
virtual void	RemoveAllInputConnections (int port)
int	GetNumberOfInputConnections (int port)
int	GetTotalNumberOfInputConnections ()
vtkAlgorithmOutput *	GetInputConnection (int port, int index)
vtkAlgorithm *	GetInputAlgorithm (int port, int index, int &algPort)
vtkAlgorithm *	GetInputAlgorithm (int port, int index)
vtkExecutive *	GetInputExecutive (int port, int index)
vtkInformation *	GetInputInformation (int port, int index)
vtkInformation *	GetOutputInformation (int port)
virtual void	UpdateInformation ()
virtual void	PropagateUpdateExtent ()
virtual void	UpdateWholeExtent ()
void	ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
virtual double	ComputePriority ()
int	SetUpdateExtentToWholeExtent (int port)
int	SetUpdateExtentToWholeExtent ()
void	SetUpdateExtent (int port, int extent[6])
int	ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
virtual int	ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, unsigned long *mtime)
virtual vtkInformation *	GetInformation ()
virtual void	SetInformation (vtkInformation *)
virtual void	Register (vtkObjectBase *o)
virtual void	UnRegister (vtkObjectBase *o)
virtual void	SetAbortExecute (int)
virtual int	GetAbortExecute ()
virtual void	AbortExecuteOn ()
virtual void	AbortExecuteOff ()
virtual void	SetProgress (double)
virtual double	GetProgress ()
void	SetProgressText (const char *ptext)
virtual char *	GetProgressText ()
virtual unsigned long	GetErrorCode ()
virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
virtual void	SetInputArrayToProcess (int idx, vtkInformation *info)
virtual void	SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
vtkDataObject *	GetInputDataObject (int port, int connection)
virtual void	SetInputConnection (int port, vtkAlgorithmOutput *input)
virtual void	SetInputConnection (vtkAlgorithmOutput *input)
virtual void	AddInputConnection (int port, vtkAlgorithmOutput *input)
virtual void	AddInputConnection (vtkAlgorithmOutput *input)
virtual void	SetInputDataObject (int port, vtkDataObject *data)
virtual void	SetInputDataObject (vtkDataObject *data)
virtual void	AddInputDataObject (int port, vtkDataObject *data)
virtual void	AddInputDataObject (vtkDataObject *data)
vtkAlgorithmOutput *	GetOutputPort (int index)
vtkAlgorithmOutput *	GetOutputPort ()
vtkAlgorithm *	GetInputAlgorithm ()
vtkExecutive *	GetInputExecutive ()
vtkInformation *	GetInputInformation ()
virtual void	Update (int port)
virtual void	Update ()
virtual void	SetReleaseDataFlag (int)
virtual int	GetReleaseDataFlag ()
void	ReleaseDataFlagOn ()
void	ReleaseDataFlagOff ()
int	UpdateExtentIsEmpty (vtkInformation *pinfo, vtkDataObject *output)
int	UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
void	SetUpdateExtent (int port, int piece, int numPieces, int ghostLevel)
void	SetUpdateExtent (int piece, int numPieces, int ghostLevel)
void	SetUpdateExtent (int extent[6])
int *	GetUpdateExtent ()
int *	GetUpdateExtent (int port)
void	GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
void	GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
void	GetUpdateExtent (int extent[6])
void	GetUpdateExtent (int port, int extent[6])
int	GetUpdatePiece ()
int	GetUpdatePiece (int port)
int	GetUpdateNumberOfPieces ()
int	GetUpdateNumberOfPieces (int port)
int	GetUpdateGhostLevel ()
int	GetUpdateGhostLevel (int port)

Static Public Member Functions
static vtkTreeMapLayout *	New ()
static int	IsTypeOf (const char *type)
static vtkTreeMapLayout *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkTreeAlgorithm
static vtkTreeAlgorithm *	New ()
static int	IsTypeOf (const char *type)
static vtkTreeAlgorithm *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithm *	New ()
static int	IsTypeOf (const char *type)
static vtkAlgorithm *	SafeDownCast (vtkObjectBase *o)
static void	SetDefaultExecutivePrototype (vtkExecutive *proto)
static vtkInformationIntegerKey *	INPUT_IS_OPTIONAL ()
static vtkInformationIntegerKey *	INPUT_IS_REPEATABLE ()
static vtkInformationInformationVectorKey *	INPUT_REQUIRED_FIELDS ()
static vtkInformationStringVectorKey *	INPUT_REQUIRED_DATA_TYPE ()
static vtkInformationInformationVectorKey *	INPUT_ARRAYS_TO_PROCESS ()
static vtkInformationIntegerKey *	INPUT_PORT ()
static vtkInformationIntegerKey *	INPUT_CONNECTION ()
static vtkInformationIntegerKey *	PRESERVES_DATASET ()
static vtkInformationIntegerKey *	PRESERVES_GEOMETRY ()
static vtkInformationIntegerKey *	PRESERVES_BOUNDS ()
static vtkInformationIntegerKey *	PRESERVES_TOPOLOGY ()
static vtkInformationIntegerKey *	PRESERVES_ATTRIBUTES ()
static vtkInformationIntegerKey *	PRESERVES_RANGES ()
static vtkInformationIntegerKey *	MANAGES_METAINFORMATION ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkTreeMapLayout ()
	~vtkTreeMapLayout ()
int	RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
Protected Member Functions inherited from vtkTreeAlgorithm
	vtkTreeAlgorithm ()
	~vtkTreeAlgorithm ()
virtual int	RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
virtual int	FillOutputPortInformation (int port, vtkInformation *info)
virtual int	FillInputPortInformation (int port, vtkInformation *info)
virtual int	RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
Protected Member Functions inherited from vtkAlgorithm
	vtkAlgorithm ()
	~vtkAlgorithm ()
virtual void	SetNumberOfInputPorts (int n)
virtual void	SetNumberOfOutputPorts (int n)
int	InputPortIndexInRange (int index, const char *action)
int	OutputPortIndexInRange (int index, const char *action)
int	GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
virtual vtkExecutive *	CreateDefaultExecutive ()
virtual void	ReportReferences (vtkGarbageCollector *)
virtual void	SetNumberOfInputConnections (int port, int n)
int	GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
int	GetInputArrayAssociation (int idx, vtkDataObject *input)
vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input)
vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkInformation *	GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
virtual void	SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
void	SetInputDataInternal (int port, vtkDataObject *input)
void	AddInputDataInternal (int port, vtkDataObject *input)
virtual void	SetErrorCode (unsigned long)

Protected Attributes
char *	RectanglesFieldName
vtkTreeMapLayoutStrategy *	LayoutStrategy
Protected Attributes inherited from vtkAlgorithm
vtkInformation *	Information
double	Progress
char *	ProgressText
unsigned long	ErrorCode

Additional Inherited Members
Public Attributes inherited from vtkAlgorithm
int	AbortExecute
Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey *	PORT_REQUIREMENTS_FILLED ()
Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutive *	DefaultExecutivePrototype

Detailed Description

layout a vtkTree into a tree map

vtkTreeMapLayout assigns rectangular regions to each vertex in the tree, creating a tree map. The data is added as a data array with four components per tuple representing the location and size of the rectangle using the format (Xmin, Xmax, Ymin, Ymax).

This algorithm relies on a helper class to perform the actual layout. This helper class is a subclass of vtkTreeMapLayoutStrategy.

Thanks:

Thanks to Brian Wylie and Ken Moreland from Sandia National Laboratories for help developing this class.

Thanks:

Tree map concept comes from: Shneiderman, B. 1992. Tree visualization with tree-maps: 2-d space-filling approach. ACM Trans. Graph. 11, 1 (Jan. 1992), 92-99.

Tests:

vtkTreeMapLayout (Tests)

Definition at line 53 of file vtkTreeMapLayout.h.

Member Typedef Documentation

typedef vtkTreeAlgorithm vtkTreeMapLayout::Superclass

Definition at line 58 of file vtkTreeMapLayout.h.

Constructor & Destructor Documentation

vtkTreeMapLayout::vtkTreeMapLayout ( )

protected

vtkTreeMapLayout::~vtkTreeMapLayout ( )

protected

Member Function Documentation

static vtkTreeMapLayout* vtkTreeMapLayout::New ( )

static

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

static

virtual int vtkTreeMapLayout::IsA ( const char *  type )

virtual

Reimplemented from vtkTreeAlgorithm.

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

static

virtual vtkObjectBase* vtkTreeMapLayout::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkTreeAlgorithm.

vtkTreeMapLayout* vtkTreeMapLayout::NewInstance

(

)

const

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

virtual char* vtkTreeMapLayout::GetRectanglesFieldName ( )

virtual

The field name to use for storing the rectangles for each vertex. The rectangles are stored in a quadruple float array (minX, maxX, minY, maxY).

virtual void vtkTreeMapLayout::SetRectanglesFieldName ( const char *  )

virtual

The field name to use for storing the rectangles for each vertex. The rectangles are stored in a quadruple float array (minX, maxX, minY, maxY).

virtual void vtkTreeMapLayout::SetSizeArrayName ( const char *  name )

inlinevirtual

The array to use for the size of each vertex.

Definition at line 71 of file vtkTreeMapLayout.h.

virtual vtkTreeMapLayoutStrategy* vtkTreeMapLayout::GetLayoutStrategy ( )

virtual

The strategy to use when laying out the tree map.

void vtkTreeMapLayout::SetLayoutStrategy

(

vtkTreeMapLayoutStrategy *

strategy

)

The strategy to use when laying out the tree map.

vtkIdType vtkTreeMapLayout::FindVertex	(	float	pnt[2],
		float *	binfo = 0
	)

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

void vtkTreeMapLayout::GetBoundingBox	(	vtkIdType	id,
		float *	binfo
	)

Return the min and max 2D points of the vertex's bounding box

virtual unsigned long vtkTreeMapLayout::GetMTime ( )

virtual

Get the modification time of the layout algorithm.

int vtkTreeMapLayout::RequestData ( vtkInformation *  request, vtkInformationVector **  inputVector, vtkInformationVector *  outputVector  )

protectedvirtual

This is called by the superclass. This is the method you should override.

Reimplemented from vtkTreeAlgorithm.

Member Data Documentation

char* vtkTreeMapLayout::RectanglesFieldName

protected

Definition at line 94 of file vtkTreeMapLayout.h.

vtkTreeMapLayoutStrategy* vtkTreeMapLayout::LayoutStrategy

protected

Definition at line 95 of file vtkTreeMapLayout.h.

---

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

• dox/Infovis/Layout/vtkTreeMapLayout.h