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

hierarchical orbital layout More...

#include <vtkTreeOrbitLayoutStrategy.h>

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

Public Types

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

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
void Layout ()
virtual void SetLogSpacingValue (double)
virtual double GetLogSpacingValue ()
virtual void SetLeafSpacing (double)
virtual double GetLeafSpacing ()
virtual void SetChildRadiusFactor (double)
virtual double GetChildRadiusFactor ()
- Public Member Functions inherited from vtkGraphLayoutStrategy
virtual void SetGraph (vtkGraph *graph)
virtual void Initialize ()
virtual int IsLayoutComplete ()
virtual void SetWeightEdges (bool state)
virtual bool GetWeightEdges ()
virtual void SetEdgeWeightField (const char *field)
virtual char * GetEdgeWeightField ()
- 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 vtkTreeOrbitLayoutStrategyNew ()
static int IsTypeOf (const char *type)
static vtkTreeOrbitLayoutStrategySafeDownCast (vtkObject *o)

Protected Member Functions

 vtkTreeOrbitLayoutStrategy ()
 ~vtkTreeOrbitLayoutStrategy ()
void OrbitChildren (vtkTree *t, vtkPoints *p, vtkIdType parent, double radius)
- Protected Member Functions inherited from vtkGraphLayoutStrategy
 vtkGraphLayoutStrategy ()
 ~vtkGraphLayoutStrategy ()
- 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 &)

Protected Attributes

double LogSpacingValue
double LeafSpacing
double ChildRadiusFactor
- Protected Attributes inherited from vtkGraphLayoutStrategy
vtkGraphGraph
char * EdgeWeightField
bool WeightEdges
- Protected Attributes inherited from vtkObject
unsigned char Debug
vtkTimeStamp MTime
vtkSubjectHelper * SubjectHelper
- Protected Attributes inherited from vtkObjectBase
int ReferenceCount
vtkWeakPointerBase ** WeakPointers

Detailed Description

hierarchical orbital layout

Assigns points to the nodes of a tree to an orbital layout. Each parent is orbited by its children, recursively.

Thanks:
Thanks to the galaxy for inspiring this layout strategy.

Definition at line 31 of file vtkTreeOrbitLayoutStrategy.h.

Member Typedef Documentation

Definition at line 36 of file vtkTreeOrbitLayoutStrategy.h.

Constructor & Destructor Documentation

vtkTreeOrbitLayoutStrategy::vtkTreeOrbitLayoutStrategy ( )
protected
vtkTreeOrbitLayoutStrategy::~vtkTreeOrbitLayoutStrategy ( )
protected

Member Function Documentation

static vtkTreeOrbitLayoutStrategy* vtkTreeOrbitLayoutStrategy::New ( )
static

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

Reimplemented from vtkObject.

virtual const char* vtkTreeOrbitLayoutStrategy::GetClassName ( )
virtual

Reimplemented from vtkGraphLayoutStrategy.

static int vtkTreeOrbitLayoutStrategy::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 vtkGraphLayoutStrategy.

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

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

Reimplemented from vtkGraphLayoutStrategy.

void vtkTreeOrbitLayoutStrategy::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 vtkGraphLayoutStrategy.

void vtkTreeOrbitLayoutStrategy::Layout ( )
virtual

Perform the orbital layout.

Implements vtkGraphLayoutStrategy.

virtual void vtkTreeOrbitLayoutStrategy::SetLogSpacingValue ( double  )
virtual

The spacing of orbital 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.

virtual double vtkTreeOrbitLayoutStrategy::GetLogSpacingValue ( )
virtual

The spacing of orbital 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.

virtual void vtkTreeOrbitLayoutStrategy::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.

virtual double vtkTreeOrbitLayoutStrategy::GetLeafSpacing ( )
virtual

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

virtual void vtkTreeOrbitLayoutStrategy::SetChildRadiusFactor ( double  )
virtual

This is a magic number right now. Controls the radius of the child layout, all of this should be fixed at some point with a more logical layout. Defaults to .5 :)

virtual double vtkTreeOrbitLayoutStrategy::GetChildRadiusFactor ( )
virtual

This is a magic number right now. Controls the radius of the child layout, all of this should be fixed at some point with a more logical layout. Defaults to .5 :)

void vtkTreeOrbitLayoutStrategy::OrbitChildren ( vtkTree t,
vtkPoints p,
vtkIdType  parent,
double  radius 
)
protected

Member Data Documentation

double vtkTreeOrbitLayoutStrategy::LogSpacingValue
protected

Definition at line 73 of file vtkTreeOrbitLayoutStrategy.h.

double vtkTreeOrbitLayoutStrategy::LeafSpacing
protected

Definition at line 74 of file vtkTreeOrbitLayoutStrategy.h.

double vtkTreeOrbitLayoutStrategy::ChildRadiusFactor
protected

Definition at line 75 of file vtkTreeOrbitLayoutStrategy.h.


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