A 2D graphics item for rendering a graph. More...

#include <vtkGraphItem.h>

Inheritance diagram for vtkGraphItem:

Collaboration diagram for vtkGraphItem:

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 int	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkGraphItem *	NewInstance () const

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

virtual vtkIncrementalForceLayout *	GetLayout ()
	Exposes the incremental graph layout for updating parameters. More...

virtual void	UpdateLayout ()
	Incrementally updates the graph layout. More...


virtual void	SetGraph (vtkGraph *graph)
	The graph that this item draws. More...

virtual vtkGraph *	GetGraph ()
	The graph that this item draws. More...


virtual void	StartLayoutAnimation (vtkRenderWindowInteractor *interactor)
	Begins or ends the layout animation. More...

virtual void	StopLayoutAnimation ()
	Begins or ends the layout animation. More...

Public Member Functions inherited from vtkContextItem
vtkContextItem *	NewInstance () 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
vtkAbstractContextItem *	NewInstance () 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...

unsigned int	AddItem (vtkAbstractContextItem *item)
	Add child items to this item. More...

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

bool	RemoveItem (unsigned int index)
	Remove child item from this item. More...

vtkAbstractContextItem *	GetItem (unsigned int index)
	Get the item at the specified index. More...

unsigned int	GetItemIndex (vtkAbstractContextItem *item)
	Get the index of the specified item. More...

unsigned int	GetNumberOfItems ()
	Get the number of child items. More...

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

unsigned int	Raise (unsigned int index)
	Raises the child to the top of the item's stack. More...

virtual unsigned int	StackAbove (unsigned int index, unsigned int under)
	Raises the child above the under sibling. More...

unsigned int	Lower (unsigned int index)
	Lowers the child to the bottom of the item's stack. More...

virtual unsigned int	StackUnder (unsigned int child, unsigned int above)
	Lowers the child under the above sibling. More...

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

virtual bool	MouseDoubleClickEvent (const vtkContextMouseEvent &mouse)
	Mouse button double click event. 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...

vtkContextScene *	GetScene ()
	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...

vtkAbstractContextItem *	GetParent ()
	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...

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	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. More...

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

int	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

int	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

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)
	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, 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)
	This method invokes an event and return whether the event was aborted or not. More...

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	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...

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

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

Static Public Member Functions
static vtkGraphItem *	New ()

static int	IsTypeOf (const char *type)

static vtkGraphItem *	SafeDownCast (vtkObjectBase *o)

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

static vtkContextItem *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkAbstractContextItem
static int	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. 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 ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

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 vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkGraphItem ()

	~vtkGraphItem ()

virtual bool	Paint (vtkContext2D *painter)
	Paints the graph. More...

virtual void	RebuildBuffers ()
	Builds a cache of data from the graph by calling the virtual functions such as VertexColor(), EdgeColor(), etc. More...

virtual void	PaintBuffers (vtkContext2D *painter)
	Efficiently draws the contents of the buffers built in RebuildBuffers. More...

virtual bool	IsDirty ()
	Returns true if the underlying vtkGraph has been modified since the last RebuildBuffers, signalling a new RebuildBuffers is needed. More...

virtual vtkIdType	NumberOfVertices ()
	Returns the number of vertices in the graph. More...

virtual vtkIdType	NumberOfEdges ()
	Returns the number of edges in the graph. More...

virtual vtkIdType	NumberOfEdgePoints (vtkIdType edge)
	Returns the number of edge control points for a particular edge. More...

virtual float	EdgeWidth (vtkIdType edge, vtkIdType point)
	Returns the edge width. More...

virtual vtkColor4ub	EdgeColor (vtkIdType edge, vtkIdType point)
	Returns the edge color. More...

virtual vtkVector2f	EdgePosition (vtkIdType edge, vtkIdType point)
	Returns the edge control point positions. More...

virtual float	VertexSize (vtkIdType vertex)
	Returns the vertex size in pixels, which is remains the same at any zoom level. More...

virtual vtkColor4ub	VertexColor (vtkIdType vertex)
	Returns the color of each vertex. More...

virtual int	VertexMarker (vtkIdType vertex)
	Returns the marker type for each vertex, as defined in vtkMarkerUtilities. More...

virtual vtkVector2f	VertexPosition (vtkIdType vertex)
	Returns the position of each vertex. More...

virtual vtkStdString	VertexTooltip (vtkIdType vertex)
	Returns the tooltip for each vertex. More...

virtual vtkIdType	HitVertex (const vtkVector2f &pos)
	Return index of hit vertex, or -1 if no hit. More...

virtual bool	Hit (const vtkContextMouseEvent &event)
	Whether this graph item is hit. More...

virtual void	PlaceTooltip (vtkIdType v)
	Change the position of the tooltip based on the vertex hovered. More...


virtual bool	MouseMoveEvent (const vtkContextMouseEvent &event)
	Handle mouse events. More...

virtual bool	MouseLeaveEvent (const vtkContextMouseEvent &event)
	Handle mouse events. More...

virtual bool	MouseEnterEvent (const vtkContextMouseEvent &event)
	Handle mouse events. More...

virtual bool	MouseButtonPressEvent (const vtkContextMouseEvent &event)
	Handle mouse events. More...

virtual bool	MouseButtonReleaseEvent (const vtkContextMouseEvent &event)
	Handle mouse events. More...

virtual bool	MouseWheelEvent (const vtkContextMouseEvent &event, int delta)
	Handle mouse events. More...

Protected Member Functions inherited from vtkContextItem
	vtkContextItem ()

	~vtkContextItem ()

Protected Member Functions inherited from vtkAbstractContextItem
	vtkAbstractContextItem ()

	~vtkAbstractContextItem ()

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=NULL)
	These methods allow a command to exclusively grab all events. More...

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events. More...

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Static Protected Member Functions
static void	ProcessEvents (vtkObject caller, unsigned long event, void clientData, void *callerData)
	Process events and dispatch to the appropriate member functions. More...

Additional Inherited Members
Protected Attributes inherited from vtkContextItem
double	Opacity

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

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

vtkContextScenePrivate *	Children
	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
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

A 2D graphics item for rendering a graph.

This item draws a graph as a part of a vtkContextScene. This simple class has minimal state and delegates the determination of visual vertex and edge properties like color, size, width, etc. to a set of virtual functions. To influence the rendering of the graph, subclass this item and override the property functions you wish to customize.

Examples:: vtkGraphItem (Examples)

Tests:: vtkGraphItem (Tests)

Definition at line 50 of file vtkGraphItem.h.

Member Typedef Documentation

typedef vtkContextItem vtkGraphItem::Superclass

Definition at line 54 of file vtkGraphItem.h.

Constructor & Destructor Documentation

vtkGraphItem::vtkGraphItem ( )

protected

vtkGraphItem::~vtkGraphItem ( )

protected

Member Function Documentation

static vtkGraphItem* vtkGraphItem::New ( )

static

static int vtkGraphItem::IsTypeOf ( const char * type )

static

virtual int vtkGraphItem::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.

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

static

virtual vtkObjectBase* vtkGraphItem::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkContextItem.

vtkGraphItem* vtkGraphItem::NewInstance ( ) const

virtual void vtkGraphItem::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

virtual

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 void vtkGraphItem::SetGraph ( vtkGraph * graph )

virtual

The graph that this item draws.

virtual vtkGraph* vtkGraphItem::GetGraph ( )

virtual

The graph that this item draws.

virtual vtkIncrementalForceLayout* vtkGraphItem::GetLayout ( )

virtual

Exposes the incremental graph layout for updating parameters.

virtual void vtkGraphItem::StartLayoutAnimation ( vtkRenderWindowInteractor * interactor )

virtual

Begins or ends the layout animation.

virtual void vtkGraphItem::StopLayoutAnimation ( )

virtual

Begins or ends the layout animation.

virtual void vtkGraphItem::UpdateLayout ( )

virtual

Incrementally updates the graph layout.

virtual bool vtkGraphItem::Paint ( vtkContext2D * painter )

protectedvirtual

Paints the graph.

This method will call RebuildBuffers() if the graph is dirty, then call PaintBuffers().

Reimplemented from vtkAbstractContextItem.

virtual void vtkGraphItem::RebuildBuffers ( )

protectedvirtual

Builds a cache of data from the graph by calling the virtual functions such as VertexColor(), EdgeColor(), etc.

This will only get called when the item is dirty (i.e. IsDirty() returns true).

virtual void vtkGraphItem::PaintBuffers ( vtkContext2D * painter )

protectedvirtual

Efficiently draws the contents of the buffers built in RebuildBuffers.

This occurs once per frame.

virtual bool vtkGraphItem::IsDirty ( )

protectedvirtual

Returns true if the underlying vtkGraph has been modified since the last RebuildBuffers, signalling a new RebuildBuffers is needed.

When the graph was modified, it assumes the buffers will be rebuilt, so it updates the modified time of the last build. Override this function if you have a subclass that uses any information in addition to the vtkGraph to determine visual propeties that may be dynamic.

virtual vtkIdType vtkGraphItem::NumberOfVertices ( )

protectedvirtual

Returns the number of vertices in the graph.

Generally you do not need to override this method as it simply queries the underlying vtkGraph.

virtual vtkIdType vtkGraphItem::NumberOfEdges ( )

protectedvirtual

Returns the number of edges in the graph.

Generally you do not need to override this method as it simply queries the underlying vtkGraph.

virtual vtkIdType vtkGraphItem::NumberOfEdgePoints ( vtkIdType edge )

protectedvirtual

Returns the number of edge control points for a particular edge.

The implementation returns GetNumberOfEdgePoints(edge) + 2 for the specified edge to incorporate the source and target vertex positions as intial and final edge points.

virtual float vtkGraphItem::EdgeWidth	(	vtkIdType	edge,
		vtkIdType	point
	)

protectedvirtual

Returns the edge width.

Override in a subclass to change the edge width. Note: The item currently supports one width per edge, queried on the first point.

virtual vtkColor4ub vtkGraphItem::EdgeColor	(	vtkIdType	edge,
		vtkIdType	point
	)

protectedvirtual

Returns the edge color.

Override in a subclass to change the edge color. Each edge control point may be rendered with a separate color with interpolation on line segments between points.

virtual vtkVector2f vtkGraphItem::EdgePosition	(	vtkIdType	edge,
		vtkIdType	point
	)

protectedvirtual

Returns the edge control point positions.

You generally do not need to override this method, instead change the edge control points on the underlying vtkGraph with SetEdgePoint(), AddEdgePoint(), etc., then call Modified() on the vtkGraph and re-render the scene.

virtual float vtkGraphItem::VertexSize ( vtkIdType vertex )

protectedvirtual

Returns the vertex size in pixels, which is remains the same at any zoom level.

Override in a subclass to change the graph vertex size. Note: The item currently supports one size per graph, queried on the first vertex.

virtual vtkColor4ub vtkGraphItem::VertexColor ( vtkIdType vertex )

protectedvirtual

Returns the color of each vertex.

Override in a subclass to change the graph vertex colors.

virtual int vtkGraphItem::VertexMarker ( vtkIdType vertex )

protectedvirtual

Returns the marker type for each vertex, as defined in vtkMarkerUtilities.

Override in a subclass to change the graph marker type. Note: The item currently supports one marker type for all vertices, queried on the first vertex.

virtual vtkVector2f vtkGraphItem::VertexPosition ( vtkIdType vertex )

protectedvirtual

Returns the position of each vertex.

You generally do not need to override this method. Instead, change the vertex positions with vtkGraph's SetPoint(), then call Modified() on the graph and re-render the scene.

virtual vtkStdString vtkGraphItem::VertexTooltip ( vtkIdType vertex )

protectedvirtual

Returns the tooltip for each vertex.

Override in a subclass to change the tooltip text.

static void vtkGraphItem::ProcessEvents	(	vtkObject *	caller,
		unsigned long	event,
		void *	clientData,
		void *	callerData
	)

staticprotected

Process events and dispatch to the appropriate member functions.

virtual vtkIdType vtkGraphItem::HitVertex ( const vtkVector2f & pos )

protectedvirtual

Return index of hit vertex, or -1 if no hit.

virtual bool vtkGraphItem::MouseMoveEvent ( const vtkContextMouseEvent & event )

protectedvirtual

Handle mouse events.

Reimplemented from vtkAbstractContextItem.

virtual bool vtkGraphItem::MouseLeaveEvent ( const vtkContextMouseEvent & event )

protectedvirtual

Handle mouse events.

Reimplemented from vtkAbstractContextItem.

virtual bool vtkGraphItem::MouseEnterEvent ( const vtkContextMouseEvent & event )

protectedvirtual

Handle mouse events.

Reimplemented from vtkAbstractContextItem.

virtual bool vtkGraphItem::MouseButtonPressEvent ( const vtkContextMouseEvent & event )

protectedvirtual

Handle mouse events.

Reimplemented from vtkAbstractContextItem.

virtual bool vtkGraphItem::MouseButtonReleaseEvent ( const vtkContextMouseEvent & event )

protectedvirtual

Handle mouse events.

Reimplemented from vtkAbstractContextItem.

virtual bool vtkGraphItem::MouseWheelEvent	(	const vtkContextMouseEvent &	event,
		int	delta
	)

protectedvirtual

Handle mouse events.

Reimplemented from vtkAbstractContextItem.

virtual bool vtkGraphItem::Hit ( const vtkContextMouseEvent & event )

protectedvirtual

Whether this graph item is hit.

Reimplemented from vtkAbstractContextItem.

virtual void vtkGraphItem::PlaceTooltip ( vtkIdType v )

protectedvirtual

Change the position of the tooltip based on the vertex hovered.

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

/home/demarle/Builds/VTK/release/Utilities/Doxygen/dox/Views/Infovis/vtkGraphItem.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation