vtkTreeAreaView Class Reference

Accepts a graph and a hierarchy - currently a tree - and provides a hierarchy-aware display. More...

#include <vtkTreeAreaView.h>

Inheritance diagram for vtkTreeAreaView:

Collaboration diagram for vtkTreeAreaView:

Public Types
typedef vtkRenderView	Superclass
Public Types inherited from vtkRenderView
enum	{ INTERACTION_MODE_2D , INTERACTION_MODE_3D , INTERACTION_MODE_UNKNOWN }
enum	{ SURFACE = 0 , FRUSTUM = 1 }
enum	{ NO_OVERLAP , ALL }
enum	{ FREETYPE , QT }
typedef vtkRenderViewBase	Superclass
Public Types inherited from vtkRenderViewBase
typedef vtkView	Superclass
Public Types inherited from vtkView
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.
vtkTreeAreaView *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	SetEdgeColorToSplineFraction ()
	Set the color to be the spline fraction.
vtkDataRepresentation *	SetTreeFromInputConnection (vtkAlgorithmOutput *conn)
	Set the tree and graph representations to the appropriate input ports.
vtkDataRepresentation *	SetTreeFromInput (vtkTree *input)
	Set the tree and graph representations to the appropriate input ports.
vtkDataRepresentation *	SetGraphFromInputConnection (vtkAlgorithmOutput *conn)
	Set the tree and graph representations to the appropriate input ports.
vtkDataRepresentation *	SetGraphFromInput (vtkGraph *input)
	Set the tree and graph representations to the appropriate input ports.
void	SetAreaLabelArrayName (const char *name)
	The array to use for area labeling.
const char *	GetAreaLabelArrayName ()
	The array to use for area labeling.
void	SetAreaSizeArrayName (const char *name)
	The array to use for area sizes.
const char *	GetAreaSizeArrayName ()
	The array to use for area sizes.
void	SetLabelPriorityArrayName (const char *name)
	The array to use for area labeling priority.
const char *	GetLabelPriorityArrayName ()
	The array to use for area labeling priority.
void	SetEdgeLabelArrayName (const char *name)
	The array to use for edge labeling.
const char *	GetEdgeLabelArrayName ()
	The array to use for edge labeling.
void	SetAreaHoverArrayName (const char *name)
	The name of the array whose value appears when the mouse hovers over a rectangle in the treemap.
const char *	GetAreaHoverArrayName ()
	The name of the array whose value appears when the mouse hovers over a rectangle in the treemap.
void	SetAreaLabelVisibility (bool vis)
	Whether to show area labels.
bool	GetAreaLabelVisibility ()
	Whether to show area labels.
virtual void	AreaLabelVisibilityOn ()
	Whether to show area labels.
virtual void	AreaLabelVisibilityOff ()
	Whether to show area labels.
void	SetEdgeLabelVisibility (bool vis)
	Whether to show edge labels.
bool	GetEdgeLabelVisibility ()
	Whether to show edge labels.
virtual void	EdgeLabelVisibilityOn ()
	Whether to show edge labels.
virtual void	EdgeLabelVisibilityOff ()
	Whether to show edge labels.
void	SetAreaColorArrayName (const char *name)
	The array to use for coloring vertices.
const char *	GetAreaColorArrayName ()
	The array to use for coloring vertices.
void	SetColorAreas (bool vis)
	Whether to color vertices.
bool	GetColorAreas ()
	Whether to color vertices.
virtual void	ColorAreasOn ()
	Whether to color vertices.
virtual void	ColorAreasOff ()
	Whether to color vertices.
void	SetEdgeColorArrayName (const char *name)
	The array to use for coloring edges.
const char *	GetEdgeColorArrayName ()
	The array to use for coloring edges.
void	SetShrinkPercentage (double value)
	Set the region shrink percentage between 0.0 and 1.0.
double	GetShrinkPercentage ()
	Set the region shrink percentage between 0.0 and 1.0.
void	SetColorEdges (bool vis)
	Whether to color edges.
bool	GetColorEdges ()
	Whether to color edges.
virtual void	ColorEdgesOn ()
	Whether to color edges.
virtual void	ColorEdgesOff ()
	Whether to color edges.
void	SetBundlingStrength (double strength)
	Set the bundling strength.
double	GetBundlingStrength ()
	Set the bundling strength.
virtual void	SetAreaLabelFontSize (int size)
	The size of the font used for area labeling.
virtual int	GetAreaLabelFontSize ()
	The size of the font used for area labeling.
virtual void	SetEdgeLabelFontSize (int size)
	The size of the font used for edge labeling.
virtual int	GetEdgeLabelFontSize ()
	The size of the font used for edge labeling.
virtual void	SetLayoutStrategy (vtkAreaLayoutStrategy *strategy)
	The layout strategy for producing spatial regions for the tree.
virtual vtkAreaLayoutStrategy *	GetLayoutStrategy ()
	The layout strategy for producing spatial regions for the tree.
virtual void	SetUseRectangularCoordinates (bool rect)
	Whether the area represents radial or rectangular coordinates.
virtual bool	GetUseRectangularCoordinates ()
	Whether the area represents radial or rectangular coordinates.
virtual void	UseRectangularCoordinatesOn ()
	Whether the area represents radial or rectangular coordinates.
virtual void	UseRectangularCoordinatesOff ()
	Whether the area represents radial or rectangular coordinates.
virtual void	SetEdgeScalarBarVisibility (bool b)
	Visibility of scalar bar actor for edges.
virtual bool	GetEdgeScalarBarVisibility ()
	Visibility of scalar bar actor for edges.
Public Member Functions inherited from vtkRenderView
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkRenderView *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	SetInteractor (vtkRenderWindowInteractor *interactor) override
	The render window interactor.
virtual void	SetInteractorStyle (vtkInteractorObserver *style)
	The interactor style associated with the render view.
virtual vtkInteractorObserver *	GetInteractorStyle ()
	Get the interactor style associated with the render view.
void	SetRenderWindow (vtkRenderWindow *win) override
	Set the render window for this view.
void	SetInteractionMode (int mode)
virtual int	GetInteractionMode ()
virtual void	SetInteractionModeTo2D ()
	Set the interaction mode for the view.
virtual void	SetInteractionModeTo3D ()
void	Render () override
	Updates the representations, then calls Render() on the render window associated with this view.
void	ApplyViewTheme (vtkViewTheme *theme) override
	Applies a view theme to this view.
virtual void	AddLabels (vtkAlgorithmOutput *conn)
	Add labels from an input connection with an associated text property.
virtual void	RemoveLabels (vtkAlgorithmOutput *conn)
	Remove labels from an input connection.
virtual void	SetTransform (vtkAbstractTransform *transform)
	Set the view's transform.
virtual vtkAbstractTransform *	GetTransform ()
	Set the view's transform.
virtual void	SetDisplayHoverText (bool b)
	Whether the view should display hover text.
virtual bool	GetDisplayHoverText ()
	Whether the view should display hover text.
virtual void	DisplayHoverTextOn ()
	Whether the view should display hover text.
virtual void	DisplayHoverTextOff ()
	Whether the view should display hover text.
virtual void	SetSelectionMode (int)
	Sets the selection mode for the render view.
virtual int	GetSelectionMode ()
	Sets the selection mode for the render view.
void	SetSelectionModeToSurface ()
	Sets the selection mode for the render view.
void	SetSelectionModeToFrustum ()
	Sets the selection mode for the render view.
virtual void	SetIconTexture (vtkTexture *texture)
	Set the icon sheet to use for rendering icons.
virtual vtkTexture *	GetIconTexture ()
	Set the icon sheet to use for rendering icons.
virtual void	SetIconSize (int, int)
	Set the size of each icon in the icon texture.
void	SetIconSize (int[2])
	Set the size of each icon in the icon texture.
virtual int *	GetIconSize ()
	Set the size of each icon in the icon texture.
virtual void	GetIconSize (int &, int &)
	Set the size of each icon in the icon texture.
virtual void	GetIconSize (int[2])
	Set the size of each icon in the icon texture.
virtual void	SetDisplaySize (int, int)
	Set the display size of the icon (which may be different from the icon size).
void	SetDisplaySize (int[2])
	Set the display size of the icon (which may be different from the icon size).
int *	GetDisplaySize ()
	Set the display size of the icon (which may be different from the icon size).
void	GetDisplaySize (int &dsx, int &dsy)
	Set the display size of the icon (which may be different from the icon size).
virtual void	SetLabelPlacementMode (int mode)
	Label placement mode.
virtual int	GetLabelPlacementMode ()
	Label placement mode.
virtual void	SetLabelPlacementModeToNoOverlap ()
	Label placement mode.
virtual void	SetLabelPlacementModeToAll ()
	Label placement mode.
virtual void	SetLabelRenderMode (int mode)
	Label render mode.
virtual int	GetLabelRenderMode ()
	Label render mode.
virtual void	SetLabelRenderModeToFreetype ()
	Label render mode.
virtual void	SetLabelRenderModeToQt ()
	Label render mode.
void	SetRenderOnMouseMove (bool b)
	Whether to render on every mouse move.
virtual bool	GetRenderOnMouseMove ()
	Whether to render on every mouse move.
virtual void	RenderOnMouseMoveOn ()
	Whether to render on every mouse move.
virtual void	RenderOnMouseMoveOff ()
	Whether to render on every mouse move.
Public Member Functions inherited from vtkRenderViewBase
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkRenderViewBase *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
virtual vtkRenderer *	GetRenderer ()
	Gets the renderer for this view.
virtual void	SetRenderer (vtkRenderer *ren)
virtual vtkRenderWindow *	GetRenderWindow ()
	Get a handle to the render window.
virtual void	SetRenderWindow (vtkRenderWindow *win)
	Set the render window for this view.
virtual void	Render ()
	Updates the representations, then calls Render() on the render window associated with this view.
virtual void	ResetCamera ()
	Updates the representations, then calls ResetCamera() on the renderer associated with this view.
virtual void	ResetCameraClippingRange ()
	Updates the representations, then calls ResetCameraClippingRange() on the renderer associated with this view.
virtual vtkRenderWindowInteractor *	GetInteractor ()
	The render window interactor.
Public Member Functions inherited from vtkView
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkView *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	AddRepresentation (vtkDataRepresentation *rep)
	Adds the representation to the view.
void	SetRepresentation (vtkDataRepresentation *rep)
	Set the representation to the view.
vtkDataRepresentation *	AddRepresentationFromInputConnection (vtkAlgorithmOutput *conn)
	Convenience method which creates a simple representation with the connection and adds it to the view.
vtkDataRepresentation *	SetRepresentationFromInputConnection (vtkAlgorithmOutput *conn)
	Convenience method which sets the representation with the connection and adds it to the view.
vtkDataRepresentation *	AddRepresentationFromInput (vtkDataObject *input)
	Convenience method which creates a simple representation with the specified input and adds it to the view.
vtkDataRepresentation *	SetRepresentationFromInput (vtkDataObject *input)
	Convenience method which sets the representation to the specified input and adds it to the view.
void	RemoveRepresentation (vtkDataRepresentation *rep)
	Removes the representation from the view.
void	RemoveRepresentation (vtkAlgorithmOutput *rep)
	Removes any representation with this connection from the view.
void	RemoveAllRepresentations ()
	Removes all representations from the view.
int	GetNumberOfRepresentations ()
	Returns the number of representations from first port(0) in this view.
vtkDataRepresentation *	GetRepresentation (int index=0)
	The representation at a specified index.
bool	IsRepresentationPresent (vtkDataRepresentation *rep)
	Check to see if a representation is present in the view.
virtual void	Update ()
	Update the view.
virtual void	ApplyViewTheme (vtkViewTheme *theme)
	Apply a theme to the view.
vtkCommand *	GetObserver ()
	Returns the observer that the subclasses can use to listen to additional events.
void	RegisterProgress (vtkObject *algorithm, const char *message=nullptr)
	Meant for use by subclasses and vtkRepresentation subclasses.
void	UnRegisterProgress (vtkObject *algorithm)
	Unregister objects previously registered with RegisterProgress.
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 vtkTreeAreaView *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkTreeAreaView *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkRenderView
static vtkRenderView *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkRenderView *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkRenderViewBase
static vtkRenderViewBase *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkRenderViewBase *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkView
static vtkView *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkView *	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
	vtkTreeAreaView ()
	~vtkTreeAreaView () override
virtual void	SetAreaToPolyData (vtkPolyDataAlgorithm *areaToPoly)
	The filter for converting areas to polydata.
virtual vtkPolyDataAlgorithm *	GetAreaToPolyData ()
	The filter for converting areas to polydata.
virtual void	SetAreaLabelMapper (vtkLabeledDataMapper *mapper)
	The mapper for rendering labels on areas.
virtual vtkLabeledDataMapper *	GetAreaLabelMapper ()
	The mapper for rendering labels on areas.
vtkDataRepresentation *	CreateDefaultRepresentation (vtkAlgorithmOutput *conn) override
	Overrides behavior in vtkView to create a vtkRenderedGraphRepresentation by default.
virtual vtkRenderedTreeAreaRepresentation *	GetTreeAreaRepresentation ()
	Overrides behavior in vtkView to create a vtkRenderedGraphRepresentation by default.
Protected Member Functions inherited from vtkRenderView
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkRenderView ()
	~vtkRenderView () override
void	ProcessEvents (vtkObject *caller, unsigned long eventId, void *callData) override
	Called to process events.
virtual void	GenerateSelection (void *callData, vtkSelection *selection)
	Generates the selection based on the view event and the selection mode.
void	PrepareForRendering () override
	Called by the view when the renderer is about to render.
virtual void	UpdateHoverText ()
	Called in PrepareForRendering to update the hover text.
virtual void	UpdateHoverWidgetState ()
	Enable or disable hovering based on DisplayHoverText ivar and interaction state.
void	UpdatePickRender ()
	Update the pick render for queries for drag selections or hover ballooons.
Protected Member Functions inherited from vtkRenderViewBase
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkRenderViewBase ()
	~vtkRenderViewBase () override
virtual void	PrepareForRendering ()
	Called by the view when the renderer is about to render.
Protected Member Functions inherited from vtkView
virtual vtkObjectBase *	NewInstanceInternal () const
virtual void	AddRepresentationInternal (vtkDataRepresentation *rep)
	Subclass "hooks" for notifying subclasses of vtkView when representations are added or removed.
virtual void	RemoveRepresentationInternal (vtkDataRepresentation *rep)
	Meant for use by subclasses and vtkRepresentation subclasses.
virtual void	SetReuseSingleRepresentation (bool)
	True if the view takes a single representation that should be reused on Add/SetRepresentationFromInput(Connection) calls.
virtual bool	GetReuseSingleRepresentation ()
	Meant for use by subclasses and vtkRepresentation subclasses.
virtual void	ReuseSingleRepresentationOn ()
	Meant for use by subclasses and vtkRepresentation subclasses.
virtual void	ReuseSingleRepresentationOff ()
	Meant for use by subclasses and vtkRepresentation subclasses.
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 &)

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 vtkRenderView
int	SelectionMode
int	LabelRenderMode
bool	DisplayHoverText
bool	Interacting
bool	InHoverTextRender
bool	InPickRender
bool	PickRenderNeedsUpdate
vtkAbstractTransform *	Transform
vtkTexture *	IconTexture
int	IconSize [2]
int	DisplaySize [2]
int	InteractionMode
bool	RenderOnMouseMove
vtkSmartPointer< vtkRenderer >	LabelRenderer
vtkSmartPointer< vtkBalloonRepresentation >	Balloon
vtkSmartPointer< vtkLabelPlacementMapper >	LabelPlacementMapper
vtkSmartPointer< vtkTexturedActor2D >	LabelActor
vtkSmartPointer< vtkHoverWidget >	HoverWidget
vtkSmartPointer< vtkHardwareSelector >	Selector
Protected Attributes inherited from vtkRenderViewBase
vtkSmartPointer< vtkRenderer >	Renderer
vtkSmartPointer< vtkRenderWindow >	RenderWindow
Protected Attributes inherited from vtkView
bool	ReuseSingleRepresentation
	Meant for use by subclasses and vtkRepresentation subclasses.
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

Detailed Description

Accepts a graph and a hierarchy - currently a tree - and provides a hierarchy-aware display.

Currently, this means displaying the hierarchy using a tree ring layout, then rendering the graph vertices as leaves of the tree with curved graph edges between leaves.

Takes a graph and a hierarchy (currently a tree) and lays out the graph vertices based on their categorization within the hierarchy.

.SEE ALSO vtkGraphLayoutView

Thanks:

Thanks to Jason Shepherd for implementing this class

Definition at line 36 of file vtkTreeAreaView.h.

Member Typedef Documentation

Superclass

typedef vtkRenderView vtkTreeAreaView::Superclass

Definition at line 40 of file vtkTreeAreaView.h.

Constructor & Destructor Documentation

vtkTreeAreaView()

vtkTreeAreaView::vtkTreeAreaView ( )

protected

~vtkTreeAreaView()

vtkTreeAreaView::~vtkTreeAreaView ( )

overrideprotected

Member Function Documentation

New()

static vtkTreeAreaView * vtkTreeAreaView::New ( )

static

IsTypeOf()

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

static

IsA()

virtual vtkTypeBool vtkTreeAreaView::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 vtkRenderView.

Reimplemented in vtkIcicleView, vtkTreeMapView, and vtkTreeRingView.

SafeDownCast()

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

static

NewInstanceInternal()

virtual vtkObjectBase * vtkTreeAreaView::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkRenderView.

Reimplemented in vtkIcicleView, vtkTreeMapView, and vtkTreeRingView.

NewInstance()

vtkTreeAreaView * vtkTreeAreaView::NewInstance

(

)

const

PrintSelf()

void vtkTreeAreaView::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 vtkRenderView.

Reimplemented in vtkTreeMapView, and vtkTreeRingView.

SetTreeFromInputConnection()

vtkDataRepresentation * vtkTreeAreaView::SetTreeFromInputConnection

(

vtkAlgorithmOutput *

conn

)

Set the tree and graph representations to the appropriate input ports.

SetTreeFromInput()

vtkDataRepresentation * vtkTreeAreaView::SetTreeFromInput

(

vtkTree *

input

)

Set the tree and graph representations to the appropriate input ports.

SetGraphFromInputConnection()

vtkDataRepresentation * vtkTreeAreaView::SetGraphFromInputConnection

(

vtkAlgorithmOutput *

conn

)

Set the tree and graph representations to the appropriate input ports.

SetGraphFromInput()

vtkDataRepresentation * vtkTreeAreaView::SetGraphFromInput

(

vtkGraph *

input

)

Set the tree and graph representations to the appropriate input ports.

SetAreaLabelArrayName()

void vtkTreeAreaView::SetAreaLabelArrayName

(

const char *

name

)

The array to use for area labeling.

Default is "label".

GetAreaLabelArrayName()

const char * vtkTreeAreaView::GetAreaLabelArrayName

(

)

The array to use for area labeling.

Default is "label".

SetAreaSizeArrayName()

void vtkTreeAreaView::SetAreaSizeArrayName

(

const char *

name

)

The array to use for area sizes.

Default is "size".

GetAreaSizeArrayName()

const char * vtkTreeAreaView::GetAreaSizeArrayName

(

)

The array to use for area sizes.

Default is "size".

SetLabelPriorityArrayName()

void vtkTreeAreaView::SetLabelPriorityArrayName

(

const char *

name

)

The array to use for area labeling priority.

Default is "GraphVertexDegree".

GetLabelPriorityArrayName()

const char * vtkTreeAreaView::GetLabelPriorityArrayName

(

)

The array to use for area labeling priority.

Default is "GraphVertexDegree".

SetEdgeLabelArrayName()

void vtkTreeAreaView::SetEdgeLabelArrayName

(

const char *

name

)

The array to use for edge labeling.

Default is "label".

GetEdgeLabelArrayName()

const char * vtkTreeAreaView::GetEdgeLabelArrayName

(

)

The array to use for edge labeling.

Default is "label".

SetAreaHoverArrayName()

void vtkTreeAreaView::SetAreaHoverArrayName

(

const char *

name

)

The name of the array whose value appears when the mouse hovers over a rectangle in the treemap.

This must be a string array.

GetAreaHoverArrayName()

const char * vtkTreeAreaView::GetAreaHoverArrayName

(

)

The name of the array whose value appears when the mouse hovers over a rectangle in the treemap.

This must be a string array.

SetAreaLabelVisibility()

void vtkTreeAreaView::SetAreaLabelVisibility

(

bool

vis

)

Whether to show area labels.

Default is off.

GetAreaLabelVisibility()

bool vtkTreeAreaView::GetAreaLabelVisibility

(

)

Whether to show area labels.

Default is off.

AreaLabelVisibilityOn()

virtual void vtkTreeAreaView::AreaLabelVisibilityOn ( )

virtual

Whether to show area labels.

Default is off.

AreaLabelVisibilityOff()

virtual void vtkTreeAreaView::AreaLabelVisibilityOff ( )

virtual

Whether to show area labels.

Default is off.

SetEdgeLabelVisibility()

void vtkTreeAreaView::SetEdgeLabelVisibility

(

bool

vis

)

Whether to show edge labels.

Default is off.

GetEdgeLabelVisibility()

bool vtkTreeAreaView::GetEdgeLabelVisibility

(

)

Whether to show edge labels.

Default is off.

EdgeLabelVisibilityOn()

virtual void vtkTreeAreaView::EdgeLabelVisibilityOn ( )

virtual

Whether to show edge labels.

Default is off.

EdgeLabelVisibilityOff()

virtual void vtkTreeAreaView::EdgeLabelVisibilityOff ( )

virtual

Whether to show edge labels.

Default is off.

SetAreaColorArrayName()

void vtkTreeAreaView::SetAreaColorArrayName

(

const char *

name

)

The array to use for coloring vertices.

Default is "color".

GetAreaColorArrayName()

const char * vtkTreeAreaView::GetAreaColorArrayName

(

)

The array to use for coloring vertices.

Default is "color".

SetColorAreas()

void vtkTreeAreaView::SetColorAreas

(

bool

vis

)

Whether to color vertices.

Default is off.

GetColorAreas()

bool vtkTreeAreaView::GetColorAreas

(

)

Whether to color vertices.

Default is off.

ColorAreasOn()

virtual void vtkTreeAreaView::ColorAreasOn ( )

virtual

Whether to color vertices.

Default is off.

ColorAreasOff()

virtual void vtkTreeAreaView::ColorAreasOff ( )

virtual

Whether to color vertices.

Default is off.

SetEdgeColorArrayName()

void vtkTreeAreaView::SetEdgeColorArrayName

(

const char *

name

)

The array to use for coloring edges.

Default is "color".

GetEdgeColorArrayName()

const char * vtkTreeAreaView::GetEdgeColorArrayName

(

)

The array to use for coloring edges.

Default is "color".

SetEdgeColorToSplineFraction()

void vtkTreeAreaView::SetEdgeColorToSplineFraction

(

)

Set the color to be the spline fraction.

SetShrinkPercentage()

void vtkTreeAreaView::SetShrinkPercentage

(

double

value

)

Set the region shrink percentage between 0.0 and 1.0.

GetShrinkPercentage()

double vtkTreeAreaView::GetShrinkPercentage

(

)

Set the region shrink percentage between 0.0 and 1.0.

SetColorEdges()

void vtkTreeAreaView::SetColorEdges

(

bool

vis

)

Whether to color edges.

Default is off.

GetColorEdges()

bool vtkTreeAreaView::GetColorEdges

(

)

Whether to color edges.

Default is off.

ColorEdgesOn()

virtual void vtkTreeAreaView::ColorEdgesOn ( )

virtual

Whether to color edges.

Default is off.

ColorEdgesOff()

virtual void vtkTreeAreaView::ColorEdgesOff ( )

virtual

Whether to color edges.

Default is off.

SetBundlingStrength()

void vtkTreeAreaView::SetBundlingStrength

(

double

strength

)

Set the bundling strength.

GetBundlingStrength()

double vtkTreeAreaView::GetBundlingStrength

(

)

Set the bundling strength.

SetAreaLabelFontSize()

virtual void vtkTreeAreaView::SetAreaLabelFontSize ( int  size )

virtual

The size of the font used for area labeling.

GetAreaLabelFontSize()

virtual int vtkTreeAreaView::GetAreaLabelFontSize ( )

virtual

The size of the font used for area labeling.

SetEdgeLabelFontSize()

virtual void vtkTreeAreaView::SetEdgeLabelFontSize ( int  size )

virtual

The size of the font used for edge labeling.

GetEdgeLabelFontSize()

virtual int vtkTreeAreaView::GetEdgeLabelFontSize ( )

virtual

The size of the font used for edge labeling.

SetLayoutStrategy()

virtual void vtkTreeAreaView::SetLayoutStrategy ( vtkAreaLayoutStrategy *  strategy )

virtual

The layout strategy for producing spatial regions for the tree.

Reimplemented in vtkTreeMapView.

GetLayoutStrategy()

virtual vtkAreaLayoutStrategy * vtkTreeAreaView::GetLayoutStrategy ( )

virtual

The layout strategy for producing spatial regions for the tree.

SetUseRectangularCoordinates()

virtual void vtkTreeAreaView::SetUseRectangularCoordinates ( bool  rect )

virtual

Whether the area represents radial or rectangular coordinates.

GetUseRectangularCoordinates()

virtual bool vtkTreeAreaView::GetUseRectangularCoordinates ( )

virtual

Whether the area represents radial or rectangular coordinates.

UseRectangularCoordinatesOn()

virtual void vtkTreeAreaView::UseRectangularCoordinatesOn ( )

virtual

Whether the area represents radial or rectangular coordinates.

UseRectangularCoordinatesOff()

virtual void vtkTreeAreaView::UseRectangularCoordinatesOff ( )

virtual

Whether the area represents radial or rectangular coordinates.

SetEdgeScalarBarVisibility()

virtual void vtkTreeAreaView::SetEdgeScalarBarVisibility ( bool  b )

virtual

Visibility of scalar bar actor for edges.

GetEdgeScalarBarVisibility()

virtual bool vtkTreeAreaView::GetEdgeScalarBarVisibility ( )

virtual

Visibility of scalar bar actor for edges.

SetAreaToPolyData()

virtual void vtkTreeAreaView::SetAreaToPolyData ( vtkPolyDataAlgorithm *  areaToPoly )

protectedvirtual

The filter for converting areas to polydata.

This may e.g. be vtkTreeMapToPolyData or vtkTreeRingToPolyData. The filter must take a vtkTree as input and produce vtkPolyData.

GetAreaToPolyData()

virtual vtkPolyDataAlgorithm * vtkTreeAreaView::GetAreaToPolyData ( )

protectedvirtual

The filter for converting areas to polydata.

This may e.g. be vtkTreeMapToPolyData or vtkTreeRingToPolyData. The filter must take a vtkTree as input and produce vtkPolyData.

SetAreaLabelMapper()

virtual void vtkTreeAreaView::SetAreaLabelMapper ( vtkLabeledDataMapper *  mapper )

protectedvirtual

The mapper for rendering labels on areas.

This may e.g. be vtkDynamic2DLabelMapper or vtkTreeMapLabelMapper.

GetAreaLabelMapper()

virtual vtkLabeledDataMapper * vtkTreeAreaView::GetAreaLabelMapper ( )

protectedvirtual

The mapper for rendering labels on areas.

This may e.g. be vtkDynamic2DLabelMapper or vtkTreeMapLabelMapper.

CreateDefaultRepresentation()

vtkDataRepresentation * vtkTreeAreaView::CreateDefaultRepresentation ( vtkAlgorithmOutput *  conn )

overrideprotectedvirtual

Overrides behavior in vtkView to create a vtkRenderedGraphRepresentation by default.

Reimplemented from vtkView.

GetTreeAreaRepresentation()

virtual vtkRenderedTreeAreaRepresentation * vtkTreeAreaView::GetTreeAreaRepresentation ( )

protectedvirtual

Overrides behavior in vtkView to create a vtkRenderedGraphRepresentation by default.

---

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

• Views/Infovis/vtkTreeAreaView.h