vtkAreaLayoutStrategy Class Reference

abstract superclass for all area layout strategies More...

#include <vtkAreaLayoutStrategy.h>

Inheritance diagram for vtkAreaLayoutStrategy:

Collaboration diagram for vtkAreaLayoutStrategy:

Public Types
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.
vtkAreaLayoutStrategy *	NewInstance () 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 sector bounds of each vertex as a tuple in a data array.
virtual void	LayoutEdgePoints (vtkTree *inputTree, vtkDataArray *areaArray, vtkDataArray *sizeArray, vtkTree *edgeRoutingTree)
virtual vtkIdType	FindVertex (vtkTree *tree, vtkDataArray *array, float pnt[2])=0
	Returns the vertex id that contains pnt (or -1 if no one contains it)
virtual void	SetShrinkPercentage (double)
virtual double	GetShrinkPercentage ()
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)
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.
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkCommand *	GetCommand (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.
int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
int	InvokeEvent (const char *event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.
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.
virtual 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.

Static Public Member Functions
static vtkTypeBool	IsTypeOf (const char *type)
static vtkAreaLayoutStrategy *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	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 (int 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 int	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 vtkObjectBase *	New ()
	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 vtkObjectBase *	NewInstanceInternal () const
	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.
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 *)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Protected Attributes
double	ShrinkPercentage
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
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

abstract superclass for all area layout strategies

All subclasses of this class perform a area layout on a tree. This involves assigning a region to each vertex in the tree, and placing that information in a data array with four components per tuple representing (innerRadius, outerRadius, startAngle, endAngle).

Instances of subclasses of this class may be assigned as the layout strategy to vtkAreaLayout

Thanks:

Thanks to Jason Shepherd from Sandia National Laboratories for help developing this class.

Definition at line 47 of file vtkAreaLayoutStrategy.h.

Member Typedef Documentation

Superclass

typedef vtkObject vtkAreaLayoutStrategy::Superclass

Definition at line 50 of file vtkAreaLayoutStrategy.h.

Constructor & Destructor Documentation

vtkAreaLayoutStrategy()

vtkAreaLayoutStrategy::vtkAreaLayoutStrategy ( )

protected

~vtkAreaLayoutStrategy()

vtkAreaLayoutStrategy::~vtkAreaLayoutStrategy ( )

overrideprotected

Member Function Documentation

IsTypeOf()

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

static

IsA()

virtual vtkTypeBool vtkAreaLayoutStrategy::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 vtkObjectBase.

Reimplemented in vtkBoxLayoutStrategy, vtkSliceAndDiceLayoutStrategy, vtkSquarifyLayoutStrategy, vtkStackedTreeLayoutStrategy, and vtkTreeMapLayoutStrategy.

SafeDownCast()

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

static

NewInstanceInternal()

virtual vtkObjectBase * vtkAreaLayoutStrategy::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented in vtkBoxLayoutStrategy, vtkSliceAndDiceLayoutStrategy, vtkSquarifyLayoutStrategy, vtkStackedTreeLayoutStrategy, and vtkTreeMapLayoutStrategy.

NewInstance()

vtkAreaLayoutStrategy * vtkAreaLayoutStrategy::NewInstance

(

)

const

PrintSelf()

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

Reimplemented in vtkBoxLayoutStrategy, vtkSliceAndDiceLayoutStrategy, vtkSquarifyLayoutStrategy, vtkStackedTreeLayoutStrategy, and vtkTreeMapLayoutStrategy.

Layout()

virtual void vtkAreaLayoutStrategy::Layout ( vtkTree *  inputTree, vtkDataArray *  areaArray, vtkDataArray *  sizeArray  )

pure virtual

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

For radial layout, this is (innerRadius, outerRadius, startAngle, endAngle). For rectangular layout, this is (xmin, xmax, ymin, ymax).

The sizeArray may be nullptr, or may contain the desired size of each vertex in the tree.

Implemented in vtkBoxLayoutStrategy, vtkSliceAndDiceLayoutStrategy, vtkSquarifyLayoutStrategy, and vtkStackedTreeLayoutStrategy.

LayoutEdgePoints()

virtual void vtkAreaLayoutStrategy::LayoutEdgePoints ( vtkTree *  inputTree, vtkDataArray *  areaArray, vtkDataArray *  sizeArray, vtkTree *  edgeRoutingTree  )

virtual

Reimplemented in vtkStackedTreeLayoutStrategy.

FindVertex()

virtual vtkIdType vtkAreaLayoutStrategy::FindVertex ( vtkTree *  tree, vtkDataArray *  array, float  pnt[2]  )

pure virtual

Returns the vertex id that contains pnt (or -1 if no one contains it)

Implemented in vtkTreeMapLayoutStrategy, and vtkStackedTreeLayoutStrategy.

SetShrinkPercentage()

virtual void vtkAreaLayoutStrategy::SetShrinkPercentage ( double  )

virtual

GetShrinkPercentage()

virtual double vtkAreaLayoutStrategy::GetShrinkPercentage ( )

virtual

Member Data Documentation

ShrinkPercentage

double vtkAreaLayoutStrategy::ShrinkPercentage

protected

Definition at line 90 of file vtkAreaLayoutStrategy.h.

---

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

• Infovis/Layout/vtkAreaLayoutStrategy.h