VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkTreeLayoutStrategy Class Reference

hierarchical layout More...

#include <vtkTreeLayoutStrategy.h>

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

Public Types

typedef vtkGraphLayoutStrategy Superclass
 
- Public Types inherited from vtkGraphLayoutStrategy
typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkTreeLayoutStrategyNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void Layout () override
 Perform the tree layout. More...
 
virtual void SetAngle (double)
 The sweep angle of the tree. More...
 
virtual double GetAngle ()
 
virtual void SetRadial (bool)
 If set, the tree is laid out with levels on concentric circles around the root. More...
 
virtual bool GetRadial ()
 
virtual void RadialOn ()
 
virtual void RadialOff ()
 
virtual void SetLogSpacingValue (double)
 The spacing of tree levels. More...
 
virtual double GetLogSpacingValue ()
 
virtual void SetLeafSpacing (double)
 The spacing of leaves. More...
 
virtual double GetLeafSpacing ()
 
virtual void SetDistanceArrayName (const char *)
 Get/Set the array to use to determine the distance from the root. More...
 
virtual char * GetDistanceArrayName ()
 
virtual void SetRotation (double)
 The amount of counter-clockwise rotation to apply after the layout. More...
 
virtual double GetRotation ()
 
virtual void SetReverseEdges (bool)
 If set and the input is not a tree but a general graph, the filter will reverse the edges on the graph before extracting a tree using breadth first search. More...
 
virtual bool GetReverseEdges ()
 
virtual void ReverseEdgesOn ()
 
virtual void ReverseEdgesOff ()
 
- Public Member Functions inherited from vtkGraphLayoutStrategy
vtkGraphLayoutStrategyNewInstance () const
 
virtual void SetGraph (vtkGraph *graph)
 Setting the graph for the layout strategy. More...
 
virtual void Initialize ()
 This method allows the layout strategy to do initialization of data structures or whatever else it might want to do. More...
 
virtual int IsLayoutComplete ()
 If your concrete class is iterative than you should overload IsLayoutComplete() otherwise it simply returns 1 by default;. More...
 
virtual void SetWeightEdges (bool state)
 Whether to use edge weights in the layout or not. More...
 
virtual bool GetWeightEdges ()
 
virtual void SetEdgeWeightField (const char *field)
 Set/Get the field to use for the edge weights. More...
 
virtual char * GetEdgeWeightField ()
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
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 *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
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
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkTreeLayoutStrategyNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkTreeLayoutStrategySafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkGraphLayoutStrategy
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkGraphLayoutStrategySafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkTreeLayoutStrategy ()
 
 ~vtkTreeLayoutStrategy () override
 
- Protected Member Functions inherited from vtkGraphLayoutStrategy
 vtkGraphLayoutStrategy ()
 
 ~vtkGraphLayoutStrategy () override
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

double Angle
 
bool Radial
 
double LogSpacingValue
 
double LeafSpacing
 
char * DistanceArrayName
 
double Rotation
 
bool ReverseEdges
 
- Protected Attributes inherited from vtkGraphLayoutStrategy
vtkGraphGraph
 
char * EdgeWeightField
 
bool WeightEdges
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

hierarchical layout

Assigns points to the nodes of a tree in either a standard or radial layout. The standard layout places each level on a horizontal line, while the radial layout places each level on a concentric circle. You may specify the sweep angle of the tree which constrains the tree to be contained within a wedge. Also, you may indicate the log scale of the tree, which diminishes the length of arcs at lower levels of the tree. Values near zero give a large proportion of the space to the tree levels near the root, while values near one give nearly equal proportions of space to all tree levels.

The user may also specify an array to use to indicate the distance from the root, either vertically (for standard layout) or radially (for radial layout). You specify this with SetDistanceArrayName().

If the input is not a tree but a general graph, this strategy first extracts a tree from the graph using a breadth-first search starting at vertex ID 0.

Examples:
vtkTreeLayoutStrategy (Examples)
Tests:
vtkTreeLayoutStrategy (Tests)

Definition at line 55 of file vtkTreeLayoutStrategy.h.

Member Typedef Documentation

◆ Superclass

Definition at line 60 of file vtkTreeLayoutStrategy.h.

Constructor & Destructor Documentation

◆ vtkTreeLayoutStrategy()

vtkTreeLayoutStrategy::vtkTreeLayoutStrategy ( )
protected

◆ ~vtkTreeLayoutStrategy()

vtkTreeLayoutStrategy::~vtkTreeLayoutStrategy ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkTreeLayoutStrategy* vtkTreeLayoutStrategy::New ( )
static

◆ IsTypeOf()

static vtkTypeBool vtkTreeLayoutStrategy::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool vtkTreeLayoutStrategy::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 vtkGraphLayoutStrategy.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkTreeLayoutStrategy::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkGraphLayoutStrategy.

◆ NewInstance()

vtkTreeLayoutStrategy* vtkTreeLayoutStrategy::NewInstance ( ) const

◆ PrintSelf()

void vtkTreeLayoutStrategy::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

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 vtkGraphLayoutStrategy.

◆ Layout()

void vtkTreeLayoutStrategy::Layout ( )
overridevirtual

Perform the tree layout.

Implements vtkGraphLayoutStrategy.

◆ SetAngle()

virtual void vtkTreeLayoutStrategy::SetAngle ( double  )
virtual

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.

◆ GetAngle()

virtual double vtkTreeLayoutStrategy::GetAngle ( )
virtual

◆ SetRadial()

virtual void vtkTreeLayoutStrategy::SetRadial ( bool  )
virtual

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.

◆ GetRadial()

virtual bool vtkTreeLayoutStrategy::GetRadial ( )
virtual

◆ RadialOn()

virtual void vtkTreeLayoutStrategy::RadialOn ( )
virtual

◆ RadialOff()

virtual void vtkTreeLayoutStrategy::RadialOff ( )
virtual

◆ SetLogSpacingValue()

virtual void vtkTreeLayoutStrategy::SetLogSpacingValue ( double  )
virtual

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. Levels above one give more space to levels near the leaves.

◆ GetLogSpacingValue()

virtual double vtkTreeLayoutStrategy::GetLogSpacingValue ( )
virtual

◆ SetLeafSpacing()

virtual void vtkTreeLayoutStrategy::SetLeafSpacing ( double  )
virtual

The spacing of leaves.

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

◆ GetLeafSpacing()

virtual double vtkTreeLayoutStrategy::GetLeafSpacing ( )
virtual

◆ SetDistanceArrayName()

virtual void vtkTreeLayoutStrategy::SetDistanceArrayName ( const char *  )
virtual

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

◆ GetDistanceArrayName()

virtual char* vtkTreeLayoutStrategy::GetDistanceArrayName ( )
virtual

◆ SetRotation()

virtual void vtkTreeLayoutStrategy::SetRotation ( double  )
virtual

The amount of counter-clockwise rotation to apply after the layout.

◆ GetRotation()

virtual double vtkTreeLayoutStrategy::GetRotation ( )
virtual

◆ SetReverseEdges()

virtual void vtkTreeLayoutStrategy::SetReverseEdges ( bool  )
virtual

If set and the input is not a tree but a general graph, the filter will reverse the edges on the graph before extracting a tree using breadth first search.

◆ GetReverseEdges()

virtual bool vtkTreeLayoutStrategy::GetReverseEdges ( )
virtual

◆ ReverseEdgesOn()

virtual void vtkTreeLayoutStrategy::ReverseEdgesOn ( )
virtual

◆ ReverseEdgesOff()

virtual void vtkTreeLayoutStrategy::ReverseEdgesOff ( )
virtual

Member Data Documentation

◆ Angle

double vtkTreeLayoutStrategy::Angle
protected

Definition at line 143 of file vtkTreeLayoutStrategy.h.

◆ Radial

bool vtkTreeLayoutStrategy::Radial
protected

Definition at line 144 of file vtkTreeLayoutStrategy.h.

◆ LogSpacingValue

double vtkTreeLayoutStrategy::LogSpacingValue
protected

Definition at line 145 of file vtkTreeLayoutStrategy.h.

◆ LeafSpacing

double vtkTreeLayoutStrategy::LeafSpacing
protected

Definition at line 146 of file vtkTreeLayoutStrategy.h.

◆ DistanceArrayName

char* vtkTreeLayoutStrategy::DistanceArrayName
protected

Definition at line 147 of file vtkTreeLayoutStrategy.h.

◆ Rotation

double vtkTreeLayoutStrategy::Rotation
protected

Definition at line 148 of file vtkTreeLayoutStrategy.h.

◆ ReverseEdges

bool vtkTreeLayoutStrategy::ReverseEdges
protected

Definition at line 149 of file vtkTreeLayoutStrategy.h.


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