A 2D graphics item for rendering a tree as a dendrogram. More...

#include <vtkDendrogramItem.h>

Inheritance diagram for vtkDendrogramItem:

Collaboration diagram for vtkDendrogramItem:

Classes
class	CompareWeightedVertices

struct	WeightedVertex

Public Types
enum	{ LEFT_TO_RIGHT , UP_TO_DOWN , RIGHT_TO_LEFT , DOWN_TO_UP }
	Enum for Orientation. More...

typedef vtkContextItem	Superclass

Public Types inherited from vtkContextItem
typedef vtkAbstractContextItem	Superclass

Public Types inherited from vtkAbstractContextItem
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.

vtkDendrogramItem *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

virtual void	SetTree (vtkTree *tree)
	Set the tree that this item draws.

vtkTree *	GetTree ()
	Get the tree that this item draws.

void	CollapseToNumberOfLeafNodes (unsigned int n)
	Collapse subtrees until there are only n leaf nodes left in the tree.

vtkTree *	GetPrunedTree ()
	Get the collapsed tree.

void	SetColorArray (const char *arrayName)
	Indicate which array within the Tree's VertexData should be used to color the tree.

void	SetOrientation (int orientation)
	Set which way the tree should face within the visualization.

int	GetOrientation ()
	Get the current tree orientation.

double	GetAngleForOrientation (int orientation)
	Get the rotation angle (in degrees) that corresponds to the given tree orientation.

double	GetTextAngleForOrientation (int orientation)
	Get the angle that vertex labels should be rotated for the corresponding tree orientation.

void	PrepareToPaint (vtkContext2D *painter)
	This function calls RebuildBuffers() if necessary.

virtual void	GetBounds (double bounds[4])
	Get the bounds for this item as (Xmin,Xmax,Ymin,Ymax).

void	ComputeLabelWidth (vtkContext2D *painter)
	Compute the width of the longest leaf node label.

float	GetLabelWidth ()
	Get the width of the longest leaf node label.

bool	GetPositionOfVertex (const std::string &vertexName, double position[2])
	Find the position of the vertex with the specified name.

bool	Paint (vtkContext2D *painter) override
	Paints the input tree as a dendrogram.

bool	Hit (const vtkContextMouseEvent &mouse) override
	Returns true if the transform is interactive, false otherwise.

bool	MouseDoubleClickEvent (const vtkContextMouseEvent &event) override
	Collapse or expand a subtree when the user double clicks on an internal node.


virtual void	SetExtendLeafNodes (bool)
	Get/set whether or not leaf nodes should be extended so that they all line up vertically.

virtual bool	GetExtendLeafNodes ()
	Get/set whether or not leaf nodes should be extended so that they all line up vertically.

virtual void	ExtendLeafNodesOn ()
	Get/set whether or not leaf nodes should be extended so that they all line up vertically.

virtual void	ExtendLeafNodesOff ()
	Get/set whether or not leaf nodes should be extended so that they all line up vertically.


virtual void	SetDrawLabels (bool)
	Get/Set whether or not leaf nodes should be labeled by this class.

virtual bool	GetDrawLabels ()
	Get/Set whether or not leaf nodes should be labeled by this class.

virtual void	DrawLabelsOn ()
	Get/Set whether or not leaf nodes should be labeled by this class.

virtual void	DrawLabelsOff ()
	Get/Set whether or not leaf nodes should be labeled by this class.


virtual void	SetPosition (float, float)
	Set the position of the dendrogram.

void	SetPosition (float[2])
	Set the position of the dendrogram.

void	SetPosition (const vtkVector2f &pos)
	Set the position of the dendrogram.


virtual float *	GetPosition ()
	Get position of the dendrogram.

virtual void	GetPosition (float &, float &)
	Get position of the dendrogram.

virtual void	GetPosition (float[2])
	Get position of the dendrogram.

vtkVector2f	GetPositionVector ()
	Get position of the dendrogram.


virtual double	GetLeafSpacing ()
	Get/Set the spacing between the leaf nodes in our dendrogram.

virtual void	SetLeafSpacing (double)
	Get/Set the spacing between the leaf nodes in our dendrogram.


virtual float	GetLineWidth ()
	Get/Set how wide the edges of this dendrogram should be.

virtual void	SetLineWidth (float)
	Get/Set how wide the edges of this dendrogram should be.


virtual void	SetDisplayNumberOfCollapsedLeafNodes (bool)
	Get/set whether or not the number of collapsed leaf nodes should be written inside the triangle representing a collapsed subtree.

virtual bool	GetDisplayNumberOfCollapsedLeafNodes ()
	Get/set whether or not the number of collapsed leaf nodes should be written inside the triangle representing a collapsed subtree.

virtual void	DisplayNumberOfCollapsedLeafNodesOn ()
	Get/set whether or not the number of collapsed leaf nodes should be written inside the triangle representing a collapsed subtree.

virtual void	DisplayNumberOfCollapsedLeafNodesOff ()
	Get/set whether or not the number of collapsed leaf nodes should be written inside the triangle representing a collapsed subtree.


virtual vtkStdString	GetDistanceArrayName ()
	Get/Set the name of the array that specifies the distance of each vertex from the root (NOT the vertex's parent).

virtual void	SetDistanceArrayName (vtkStdString)
	Get/Set the name of the array that specifies the distance of each vertex from the root (NOT the vertex's parent).


virtual vtkStdString	GetVertexNameArrayName ()
	Get/Set the name of a vtkStringArray that specifies the names of the vertices of the input tree.

virtual void	SetVertexNameArrayName (vtkStdString)
	Get/Set the name of a vtkStringArray that specifies the names of the vertices of the input tree.

Public Member Functions inherited from vtkContextItem
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkContextItem *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

virtual void	SetTransform (vtkContextTransform *)
	Set the transform of the item.

virtual double	GetOpacity ()
	Get the opacity of the item.

virtual void	SetOpacity (double)
	Set the opacity of the item.

Public Member Functions inherited from vtkAbstractContextItem
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkAbstractContextItem *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

virtual void	Update ()
	Perform any updates to the item that may be necessary before rendering.

virtual bool	Paint (vtkContext2D *painter)
	Paint event for the item, called whenever the item needs to be drawn.

virtual bool	PaintChildren (vtkContext2D *painter)
	Paint the children of the item, should be called whenever the children need to be rendered.

virtual void	ReleaseGraphicsResources ()
	Release graphics resources hold by the item.

virtual vtkIdType	AddItem (vtkAbstractContextItem *item)
	Add child items to this item.

bool	RemoveItem (vtkAbstractContextItem *item)
	Remove child item from this item.

bool	RemoveItem (vtkIdType index)
	Remove child item from this item.

virtual vtkAbstractContextItem *	GetItem (vtkIdType index)
	Get the item at the specified index.

vtkIdType	GetItemIndex (vtkAbstractContextItem *item)
	Get the index of the specified item in itemIndex.

vtkIdType	GetNumberOfItems () VTK_FUTURE_CONST
	Get the number of child items.

void	ClearItems ()
	Remove all child items from this item.

vtkIdType	Raise (vtkIdType index)
	Raises the child to the top of the item's stack.

virtual vtkIdType	StackAbove (vtkIdType index, vtkIdType under)
	Raises the child above the under sibling.

vtkIdType	Lower (vtkIdType index)
	Lowers the child to the bottom of the item's stack.

virtual vtkIdType	StackUnder (vtkIdType child, vtkIdType above)
	Lowers the child under the above sibling.

virtual bool	Hit (const vtkContextMouseEvent &mouse)
	Return true if the supplied x, y coordinate is inside the item.

virtual vtkAbstractContextItem *	GetPickedItem (const vtkContextMouseEvent &mouse)
	Return the item under the mouse.

virtual bool	MouseEnterEvent (const vtkContextMouseEvent &mouse)
	Mouse enter event.

virtual bool	MouseMoveEvent (const vtkContextMouseEvent &mouse)
	Mouse move event.

virtual bool	MouseLeaveEvent (const vtkContextMouseEvent &mouse)
	Mouse leave event.

virtual bool	MouseButtonPressEvent (const vtkContextMouseEvent &mouse)
	Mouse button down event Return true if the item holds the event, false if the event can be propagated to other items.

virtual bool	MouseButtonReleaseEvent (const vtkContextMouseEvent &mouse)
	Mouse button release event.

virtual bool	MouseDoubleClickEvent (const vtkContextMouseEvent &mouse)
	Mouse button double click event.

virtual bool	MouseWheelEvent (const vtkContextMouseEvent &mouse, int delta)
	Mouse wheel event, positive delta indicates forward movement of the wheel.

virtual bool	KeyPressEvent (const vtkContextKeyEvent &key)
	Key press event.

virtual bool	KeyReleaseEvent (const vtkContextKeyEvent &key)
	Key release event.

virtual void	SetScene (vtkContextScene *scene)
	Set the vtkContextScene for the item, always set for an item in a scene.

vtkContextScene *	GetScene ()
	Get the vtkContextScene for the item, always set for an item in a scene.

virtual void	SetParent (vtkAbstractContextItem *parent)
	Set the parent item.

vtkAbstractContextItem *	GetParent ()
	Get the parent item.

virtual vtkVector2f	MapToParent (const vtkVector2f &point)
	Maps the point to the parent coordinate system.

virtual vtkVector2f	MapFromParent (const vtkVector2f &point)
	Maps the point from the parent coordinate system.

virtual vtkVector2f	MapToScene (const vtkVector2f &point)
	Maps the point to the scene coordinate system.

virtual vtkVector2f	MapFromScene (const vtkVector2f &point)
	Maps the point from the scene coordinate system.

virtual bool	GetVisible ()
	Get the visibility of the item (should it be drawn).

virtual void	SetVisible (bool)
	Set the visibility of the item (should it be drawn).

virtual bool	GetInteractive ()
	Get if the item is interactive (should respond to mouse events).

virtual void	SetInteractive (bool)
	Set if the item is interactive (should respond to mouse events).

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.

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.

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 vtkDendrogramItem *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkDendrogramItem *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkContextItem
static vtkTypeBool	IsTypeOf (const char *type)

static vtkContextItem *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkAbstractContextItem
static vtkTypeBool	IsTypeOf (const char *type)

static vtkAbstractContextItem *	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 (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 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

	vtkDendrogramItem ()

	~vtkDendrogramItem () override

virtual void	RebuildBuffers ()
	Generate some data needed for painting.

virtual void	PaintBuffers (vtkContext2D *painter)
	This function does the bulk of the actual work in rendering our dendrogram.

virtual bool	IsDirty ()
	This function returns a bool indicating whether or not we need to rebuild our cached data before painting.

void	ComputeMultipliers ()
	Compute how to scale our data so that text labels will fit within the bounds determined by the spacing between the leaf nodes of the tree.

void	ComputeBounds ()
	Compute the bounds of our tree in pixel coordinates.

void	CountLeafNodes ()
	Count the number of leaf nodes in the tree.

int	CountLeafNodes (vtkIdType vertex)
	Count the number of leaf nodes that descend from a given vertex.

vtkIdType	GetClosestVertex (double x, double y)
	Get the tree vertex closest to the specified coordinates.

void	CollapseSubTree (vtkIdType vertex)
	Collapse the subtree rooted at vertex.

void	ExpandSubTree (vtkIdType vertex)
	Expand the previously collapsed subtree rooted at vertex.

vtkIdType	GetOriginalId (vtkIdType vertex)
	Look up the original ID of a vertex in the pruned tree.

vtkIdType	GetPrunedIdForOriginalId (vtkIdType originalId)
	Look up the ID of a vertex in the pruned tree from a vertex ID of the input tree.

vtkIdType	GetClickedCollapsedSubTree (double x, double y)
	Check if the click at (x, y) should be considered as a click on a collapsed subtree.

void	UpdateVisibleSceneExtent (vtkContext2D *painter)
	Calculate the extent of the data that is visible within the window.

bool	LineIsVisible (double x0, double y0, double x1, double y1)
	Returns true if any part of the line segment defined by endpoints (x0, y0), (x1, y1) falls within the extent of the currently visible scene.

void	SetOrientation (vtkTree *tree, int orientation)
	Internal function.

void	PositionColorLegend ()

Protected Member Functions inherited from vtkContextItem
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkContextItem ()=default

	~vtkContextItem () override

Protected Member Functions inherited from vtkAbstractContextItem
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkAbstractContextItem ()

	~vtkAbstractContextItem () override

virtual void	ReleaseGraphicsCache ()
	Release cache entries created by this context item.

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
vtkVector2f	PositionVector

float *	Position

vtkSmartPointer< vtkTree >	Tree

vtkSmartPointer< vtkTree >	LayoutTree

Protected Attributes inherited from vtkContextItem
double	Opacity = 1.0

vtkContextTransform *	Transform = nullptr

Protected Attributes inherited from vtkAbstractContextItem
vtkContextScene *	Scene
	Point to the scene the item is on - can be null.

vtkAbstractContextItem *	Parent
	Point to the parent item - can be null.

vtkContextScenePrivate *	Children
	This structure provides a list of children, along with convenience functions to paint the children etc.

bool	Visible
	Store the visibility of the item (default is true).

bool	Interactive
	Store whether the item should respond to interactions (default is true).

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

A 2D graphics item for rendering a tree as a dendrogram.

Draw a tree as a dendrogram The input tree's vertex data must contain at least two arrays. The first required array is a vtkStringArray called "node name". This array is used to label the leaf nodes of the tree. The second required array is a scalar array called "node weight". This array is used by vtkTreeLayoutStrategy to set any particular node's distance from the root of the tree.

The vtkNewickTreeReader automatically initializes both of these required arrays in its output tree.

.SEE ALSO vtkTree vtkNewickTreeReader

Tests:: vtkDendrogramItem (Tests)

Definition at line 47 of file vtkDendrogramItem.h.

Member Typedef Documentation

◆ Superclass

typedef vtkContextItem vtkDendrogramItem::Superclass

Definition at line 51 of file vtkDendrogramItem.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enum for Orientation.

Enumerator
LEFT_TO_RIGHT
UP_TO_DOWN
RIGHT_TO_LEFT
DOWN_TO_UP

Definition at line 257 of file vtkDendrogramItem.h.

Constructor & Destructor Documentation

◆ vtkDendrogramItem()

vtkDendrogramItem::vtkDendrogramItem ( )

protected

◆ ~vtkDendrogramItem()

vtkDendrogramItem::~vtkDendrogramItem ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkDendrogramItem * vtkDendrogramItem::New ( )

static

◆ IsTypeOf()

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

static

◆ IsA()

virtual vtkTypeBool vtkDendrogramItem::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 vtkContextItem.

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkDendrogramItem::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkContextItem.

◆ NewInstance()

vtkDendrogramItem * vtkDendrogramItem::NewInstance ( ) const

◆ PrintSelf()

void vtkDendrogramItem::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 vtkContextItem.

◆ SetTree()

virtual void vtkDendrogramItem::SetTree ( vtkTree * tree )

virtual

Set the tree that this item draws.

Note that this tree's vertex data must contain a vtkStringArray called "node name". The vtkNewickTreeReader automatically creates this required array for you.

◆ GetTree()

vtkTree * vtkDendrogramItem::GetTree ( )

Get the tree that this item draws.

◆ CollapseToNumberOfLeafNodes()

void vtkDendrogramItem::CollapseToNumberOfLeafNodes ( unsigned int n )

Collapse subtrees until there are only n leaf nodes left in the tree.

The leaf nodes that remain are those that are closest to the root. Any subtrees that were collapsed prior to this function being called may be re-expanded.

◆ GetPrunedTree()

vtkTree * vtkDendrogramItem::GetPrunedTree ( )

Get the collapsed tree.

◆ SetColorArray()

void vtkDendrogramItem::SetColorArray ( const char * arrayName )

Indicate which array within the Tree's VertexData should be used to color the tree.

The specified array must be a vtkDoubleArray. By default, the tree will be drawn in black.

◆ SetExtendLeafNodes()

virtual void vtkDendrogramItem::SetExtendLeafNodes ( bool )

virtual

Get/set whether or not leaf nodes should be extended so that they all line up vertically.

The default is to NOT extend leaf nodes. When extending leaf nodes, the extra length is drawn in grey so as to distinguish it from the actual length of the leaf node.

◆ GetExtendLeafNodes()

virtual bool vtkDendrogramItem::GetExtendLeafNodes ( )

virtual

Get/set whether or not leaf nodes should be extended so that they all line up vertically.

The default is to NOT extend leaf nodes. When extending leaf nodes, the extra length is drawn in grey so as to distinguish it from the actual length of the leaf node.

◆ ExtendLeafNodesOn()

virtual void vtkDendrogramItem::ExtendLeafNodesOn ( )

virtual

Get/set whether or not leaf nodes should be extended so that they all line up vertically.

The default is to NOT extend leaf nodes. When extending leaf nodes, the extra length is drawn in grey so as to distinguish it from the actual length of the leaf node.

◆ ExtendLeafNodesOff()

virtual void vtkDendrogramItem::ExtendLeafNodesOff ( )

virtual

Get/set whether or not leaf nodes should be extended so that they all line up vertically.

The default is to NOT extend leaf nodes. When extending leaf nodes, the extra length is drawn in grey so as to distinguish it from the actual length of the leaf node.

◆ SetOrientation() [1/2]

void vtkDendrogramItem::SetOrientation ( int orientation )

Set which way the tree should face within the visualization.

The default is for the tree to be drawn left to right.

◆ GetOrientation()

int vtkDendrogramItem::GetOrientation ( )

Get the current tree orientation.

◆ GetAngleForOrientation()

double vtkDendrogramItem::GetAngleForOrientation ( int orientation )

Get the rotation angle (in degrees) that corresponds to the given tree orientation.

For the default orientation (LEFT_TO_RIGHT), this is 90 degrees.

◆ GetTextAngleForOrientation()

double vtkDendrogramItem::GetTextAngleForOrientation ( int orientation )

Get the angle that vertex labels should be rotated for the corresponding tree orientation.

For the default orientation (LEFT_TO_RIGHT), this is 0 degrees.

◆ SetDrawLabels()

virtual void vtkDendrogramItem::SetDrawLabels ( bool )

virtual

Get/Set whether or not leaf nodes should be labeled by this class.

Default is true.

◆ GetDrawLabels()

virtual bool vtkDendrogramItem::GetDrawLabels ( )

virtual

Get/Set whether or not leaf nodes should be labeled by this class.

Default is true.

◆ DrawLabelsOn()

virtual void vtkDendrogramItem::DrawLabelsOn ( )

virtual

Get/Set whether or not leaf nodes should be labeled by this class.

Default is true.

◆ DrawLabelsOff()

virtual void vtkDendrogramItem::DrawLabelsOff ( )

virtual

Get/Set whether or not leaf nodes should be labeled by this class.

Default is true.

◆ SetPosition() [1/3]

virtual void vtkDendrogramItem::SetPosition	(	float	,
		float
	)

virtual

Set the position of the dendrogram.

◆ SetPosition() [2/3]

void vtkDendrogramItem::SetPosition ( float [2] )

Set the position of the dendrogram.

◆ SetPosition() [3/3]

void vtkDendrogramItem::SetPosition ( const vtkVector2f & pos )

Set the position of the dendrogram.

◆ GetPosition() [1/3]

virtual float * vtkDendrogramItem::GetPosition ( )

virtual

Get position of the dendrogram.

◆ GetPosition() [2/3]

virtual void vtkDendrogramItem::GetPosition	(	float &	,
		float &
	)

virtual

Get position of the dendrogram.

◆ GetPosition() [3/3]

virtual void vtkDendrogramItem::GetPosition ( float [2] )

virtual

Get position of the dendrogram.

◆ GetPositionVector()

vtkVector2f vtkDendrogramItem::GetPositionVector ( )

Get position of the dendrogram.

◆ GetLeafSpacing()

virtual double vtkDendrogramItem::GetLeafSpacing ( )

virtual

Get/Set the spacing between the leaf nodes in our dendrogram.

Default is 18 pixels.

◆ SetLeafSpacing()

virtual void vtkDendrogramItem::SetLeafSpacing ( double )

virtual

Get/Set the spacing between the leaf nodes in our dendrogram.

Default is 18 pixels.

◆ PrepareToPaint()

void vtkDendrogramItem::PrepareToPaint ( vtkContext2D * painter )

This function calls RebuildBuffers() if necessary.

Once PrepareToPaint() has been called, GetBounds() is guaranteed to provide useful information.

◆ GetBounds()

virtual void vtkDendrogramItem::GetBounds ( double bounds[4] )

virtual

Get the bounds for this item as (Xmin,Xmax,Ymin,Ymax).

These bounds are only guaranteed to be accurate after Paint() or PrepareToPaint() has been called.

◆ ComputeLabelWidth()

void vtkDendrogramItem::ComputeLabelWidth ( vtkContext2D * painter )

Compute the width of the longest leaf node label.

◆ GetLabelWidth()

float vtkDendrogramItem::GetLabelWidth ( )

Get the width of the longest leaf node label.

◆ GetPositionOfVertex()

bool vtkDendrogramItem::GetPositionOfVertex	(	const std::string &	vertexName,
		double	position[2]
	)

Find the position of the vertex with the specified name.

Store this information in the passed array. Returns true if the vertex was found, false otherwise.

◆ Paint()

bool vtkDendrogramItem::Paint ( vtkContext2D * painter )

overridevirtual

Paints the input tree as a dendrogram.

Reimplemented from vtkAbstractContextItem.

◆ GetLineWidth()

virtual float vtkDendrogramItem::GetLineWidth ( )

virtual

Get/Set how wide the edges of this dendrogram should be.

Default is one pixel.

◆ SetLineWidth()

virtual void vtkDendrogramItem::SetLineWidth ( float )

virtual

Get/Set how wide the edges of this dendrogram should be.

Default is one pixel.

◆ SetDisplayNumberOfCollapsedLeafNodes()

virtual void vtkDendrogramItem::SetDisplayNumberOfCollapsedLeafNodes ( bool )

virtual

Get/set whether or not the number of collapsed leaf nodes should be written inside the triangle representing a collapsed subtree.

Default is true.

◆ GetDisplayNumberOfCollapsedLeafNodes()

virtual bool vtkDendrogramItem::GetDisplayNumberOfCollapsedLeafNodes ( )

virtual

Get/set whether or not the number of collapsed leaf nodes should be written inside the triangle representing a collapsed subtree.

Default is true.

◆ DisplayNumberOfCollapsedLeafNodesOn()

virtual void vtkDendrogramItem::DisplayNumberOfCollapsedLeafNodesOn ( )

virtual

Get/set whether or not the number of collapsed leaf nodes should be written inside the triangle representing a collapsed subtree.

Default is true.

◆ DisplayNumberOfCollapsedLeafNodesOff()

virtual void vtkDendrogramItem::DisplayNumberOfCollapsedLeafNodesOff ( )

virtual

Get/set whether or not the number of collapsed leaf nodes should be written inside the triangle representing a collapsed subtree.

Default is true.

◆ GetDistanceArrayName()

virtual vtkStdString vtkDendrogramItem::GetDistanceArrayName ( )

virtual

Get/Set the name of the array that specifies the distance of each vertex from the root (NOT the vertex's parent).

This array should be a part of the input tree's VertexData. By default, this value is "node weight", which is the name of the array created by vtkNewickTreeReader.

◆ SetDistanceArrayName()

virtual void vtkDendrogramItem::SetDistanceArrayName ( vtkStdString )

virtual

Get/Set the name of the array that specifies the distance of each vertex from the root (NOT the vertex's parent).

This array should be a part of the input tree's VertexData. By default, this value is "node weight", which is the name of the array created by vtkNewickTreeReader.

◆ GetVertexNameArrayName()

virtual vtkStdString vtkDendrogramItem::GetVertexNameArrayName ( )

virtual

Get/Set the name of a vtkStringArray that specifies the names of the vertices of the input tree.

This array should be a part of the input tree's VertexData. By default, this value is "node name", which is the name of the array created by vtkNewickTreeReader.

◆ SetVertexNameArrayName()

virtual void vtkDendrogramItem::SetVertexNameArrayName ( vtkStdString )

virtual

Get/Set the name of a vtkStringArray that specifies the names of the vertices of the input tree.

This array should be a part of the input tree's VertexData. By default, this value is "node name", which is the name of the array created by vtkNewickTreeReader.

◆ Hit()

bool vtkDendrogramItem::Hit ( const vtkContextMouseEvent & mouse )

overridevirtual

Returns true if the transform is interactive, false otherwise.

Reimplemented from vtkAbstractContextItem.

◆ MouseDoubleClickEvent()

bool vtkDendrogramItem::MouseDoubleClickEvent ( const vtkContextMouseEvent & event )

overridevirtual

Collapse or expand a subtree when the user double clicks on an internal node.

Reimplemented from vtkAbstractContextItem.

◆ RebuildBuffers()

virtual void vtkDendrogramItem::RebuildBuffers ( )

protectedvirtual

Generate some data needed for painting.

We cache this information as it only needs to be generated when the input data changes.

◆ PaintBuffers()

virtual void vtkDendrogramItem::PaintBuffers ( vtkContext2D * painter )

protectedvirtual

This function does the bulk of the actual work in rendering our dendrogram.

◆ IsDirty()

virtual bool vtkDendrogramItem::IsDirty ( )

protectedvirtual

This function returns a bool indicating whether or not we need to rebuild our cached data before painting.

◆ ComputeMultipliers()

void vtkDendrogramItem::ComputeMultipliers ( )

protected

Compute how to scale our data so that text labels will fit within the bounds determined by the spacing between the leaf nodes of the tree.

◆ ComputeBounds()

void vtkDendrogramItem::ComputeBounds ( )

protected

Compute the bounds of our tree in pixel coordinates.

◆ CountLeafNodes() [1/2]

void vtkDendrogramItem::CountLeafNodes ( )

protected

Count the number of leaf nodes in the tree.

◆ CountLeafNodes() [2/2]

int vtkDendrogramItem::CountLeafNodes ( vtkIdType vertex )

protected

Count the number of leaf nodes that descend from a given vertex.

◆ GetClosestVertex()

vtkIdType vtkDendrogramItem::GetClosestVertex	(	double	x,
		double	y
	)

protected

Get the tree vertex closest to the specified coordinates.

◆ CollapseSubTree()

void vtkDendrogramItem::CollapseSubTree ( vtkIdType vertex )

protected

Collapse the subtree rooted at vertex.

◆ ExpandSubTree()

void vtkDendrogramItem::ExpandSubTree ( vtkIdType vertex )

protected

Expand the previously collapsed subtree rooted at vertex.

◆ GetOriginalId()

vtkIdType vtkDendrogramItem::GetOriginalId ( vtkIdType vertex )

protected

Look up the original ID of a vertex in the pruned tree.

◆ GetPrunedIdForOriginalId()

vtkIdType vtkDendrogramItem::GetPrunedIdForOriginalId ( vtkIdType originalId )

protected

Look up the ID of a vertex in the pruned tree from a vertex ID of the input tree.

◆ GetClickedCollapsedSubTree()

vtkIdType vtkDendrogramItem::GetClickedCollapsedSubTree	(	double	x,
		double	y
	)

protected

Check if the click at (x, y) should be considered as a click on a collapsed subtree.

Returns the vtkIdType of the pruned subtree if so, -1 otherwise.

◆ UpdateVisibleSceneExtent()

void vtkDendrogramItem::UpdateVisibleSceneExtent ( vtkContext2D * painter )

protected

Calculate the extent of the data that is visible within the window.

This information is used to ensure that we only draw details that will be seen by the user. This improves rendering speed, particularly for larger data.

◆ LineIsVisible()

bool vtkDendrogramItem::LineIsVisible	(	double	x0,
		double	y0,
		double	x1,
		double	y1
	)

protected

Returns true if any part of the line segment defined by endpoints (x0, y0), (x1, y1) falls within the extent of the currently visible scene.

Returns false otherwise.

◆ SetOrientation() [2/2]

void vtkDendrogramItem::SetOrientation	(	vtkTree *	tree,
		int	orientation
	)

protected

Internal function.

Use SetOrientation(int orientation) instead.

◆ PositionColorLegend()

void vtkDendrogramItem::PositionColorLegend ( )

protected

Member Data Documentation

◆ PositionVector

vtkVector2f vtkDendrogramItem::PositionVector

protected

Definition at line 280 of file vtkDendrogramItem.h.

◆ Position

float* vtkDendrogramItem::Position

protected

Definition at line 281 of file vtkDendrogramItem.h.

◆ Tree

vtkSmartPointer<vtkTree> vtkDendrogramItem::Tree

protected

Definition at line 378 of file vtkDendrogramItem.h.

◆ LayoutTree

vtkSmartPointer<vtkTree> vtkDendrogramItem::LayoutTree

protected

Definition at line 379 of file vtkDendrogramItem.h.

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

Views/Infovis/vtkDendrogramItem.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ vtkDendrogramItem()

◆ ~vtkDendrogramItem()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ SetTree()

◆ GetTree()

◆ CollapseToNumberOfLeafNodes()

◆ GetPrunedTree()

◆ SetColorArray()

◆ SetExtendLeafNodes()

◆ GetExtendLeafNodes()

◆ ExtendLeafNodesOn()

◆ ExtendLeafNodesOff()

◆ SetOrientation() [1/2]

◆ GetOrientation()

◆ GetAngleForOrientation()

◆ GetTextAngleForOrientation()

◆ SetDrawLabels()

◆ GetDrawLabels()

◆ DrawLabelsOn()

◆ DrawLabelsOff()

◆ SetPosition() [1/3]

◆ SetPosition() [2/3]

◆ SetPosition() [3/3]

◆ GetPosition() [1/3]

◆ GetPosition() [2/3]

◆ GetPosition() [3/3]

◆ GetPositionVector()

◆ GetLeafSpacing()

◆ SetLeafSpacing()

◆ PrepareToPaint()

◆ GetBounds()

◆ ComputeLabelWidth()

◆ GetLabelWidth()

◆ GetPositionOfVertex()

◆ Paint()

◆ GetLineWidth()

◆ SetLineWidth()

◆ SetDisplayNumberOfCollapsedLeafNodes()

◆ GetDisplayNumberOfCollapsedLeafNodes()

◆ DisplayNumberOfCollapsedLeafNodesOn()

◆ DisplayNumberOfCollapsedLeafNodesOff()

◆ GetDistanceArrayName()

◆ SetDistanceArrayName()

◆ GetVertexNameArrayName()

◆ SetVertexNameArrayName()

◆ Hit()

◆ MouseDoubleClickEvent()

◆ RebuildBuffers()

◆ PaintBuffers()

◆ IsDirty()

◆ ComputeMultipliers()

◆ ComputeBounds()

◆ CountLeafNodes() [1/2]

◆ CountLeafNodes() [2/2]

◆ GetClosestVertex()

◆ CollapseSubTree()

◆ ExpandSubTree()

◆ GetOriginalId()

◆ GetPrunedIdForOriginalId()

◆ GetClickedCollapsedSubTree()