vtkTreeAreaView Class Reference

Accepts a graph and a hierarchy - currently a tree - and provides a hierarchy-aware display. Currently, this means displaying the hierarchy using a tree ring layout, then rendering the graph vertices as leaves of the tree with curved graph edges between leaves. More...

#include <vtkTreeAreaView.h>

Inheritance diagram for vtkTreeAreaView:

Collaboration diagram for vtkTreeAreaView:

Public Types
typedef vtkRenderView	Superclass
Public Types inherited from vtkRenderView
enum	{ INTERACTION_MODE_2D, INTERACTION_MODE_3D, INTERACTION_MODE_UNKNOWN }
enum	{ SURFACE = 0, FRUSTUM = 1 }
enum	{ NO_OVERLAP, ALL }
enum	{ FREETYPE, QT }
typedef vtkRenderViewBase	Superclass
Public Types inherited from vtkRenderViewBase
typedef vtkView	Superclass
Public Types inherited from vtkView
typedef vtkObject	Superclass

Public Member Functions
virtual int	IsA (const char *type)
vtkTreeAreaView *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
void	SetEdgeColorToSplineFraction ()
vtkDataRepresentation *	SetTreeFromInputConnection (vtkAlgorithmOutput *conn)
vtkDataRepresentation *	SetTreeFromInput (vtkTree *input)
vtkDataRepresentation *	SetGraphFromInputConnection (vtkAlgorithmOutput *conn)
vtkDataRepresentation *	SetGraphFromInput (vtkGraph *input)
void	SetAreaLabelArrayName (const char *name)
const char *	GetAreaLabelArrayName ()
void	SetAreaSizeArrayName (const char *name)
const char *	GetAreaSizeArrayName ()
void	SetLabelPriorityArrayName (const char *name)
const char *	GetLabelPriorityArrayName ()
void	SetEdgeLabelArrayName (const char *name)
const char *	GetEdgeLabelArrayName ()
void	SetAreaHoverArrayName (const char *name)
const char *	GetAreaHoverArrayName ()
void	SetAreaLabelVisibility (bool vis)
bool	GetAreaLabelVisibility ()
virtual void	AreaLabelVisibilityOn ()
virtual void	AreaLabelVisibilityOff ()
void	SetEdgeLabelVisibility (bool vis)
bool	GetEdgeLabelVisibility ()
virtual void	EdgeLabelVisibilityOn ()
virtual void	EdgeLabelVisibilityOff ()
void	SetAreaColorArrayName (const char *name)
const char *	GetAreaColorArrayName ()
void	SetColorAreas (bool vis)
bool	GetColorAreas ()
virtual void	ColorAreasOn ()
virtual void	ColorAreasOff ()
void	SetEdgeColorArrayName (const char *name)
const char *	GetEdgeColorArrayName ()
void	SetShrinkPercentage (double value)
double	GetShrinkPercentage ()
void	SetColorEdges (bool vis)
bool	GetColorEdges ()
virtual void	ColorEdgesOn ()
virtual void	ColorEdgesOff ()
void	SetBundlingStrength (double strength)
double	GetBundlingStrength ()
virtual void	SetAreaLabelFontSize (const int size)
virtual int	GetAreaLabelFontSize ()
virtual void	SetEdgeLabelFontSize (const int size)
virtual int	GetEdgeLabelFontSize ()
virtual void	SetLayoutStrategy (vtkAreaLayoutStrategy *strategy)
virtual vtkAreaLayoutStrategy *	GetLayoutStrategy ()
virtual void	SetUseRectangularCoordinates (bool rect)
virtual bool	GetUseRectangularCoordinates ()
virtual void	UseRectangularCoordinatesOn ()
virtual void	UseRectangularCoordinatesOff ()
virtual void	SetEdgeScalarBarVisibility (bool b)
virtual bool	GetEdgeScalarBarVisibility ()
Public Member Functions inherited from vtkRenderView
vtkRenderView *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	SetInteractor (vtkRenderWindowInteractor *interactor)
virtual void	SetInteractorStyle (vtkInteractorObserver *style)
virtual vtkInteractorObserver *	GetInteractorStyle ()
virtual void	SetRenderWindow (vtkRenderWindow *win)
void	SetInteractionMode (int mode)
virtual int	GetInteractionMode ()
virtual void	Render ()
virtual void	ApplyViewTheme (vtkViewTheme *theme)
virtual void	AddLabels (vtkAlgorithmOutput *conn)
virtual void	RemoveLabels (vtkAlgorithmOutput *conn)
virtual void	SetInteractionModeTo2D ()
virtual void	SetInteractionModeTo3D ()
virtual void	SetTransform (vtkAbstractTransform *transform)
virtual vtkAbstractTransform *	GetTransform ()
virtual void	SetDisplayHoverText (bool b)
virtual bool	GetDisplayHoverText ()
virtual void	DisplayHoverTextOn ()
virtual void	DisplayHoverTextOff ()
virtual void	SetSelectionMode (int)
virtual int	GetSelectionMode ()
void	SetSelectionModeToSurface ()
void	SetSelectionModeToFrustum ()
virtual void	SetIconTexture (vtkTexture *texture)
virtual vtkTexture *	GetIconTexture ()
virtual void	SetIconSize (int, int)
void	SetIconSize (int[2])
virtual int *	GetIconSize ()
virtual void	GetIconSize (int &, int &)
virtual void	GetIconSize (int[2])
virtual void	SetDisplaySize (int, int)
void	SetDisplaySize (int[2])
int *	GetDisplaySize ()
void	GetDisplaySize (int &dsx, int &dsy)
virtual void	SetLabelPlacementMode (int mode)
virtual int	GetLabelPlacementMode ()
virtual void	SetLabelPlacementModeToNoOverlap ()
virtual void	SetLabelPlacementModeToAll ()
virtual void	SetLabelRenderMode (int mode)
virtual int	GetLabelRenderMode ()
virtual void	SetLabelRenderModeToFreetype ()
virtual void	SetLabelRenderModeToQt ()
void	SetRenderOnMouseMove (bool b)
virtual bool	GetRenderOnMouseMove ()
virtual void	RenderOnMouseMoveOn ()
virtual void	RenderOnMouseMoveOff ()
Public Member Functions inherited from vtkRenderViewBase
vtkRenderViewBase *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
virtual vtkRenderer *	GetRenderer ()
virtual void	SetRenderer (vtkRenderer *ren)
virtual vtkRenderWindow *	GetRenderWindow ()
virtual void	ResetCamera ()
virtual void	ResetCameraClippingRange ()
virtual vtkRenderWindowInteractor *	GetInteractor ()
Public Member Functions inherited from vtkView
vtkView *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
void	AddRepresentation (vtkDataRepresentation *rep)
void	SetRepresentation (vtkDataRepresentation *rep)
vtkDataRepresentation *	AddRepresentationFromInputConnection (vtkAlgorithmOutput *conn)
vtkDataRepresentation *	SetRepresentationFromInputConnection (vtkAlgorithmOutput *conn)
vtkDataRepresentation *	AddRepresentationFromInput (vtkDataObject *input)
vtkDataRepresentation *	SetRepresentationFromInput (vtkDataObject *input)
void	RemoveRepresentation (vtkDataRepresentation *rep)
void	RemoveRepresentation (vtkAlgorithmOutput *rep)
void	RemoveAllRepresentations ()
int	GetNumberOfRepresentations ()
vtkDataRepresentation *	GetRepresentation (int index=0)
bool	IsRepresentationPresent (vtkDataRepresentation *rep)
virtual void	Update ()
virtual void	ApplyViewTheme (vtkViewTheme *vtkNotUsed(theme))
vtkCommand *	GetObserver ()
void	RegisterProgress (vtkObject *algorithm, const char *message=NULL)
void	UnRegisterProgress (vtkObject *algorithm)

Static Public Member Functions
static vtkTreeAreaView *	New ()
static int	IsTypeOf (const char *type)
static vtkTreeAreaView *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkRenderView
static vtkRenderView *	New ()
static int	IsTypeOf (const char *type)
static vtkRenderView *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkRenderViewBase
static vtkRenderViewBase *	New ()
static int	IsTypeOf (const char *type)
static vtkRenderViewBase *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkView
static vtkView *	New ()
static int	IsTypeOf (const char *type)
static vtkView *	SafeDownCast (vtkObjectBase *o)

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkTreeAreaView ()
	~vtkTreeAreaView ()
virtual void	SetAreaToPolyData (vtkPolyDataAlgorithm *areaToPoly)
virtual vtkPolyDataAlgorithm *	GetAreaToPolyData ()
virtual void	SetAreaLabelMapper (vtkLabeledDataMapper *mapper)
virtual vtkLabeledDataMapper *	GetAreaLabelMapper ()
virtual vtkDataRepresentation *	CreateDefaultRepresentation (vtkAlgorithmOutput *conn)
virtual vtkRenderedTreeAreaRepresentation *	GetTreeAreaRepresentation ()
Protected Member Functions inherited from vtkRenderView
virtual void	PrepareForRendering ()
virtual void	UpdateHoverText ()
virtual void	UpdateHoverWidgetState ()
void	UpdatePickRender ()
virtual void	ProcessEvents (vtkObject *caller, unsigned long eventId, void *callData)
virtual void	GenerateSelection (void *callData, vtkSelection *selection)
	vtkRenderView ()
	~vtkRenderView ()
Protected Member Functions inherited from vtkRenderViewBase
	vtkRenderViewBase ()
	~vtkRenderViewBase ()
Protected Member Functions inherited from vtkView
	vtkView ()
	~vtkView ()
virtual void	AddRepresentationInternal (vtkDataRepresentation *vtkNotUsed(rep))
virtual void	RemoveRepresentationInternal (vtkDataRepresentation *vtkNotUsed(rep))
virtual void	SetReuseSingleRepresentation (bool)
virtual bool	GetReuseSingleRepresentation ()
virtual void	ReuseSingleRepresentationOn ()
virtual void	ReuseSingleRepresentationOff ()

Additional Inherited Members
Protected Attributes inherited from vtkRenderView
int	SelectionMode
int	LabelRenderMode
bool	DisplayHoverText
bool	Interacting
bool	InHoverTextRender
bool	InPickRender
bool	PickRenderNeedsUpdate
vtkAbstractTransform *	Transform
vtkTexture *	IconTexture
int	IconSize [2]
int	DisplaySize [2]
int	InteractionMode
bool	RenderOnMouseMove
vtkSmartPointer< vtkRenderer >	LabelRenderer
vtkSmartPointer < vtkBalloonRepresentation >	Balloon
vtkSmartPointer < vtkLabelPlacementMapper >	LabelPlacementMapper
vtkSmartPointer < vtkTexturedActor2D >	LabelActor
vtkSmartPointer< vtkHoverWidget >	HoverWidget
vtkSmartPointer < vtkHardwareSelector >	Selector
Protected Attributes inherited from vtkRenderViewBase
vtkSmartPointer< vtkRenderer >	Renderer
vtkSmartPointer< vtkRenderWindow >	RenderWindow
Protected Attributes inherited from vtkView
bool	ReuseSingleRepresentation

Detailed Description

Accepts a graph and a hierarchy - currently a tree - and provides a hierarchy-aware display. Currently, this means displaying the hierarchy using a tree ring layout, then rendering the graph vertices as leaves of the tree with curved graph edges between leaves.

Takes a graph and a hierarchy (currently a tree) and lays out the graph vertices based on their categorization within the hierarchy.

.SEE ALSO vtkGraphLayoutView

Thanks:

Thanks to Jason Shepherd for implementing this class

Definition at line 52 of file vtkTreeAreaView.h.

Member Typedef Documentation

typedef vtkRenderView vtkTreeAreaView::Superclass

Definition at line 56 of file vtkTreeAreaView.h.

Constructor & Destructor Documentation

vtkTreeAreaView::vtkTreeAreaView ( )

protected

vtkTreeAreaView::~vtkTreeAreaView ( )

protected

Member Function Documentation

static vtkTreeAreaView* vtkTreeAreaView::New ( )

static

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

static

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

virtual

Reimplemented from vtkRenderView.

Reimplemented in vtkTreeRingView, vtkTreeMapView, and vtkIcicleView.

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

static

virtual vtkObjectBase* vtkTreeAreaView::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkRenderView.

Reimplemented in vtkTreeRingView, vtkTreeMapView, and vtkIcicleView.

vtkTreeAreaView* vtkTreeAreaView::NewInstance

(

)

const

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

vtkDataRepresentation* vtkTreeAreaView::SetTreeFromInputConnection

(

vtkAlgorithmOutput *

conn

)

Set the tree and graph representations to the appropriate input ports.

vtkDataRepresentation* vtkTreeAreaView::SetTreeFromInput

(

vtkTree *

input

)

Set the tree and graph representations to the appropriate input ports.

vtkDataRepresentation* vtkTreeAreaView::SetGraphFromInputConnection

(

vtkAlgorithmOutput *

conn

)

Set the tree and graph representations to the appropriate input ports.

vtkDataRepresentation* vtkTreeAreaView::SetGraphFromInput

(

vtkGraph *

input

)

Set the tree and graph representations to the appropriate input ports.

void vtkTreeAreaView::SetAreaLabelArrayName

(

const char *

name

)

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

const char* vtkTreeAreaView::GetAreaLabelArrayName

(

)

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

void vtkTreeAreaView::SetAreaSizeArrayName

(

const char *

name

)

The array to use for area sizes. Default is "size".

const char* vtkTreeAreaView::GetAreaSizeArrayName

(

)

The array to use for area sizes. Default is "size".

void vtkTreeAreaView::SetLabelPriorityArrayName

(

const char *

name

)

The array to use for area labeling priority. Default is "GraphVertexDegree".

const char* vtkTreeAreaView::GetLabelPriorityArrayName

(

)

The array to use for area labeling priority. Default is "GraphVertexDegree".

void vtkTreeAreaView::SetEdgeLabelArrayName

(

const char *

name

)

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

const char* vtkTreeAreaView::GetEdgeLabelArrayName

(

)

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

void vtkTreeAreaView::SetAreaHoverArrayName

(

const char *

name

)

The name of the array whose value appears when the mouse hovers over a rectangle in the treemap. This must be a string array.

const char* vtkTreeAreaView::GetAreaHoverArrayName

(

)

The name of the array whose value appears when the mouse hovers over a rectangle in the treemap. This must be a string array.

void vtkTreeAreaView::SetAreaLabelVisibility

(

bool

vis

)

Whether to show area labels. Default is off.

bool vtkTreeAreaView::GetAreaLabelVisibility

(

)

Whether to show area labels. Default is off.

virtual void vtkTreeAreaView::AreaLabelVisibilityOn ( )

virtual

Whether to show area labels. Default is off.

virtual void vtkTreeAreaView::AreaLabelVisibilityOff ( )

virtual

Whether to show area labels. Default is off.

void vtkTreeAreaView::SetEdgeLabelVisibility

(

bool

vis

)

Whether to show edge labels. Default is off.

bool vtkTreeAreaView::GetEdgeLabelVisibility

(

)

Whether to show edge labels. Default is off.

virtual void vtkTreeAreaView::EdgeLabelVisibilityOn ( )

virtual

Whether to show edge labels. Default is off.

virtual void vtkTreeAreaView::EdgeLabelVisibilityOff ( )

virtual

Whether to show edge labels. Default is off.

void vtkTreeAreaView::SetAreaColorArrayName

(

const char *

name

)

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

const char* vtkTreeAreaView::GetAreaColorArrayName

(

)

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

void vtkTreeAreaView::SetColorAreas

(

bool

vis

)

Whether to color vertices. Default is off.

bool vtkTreeAreaView::GetColorAreas

(

)

Whether to color vertices. Default is off.

virtual void vtkTreeAreaView::ColorAreasOn ( )

virtual

Whether to color vertices. Default is off.

virtual void vtkTreeAreaView::ColorAreasOff ( )

virtual

Whether to color vertices. Default is off.

void vtkTreeAreaView::SetEdgeColorArrayName

(

const char *

name

)

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

const char* vtkTreeAreaView::GetEdgeColorArrayName

(

)

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

void vtkTreeAreaView::SetEdgeColorToSplineFraction

(

)

Set the color to be the spline fraction

void vtkTreeAreaView::SetShrinkPercentage

(

double

value

)

Set the region shrink percentage between 0.0 and 1.0.

double vtkTreeAreaView::GetShrinkPercentage

(

)

Set the region shrink percentage between 0.0 and 1.0.

void vtkTreeAreaView::SetColorEdges

(

bool

vis

)

Whether to color edges. Default is off.

bool vtkTreeAreaView::GetColorEdges

(

)

Whether to color edges. Default is off.

virtual void vtkTreeAreaView::ColorEdgesOn ( )

virtual

Whether to color edges. Default is off.

virtual void vtkTreeAreaView::ColorEdgesOff ( )

virtual

Whether to color edges. Default is off.

void vtkTreeAreaView::SetBundlingStrength

(

double

strength

)

Set the bundling strength.

double vtkTreeAreaView::GetBundlingStrength

(

)

Set the bundling strength.

virtual void vtkTreeAreaView::SetAreaLabelFontSize ( const int  size )

virtual

The size of the font used for area labeling

virtual int vtkTreeAreaView::GetAreaLabelFontSize ( )

virtual

The size of the font used for area labeling

virtual void vtkTreeAreaView::SetEdgeLabelFontSize ( const int  size )

virtual

The size of the font used for edge labeling

virtual int vtkTreeAreaView::GetEdgeLabelFontSize ( )

virtual

The size of the font used for edge labeling

virtual void vtkTreeAreaView::SetLayoutStrategy ( vtkAreaLayoutStrategy *  strategy )

virtual

The layout strategy for producing spatial regions for the tree.

Reimplemented in vtkTreeMapView.

virtual vtkAreaLayoutStrategy* vtkTreeAreaView::GetLayoutStrategy ( )

virtual

The layout strategy for producing spatial regions for the tree.

virtual void vtkTreeAreaView::SetUseRectangularCoordinates ( bool  rect )

virtual

Whether the area represents radial or rectangular coordinates.

virtual bool vtkTreeAreaView::GetUseRectangularCoordinates ( )

virtual

Whether the area represents radial or rectangular coordinates.

virtual void vtkTreeAreaView::UseRectangularCoordinatesOn ( )

virtual

Whether the area represents radial or rectangular coordinates.

virtual void vtkTreeAreaView::UseRectangularCoordinatesOff ( )

virtual

Whether the area represents radial or rectangular coordinates.

virtual void vtkTreeAreaView::SetEdgeScalarBarVisibility ( bool  b )

virtual

Visibility of scalar bar actor for edges.

virtual bool vtkTreeAreaView::GetEdgeScalarBarVisibility ( )

virtual

Visibility of scalar bar actor for edges.

virtual void vtkTreeAreaView::SetAreaToPolyData ( vtkPolyDataAlgorithm *  areaToPoly )

protectedvirtual

The filter for converting areas to polydata. This may e.g. be vtkTreeMapToPolyData or vtkTreeRingToPolyData. The filter must take a vtkTree as input and produce vtkPolyData.

virtual vtkPolyDataAlgorithm* vtkTreeAreaView::GetAreaToPolyData ( )

protectedvirtual

The filter for converting areas to polydata. This may e.g. be vtkTreeMapToPolyData or vtkTreeRingToPolyData. The filter must take a vtkTree as input and produce vtkPolyData.

virtual void vtkTreeAreaView::SetAreaLabelMapper ( vtkLabeledDataMapper *  mapper )

protectedvirtual

The mapper for rendering labels on areas. This may e.g. be vtkDynamic2DLabelMapper or vtkTreeMapLabelMapper.

virtual vtkLabeledDataMapper* vtkTreeAreaView::GetAreaLabelMapper ( )

protectedvirtual

The mapper for rendering labels on areas. This may e.g. be vtkDynamic2DLabelMapper or vtkTreeMapLabelMapper.

virtual vtkDataRepresentation* vtkTreeAreaView::CreateDefaultRepresentation ( vtkAlgorithmOutput *  conn )

protectedvirtual

Overrides behavior in vtkView to create a vtkRenderedGraphRepresentation by default.

Reimplemented from vtkView.

virtual vtkRenderedTreeAreaRepresentation* vtkTreeAreaView::GetTreeAreaRepresentation ( )

protectedvirtual

Overrides behavior in vtkView to create a vtkRenderedGraphRepresentation by default.

---

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

• dox/Views/Infovis/vtkTreeAreaView.h