vtkTreeLayoutView Class Reference

#include <vtkTreeLayoutView.h>

Inheritance diagram for vtkTreeLayoutView:

Inheritance graph
[legend]
Collaboration diagram for vtkTreeLayoutView:

Collaboration graph
[legend]

List of all members.


Detailed Description

Lays out and displays a tree.

vtkTreeLayoutView displays a tree in radial or standard "top-down" format. You may specify the vertex labels and colors.

Examples:
vtkTreeLayoutView (Examples)
Tests:
vtkTreeLayoutView (Tests)

Definition at line 55 of file vtkTreeLayoutView.h.


Public Types

typedef vtkRenderView Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual void SetupRenderWindow (vtkRenderWindow *win)
virtual void ApplyViewTheme (vtkViewTheme *theme)
void SetLabelArrayName (const char *name)
const char * GetLabelArrayName ()
void SetLabelVisibility (bool vis)
bool GetLabelVisibility ()
void LabelVisibilityOn ()
void LabelVisibilityOff ()
void SetVertexColorArrayName (const char *name)
const char * GetVertexColorArrayName ()
void SetColorVertices (bool vis)
bool GetColorVertices ()
void ColorVerticesOn ()
void ColorVerticesOff ()
void SetEdgeColorArrayName (const char *name)
const char * GetEdgeColorArrayName ()
void SetColorEdges (bool vis)
bool GetColorEdges ()
void ColorEdgesOn ()
void ColorEdgesOff ()
void SetAngle (double angle)
double GetAngle ()
void SetRadial (bool radial)
bool GetRadial ()
void RadialOn ()
void RadialOff ()
void SetLogSpacingValue (double value)
double GetLogSpacingValue ()
void SetLeafSpacing (double value)
double GetLeafSpacing ()
const char * GetDistanceArrayName ()
void SetDistanceArrayName (const char *name)

Static Public Member Functions

static vtkTreeLayoutViewNew ()
static int IsTypeOf (const char *type)
static vtkTreeLayoutViewSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkTreeLayoutView ()
 ~vtkTreeLayoutView ()
virtual void AddInputConnection (vtkAlgorithmOutput *conn)
virtual void RemoveInputConnection (vtkAlgorithmOutput *conn)
virtual void SetSelectionLink (vtkSelectionLink *link)
virtual void PrepareForRendering ()
void MapToXYPlane (double displayX, double displayY, double &x, double &y)
virtual void ProcessEvents (vtkObject *caller, unsigned long eventId, void *callData)
virtual char * GetVertexColorArrayNameInternal ()
virtual void SetVertexColorArrayNameInternal (const char *)
virtual char * GetEdgeColorArrayNameInternal ()
virtual void SetEdgeColorArrayNameInternal (const char *)

Protected Attributes

char * VertexColorArrayNameInternal
char * EdgeColorArrayNameInternal
vtkCoordinateCoordinate
vtkGraphLayoutGraphLayout
vtkTreeLayoutStrategyTreeStrategy
vtkGraphToPolyDataGraphToPolyData
vtkVertexGlyphFilterVertexGlyph
vtkPolyDataMapperVertexMapper
vtkLookupTableVertexColorLUT
vtkActorVertexActor
vtkPolyDataMapperOutlineMapper
vtkActorOutlineActor
vtkPolyDataMapperEdgeMapper
vtkLookupTableEdgeColorLUT
vtkActorEdgeActor
vtkDynamic2DLabelMapperLabelMapper
vtkActor2DLabelActor
vtkKdTreeSelectorKdTreeSelector
vtkVisibleCellSelectorVisibleCellSelector
vtkExtractSelectedGraphExtractSelectedGraph
vtkGraphToPolyDataSelectionToPolyData
vtkVertexGlyphFilterSelectionVertexGlyph
vtkPolyDataMapperSelectionVertexMapper
vtkActorSelectionVertexActor
vtkPolyDataMapperSelectionEdgeMapper
vtkActorSelectionEdgeActor

Member Typedef Documentation

Reimplemented from vtkRenderView.

Definition at line 59 of file vtkTreeLayoutView.h.


Constructor & Destructor Documentation

vtkTreeLayoutView::vtkTreeLayoutView (  )  [protected]

vtkTreeLayoutView::~vtkTreeLayoutView (  )  [protected]


Member Function Documentation

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

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

Reimplemented from vtkRenderView.

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

Reimplemented from vtkRenderView.

static int vtkTreeLayoutView::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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkRenderView.

virtual int vtkTreeLayoutView::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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkRenderView.

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

Reimplemented from vtkRenderView.

void vtkTreeLayoutView::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 vtkRenderView.

void vtkTreeLayoutView::SetLabelArrayName ( const char *  name  ) 

The array to use for labeling. Default is "label".

const char* vtkTreeLayoutView::GetLabelArrayName (  ) 

The array to use for labeling. Default is "label".

void vtkTreeLayoutView::SetLabelVisibility ( bool  vis  ) 

Whether to show labels. Default is off.

bool vtkTreeLayoutView::GetLabelVisibility (  ) 

Whether to show labels. Default is off.

void vtkTreeLayoutView::LabelVisibilityOn (  ) 

Whether to show labels. Default is off.

void vtkTreeLayoutView::LabelVisibilityOff (  ) 

Whether to show labels. Default is off.

void vtkTreeLayoutView::SetVertexColorArrayName ( const char *  name  ) 

The array to use for coloring vertices. Default is "color".

const char* vtkTreeLayoutView::GetVertexColorArrayName (  ) 

The array to use for coloring vertices. Default is "color".

void vtkTreeLayoutView::SetColorVertices ( bool  vis  ) 

Whether to show labels. Default is off.

bool vtkTreeLayoutView::GetColorVertices (  ) 

Whether to show labels. Default is off.

void vtkTreeLayoutView::ColorVerticesOn (  ) 

Whether to show labels. Default is off.

void vtkTreeLayoutView::ColorVerticesOff (  ) 

Whether to show labels. Default is off.

void vtkTreeLayoutView::SetEdgeColorArrayName ( const char *  name  ) 

The array to use for coloring edges. Default is "color".

const char* vtkTreeLayoutView::GetEdgeColorArrayName (  ) 

The array to use for coloring edges. Default is "color".

void vtkTreeLayoutView::SetColorEdges ( bool  vis  ) 

Whether to show labels. Default is off.

bool vtkTreeLayoutView::GetColorEdges (  ) 

Whether to show labels. Default is off.

void vtkTreeLayoutView::ColorEdgesOn (  ) 

Whether to show labels. Default is off.

void vtkTreeLayoutView::ColorEdgesOff (  ) 

Whether to show labels. Default is off.

void vtkTreeLayoutView::SetAngle ( double  angle  ) 

The sweep angle of the tree. For a standard tree layout, this should be between 0 and 180. For a radial tree layout, this can be between 0 and 360.

double vtkTreeLayoutView::GetAngle (  ) 

The sweep angle of the tree. For a standard tree layout, this should be between 0 and 180. For a radial tree layout, this can be between 0 and 360.

void vtkTreeLayoutView::SetRadial ( bool  radial  ) 

If set, the tree is laid out with levels on concentric circles around the root. If unset (default), the tree is laid out with levels on horizontal lines.

bool vtkTreeLayoutView::GetRadial (  ) 

If set, the tree is laid out with levels on concentric circles around the root. If unset (default), the tree is laid out with levels on horizontal lines.

void vtkTreeLayoutView::RadialOn (  ) 

If set, the tree is laid out with levels on concentric circles around the root. If unset (default), the tree is laid out with levels on horizontal lines.

void vtkTreeLayoutView::RadialOff (  ) 

If set, the tree is laid out with levels on concentric circles around the root. If unset (default), the tree is laid out with levels on horizontal lines.

void vtkTreeLayoutView::SetLogSpacingValue ( double  value  ) 

The spacing of tree levels. Levels near zero give more space to levels near the root, while levels near one (the default) create evenly-spaced levels.

double vtkTreeLayoutView::GetLogSpacingValue (  ) 

The spacing of tree levels. Levels near zero give more space to levels near the root, while levels near one (the default) create evenly-spaced levels.

void vtkTreeLayoutView::SetLeafSpacing ( double  value  ) 

The spacing of leaves. Levels near one evenly space leaves with no gaps between subtrees. Levels near zero creates large gaps between subtrees.

double vtkTreeLayoutView::GetLeafSpacing (  ) 

The spacing of leaves. Levels near one evenly space leaves with no gaps between subtrees. Levels near zero creates large gaps between subtrees.

const char* vtkTreeLayoutView::GetDistanceArrayName (  ) 

Get/Set the array to use to determine the distance from the root.

void vtkTreeLayoutView::SetDistanceArrayName ( const char *  name  ) 

Get/Set the array to use to determine the distance from the root.

virtual void vtkTreeLayoutView::SetupRenderWindow ( vtkRenderWindow win  )  [virtual]

Sets up interactor style.

Reimplemented from vtkRenderView.

virtual void vtkTreeLayoutView::ApplyViewTheme ( vtkViewTheme theme  )  [virtual]

Apply the theme to this view.

Reimplemented from vtkRenderView.

virtual void vtkTreeLayoutView::ProcessEvents ( vtkObject caller,
unsigned long  eventId,
void *  callData 
) [protected, virtual]

Called to process the user event from the interactor style.

Reimplemented from vtkRenderView.

virtual void vtkTreeLayoutView::AddInputConnection ( vtkAlgorithmOutput conn  )  [protected, virtual]

Connects the algorithm output to the internal pipeline. This view only supports a single representation.

virtual void vtkTreeLayoutView::RemoveInputConnection ( vtkAlgorithmOutput conn  )  [protected, virtual]

Removes the algorithm output from the internal pipeline.

virtual void vtkTreeLayoutView::SetSelectionLink ( vtkSelectionLink link  )  [protected, virtual]

Connects the selection link to the internal pipeline.

virtual void vtkTreeLayoutView::PrepareForRendering (  )  [protected, virtual]

Prepares the view for rendering.

Reimplemented from vtkRenderView.

void vtkTreeLayoutView::MapToXYPlane ( double  displayX,
double  displayY,
double &  x,
double &  y 
) [protected]

May a display coordinate to a world coordinate on the x-y plane.

virtual char* vtkTreeLayoutView::GetVertexColorArrayNameInternal (  )  [protected, virtual]

Used to store the vertex and edge color array names

virtual void vtkTreeLayoutView::SetVertexColorArrayNameInternal ( const char *   )  [protected, virtual]

Used to store the vertex and edge color array names

virtual char* vtkTreeLayoutView::GetEdgeColorArrayNameInternal (  )  [protected, virtual]

Used to store the vertex and edge color array names

virtual void vtkTreeLayoutView::SetEdgeColorArrayNameInternal ( const char *   )  [protected, virtual]

Used to store the vertex and edge color array names


Member Data Documentation

Definition at line 181 of file vtkTreeLayoutView.h.

Definition at line 185 of file vtkTreeLayoutView.h.

Definition at line 188 of file vtkTreeLayoutView.h.

Definition at line 191 of file vtkTreeLayoutView.h.

Definition at line 192 of file vtkTreeLayoutView.h.

Definition at line 193 of file vtkTreeLayoutView.h.

Definition at line 194 of file vtkTreeLayoutView.h.

Definition at line 195 of file vtkTreeLayoutView.h.

Definition at line 196 of file vtkTreeLayoutView.h.

Definition at line 197 of file vtkTreeLayoutView.h.

Definition at line 198 of file vtkTreeLayoutView.h.

Definition at line 199 of file vtkTreeLayoutView.h.

Definition at line 200 of file vtkTreeLayoutView.h.

Definition at line 201 of file vtkTreeLayoutView.h.

Definition at line 202 of file vtkTreeLayoutView.h.

Definition at line 203 of file vtkTreeLayoutView.h.

Definition at line 204 of file vtkTreeLayoutView.h.

Definition at line 207 of file vtkTreeLayoutView.h.

Definition at line 208 of file vtkTreeLayoutView.h.

Definition at line 209 of file vtkTreeLayoutView.h.

Definition at line 210 of file vtkTreeLayoutView.h.

Definition at line 211 of file vtkTreeLayoutView.h.

Definition at line 212 of file vtkTreeLayoutView.h.

Definition at line 213 of file vtkTreeLayoutView.h.

Definition at line 214 of file vtkTreeLayoutView.h.

Definition at line 215 of file vtkTreeLayoutView.h.


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

Generated on Sat Dec 27 13:55:17 2008 for VTK by  doxygen 1.5.6