VTK
9.1.0
|
Display two related trees. More...
#include <vtkTanglegramItem.h>
Public Types | |
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. | |
vtkTanglegramItem * | NewInstance () const |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. | |
virtual void | SetTree1 (vtkTree *tree) |
Set the first tree. | |
virtual void | SetTree2 (vtkTree *tree) |
Set the second tree. | |
void | SetOrientation (int orientation) |
Set which way the tanglegram should face within the visualization. | |
int | GetOrientation () |
Get the current orientation. | |
bool | Hit (const vtkContextMouseEvent &mouse) override |
Returns true if the transform is interactive, false otherwise. | |
bool | MouseDoubleClickEvent (const vtkContextMouseEvent &event) override |
Propagate any double click onto the dendrograms to check if any subtrees should be collapsed or expanded. | |
vtkTable * | GetTable () |
Get/Set the table that describes the correspondences between the two trees. | |
void | SetTable (vtkTable *table) |
Get/Set the table that describes the correspondences between the two trees. | |
virtual char * | GetTree1Label () |
Get/Set the label for tree #1. | |
virtual void | SetTree1Label (const char *) |
Get/Set the label for tree #1. | |
virtual char * | GetTree2Label () |
Get/Set the label for tree #2. | |
virtual void | SetTree2Label (const char *) |
Get/Set the label for tree #2. | |
virtual int | GetMinimumVisibleFontSize () |
Get/Set the smallest font size that is still considered legible. | |
virtual void | SetMinimumVisibleFontSize (int) |
Get/Set the smallest font size that is still considered legible. | |
virtual int | GetLabelSizeDifference () |
Get/Set how much larger the dendrogram labels should be compared to the vertex labels. | |
virtual void | SetLabelSizeDifference (int) |
Get/Set how much larger the dendrogram labels should be compared to the vertex labels. | |
virtual float | GetCorrespondenceLineWidth () |
Get/Set how wide the correspondence lines should be. | |
virtual void | SetCorrespondenceLineWidth (float) |
Get/Set how wide the correspondence lines should be. | |
float | GetTreeLineWidth () |
Get/Set how wide the edges of the trees should be. | |
void | SetTreeLineWidth (float width) |
Get/Set how wide the edges of the trees should be. | |
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. | |
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. | |
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 () |
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) |
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 vtkTanglegramItem * | New () |
static vtkTypeBool | IsTypeOf (const char *type) |
static vtkTanglegramItem * | 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 (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 |
vtkTanglegramItem () | |
~vtkTanglegramItem () override | |
void | RefreshBuffers (vtkContext2D *painter) |
Update the bounds of our two dendrograms. | |
void | PositionTree2 () |
Calculate and set an appropriate position for our second dendrogram. | |
void | PaintCorrespondenceLines (vtkContext2D *painter) |
Draw the lines between the corresponding vertices of our two dendrograms. | |
void | PaintTreeLabels (vtkContext2D *painter) |
Draw the labels of our two dendrograms. | |
void | ReorderTree () |
Reorder the children of tree #2 to minimize the amount of crossings in our tanglegram. | |
void | ReorderTreeAtVertex (vtkIdType parent, vtkTree *tree) |
Helper function used by ReorderTree. | |
double | GetPositionScoreForVertex (vtkIdType vertex, vtkTree *tree) |
Helper function used by ReorderTreeAtVertex. | |
void | GenerateLookupTable () |
Initialize the lookup table used to color the lines between the two dendrograms. | |
bool | Paint (vtkContext2D *painter) override |
Paints the tree & associated table as a heatmap. | |
Protected Member Functions inherited from vtkContextItem | |
virtual vtkObjectBase * | NewInstanceInternal () const |
vtkContextItem ()=default | |
~vtkContextItem () override=default | |
Protected Member Functions inherited from vtkAbstractContextItem | |
virtual vtkObjectBase * | NewInstanceInternal () const |
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. | |
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 &) |
Additional Inherited Members | |
Static Protected Member Functions inherited from vtkObjectBase | |
static vtkMallocingFunction | GetCurrentMallocFunction () |
static vtkReallocingFunction | GetCurrentReallocFunction () |
static vtkFreeingFunction | GetCurrentFreeFunction () |
static vtkFreeingFunction | GetAlternateFreeFunction () |
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 |
Protected Attributes inherited from vtkObjectBase | |
std::atomic< int32_t > | ReferenceCount |
vtkWeakPointerBase ** | WeakPointers |
Display two related trees.
This item draws two trees with connections between their leaf nodes. Use SetTable() to specify what leaf nodes correspond to one another between the two trees. See the documentation for this function for more details on how this table should be formatted.
.SEE ALSO vtkTree vtkTable vtkDendrogramItem vtkNewickTreeReader
Definition at line 43 of file vtkTanglegramItem.h.
Definition at line 47 of file vtkTanglegramItem.h.
|
protected |
|
overrideprotected |
|
static |
|
static |
|
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.
|
static |
|
protectedvirtual |
Reimplemented from vtkContextItem.
vtkTanglegramItem * vtkTanglegramItem::NewInstance | ( | ) | const |
|
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.
|
virtual |
Set the first tree.
|
virtual |
Set the second tree.
vtkTable * vtkTanglegramItem::GetTable | ( | ) |
Get/Set the table that describes the correspondences between the two trees.
The first column should contain the names of the leaf nodes from tree #1. The columns of this table should be named after the leaf nodes of tree #2. A non-zero cell should be used to create a connection between the two trees. Different numbers in the table will result in connections being drawn in different colors.
void vtkTanglegramItem::SetTable | ( | vtkTable * | table | ) |
Get/Set the table that describes the correspondences between the two trees.
The first column should contain the names of the leaf nodes from tree #1. The columns of this table should be named after the leaf nodes of tree #2. A non-zero cell should be used to create a connection between the two trees. Different numbers in the table will result in connections being drawn in different colors.
|
virtual |
Get/Set the label for tree #1.
|
virtual |
Get/Set the label for tree #1.
|
virtual |
Get/Set the label for tree #2.
|
virtual |
Get/Set the label for tree #2.
void vtkTanglegramItem::SetOrientation | ( | int | orientation | ) |
Set which way the tanglegram should face within the visualization.
The default is for tree #1 to be drawn left to right.
int vtkTanglegramItem::GetOrientation | ( | ) |
Get the current orientation.
|
virtual |
Get/Set the smallest font size that is still considered legible.
If the current zoom level requires our vertex labels to be smaller than this size the labels will not be drawn at all. Default value is 8 pt.
|
virtual |
Get/Set the smallest font size that is still considered legible.
If the current zoom level requires our vertex labels to be smaller than this size the labels will not be drawn at all. Default value is 8 pt.
|
virtual |
Get/Set how much larger the dendrogram labels should be compared to the vertex labels.
Because the vertex labels automatically resize based on zoom levels, this is a relative (not absolute) size. Default value is 4 pts larger than the vertex labels.
|
virtual |
Get/Set how much larger the dendrogram labels should be compared to the vertex labels.
Because the vertex labels automatically resize based on zoom levels, this is a relative (not absolute) size. Default value is 4 pts larger than the vertex labels.
|
virtual |
Get/Set how wide the correspondence lines should be.
Default is two pixels.
|
virtual |
Get/Set how wide the correspondence lines should be.
Default is two pixels.
float vtkTanglegramItem::GetTreeLineWidth | ( | ) |
Get/Set how wide the edges of the trees should be.
Default is one pixel.
void vtkTanglegramItem::SetTreeLineWidth | ( | float | width | ) |
Get/Set how wide the edges of the trees should be.
Default is one pixel.
|
overridevirtual |
Returns true if the transform is interactive, false otherwise.
Reimplemented from vtkAbstractContextItem.
|
overridevirtual |
Propagate any double click onto the dendrograms to check if any subtrees should be collapsed or expanded.
Reimplemented from vtkAbstractContextItem.
|
protected |
Update the bounds of our two dendrograms.
|
protected |
Calculate and set an appropriate position for our second dendrogram.
|
protected |
Draw the lines between the corresponding vertices of our two dendrograms.
|
protected |
Draw the labels of our two dendrograms.
|
protected |
Reorder the children of tree #2 to minimize the amount of crossings in our tanglegram.
Helper function used by ReorderTree.
Rearrange the children of the specified parent vertex in order to minimize tanglegram crossings.
Helper function used by ReorderTreeAtVertex.
Get the average height of the vertices that correspond to the vertex parameter. This information is used to determine what order sibling vertices should have within the tree.
|
protected |
Initialize the lookup table used to color the lines between the two dendrograms.
|
overrideprotectedvirtual |
Paints the tree & associated table as a heatmap.
Reimplemented from vtkAbstractContextItem.