abstract superclass for all graph layout strategies More...
#include <vtkGraphLayoutStrategy.h>
Public Types | |
| 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... | |
| vtkGraphLayoutStrategy * | NewInstance () 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) |
| Setting the graph for the layout strategy. More... | |
| virtual void | Initialize () |
| This method allows the layout strategy to do initialization of data structures or whatever else it might want to do. More... | |
| virtual void | Layout ()=0 |
| This is the layout method where the graph that was set in SetGraph() is laid out. More... | |
| virtual int | IsLayoutComplete () |
| If your concrete class is iterative than you should overload IsLayoutComplete() otherwise it simply returns 1 by default;. More... | |
| virtual void | SetWeightEdges (bool state) |
| Whether to use edge weights in the layout or not. More... | |
| virtual bool | GetWeightEdges () |
| Whether to use edge weights in the layout or not. More... | |
| virtual void | SetEdgeWeightField (const char *field) |
| Set/Get the field to use for the edge weights. More... | |
| virtual char * | GetEdgeWeightField () |
| Set/Get the field to use for the edge weights. 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 () |
| 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. 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... | |
| vtkTypeBool | HasObserver (unsigned long event, vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| vtkTypeBool | 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 vtkTypeBool | IsTypeOf (const char *type) |
| static vtkGraphLayoutStrategy * | 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 |
| vtkGraphLayoutStrategy () | |
| ~vtkGraphLayoutStrategy () 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 () |
| 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 &) |
Protected Attributes | |
| vtkGraph * | Graph |
| char * | EdgeWeightField |
| bool | WeightEdges |
| Protected Attributes inherited from vtkObject | |
| bool | Debug |
| vtkTimeStamp | MTime |
| vtkSubjectHelper * | SubjectHelper |
| Protected Attributes inherited from vtkObjectBase | |
| vtkAtomicInt32 | ReferenceCount |
| vtkWeakPointerBase ** | WeakPointers |
Detailed Description
abstract superclass for all graph layout strategies
All graph layouts should subclass from this class. vtkGraphLayoutStrategy works as a plug-in to the vtkGraphLayout algorithm. The Layout() function should perform some reasonable "chunk" of the layout. This allows the user to be able to see the progress of the layout. Use IsLayoutComplete() to tell the user when there is no more layout to perform.
- Thanks:
- Thanks to Brian Wylie from Sandia National Laboratories for adding incremental layout capabilities.
Definition at line 45 of file vtkGraphLayoutStrategy.h.
Member Typedef Documentation
Definition at line 48 of file vtkGraphLayoutStrategy.h.
Constructor & Destructor Documentation
|
protected |
|
overrideprotected |
Member Function Documentation
|
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 vtkObjectBase.
Reimplemented in vtkSpanTreeLayoutStrategy, vtkConeLayoutStrategy, vtkTreeLayoutStrategy, vtkSimple3DCirclesStrategy, vtkFast2DLayoutStrategy, vtkConstrained2DLayoutStrategy, vtkSimple2DLayoutStrategy, vtkCommunity2DLayoutStrategy, vtkAttributeClustering2DLayoutStrategy, vtkClustering2DLayoutStrategy, vtkCosmicTreeLayoutStrategy, vtkForceDirectedLayoutStrategy, vtkRandomLayoutStrategy, vtkPassThroughLayoutStrategy, vtkCircularLayoutStrategy, vtkAssignCoordinatesLayoutStrategy, and vtkTreeOrbitLayoutStrategy.
|
static |
|
protectedvirtual |
Reimplemented in vtkSpanTreeLayoutStrategy, vtkConeLayoutStrategy, vtkTreeLayoutStrategy, vtkSimple3DCirclesStrategy, vtkFast2DLayoutStrategy, vtkConstrained2DLayoutStrategy, vtkSimple2DLayoutStrategy, vtkCommunity2DLayoutStrategy, vtkAttributeClustering2DLayoutStrategy, vtkClustering2DLayoutStrategy, vtkCosmicTreeLayoutStrategy, vtkForceDirectedLayoutStrategy, vtkRandomLayoutStrategy, vtkPassThroughLayoutStrategy, vtkCircularLayoutStrategy, vtkAssignCoordinatesLayoutStrategy, and vtkTreeOrbitLayoutStrategy.
| vtkGraphLayoutStrategy* vtkGraphLayoutStrategy::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 vtkObject.
Reimplemented in vtkSpanTreeLayoutStrategy, vtkTreeLayoutStrategy, vtkSimple3DCirclesStrategy, vtkSimple2DLayoutStrategy, vtkRandomLayoutStrategy, vtkPassThroughLayoutStrategy, and vtkTreeOrbitLayoutStrategy.
|
virtual |
Setting the graph for the layout strategy.
Reimplemented in vtkSimple3DCirclesStrategy, and vtkRandomLayoutStrategy.
|
inlinevirtual |
This method allows the layout strategy to do initialization of data structures or whatever else it might want to do.
Reimplemented in vtkForceDirectedLayoutStrategy, vtkSimple2DLayoutStrategy, vtkAttributeClustering2DLayoutStrategy, vtkConstrained2DLayoutStrategy, vtkFast2DLayoutStrategy, vtkCommunity2DLayoutStrategy, vtkClustering2DLayoutStrategy, and vtkPassThroughLayoutStrategy.
Definition at line 61 of file vtkGraphLayoutStrategy.h.
|
pure virtual |
This is the layout method where the graph that was set in SetGraph() is laid out.
The method can either entirely layout the graph or iteratively lay out the graph. If you have an iterative layout please implement the IsLayoutComplete() method.
Implemented in vtkSimple3DCirclesStrategy, vtkForceDirectedLayoutStrategy, vtkSimple2DLayoutStrategy, vtkAttributeClustering2DLayoutStrategy, vtkConstrained2DLayoutStrategy, vtkFast2DLayoutStrategy, vtkCommunity2DLayoutStrategy, vtkClustering2DLayoutStrategy, vtkConeLayoutStrategy, vtkRandomLayoutStrategy, vtkSpanTreeLayoutStrategy, vtkAssignCoordinatesLayoutStrategy, vtkTreeLayoutStrategy, vtkPassThroughLayoutStrategy, vtkCosmicTreeLayoutStrategy, vtkCircularLayoutStrategy, and vtkTreeOrbitLayoutStrategy.
|
inlinevirtual |
If your concrete class is iterative than you should overload IsLayoutComplete() otherwise it simply returns 1 by default;.
Reimplemented in vtkForceDirectedLayoutStrategy, vtkSimple2DLayoutStrategy, vtkAttributeClustering2DLayoutStrategy, vtkConstrained2DLayoutStrategy, vtkFast2DLayoutStrategy, vtkCommunity2DLayoutStrategy, vtkClustering2DLayoutStrategy, and vtkPassThroughLayoutStrategy.
Definition at line 77 of file vtkGraphLayoutStrategy.h.
|
virtual |
Whether to use edge weights in the layout or not.
|
virtual |
Whether to use edge weights in the layout or not.
|
virtual |
Set/Get the field to use for the edge weights.
|
virtual |
Set/Get the field to use for the edge weights.
Member Data Documentation
|
protected |
Definition at line 99 of file vtkGraphLayoutStrategy.h.
|
protected |
Definition at line 100 of file vtkGraphLayoutStrategy.h.
|
protected |
Definition at line 101 of file vtkGraphLayoutStrategy.h.
The documentation for this class was generated from the following file:
- /home/demarle/Source/VTK/release/8.2/build/Utilities/Doxygen/dox/Infovis/Layout/vtkGraphLayoutStrategy.h
