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

produce a cone-tree layout for a forest More...

#include <vtkConeLayoutStrategy.h>

Inheritance diagram for vtkConeLayoutStrategy:
[legend]
Collaboration diagram for vtkConeLayoutStrategy:
[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...
 
vtkConeLayoutStrategyNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void SetCompactness (float)
 Determine the compactness, the ratio between the average width of a cone in the tree, and the height of the cone. More...
 
virtual float GetCompactness ()
 
virtual void SetCompression (vtkTypeBool)
 Determine if layout should be compressed, i.e. More...
 
virtual vtkTypeBool GetCompression ()
 
virtual void CompressionOn ()
 
virtual void CompressionOff ()
 
virtual void SetSpacing (float)
 Set the spacing parameter that affects space between layers of the tree. More...
 
virtual float GetSpacing ()
 
void Layout () override
 Perform the layout. More...
 
- Public Member Functions inherited from vtkGraphLayoutStrategy
vtkGraphLayoutStrategyNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
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 vtkConeLayoutStrategyNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkConeLayoutStrategySafeDownCast (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
 
 vtkConeLayoutStrategy ()
 
 ~vtkConeLayoutStrategy () override
 
double LocalPlacement (vtkIdType root, vtkPoints *points)
 Helper operations for tree layout. More...
 
void GlobalPlacement (vtkIdType root, vtkPoints *points, double refX, double refY, double level)
 
- 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

float Compactness
 
vtkTypeBool Compression
 
float Spacing
 
double MinRadius
 
double MaxRadius
 
int NrCones
 
double SumOfRadii
 
- 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

produce a cone-tree layout for a forest

vtkConeLayoutStrategy positions the nodes of a tree(forest) in 3D space based on the cone-tree approach first described by Robertson, Mackinlay and Card in Proc. CHI'91. This implementation incorporates refinements to the layout developed by Carriere and Kazman, and by Auber.

The input graph must be a forest (i.e. a set of trees, or a single tree); in the case of a forest, the input will be converted to a single tree by introducing a new root node, and connecting each root in the input forest to the meta-root. The tree is then laid out, after which the meta-root is removed.

The cones are positioned so that children lie in planes parallel to the X-Y plane, with the axis of cones parallel to Z, and with Z coordinate increasing with distance of nodes from the root.

Thanks:
Thanks to David Duke from the University of Leeds for providing this implementation.

Definition at line 54 of file vtkConeLayoutStrategy.h.

Member Typedef Documentation

◆ Superclass

Definition at line 59 of file vtkConeLayoutStrategy.h.

Constructor & Destructor Documentation

◆ vtkConeLayoutStrategy()

vtkConeLayoutStrategy::vtkConeLayoutStrategy ( )
protected

◆ ~vtkConeLayoutStrategy()

vtkConeLayoutStrategy::~vtkConeLayoutStrategy ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkConeLayoutStrategy* vtkConeLayoutStrategy::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkConeLayoutStrategy::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 vtkConeLayoutStrategy* vtkConeLayoutStrategy::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkConeLayoutStrategy::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkGraphLayoutStrategy.

◆ NewInstance()

vtkConeLayoutStrategy* vtkConeLayoutStrategy::NewInstance ( ) const

◆ PrintSelf()

void vtkConeLayoutStrategy::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 vtkObject.

◆ SetCompactness()

virtual void vtkConeLayoutStrategy::SetCompactness ( float  )
virtual

Determine the compactness, the ratio between the average width of a cone in the tree, and the height of the cone.

The default setting is 0.75 which (empirically) seems reasonable, but this will need adapting depending on the data.

◆ GetCompactness()

virtual float vtkConeLayoutStrategy::GetCompactness ( )
virtual

◆ SetCompression()

virtual void vtkConeLayoutStrategy::SetCompression ( vtkTypeBool  )
virtual

Determine if layout should be compressed, i.e.

the layout puts children closer together, possibly allowing sub-trees to overlap. This is useful if the tree is actually the spanning tree of a graph. For "real" trees, non-compressed layout is best, and is the default.

◆ GetCompression()

virtual vtkTypeBool vtkConeLayoutStrategy::GetCompression ( )
virtual

◆ CompressionOn()

virtual void vtkConeLayoutStrategy::CompressionOn ( )
virtual

◆ CompressionOff()

virtual void vtkConeLayoutStrategy::CompressionOff ( )
virtual

◆ SetSpacing()

virtual void vtkConeLayoutStrategy::SetSpacing ( float  )
virtual

Set the spacing parameter that affects space between layers of the tree.

If compression is on, Spacing is the actual distance between layers. If compression is off, actual distance also includes a factor of the compactness and maximum cone radius.

◆ GetSpacing()

virtual float vtkConeLayoutStrategy::GetSpacing ( )
virtual

◆ Layout()

void vtkConeLayoutStrategy::Layout ( )
overridevirtual

Perform the layout.

Implements vtkGraphLayoutStrategy.

◆ LocalPlacement()

double vtkConeLayoutStrategy::LocalPlacement ( vtkIdType  root,
vtkPoints points 
)
protected

Helper operations for tree layout.

Layout is performed in two traversals of the tree. The first traversal finds the position of child nodes relative to their parent. The second traversal positions each node absolutely, working from the initial position of the root node.

◆ GlobalPlacement()

void vtkConeLayoutStrategy::GlobalPlacement ( vtkIdType  root,
vtkPoints points,
double  refX,
double  refY,
double  level 
)
protected

Member Data Documentation

◆ Compactness

float vtkConeLayoutStrategy::Compactness
protected

Definition at line 123 of file vtkConeLayoutStrategy.h.

◆ Compression

vtkTypeBool vtkConeLayoutStrategy::Compression
protected

Definition at line 124 of file vtkConeLayoutStrategy.h.

◆ Spacing

float vtkConeLayoutStrategy::Spacing
protected

Definition at line 125 of file vtkConeLayoutStrategy.h.

◆ MinRadius

double vtkConeLayoutStrategy::MinRadius
protected

Definition at line 128 of file vtkConeLayoutStrategy.h.

◆ MaxRadius

double vtkConeLayoutStrategy::MaxRadius
protected

Definition at line 129 of file vtkConeLayoutStrategy.h.

◆ NrCones

int vtkConeLayoutStrategy::NrCones
protected

Definition at line 130 of file vtkConeLayoutStrategy.h.

◆ SumOfRadii

double vtkConeLayoutStrategy::SumOfRadii
protected

Definition at line 131 of file vtkConeLayoutStrategy.h.


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