VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions
vtkTreeRingView Class Reference

Displays a tree in concentric rings. More...

#include <vtkTreeRingView.h>

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

List of all members.

Public Types

typedef vtkTreeAreaView Superclass
- Public Types inherited from vtkTreeAreaView
- 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 }
- Public Types inherited from vtkRenderViewBase
- Public Types inherited from vtkView
- Public Types inherited from vtkObject

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
void SetRootAngles (double start, double end)
virtual void SetRootAtCenter (bool value)
virtual bool GetRootAtCenter ()
virtual void RootAtCenterOn ()
virtual void RootAtCenterOff ()
virtual void SetLayerThickness (double thickness)
virtual double GetLayerThickness ()
virtual void SetInteriorRadius (double thickness)
virtual double GetInteriorRadius ()
virtual void SetInteriorLogSpacingValue (double thickness)
virtual double GetInteriorLogSpacingValue ()
- Public Member Functions inherited from vtkTreeAreaView
void SetEdgeColorToSplineFraction ()
vtkDataRepresentationSetTreeFromInputConnection (vtkAlgorithmOutput *conn)
vtkDataRepresentationSetTreeFromInput (vtkTree *input)
vtkDataRepresentationSetGraphFromInputConnection (vtkAlgorithmOutput *conn)
vtkDataRepresentationSetGraphFromInput (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 vtkAreaLayoutStrategyGetLayoutStrategy ()
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
virtual void SetInteractor (vtkRenderWindowInteractor *interactor)
virtual void SetInteractorStyle (vtkInteractorObserver *style)
virtual vtkInteractorObserverGetInteractorStyle ()
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 vtkAbstractTransformGetTransform ()
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 vtkTextureGetIconTexture ()
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
virtual vtkRendererGetRenderer ()
virtual void SetRenderer (vtkRenderer *ren)
virtual vtkRenderWindowGetRenderWindow ()
virtual void ResetCamera ()
virtual void ResetCameraClippingRange ()
virtual vtkRenderWindowInteractorGetInteractor ()
- Public Member Functions inherited from vtkView
void AddRepresentation (vtkDataRepresentation *rep)
void SetRepresentation (vtkDataRepresentation *rep)
vtkDataRepresentationAddRepresentationFromInputConnection (vtkAlgorithmOutput *conn)
vtkDataRepresentationSetRepresentationFromInputConnection (vtkAlgorithmOutput *conn)
vtkDataRepresentationAddRepresentationFromInput (vtkDataObject *input)
vtkDataRepresentationSetRepresentationFromInput (vtkDataObject *input)
void RemoveRepresentation (vtkDataRepresentation *rep)
void RemoveRepresentation (vtkAlgorithmOutput *rep)
void RemoveAllRepresentations ()
int GetNumberOfRepresentations ()
vtkDataRepresentationGetRepresentation (int index=0)
bool IsRepresentationPresent (vtkDataRepresentation *rep)
virtual void Update ()
virtual void ApplyViewTheme (vtkViewTheme *vtkNotUsed(theme))
vtkCommandGetObserver ()
void RegisterProgress (vtkObject *algorithm, const char *message=NULL)
void UnRegisterProgress (vtkObject *algorithm)
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
virtual void DebugOff ()
unsigned char GetDebug ()
void SetDebug (unsigned char debugFlag)
virtual void Modified ()
virtual unsigned long GetMTime ()
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommandGetCommand (unsigned long tag)
void RemoveObserver (vtkCommand *)
void RemoveObservers (unsigned long event, vtkCommand *)
void RemoveObservers (const char *event, vtkCommand *)
int HasObserver (unsigned long event, vtkCommand *)
int HasObserver (const char *event, vtkCommand *)
void RemoveObserver (unsigned long tag)
void RemoveObservers (unsigned long event)
void RemoveObservers (const char *event)
void RemoveAllObservers ()
int HasObserver (unsigned long event)
int HasObserver (const char *event)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int InvokeEvent (unsigned long event, void *callData)
int InvokeEvent (const char *event, void *callData)
int InvokeEvent (unsigned long event)
int InvokeEvent (const char *event)
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
virtual void Delete ()
virtual void FastDelete ()
void Print (ostream &os)
virtual void Register (vtkObjectBase *o)
virtual void UnRegister (vtkObjectBase *o)
void SetReferenceCount (int)
void PrintRevisions (ostream &os)
virtual void PrintHeader (ostream &os, vtkIndent indent)
virtual void PrintTrailer (ostream &os, vtkIndent indent)
int GetReferenceCount ()

Static Public Member Functions

static vtkTreeRingViewNew ()
static int IsTypeOf (const char *type)
static vtkTreeRingViewSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkTreeRingView ()
 ~vtkTreeRingView ()
- Protected Member Functions inherited from vtkTreeAreaView
 vtkTreeAreaView ()
 ~vtkTreeAreaView ()
virtual void SetAreaToPolyData (vtkPolyDataAlgorithm *areaToPoly)
virtual vtkPolyDataAlgorithmGetAreaToPolyData ()
virtual void SetAreaLabelMapper (vtkLabeledDataMapper *mapper)
virtual vtkLabeledDataMapperGetAreaLabelMapper ()
virtual vtkDataRepresentationCreateDefaultRepresentation (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 ()
- Protected Member Functions inherited from vtkObject
 vtkObject ()
virtual ~vtkObject ()
virtual void RegisterInternal (vtkObjectBase *, int check)
virtual void UnRegisterInternal (vtkObjectBase *, int check)
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void InternalReleaseFocus ()
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
virtual ~vtkObjectBase ()
virtual void CollectRevisions (ostream &os)
virtual void ReportReferences (vtkGarbageCollector *)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)

Detailed Description

Displays a tree in concentric rings.

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.

.SEE ALSO vtkGraphLayoutView

Thanks:
Thanks to Jason Shepherd for implementing this class
Examples:
vtkTreeRingView (Examples)
Tests:
vtkTreeRingView (Tests)

Definition at line 49 of file vtkTreeRingView.h.


Member Typedef Documentation

Reimplemented from vtkTreeAreaView.

Definition at line 53 of file vtkTreeRingView.h.


Constructor & Destructor Documentation

vtkTreeRingView::vtkTreeRingView ( )
protected
vtkTreeRingView::~vtkTreeRingView ( )
protected

Member Function Documentation

static vtkTreeRingView* vtkTreeRingView::New ( )
static

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

Reimplemented from vtkTreeAreaView.

virtual const char* vtkTreeRingView::GetClassName ( )
virtual

Reimplemented from vtkTreeAreaView.

static int vtkTreeRingView::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 vtkTreeAreaView.

virtual int vtkTreeRingView::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 vtkTreeAreaView.

static vtkTreeRingView* vtkTreeRingView::SafeDownCast ( vtkObject o)
static

Reimplemented from vtkTreeAreaView.

void vtkTreeRingView::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 vtkTreeAreaView.

void vtkTreeRingView::SetRootAngles ( double  start,
double  end 
)

Set the root angles for laying out the hierarchy.

virtual void vtkTreeRingView::SetRootAtCenter ( bool  value)
virtual

Sets whether the root is at the center or around the outside.

virtual bool vtkTreeRingView::GetRootAtCenter ( )
virtual

Sets whether the root is at the center or around the outside.

virtual void vtkTreeRingView::RootAtCenterOn ( )
virtual

Sets whether the root is at the center or around the outside.

virtual void vtkTreeRingView::RootAtCenterOff ( )
virtual

Sets whether the root is at the center or around the outside.

virtual void vtkTreeRingView::SetLayerThickness ( double  thickness)
virtual

Set the thickness of each layer.

virtual double vtkTreeRingView::GetLayerThickness ( )
virtual

Set the thickness of each layer.

virtual void vtkTreeRingView::SetInteriorRadius ( double  thickness)
virtual

Set the interior radius of the tree (i.e. the size of the "hole" in the center).

virtual double vtkTreeRingView::GetInteriorRadius ( )
virtual

Set the interior radius of the tree (i.e. the size of the "hole" in the center).

virtual void vtkTreeRingView::SetInteriorLogSpacingValue ( double  thickness)
virtual

Set the log spacing factor for the invisible interior tree used for routing edges of the overlaid graph.

virtual double vtkTreeRingView::GetInteriorLogSpacingValue ( )
virtual

Set the log spacing factor for the invisible interior tree used for routing edges of the overlaid graph.


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