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 int 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)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void Layout (vtkTree *inputTree, vtkDataArray *coordsArray, vtkDataArray *sizeArray)
 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)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual vtkIdType FindVertex (vtkTree *tree, vtkDataArray *areaArray, float pnt[2])
 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...
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
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)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
int HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
int HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
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)
 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, 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)
 This method invokes an event and return whether the event was aborted or not. More...
 
- 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 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...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 

Static Public Member Functions

static vtkBoxLayoutStrategyNew ()
 
static int IsTypeOf (const char *type)
 
static vtkBoxLayoutStrategySafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkTreeMapLayoutStrategy
static int IsTypeOf (const char *type)
 
static vtkTreeMapLayoutStrategySafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAreaLayoutStrategy
static int 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 ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- 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 ()
 
- Protected Member Functions inherited from vtkTreeMapLayoutStrategy
 vtkTreeMapLayoutStrategy ()
 
 ~vtkTreeMapLayoutStrategy ()
 
void AddBorder (float *boxInfo)
 
- Protected Member Functions inherited from vtkAreaLayoutStrategy
 vtkAreaLayoutStrategy ()
 
 ~vtkAreaLayoutStrategy ()
 
- 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=NULL)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events. More...
 
- 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

Definition at line 46 of file vtkBoxLayoutStrategy.h.

Constructor & Destructor Documentation

vtkBoxLayoutStrategy::vtkBoxLayoutStrategy ( )
protected
vtkBoxLayoutStrategy::~vtkBoxLayoutStrategy ( )
protected

Member Function Documentation

static vtkBoxLayoutStrategy* vtkBoxLayoutStrategy::New ( )
static
static int vtkBoxLayoutStrategy::IsTypeOf ( const char *  type)
static
virtual int 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.

static vtkBoxLayoutStrategy* vtkBoxLayoutStrategy::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkBoxLayoutStrategy::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkTreeMapLayoutStrategy.

vtkBoxLayoutStrategy* vtkBoxLayoutStrategy::NewInstance ( ) const
void vtkBoxLayoutStrategy::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 vtkAreaLayoutStrategy.

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

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: