VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | List of all members
vtkGraphItem Class Reference

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

#include <vtkGraphItem.h>

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

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. More...
 
vtkGraphItemNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void SetGraph (vtkGraph *graph)
 The graph that this item draws. More...
 
virtual vtkGraphGetGraph ()
 
virtual vtkIncrementalForceLayoutGetLayout ()
 Exposes the incremental graph layout for updating parameters. More...
 
virtual void StartLayoutAnimation (vtkRenderWindowInteractor *interactor)
 Begins or ends the layout animation. More...
 
virtual void StopLayoutAnimation ()
 
virtual void UpdateLayout ()
 Incrementally updates the graph layout. 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 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...
 
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 vtkGraphItemNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkGraphItemSafeDownCast (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
 
 vtkGraphItem ()
 
 ~vtkGraphItem () override
 
bool Paint (vtkContext2D *painter) override
 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...
 
bool MouseMoveEvent (const vtkContextMouseEvent &event) override
 Handle mouse events. More...
 
bool MouseLeaveEvent (const vtkContextMouseEvent &event) override
 Mouse leave event. More...
 
bool MouseEnterEvent (const vtkContextMouseEvent &event) override
 Mouse enter event. More...
 
bool MouseButtonPressEvent (const vtkContextMouseEvent &event) override
 Mouse button down event Return true if the item holds the event, false if the event can be propagated to other items. More...
 
bool MouseButtonReleaseEvent (const vtkContextMouseEvent &event) override
 Mouse button release event. More...
 
bool MouseWheelEvent (const vtkContextMouseEvent &event, int delta) override
 Mouse wheel event, positive delta indicates forward movement of the wheel. More...
 
bool Hit (const vtkContextMouseEvent &event) override
 Whether this graph item is hit. More...
 
virtual void PlaceTooltip (vtkIdType v)
 Change the position of the tooltip based on the vertex hovered. More...
 
- 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 &)
 

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

Definition at line 44 of file vtkGraphItem.h.

Member Typedef Documentation

◆ Superclass

Definition at line 48 of file vtkGraphItem.h.

Constructor & Destructor Documentation

◆ vtkGraphItem()

vtkGraphItem::vtkGraphItem ( )
protected

◆ ~vtkGraphItem()

vtkGraphItem::~vtkGraphItem ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkGraphItem* vtkGraphItem::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

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

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkGraphItem::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkContextItem.

◆ NewInstance()

vtkGraphItem* vtkGraphItem::NewInstance ( ) const

◆ PrintSelf()

void vtkGraphItem::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.

◆ SetGraph()

virtual void vtkGraphItem::SetGraph ( vtkGraph graph)
virtual

The graph that this item draws.

◆ GetGraph()

virtual vtkGraph* vtkGraphItem::GetGraph ( )
virtual

◆ GetLayout()

virtual vtkIncrementalForceLayout* vtkGraphItem::GetLayout ( )
virtual

Exposes the incremental graph layout for updating parameters.

◆ StartLayoutAnimation()

virtual void vtkGraphItem::StartLayoutAnimation ( vtkRenderWindowInteractor interactor)
virtual

Begins or ends the layout animation.

◆ StopLayoutAnimation()

virtual void vtkGraphItem::StopLayoutAnimation ( )
virtual

◆ UpdateLayout()

virtual void vtkGraphItem::UpdateLayout ( )
virtual

Incrementally updates the graph layout.

◆ Paint()

bool vtkGraphItem::Paint ( vtkContext2D painter)
overrideprotectedvirtual

Paints the graph.

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

Reimplemented from vtkAbstractContextItem.

◆ RebuildBuffers()

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

◆ PaintBuffers()

virtual void vtkGraphItem::PaintBuffers ( vtkContext2D painter)
protectedvirtual

Efficiently draws the contents of the buffers built in RebuildBuffers.

This occurs once per frame.

◆ IsDirty()

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 properties that may be dynamic.

◆ NumberOfVertices()

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.

◆ NumberOfEdges()

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.

◆ NumberOfEdgePoints()

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 initial and final edge points.

◆ EdgeWidth()

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.

◆ EdgeColor()

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.

◆ EdgePosition()

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.

◆ VertexSize()

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.

◆ VertexColor()

virtual vtkColor4ub vtkGraphItem::VertexColor ( vtkIdType  vertex)
protectedvirtual

Returns the color of each vertex.

Override in a subclass to change the graph vertex colors.

◆ VertexMarker()

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.

◆ VertexPosition()

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.

◆ VertexTooltip()

virtual vtkStdString vtkGraphItem::VertexTooltip ( vtkIdType  vertex)
protectedvirtual

Returns the tooltip for each vertex.

Override in a subclass to change the tooltip text.

◆ ProcessEvents()

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

Process events and dispatch to the appropriate member functions.

◆ HitVertex()

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

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

◆ MouseMoveEvent()

bool vtkGraphItem::MouseMoveEvent ( const vtkContextMouseEvent event)
overrideprotectedvirtual

Handle mouse events.

Reimplemented from vtkAbstractContextItem.

◆ MouseLeaveEvent()

bool vtkGraphItem::MouseLeaveEvent ( const vtkContextMouseEvent mouse)
overrideprotectedvirtual

Mouse leave event.

Return true if the item holds the event, false if the event can be propagated to other items.

Reimplemented from vtkAbstractContextItem.

◆ MouseEnterEvent()

bool vtkGraphItem::MouseEnterEvent ( const vtkContextMouseEvent mouse)
overrideprotectedvirtual

Mouse enter event.

Return true if the item holds the event, false if the event can be propagated to other items.

Reimplemented from vtkAbstractContextItem.

◆ MouseButtonPressEvent()

bool vtkGraphItem::MouseButtonPressEvent ( const vtkContextMouseEvent mouse)
overrideprotectedvirtual

Mouse button down event Return true if the item holds the event, false if the event can be propagated to other items.

Reimplemented from vtkAbstractContextItem.

◆ MouseButtonReleaseEvent()

bool vtkGraphItem::MouseButtonReleaseEvent ( const vtkContextMouseEvent mouse)
overrideprotectedvirtual

Mouse button release event.

Return true if the item holds the event, false if the event can be propagated to other items.

Reimplemented from vtkAbstractContextItem.

◆ MouseWheelEvent()

bool vtkGraphItem::MouseWheelEvent ( const vtkContextMouseEvent mouse,
int  delta 
)
overrideprotectedvirtual

Mouse wheel event, positive delta indicates forward movement of the wheel.

Return true if the item holds the event, false if the event can be propagated to other items.

Reimplemented from vtkAbstractContextItem.

◆ Hit()

bool vtkGraphItem::Hit ( const vtkContextMouseEvent event)
overrideprotectedvirtual

Whether this graph item is hit.

Reimplemented from vtkAbstractContextItem.

◆ PlaceTooltip()

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: