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

layout a vtkTree into packed circles using the front chain algorithm. More...

#include <vtkCirclePackFrontChainLayoutStrategy.h>

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

Public Types

typedef vtkCirclePackLayoutStrategy Superclass
 
- Public Types inherited from vtkCirclePackLayoutStrategy
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.
 
vtkCirclePackFrontChainLayoutStrategyNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
void Layout (vtkTree *inputTree, vtkDataArray *areaArray, vtkDataArray *sizeArray) override
 Perform the layout of the input tree, and store the circle bounds of each vertex as a tuple in a data array.
 
virtual int GetWidth ()
 Width and Height define the size of the output window that the circle packing is placed inside.
 
virtual void SetWidth (int)
 Width and Height define the size of the output window that the circle packing is placed inside.
 
virtual int GetHeight ()
 Width and Height define the size of the output window that the circle packing is placed inside.
 
virtual void SetHeight (int)
 Width and Height define the size of the output window that the circle packing is placed inside.
 
- Public Member Functions inherited from vtkCirclePackLayoutStrategy
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkCirclePackLayoutStrategyNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
virtual void Layout (vtkTree *inputTree, vtkDataArray *areaArray, vtkDataArray *sizeArray)=0
 Perform the layout of the input tree, and store the circle bounds of each vertex as a tuple in a data array.
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on.
 
virtual void DebugOff ()
 Turn debugging output off.
 
bool GetDebug ()
 Get the value of the debug flag.
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag.
 
virtual void Modified ()
 Update the modification time for this object.
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time.
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
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)
 
vtkTypeBool InvokeEvent (unsigned long event)
 
vtkTypeBool InvokeEvent (const char *event)
 
std::string GetObjectDescription () const override
 The object description printed in messages and PrintSelf output.
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
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.
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
 
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.
 
vtkTypeBool InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
vtkTypeBool InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
virtual void SetObjectName (const std::string &objectName)
 Set/get the name of this object for reporting purposes.
 
virtual std::string GetObjectName () const
 Set/get the name of this object for reporting purposes.
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string.
 
virtual std::string GetObjectDescription () const
 The object description printed in messages and PrintSelf output.
 
virtual vtkTypeBool IsA (const char *name)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
virtual vtkIdType GetNumberOfGenerationsFromBase (const char *name)
 Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
 
virtual void Delete ()
 Delete a VTK object.
 
virtual void FastDelete ()
 Delete a reference to this object.
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream.
 
void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object).
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object).
 
int GetReferenceCount ()
 Return the current reference count of this object.
 
void SetReferenceCount (int)
 Sets the reference count.
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space.
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 
virtual bool UsesGarbageCollector () const
 Indicate whether the class uses vtkGarbageCollector or not.
 

Static Public Member Functions

static vtkCirclePackFrontChainLayoutStrategyNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkCirclePackFrontChainLayoutStrategySafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkCirclePackLayoutStrategy
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkCirclePackLayoutStrategySafeDownCast (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.
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes.
 
static void SetGlobalWarningDisplay (vtkTypeBool val)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static vtkTypeBool GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
- 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.
 
static vtkIdType GetNumberOfGenerationsFromBaseType (const char *name)
 Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
 
static bool GetUsingMemkind ()
 A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkCirclePackFrontChainLayoutStrategy ()
 
 ~vtkCirclePackFrontChainLayoutStrategy () override
 
- Protected Member Functions inherited from vtkCirclePackLayoutStrategy
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkCirclePackLayoutStrategy ()
 
 ~vtkCirclePackLayoutStrategy () 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.
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events.
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void RegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
virtual void ObjectFinalize ()
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

char * CirclesFieldName
 
int Width
 
int Height
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
std::string ObjectName
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 

Detailed Description

layout a vtkTree into packed circles using the front chain algorithm.

vtkCirclePackFrontChainLayoutStrategy assigns circles to each node of the input vtkTree using the front chain algorithm. The algorithm packs circles by searching a "front chain" of circles around the perimeter of the circles that have already been packed for the current level in the tree hierarchy. Searching the front chain is in general faster than searching all of the circles that have been packed at the current level.

WARNING: The algorithm tends to break down and produce packings with overlapping circles when there is a large difference in the radii of the circles at a given level of the tree hierarchy. Roughly on the order a 1000:1 ratio of circle radii.

Please see the following reference for more details on the algorithm.

Title: "Visualization of large hierarchical data by circle packing" Authors: Weixin Wang, Hui Wang, Guozhong Dai, Hongan Wang Conference: Proceedings of the SIGCHI conference on Human Factors in computing systems Year: 2006

Tests:
vtkCirclePackFrontChainLayoutStrategy (Tests)

Definition at line 41 of file vtkCirclePackFrontChainLayoutStrategy.h.

Member Typedef Documentation

◆ Superclass

Definition at line 47 of file vtkCirclePackFrontChainLayoutStrategy.h.

Constructor & Destructor Documentation

◆ vtkCirclePackFrontChainLayoutStrategy()

vtkCirclePackFrontChainLayoutStrategy::vtkCirclePackFrontChainLayoutStrategy ( )
protected

◆ ~vtkCirclePackFrontChainLayoutStrategy()

vtkCirclePackFrontChainLayoutStrategy::~vtkCirclePackFrontChainLayoutStrategy ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkCirclePackFrontChainLayoutStrategy * vtkCirclePackFrontChainLayoutStrategy::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkCirclePackFrontChainLayoutStrategy::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 vtkCirclePackLayoutStrategy.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkCirclePackFrontChainLayoutStrategy::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkCirclePackLayoutStrategy.

◆ NewInstance()

vtkCirclePackFrontChainLayoutStrategy * vtkCirclePackFrontChainLayoutStrategy::NewInstance ( ) const

◆ PrintSelf()

void vtkCirclePackFrontChainLayoutStrategy::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 vtkObjectBase.

◆ Layout()

void vtkCirclePackFrontChainLayoutStrategy::Layout ( vtkTree inputTree,
vtkDataArray areaArray,
vtkDataArray sizeArray 
)
overridevirtual

Perform the layout of the input tree, and store the circle bounds of each vertex as a tuple in a data array.

(Xcenter, Ycenter, Radius).

Implements vtkCirclePackLayoutStrategy.

◆ GetWidth()

virtual int vtkCirclePackFrontChainLayoutStrategy::GetWidth ( )
virtual

Width and Height define the size of the output window that the circle packing is placed inside.

Defaults to Width 1, Height 1

◆ SetWidth()

virtual void vtkCirclePackFrontChainLayoutStrategy::SetWidth ( int  )
virtual

Width and Height define the size of the output window that the circle packing is placed inside.

Defaults to Width 1, Height 1

◆ GetHeight()

virtual int vtkCirclePackFrontChainLayoutStrategy::GetHeight ( )
virtual

Width and Height define the size of the output window that the circle packing is placed inside.

Defaults to Width 1, Height 1

◆ SetHeight()

virtual void vtkCirclePackFrontChainLayoutStrategy::SetHeight ( int  )
virtual

Width and Height define the size of the output window that the circle packing is placed inside.

Defaults to Width 1, Height 1

Member Data Documentation

◆ CirclesFieldName

char* vtkCirclePackFrontChainLayoutStrategy::CirclesFieldName
protected

Definition at line 72 of file vtkCirclePackFrontChainLayoutStrategy.h.

◆ Width

int vtkCirclePackFrontChainLayoutStrategy::Width
protected

Definition at line 73 of file vtkCirclePackFrontChainLayoutStrategy.h.

◆ Height

int vtkCirclePackFrontChainLayoutStrategy::Height
protected

Definition at line 74 of file vtkCirclePackFrontChainLayoutStrategy.h.


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