VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkCirclePackLayout Class Reference

layout a vtkTree as a circle packing. More...

#include <vtkCirclePackLayout.h>

Inheritance diagram for vtkCirclePackLayout:
[legend]
Collaboration diagram for vtkCirclePackLayout:
[legend]

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)
 
vtkCirclePackLayoutNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
vtkIdType FindVertex (double pnt[2], double *cinfo=0)
 
void GetBoundingCircle (vtkIdType id, double *cinfo)
 
virtual unsigned long GetMTime ()
 
virtual char * GetCirclesFieldName ()
 
virtual void SetCirclesFieldName (const char *)
 
virtual void SetSizeArrayName (const char *name)
 
virtual
vtkCirclePackLayoutStrategy
GetLayoutStrategy ()
 
void SetLayoutStrategy (vtkCirclePackLayoutStrategy *strategy)
 
- Public Member Functions inherited from vtkTreeAlgorithm
vtkTreeAlgorithmNewInstance () 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
vtkAlgorithmNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
int HasExecutive ()
 
vtkExecutiveGetExecutive ()
 
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 ()
 
vtkDataObjectGetOutputDataObject (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 ()
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 
vtkExecutiveGetInputExecutive (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)
 
vtkDataObjectGetInputDataObject (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)
 
vtkAlgorithmOutputGetOutputPort (int index)
 
vtkAlgorithmOutputGetOutputPort ()
 
vtkAlgorithmGetInputAlgorithm ()
 
vtkExecutiveGetInputExecutive ()
 
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 vtkCirclePackLayoutNew ()
 
static int IsTypeOf (const char *type)
 
static vtkCirclePackLayoutSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkTreeAlgorithm
static vtkTreeAlgorithmNew ()
 
static int IsTypeOf (const char *type)
 
static vtkTreeAlgorithmSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static int IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (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
 
 vtkCirclePackLayout ()
 
 ~vtkCirclePackLayout ()
 
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 vtkExecutiveCreateDefaultExecutive ()
 
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 * CirclesFieldName
 
vtkCirclePackLayoutStrategyLayoutStrategy
 
- 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 vtkExecutiveDefaultExecutivePrototype
 

Detailed Description

layout a vtkTree as a circle packing.

vtkCirclePackLayout assigns circle shaped regions to each vertex in the tree, creating a circle packing layout. The data is added as a data array with three components per tuple representing the center and radius of the circle using the format (Xcenter, Ycenter, Radius).

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

An array by default called "size" can be attached to the input tree that specifies the size of each leaf node in the tree. The filter will calculate the sizes of all interior nodes in the tree based on the sum of the leaf node sizes. If no "size" array is given in the input vtkTree, a size of 1 is used for all leaf nodes to find the size of the interior nodes.

Thanks:
Thanks to Thomas Otahal from Sandia National Laboratories for help developing this class.
Tests:
vtkCirclePackLayout (Tests)

Definition at line 58 of file vtkCirclePackLayout.h.

Member Typedef Documentation

Definition at line 63 of file vtkCirclePackLayout.h.

Constructor & Destructor Documentation

vtkCirclePackLayout::vtkCirclePackLayout ( )
protected
vtkCirclePackLayout::~vtkCirclePackLayout ( )
protected

Member Function Documentation

static vtkCirclePackLayout* vtkCirclePackLayout::New ( )
static
static int vtkCirclePackLayout::IsTypeOf ( const char *  type)
static
virtual int vtkCirclePackLayout::IsA ( const char *  type)
virtual

Reimplemented from vtkTreeAlgorithm.

static vtkCirclePackLayout* vtkCirclePackLayout::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkCirclePackLayout::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkTreeAlgorithm.

vtkCirclePackLayout* vtkCirclePackLayout::NewInstance ( ) const
void vtkCirclePackLayout::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual char* vtkCirclePackLayout::GetCirclesFieldName ( )
virtual

The field name to use for storing the circles for each vertex. The rectangles are stored in a triple float array (Xcenter, Ycenter, Radius). Default name is "circles"

virtual void vtkCirclePackLayout::SetCirclesFieldName ( const char *  )
virtual

The field name to use for storing the circles for each vertex. The rectangles are stored in a triple float array (Xcenter, Ycenter, Radius). Default name is "circles"

virtual void vtkCirclePackLayout::SetSizeArrayName ( const char *  name)
inlinevirtual

The array to use for the size of each vertex. Default name is "size".

Definition at line 77 of file vtkCirclePackLayout.h.

virtual vtkCirclePackLayoutStrategy* vtkCirclePackLayout::GetLayoutStrategy ( )
virtual

The strategy to use when laying out the tree map.

void vtkCirclePackLayout::SetLayoutStrategy ( vtkCirclePackLayoutStrategy strategy)

The strategy to use when laying out the tree map.

vtkIdType vtkCirclePackLayout::FindVertex ( double  pnt[2],
double *  cinfo = 0 
)

Returns the vertex id that contains pnt (or -1 if no one contains it) pnt[0] is x, and pnt[1] is y. If cinfo[3] is provided, then (Xcenter, Ycenter, Radius) of the circle containing pnt[2] will be returned.

void vtkCirclePackLayout::GetBoundingCircle ( vtkIdType  id,
double *  cinfo 
)

Return the Xcenter, Ycenter, and Radius of the vertex's bounding circle

virtual unsigned long vtkCirclePackLayout::GetMTime ( )
virtual

Get the modification time of the layout algorithm.

int vtkCirclePackLayout::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* vtkCirclePackLayout::CirclesFieldName
protected

Definition at line 104 of file vtkCirclePackLayout.h.

vtkCirclePackLayoutStrategy* vtkCirclePackLayout::LayoutStrategy
protected

Definition at line 105 of file vtkCirclePackLayout.h.


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