VTK
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkDendrogramItem Class Reference

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

#include <vtkDendrogramItem.h>

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

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. More...
 
vtkDendrogramItemNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void SetTree (vtkTree *tree)
 Set the tree that this item draws. More...
 
vtkTreeGetTree ()
 Get the tree that this item draws. More...
 
void CollapseToNumberOfLeafNodes (unsigned int n)
 Collapse subtrees until there are only n leaf nodes left in the tree. More...
 
vtkTreeGetPrunedTree ()
 Get the collapsed tree. More...
 
void SetColorArray (const char *arrayName)
 Indicate which array within the Tree's VertexData should be used to color the tree. More...
 
virtual void SetExtendLeafNodes (bool)
 Get/set whether or not leaf nodes should be extended so that they all line up vertically. More...
 
virtual bool GetExtendLeafNodes ()
 
virtual void ExtendLeafNodesOn ()
 
virtual void ExtendLeafNodesOff ()
 
void SetOrientation (int orientation)
 Set which way the tree should face within the visualization. More...
 
int GetOrientation ()
 Get the current tree orientation. More...
 
double GetAngleForOrientation (int orientation)
 Get the rotation angle (in degrees) that corresponds to the given tree orientation. More...
 
double GetTextAngleForOrientation (int orientation)
 Get the angle that vertex labels should be rotated for the corresponding tree orientation. More...
 
virtual void SetDrawLabels (bool)
 Get/Set whether or not leaf nodes should be labeled by this class. More...
 
virtual bool GetDrawLabels ()
 
virtual void DrawLabelsOn ()
 
virtual void DrawLabelsOff ()
 
virtual void SetPosition (float, float)
 Set the position of the dendrogram. More...
 
void SetPosition (float[2])
 
void SetPosition (const vtkVector2f &pos)
 
virtual float * GetPosition ()
 Get position of the dendrogram. More...
 
virtual void GetPosition (float &, float &)
 
virtual void GetPosition (float[2])
 
vtkVector2f GetPositionVector ()
 
virtual double GetLeafSpacing ()
 Get/Set the spacing between the leaf nodes in our dendrogram. More...
 
virtual void SetLeafSpacing (double)
 
void PrepareToPaint (vtkContext2D *painter)
 This function calls RebuildBuffers() if necessary. More...
 
virtual void GetBounds (double bounds[4])
 Get the bounds for this item as (Xmin,Xmax,Ymin,Ymax). More...
 
void ComputeLabelWidth (vtkContext2D *painter)
 Compute the width of the longest leaf node label. More...
 
float GetLabelWidth ()
 Get the width of the longest leaf node label. More...
 
bool GetPositionOfVertex (const std::string &vertexName, double position[2])
 Find the position of the vertex with the specified name. More...
 
bool Paint (vtkContext2D *painter) override
 Paints the input tree as a dendrogram. More...
 
virtual float GetLineWidth ()
 Get/Set how wide the edges of this dendrogram should be. More...
 
virtual void SetLineWidth (float)
 
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. More...
 
virtual bool GetDisplayNumberOfCollapsedLeafNodes ()
 
virtual void DisplayNumberOfCollapsedLeafNodesOn ()
 
virtual void DisplayNumberOfCollapsedLeafNodesOff ()
 
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). More...
 
virtual void SetDistanceArrayName (vtkStdString)
 
virtual vtkStdString GetVertexNameArrayName ()
 Get/Set the name of a vtkStringArray that specifies the names of the vertices of the input tree. More...
 
virtual void SetVertexNameArrayName (vtkStdString)
 
bool Hit (const vtkContextMouseEvent &mouse) override
 Returns true if the transform is interactive, false otherwise. More...
 
bool MouseDoubleClickEvent (const vtkContextMouseEvent &event) override
 Collapse or expand a subtree when the user double clicks on an internal node. More...
 
- Public Member Functions inherited from vtkContextItem
vtkContextItemNewInstance () const
 
virtual double GetOpacity ()
 Get the opacity of the item. More...
 
virtual void SetOpacity (double)
 Set the opacity of the item. More...
 
- Public Member Functions inherited from vtkAbstractContextItem
vtkAbstractContextItemNewInstance () const
 
virtual void Update ()
 Perform any updates to the item that may be necessary before rendering. More...
 
virtual bool PaintChildren (vtkContext2D *painter)
 Paint the children of the item, should be called whenever the children need to be rendered. More...
 
virtual void ReleaseGraphicsResources ()
 Release graphics resources hold by the item. More...
 
vtkIdType AddItem (vtkAbstractContextItem *item)
 Add child items to this item. More...
 
bool RemoveItem (vtkAbstractContextItem *item)
 Remove child item from this item. More...
 
bool RemoveItem (vtkIdType index)
 Remove child item from this item. More...
 
vtkAbstractContextItemGetItem (vtkIdType index)
 Get the item at the specified index. More...
 
vtkIdType GetItemIndex (vtkAbstractContextItem *item)
 Get the index of the specified item in itemIndex. More...
 
vtkIdType GetNumberOfItems ()
 Get the number of child items. More...
 
void ClearItems ()
 Remove all child items from this item. More...
 
vtkIdType Raise (vtkIdType index)
 Raises the child to the top of the item's stack. More...
 
virtual vtkIdType StackAbove (vtkIdType index, vtkIdType under)
 Raises the child above the under sibling. More...
 
vtkIdType Lower (vtkIdType index)
 Lowers the child to the bottom of the item's stack. More...
 
virtual vtkIdType StackUnder (vtkIdType child, vtkIdType above)
 Lowers the child under the above sibling. More...
 
virtual vtkAbstractContextItemGetPickedItem (const vtkContextMouseEvent &mouse)
 Return the item under the mouse. More...
 
virtual bool MouseEnterEvent (const vtkContextMouseEvent &mouse)
 Mouse enter event. More...
 
virtual bool MouseMoveEvent (const vtkContextMouseEvent &mouse)
 Mouse move event. More...
 
virtual bool MouseLeaveEvent (const vtkContextMouseEvent &mouse)
 Mouse leave event. More...
 
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. More...
 
virtual bool MouseButtonReleaseEvent (const vtkContextMouseEvent &mouse)
 Mouse button release event. More...
 
virtual bool MouseWheelEvent (const vtkContextMouseEvent &mouse, int delta)
 Mouse wheel event, positive delta indicates forward movement of the wheel. More...
 
virtual bool KeyPressEvent (const vtkContextKeyEvent &key)
 Key press event. More...
 
virtual bool KeyReleaseEvent (const vtkContextKeyEvent &key)
 Key release event. More...
 
virtual void SetScene (vtkContextScene *scene)
 Set the vtkContextScene for the item, always set for an item in a scene. More...
 
vtkContextSceneGetScene ()
 Get the vtkContextScene for the item, always set for an item in a scene. More...
 
virtual void SetParent (vtkAbstractContextItem *parent)
 Set the parent item. More...
 
vtkAbstractContextItemGetParent ()
 Get the parent item. More...
 
virtual vtkVector2f MapToParent (const vtkVector2f &point)
 Maps the point to the parent coordinate system. More...
 
virtual vtkVector2f MapFromParent (const vtkVector2f &point)
 Maps the point from the parent coordinate system. More...
 
virtual vtkVector2f MapToScene (const vtkVector2f &point)
 Maps the point to the scene coordinate system. More...
 
virtual vtkVector2f MapFromScene (const vtkVector2f &point)
 Maps the point from the scene coordinate system. More...
 
virtual bool GetVisible ()
 Get the visibility of the item (should it be drawn). More...
 
virtual void SetVisible (bool)
 Set the visibility of the item (should it be drawn). More...
 
virtual bool GetInteractive ()
 Get if the item is interactive (should respond to mouse events). More...
 
virtual void SetInteractive (bool)
 Set if the item is interactive (should respond to mouse events). More...
 
- 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 vtkDendrogramItemNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkDendrogramItemSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkContextItem
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkContextItemSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAbstractContextItem
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAbstractContextItemSafeDownCast (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
 
 vtkDendrogramItem ()
 
 ~vtkDendrogramItem () override
 
virtual void RebuildBuffers ()
 Generate some data needed for painting. More...
 
virtual void PaintBuffers (vtkContext2D *painter)
 This function does the bulk of the actual work in rendering our dendrogram. More...
 
virtual bool IsDirty ()
 This function returns a bool indicating whether or not we need to rebuild our cached data before painting. More...
 
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. More...
 
void ComputeBounds ()
 Compute the bounds of our tree in pixel coordinates. More...
 
void CountLeafNodes ()
 Count the number of leaf nodes in the tree. More...
 
int CountLeafNodes (vtkIdType vertex)
 Count the number of leaf nodes that descend from a given vertex. More...
 
vtkIdType GetClosestVertex (double x, double y)
 Get the tree vertex closest to the specified coordinates. More...
 
void CollapseSubTree (vtkIdType vertex)
 Collapse the subtree rooted at vertex. More...
 
void ExpandSubTree (vtkIdType vertex)
 Expand the previously collapsed subtree rooted at vertex. More...
 
vtkIdType GetOriginalId (vtkIdType vertex)
 Look up the original ID of a vertex in the pruned tree. More...
 
vtkIdType GetPrunedIdForOriginalId (vtkIdType originalId)
 Look up the ID of a vertex in the pruned tree from a vertex ID of the input tree. More...
 
vtkIdType GetClickedCollapsedSubTree (double x, double y)
 Check if the click at (x, y) should be considered as a click on a collapsed subtree. More...
 
void UpdateVisibleSceneExtent (vtkContext2D *painter)
 Calculate the extent of the data that is visible within the window. More...
 
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. More...
 
void SetOrientation (vtkTree *tree, int orientation)
 Internal function. More...
 
void PositionColorLegend ()
 
- Protected Member Functions inherited from vtkContextItem
 vtkContextItem ()
 
 ~vtkContextItem () override
 
- Protected Member Functions inherited from vtkAbstractContextItem
 vtkAbstractContextItem ()
 
 ~vtkAbstractContextItem () 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 &)
 

Protected Attributes

vtkVector2f PositionVector
 
float * Position
 
vtkSmartPointer< vtkTreeTree
 
vtkSmartPointer< vtkTreeLayoutTree
 
- Protected Attributes inherited from vtkContextItem
double Opacity
 
- Protected Attributes inherited from vtkAbstractContextItem
vtkContextSceneScene
 Point to the scene the item is on - can be null. More...
 
vtkAbstractContextItemParent
 Point to the parent item - can be null. More...
 
vtkContextScenePrivateChildren
 This structure provides a list of children, along with convenience functions to paint the children etc. More...
 
bool Visible
 Store the visibility of the item (default is true). More...
 
bool Interactive
 Store whether the item should respond to interactions (default is true). More...
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

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

Definition at line 54 of file vtkDendrogramItem.h.

Member Typedef Documentation

◆ Superclass

Definition at line 58 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 264 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

◆ ExtendLeafNodesOn()

virtual void vtkDendrogramItem::ExtendLeafNodesOn ( )
virtual

◆ ExtendLeafNodesOff()

virtual void vtkDendrogramItem::ExtendLeafNodesOff ( )
virtual

◆ 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

◆ DrawLabelsOn()

virtual void vtkDendrogramItem::DrawLabelsOn ( )
virtual

◆ DrawLabelsOff()

virtual void vtkDendrogramItem::DrawLabelsOff ( )
virtual

◆ SetPosition() [1/3]

virtual void vtkDendrogramItem::SetPosition ( float  ,
float   
)
virtual

Set the position of the dendrogram.

◆ SetPosition() [2/3]

void vtkDendrogramItem::SetPosition ( float  [2])

◆ SetPosition() [3/3]

void vtkDendrogramItem::SetPosition ( const vtkVector2f pos)

◆ GetPosition() [1/3]

virtual float* vtkDendrogramItem::GetPosition ( )
virtual

Get position of the dendrogram.

◆ GetPosition() [2/3]

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

◆ GetPosition() [3/3]

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

◆ GetPositionVector()

vtkVector2f vtkDendrogramItem::GetPositionVector ( )

◆ 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

◆ 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

◆ 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

◆ DisplayNumberOfCollapsedLeafNodesOn()

virtual void vtkDendrogramItem::DisplayNumberOfCollapsedLeafNodesOn ( )
virtual

◆ DisplayNumberOfCollapsedLeafNodesOff()

virtual void vtkDendrogramItem::DisplayNumberOfCollapsedLeafNodesOff ( )
virtual

◆ 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

◆ 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

◆ 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 287 of file vtkDendrogramItem.h.

◆ Position

float* vtkDendrogramItem::Position
protected

Definition at line 288 of file vtkDendrogramItem.h.

◆ Tree

vtkSmartPointer<vtkTree> vtkDendrogramItem::Tree
protected

Definition at line 385 of file vtkDendrogramItem.h.

◆ LayoutTree

vtkSmartPointer<vtkTree> vtkDendrogramItem::LayoutTree
protected

Definition at line 386 of file vtkDendrogramItem.h.


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