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

tree layout strategy reminiscent of astronomical systems More...

#include <vtkCosmicTreeLayoutStrategy.h>

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

Public Types

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

Public Member Functions

void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkCosmicTreeLayoutStrategyNewInstance () const
 
void Layout () override
 Perform the layout. More...
 
virtual void SetSizeLeafNodesOnly (vtkTypeBool)
 Should node size specifications be obeyed at leaf nodes only or (with scaling as required to meet constraints) at every node in the tree? This defaults to true, so that leaf nodes are scaled according to the size specification provided, and the parent node sizes are calculated by the algorithm. More...
 
virtual vtkTypeBool GetSizeLeafNodesOnly ()
 
virtual void SizeLeafNodesOnlyOn ()
 
virtual void SizeLeafNodesOnlyOff ()
 
virtual void SetLayoutDepth (int)
 How many levels of the tree should be laid out? For large trees, you may wish to set the root and maximum depth in order to retrieve the layout for the visible portion of the tree. More...
 
virtual int GetLayoutDepth ()
 
virtual void SetLayoutRoot (vtkIdType)
 What is the top-most tree node to lay out? This node will become the largest containing circle in the layout. More...
 
virtual vtkIdType GetLayoutRoot ()
 
virtual void SetNodeSizeArrayName (const char *)
 Set the array to be used for sizing nodes. More...
 
virtual char * GetNodeSizeArrayName ()
 
- 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 vtkCosmicTreeLayoutStrategyNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkCosmicTreeLayoutStrategySafeDownCast (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 Types

enum  RadiusMode { NONE, LEAVES, ALL }
 How are node sizes specified? More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkCosmicTreeLayoutStrategy ()
 
 ~vtkCosmicTreeLayoutStrategy () override
 
void LayoutChildren (vtkTree *tree, vtkPoints *newPoints, vtkDoubleArray *radii, vtkDoubleArray *scale, vtkIdType root, int depth, RadiusMode mode)
 Recursive routine used to lay out tree nodes. More...
 
void OffsetChildren (vtkTree *tree, vtkPoints *pts, vtkDoubleArray *radii, vtkDoubleArray *scale, double parent[4], vtkIdType root, int depth, RadiusMode mode)
 Recursive routine that adds each parent node's (x,y) position to its children. More...
 
vtkDoubleArrayCreateRadii (vtkIdType numVertices, double initialValue, vtkDataArray *inputRadii)
 Create an array to hold radii, named appropriately (depends on NodeSizeArrayName) and initialized to either (a) -1.0 for each node or (b) a deep copy of an existing array. More...
 
vtkDoubleArrayCreateScaleFactors (vtkIdType numVertices)
 Create an array to hold scale factors, named appropriately (depends on NodeSizeArrayName) and initialized to -1.0. More...
 
- 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

vtkTypeBool SizeLeafNodesOnly
 
int LayoutDepth
 
vtkIdType LayoutRoot
 
char * NodeSizeArrayName
 
- 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

tree layout strategy reminiscent of astronomical systems

This layout strategy takes an input tree and places all the children of a node into a containing circle. The placement is such that each child placed can be represented with a circle tangent to the containing circle and (usually) 2 other children. The interior of the circle is left empty so that graph edges drawn on top of the tree will not obfuscate the tree. However, when one child is much larger than all the others, it may encroach on the center of the containing circle; that's OK, because it's large enough not to be obscured by edges drawn atop it.

Thanks:
Thanks to the galaxy and David Thompson hierarchically nested inside it for inspiring this layout strategy.

Definition at line 41 of file vtkCosmicTreeLayoutStrategy.h.

Member Typedef Documentation

◆ Superclass

Definition at line 46 of file vtkCosmicTreeLayoutStrategy.h.

Member Enumeration Documentation

◆ RadiusMode

How are node sizes specified?

Enumerator
NONE 

No node sizes specified... unit radius is assumed.

LEAVES 

Only leaf node sizes specified... parents are calculated during layout.

ALL 

All node sizes specified (overconstrained, so a scale factor for each parent is calculated during layout).

Definition at line 107 of file vtkCosmicTreeLayoutStrategy.h.

Constructor & Destructor Documentation

◆ vtkCosmicTreeLayoutStrategy()

vtkCosmicTreeLayoutStrategy::vtkCosmicTreeLayoutStrategy ( )
protected

◆ ~vtkCosmicTreeLayoutStrategy()

vtkCosmicTreeLayoutStrategy::~vtkCosmicTreeLayoutStrategy ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkCosmicTreeLayoutStrategy* vtkCosmicTreeLayoutStrategy::New ( )
static

◆ PrintSelf()

void vtkCosmicTreeLayoutStrategy::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.

◆ IsTypeOf()

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

◆ IsA()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkCosmicTreeLayoutStrategy::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkGraphLayoutStrategy.

◆ NewInstance()

vtkCosmicTreeLayoutStrategy* vtkCosmicTreeLayoutStrategy::NewInstance ( ) const

◆ Layout()

void vtkCosmicTreeLayoutStrategy::Layout ( )
overridevirtual

Perform the layout.

Implements vtkGraphLayoutStrategy.

◆ SetSizeLeafNodesOnly()

virtual void vtkCosmicTreeLayoutStrategy::SetSizeLeafNodesOnly ( vtkTypeBool  )
virtual

Should node size specifications be obeyed at leaf nodes only or (with scaling as required to meet constraints) at every node in the tree? This defaults to true, so that leaf nodes are scaled according to the size specification provided, and the parent node sizes are calculated by the algorithm.

◆ GetSizeLeafNodesOnly()

virtual vtkTypeBool vtkCosmicTreeLayoutStrategy::GetSizeLeafNodesOnly ( )
virtual

◆ SizeLeafNodesOnlyOn()

virtual void vtkCosmicTreeLayoutStrategy::SizeLeafNodesOnlyOn ( )
virtual

◆ SizeLeafNodesOnlyOff()

virtual void vtkCosmicTreeLayoutStrategy::SizeLeafNodesOnlyOff ( )
virtual

◆ SetLayoutDepth()

virtual void vtkCosmicTreeLayoutStrategy::SetLayoutDepth ( int  )
virtual

How many levels of the tree should be laid out? For large trees, you may wish to set the root and maximum depth in order to retrieve the layout for the visible portion of the tree.

When this value is zero or negative, all nodes below and including the LayoutRoot will be presented. This defaults to 0.

◆ GetLayoutDepth()

virtual int vtkCosmicTreeLayoutStrategy::GetLayoutDepth ( )
virtual

◆ SetLayoutRoot()

virtual void vtkCosmicTreeLayoutStrategy::SetLayoutRoot ( vtkIdType  )
virtual

What is the top-most tree node to lay out? This node will become the largest containing circle in the layout.

Use this in combination with SetLayoutDepth to retrieve the layout of a subtree of interest for rendering. Setting LayoutRoot to a negative number signals that the root node of the tree should be used as the root node of the layout. This defaults to -1.

◆ GetLayoutRoot()

virtual vtkIdType vtkCosmicTreeLayoutStrategy::GetLayoutRoot ( )
virtual

◆ SetNodeSizeArrayName()

virtual void vtkCosmicTreeLayoutStrategy::SetNodeSizeArrayName ( const char *  )
virtual

Set the array to be used for sizing nodes.

If this is set to an empty string or nullptr (the default), then all leaf nodes (or all nodes, when SizeLeafNodesOnly is false) will be assigned a unit size.

◆ GetNodeSizeArrayName()

virtual char* vtkCosmicTreeLayoutStrategy::GetNodeSizeArrayName ( )
virtual

◆ LayoutChildren()

void vtkCosmicTreeLayoutStrategy::LayoutChildren ( vtkTree tree,
vtkPoints newPoints,
vtkDoubleArray radii,
vtkDoubleArray scale,
vtkIdType  root,
int  depth,
RadiusMode  mode 
)
protected

Recursive routine used to lay out tree nodes.

Called from Layout().

◆ OffsetChildren()

void vtkCosmicTreeLayoutStrategy::OffsetChildren ( vtkTree tree,
vtkPoints pts,
vtkDoubleArray radii,
vtkDoubleArray scale,
double  parent[4],
vtkIdType  root,
int  depth,
RadiusMode  mode 
)
protected

Recursive routine that adds each parent node's (x,y) position to its children.

This must be done only after all the children have been laid out at the origin since we will not know the parent's position until after the child radii have been determined.

◆ CreateRadii()

vtkDoubleArray* vtkCosmicTreeLayoutStrategy::CreateRadii ( vtkIdType  numVertices,
double  initialValue,
vtkDataArray inputRadii 
)
protected

Create an array to hold radii, named appropriately (depends on NodeSizeArrayName) and initialized to either (a) -1.0 for each node or (b) a deep copy of an existing array.

Parameters
numVerticesThe number of vertices on the tree.
initialValueThe starting value of each node's radius. Only used when inputRadii is nullptr.
inputRadiiEither nullptr or the address of another array to be copied into the output array
Return values
Thearray of node radii to be set on the output

◆ CreateScaleFactors()

vtkDoubleArray* vtkCosmicTreeLayoutStrategy::CreateScaleFactors ( vtkIdType  numVertices)
protected

Create an array to hold scale factors, named appropriately (depends on NodeSizeArrayName) and initialized to -1.0.

Parameters
numVerticesThe number of vertices on the tree.
Return values
Thearray of node scale factors to be set on the output

Member Data Documentation

◆ SizeLeafNodesOnly

vtkTypeBool vtkCosmicTreeLayoutStrategy::SizeLeafNodesOnly
protected

Definition at line 153 of file vtkCosmicTreeLayoutStrategy.h.

◆ LayoutDepth

int vtkCosmicTreeLayoutStrategy::LayoutDepth
protected

Definition at line 154 of file vtkCosmicTreeLayoutStrategy.h.

◆ LayoutRoot

vtkIdType vtkCosmicTreeLayoutStrategy::LayoutRoot
protected

Definition at line 155 of file vtkCosmicTreeLayoutStrategy.h.

◆ NodeSizeArrayName

char* vtkCosmicTreeLayoutStrategy::NodeSizeArrayName
protected

Definition at line 156 of file vtkCosmicTreeLayoutStrategy.h.


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