vtkGraphLayout Class Reference

#include <vtkGraphLayout.h>

Inheritance diagram for vtkGraphLayout:

Inheritance graph
[legend]
Collaboration diagram for vtkGraphLayout:

Collaboration graph
[legend]

List of all members.


Detailed Description

layout a graph in 2 or 3 dimensions

This class is a shell for many graph layout strategies which may be set using the SetLayoutStrategy() function. The layout strategies do the actual work.

.SECION Thanks Thanks to Brian Wylie from Sandia National Laboratories for adding incremental layout capabilities.

Examples:
vtkGraphLayout (Examples)
Tests:
vtkGraphLayout (Tests)

Definition at line 48 of file vtkGraphLayout.h.


Public Types

typedef vtkGraphAlgorithm Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual int IsLayoutComplete ()
virtual unsigned long GetMTime ()
void SetLayoutStrategy (vtkGraphLayoutStrategy *strategy)
virtual vtkGraphLayoutStrategyGetLayoutStrategy ()
virtual double GetZRange ()
virtual void SetZRange (double)
virtual vtkAbstractTransformGetTransform ()
virtual void SetTransform (vtkAbstractTransform *t)
virtual void SetUseTransform (bool)
virtual bool GetUseTransform ()
virtual void UseTransformOn ()
virtual void UseTransformOff ()

Static Public Member Functions

static vtkGraphLayoutNew ()
static int IsTypeOf (const char *type)
static vtkGraphLayoutSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkGraphLayout ()
 ~vtkGraphLayout ()
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)

Protected Attributes

vtkGraphLayoutStrategyLayoutStrategy
vtkEventForwarderCommandEventForwarder

Member Typedef Documentation

Reimplemented from vtkGraphAlgorithm.

Definition at line 52 of file vtkGraphLayout.h.


Constructor & Destructor Documentation

vtkGraphLayout::vtkGraphLayout (  )  [protected]

vtkGraphLayout::~vtkGraphLayout (  )  [protected]


Member Function Documentation

static vtkGraphLayout* vtkGraphLayout::New (  )  [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkGraphAlgorithm.

virtual const char* vtkGraphLayout::GetClassName (  )  [virtual]

Reimplemented from vtkGraphAlgorithm.

static int vtkGraphLayout::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 vtkGraphAlgorithm.

virtual int vtkGraphLayout::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 vtkGraphAlgorithm.

static vtkGraphLayout* vtkGraphLayout::SafeDownCast ( vtkObject o  )  [static]

Reimplemented from vtkGraphAlgorithm.

void vtkGraphLayout::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 vtkGraphAlgorithm.

void vtkGraphLayout::SetLayoutStrategy ( vtkGraphLayoutStrategy strategy  ) 

The layout strategy to use during graph layout.

virtual vtkGraphLayoutStrategy* vtkGraphLayout::GetLayoutStrategy (  )  [virtual]

The layout strategy to use during graph layout.

virtual int vtkGraphLayout::IsLayoutComplete (  )  [virtual]

Ask the layout algorithm if the layout is complete

virtual unsigned long vtkGraphLayout::GetMTime (  )  [virtual]

Get the modification time of the layout algorithm.

Reimplemented from vtkObject.

virtual double vtkGraphLayout::GetZRange (  )  [virtual]

Set the ZRange for the output data. If the initial layout is planar (i.e. all z coordinates are zero), the coordinates will be evenly spaced from 0.0 to ZRange. The default is zero, which has no effect.

virtual void vtkGraphLayout::SetZRange ( double   )  [virtual]

Set the ZRange for the output data. If the initial layout is planar (i.e. all z coordinates are zero), the coordinates will be evenly spaced from 0.0 to ZRange. The default is zero, which has no effect.

virtual vtkAbstractTransform* vtkGraphLayout::GetTransform (  )  [virtual]

Transform the graph vertices after the layout.

virtual void vtkGraphLayout::SetTransform ( vtkAbstractTransform t  )  [virtual]

Transform the graph vertices after the layout.

virtual void vtkGraphLayout::SetUseTransform ( bool   )  [virtual]

Whether to use the specified transform after layout.

virtual bool vtkGraphLayout::GetUseTransform (  )  [virtual]

Whether to use the specified transform after layout.

virtual void vtkGraphLayout::UseTransformOn (  )  [virtual]

Whether to use the specified transform after layout.

virtual void vtkGraphLayout::UseTransformOff (  )  [virtual]

Whether to use the specified transform after layout.

int vtkGraphLayout::RequestData ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
) [protected, virtual]

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

Reimplemented from vtkGraphAlgorithm.


Member Data Documentation

Definition at line 92 of file vtkGraphLayout.h.

This intercepts events from the strategy object and re-emits them as if they came from the layout engine itself.

Definition at line 96 of file vtkGraphLayout.h.


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

Generated on Mon Sep 27 18:26:15 2010 for VTK by  doxygen 1.5.6