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

a tree map layout that puts vertices in square-ish boxes More...

#include <vtkBoxLayoutStrategy.h>

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

Public Types

typedef vtkTreeMapLayoutStrategy Superclass
 
- Public Types inherited from vtkTreeMapLayoutStrategy
typedef vtkAreaLayoutStrategy Superclass
 
- Public Types inherited from vtkAreaLayoutStrategy
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...
 
vtkBoxLayoutStrategyNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void Layout (vtkTree *inputTree, vtkDataArray *coordsArray, vtkDataArray *sizeArray) override
 Perform the layout of a tree and place the results as 4-tuples in coordsArray (Xmin, Xmax, Ymin, Ymax). More...
 
- Public Member Functions inherited from vtkTreeMapLayoutStrategy
vtkTreeMapLayoutStrategyNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
vtkIdType FindVertex (vtkTree *tree, vtkDataArray *areaArray, float pnt[2]) override
 Find the vertex at a certain location, or -1 if none found. More...
 
- Public Member Functions inherited from vtkAreaLayoutStrategy
vtkAreaLayoutStrategyNewInstance () const
 
virtual void LayoutEdgePoints (vtkTree *inputTree, vtkDataArray *areaArray, vtkDataArray *sizeArray, vtkTree *edgeLayoutTree)
 
virtual void SetShrinkPercentage (double)
 
virtual double GetShrinkPercentage ()
 
- 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 vtkBoxLayoutStrategyNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkBoxLayoutStrategySafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkTreeMapLayoutStrategy
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkTreeMapLayoutStrategySafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAreaLayoutStrategy
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAreaLayoutStrategySafeDownCast (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
 
 vtkBoxLayoutStrategy ()
 
 ~vtkBoxLayoutStrategy () override
 
- Protected Member Functions inherited from vtkTreeMapLayoutStrategy
 vtkTreeMapLayoutStrategy ()
 
 ~vtkTreeMapLayoutStrategy () override
 
void AddBorder (float *boxInfo)
 
- Protected Member Functions inherited from vtkAreaLayoutStrategy
 vtkAreaLayoutStrategy ()
 
 ~vtkAreaLayoutStrategy () 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 &)
 

Additional Inherited Members

- Protected Attributes inherited from vtkAreaLayoutStrategy
double ShrinkPercentage
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

a tree map layout that puts vertices in square-ish boxes

vtkBoxLayoutStrategy recursively partitions the space for children vertices in a tree-map into square regions (or regions very close to a square).

Thanks:
Thanks to Brian Wylie from Sandia National Laboratories for creating this class.
Tests:
vtkBoxLayoutStrategy (Tests)

Definition at line 41 of file vtkBoxLayoutStrategy.h.

Member Typedef Documentation

◆ Superclass

Definition at line 46 of file vtkBoxLayoutStrategy.h.

Constructor & Destructor Documentation

◆ vtkBoxLayoutStrategy()

vtkBoxLayoutStrategy::vtkBoxLayoutStrategy ( )
protected

◆ ~vtkBoxLayoutStrategy()

vtkBoxLayoutStrategy::~vtkBoxLayoutStrategy ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkBoxLayoutStrategy* vtkBoxLayoutStrategy::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkBoxLayoutStrategy::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 vtkTreeMapLayoutStrategy.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkBoxLayoutStrategy::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkTreeMapLayoutStrategy.

◆ NewInstance()

vtkBoxLayoutStrategy* vtkBoxLayoutStrategy::NewInstance ( ) const

◆ PrintSelf()

void vtkBoxLayoutStrategy::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 vtkAreaLayoutStrategy.

◆ Layout()

void vtkBoxLayoutStrategy::Layout ( vtkTree inputTree,
vtkDataArray coordsArray,
vtkDataArray sizeArray 
)
overridevirtual

Perform the layout of a tree and place the results as 4-tuples in coordsArray (Xmin, Xmax, Ymin, Ymax).

Implements vtkAreaLayoutStrategy.


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