VTK
9.3.20240907
|
a force directed graph layout algorithm More...
#include <vtkForceDirectedLayoutStrategy.h>
Public Types | |
typedef vtkGraphLayoutStrategy | Superclass |
![]() | |
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. | |
vtkForceDirectedLayoutStrategy * | NewInstance () const |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. | |
void | Initialize () override |
This strategy sets up some data structures for faster processing of each Layout() call. | |
void | Layout () override |
This is the layout method where the graph that was set in SetGraph() is laid out. | |
int | IsLayoutComplete () override |
I'm an iterative layout so this method lets the caller know if I'm done laying out the graph. | |
virtual void | SetRandomSeed (int) |
Seed the random number generator used to jitter point positions. | |
virtual int | GetRandomSeed () |
Seed the random number generator used to jitter point positions. | |
virtual void | SetGraphBounds (double, double, double, double, double, double) |
Set / get the region in space in which to place the final graph. | |
virtual void | SetGraphBounds (double[6]) |
Set / get the region in space in which to place the final graph. | |
virtual double * | GetGraphBounds () |
Set / get the region in space in which to place the final graph. | |
virtual void | GetGraphBounds (double data[6]) |
Set / get the region in space in which to place the final graph. | |
virtual void | SetAutomaticBoundsComputation (vtkTypeBool) |
Turn on/off automatic graph bounds calculation. | |
virtual vtkTypeBool | GetAutomaticBoundsComputation () |
Turn on/off automatic graph bounds calculation. | |
virtual void | AutomaticBoundsComputationOn () |
Turn on/off automatic graph bounds calculation. | |
virtual void | AutomaticBoundsComputationOff () |
Turn on/off automatic graph bounds calculation. | |
virtual void | SetMaxNumberOfIterations (int) |
Set/Get the maximum number of iterations to be used. | |
virtual int | GetMaxNumberOfIterations () |
Set/Get the maximum number of iterations to be used. | |
virtual void | SetIterationsPerLayout (int) |
Set/Get the number of iterations per layout. | |
virtual int | GetIterationsPerLayout () |
Set/Get the number of iterations per layout. | |
virtual void | SetCoolDownRate (double) |
Set/Get the Cool-down rate. | |
virtual double | GetCoolDownRate () |
Set/Get the Cool-down rate. | |
virtual void | SetThreeDimensionalLayout (vtkTypeBool) |
Turn on/off layout of graph in three dimensions. | |
virtual vtkTypeBool | GetThreeDimensionalLayout () |
Turn on/off layout of graph in three dimensions. | |
virtual void | ThreeDimensionalLayoutOn () |
Turn on/off layout of graph in three dimensions. | |
virtual void | ThreeDimensionalLayoutOff () |
Turn on/off layout of graph in three dimensions. | |
virtual void | SetRandomInitialPoints (vtkTypeBool) |
Turn on/off use of random positions within the graph bounds as initial points. | |
virtual vtkTypeBool | GetRandomInitialPoints () |
Turn on/off use of random positions within the graph bounds as initial points. | |
virtual void | RandomInitialPointsOn () |
Turn on/off use of random positions within the graph bounds as initial points. | |
virtual void | RandomInitialPointsOff () |
Turn on/off use of random positions within the graph bounds as initial points. | |
virtual void | SetInitialTemperature (float) |
Set the initial temperature. | |
virtual float | GetInitialTemperature () |
Set the initial temperature. | |
![]() | |
virtual vtkTypeBool | IsA (const char *type) |
Return 1 if this class is the same type of (or a subclass of) the named class. | |
vtkGraphLayoutStrategy * | NewInstance () const |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. | |
virtual void | SetGraph (vtkGraph *graph) |
Setting the graph for the layout strategy. | |
virtual void | Initialize () |
This method allows the layout strategy to do initialization of data structures or whatever else it might want to do. | |
virtual void | Layout ()=0 |
This is the layout method where the graph that was set in SetGraph() is laid out. | |
virtual int | IsLayoutComplete () |
If your concrete class is iterative than you should overload IsLayoutComplete() otherwise it simply returns 1 by default;. | |
virtual void | SetWeightEdges (bool state) |
Whether to use edge weights in the layout or not. | |
virtual bool | GetWeightEdges () |
Whether to use edge weights in the layout or not. | |
virtual void | SetEdgeWeightField (const char *field) |
Set/Get the field to use for the edge weights. | |
virtual char * | GetEdgeWeightField () |
Set/Get the field to use for the edge weights. | |
![]() | |
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. | |
![]() | |
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 vtkForceDirectedLayoutStrategy * | New () |
static vtkTypeBool | IsTypeOf (const char *type) |
static vtkForceDirectedLayoutStrategy * | SafeDownCast (vtkObjectBase *o) |
![]() | |
static vtkTypeBool | IsTypeOf (const char *type) |
static vtkGraphLayoutStrategy * | SafeDownCast (vtkObjectBase *o) |
![]() | |
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 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 |
vtkForceDirectedLayoutStrategy () | |
~vtkForceDirectedLayoutStrategy () override | |
![]() | |
virtual vtkObjectBase * | NewInstanceInternal () const |
vtkGraphLayoutStrategy () | |
~vtkGraphLayoutStrategy () override | |
![]() | |
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. | |
![]() | |
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 &) |
Protected Attributes | |
double | GraphBounds [6] |
vtkTypeBool | AutomaticBoundsComputation |
int | MaxNumberOfIterations |
double | CoolDownRate |
double | InitialTemperature |
vtkTypeBool | ThreeDimensionalLayout |
vtkTypeBool | RandomInitialPoints |
![]() | |
vtkGraph * | Graph |
char * | EdgeWeightField |
bool | WeightEdges |
![]() | |
bool | Debug |
vtkTimeStamp | MTime |
vtkSubjectHelper * | SubjectHelper |
std::string | ObjectName |
![]() | |
std::atomic< int32_t > | ReferenceCount |
vtkWeakPointerBase ** | WeakPointers |
Additional Inherited Members | |
![]() | |
static vtkMallocingFunction | GetCurrentMallocFunction () |
static vtkReallocingFunction | GetCurrentReallocFunction () |
static vtkFreeingFunction | GetCurrentFreeFunction () |
static vtkFreeingFunction | GetAlternateFreeFunction () |
a force directed graph layout algorithm
Lays out a graph in 2D or 3D using a force-directed algorithm. The user may specify whether to layout the graph randomly initially, the bounds, the number of dimensions (2 or 3), and the cool-down rate.
Definition at line 87 of file vtkForceDirectedLayoutStrategy.h.
Definition at line 92 of file vtkForceDirectedLayoutStrategy.h.
|
protected |
|
overrideprotected |
|
static |
|
static |
|
virtual |
Return 1 if this class is the same type of (or a subclass of) the named class.
Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.
Reimplemented from vtkGraphLayoutStrategy.
|
static |
|
protectedvirtual |
Reimplemented from vtkGraphLayoutStrategy.
vtkForceDirectedLayoutStrategy * vtkForceDirectedLayoutStrategy::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 vtkObjectBase.
|
virtual |
Seed the random number generator used to jitter point positions.
This has a significant effect on their final positions when the layout is complete.
|
virtual |
Seed the random number generator used to jitter point positions.
This has a significant effect on their final positions when the layout is complete.
|
virtual |
Set / get the region in space in which to place the final graph.
The GraphBounds only affects the results if AutomaticBoundsComputation is off.
|
virtual |
Set / get the region in space in which to place the final graph.
The GraphBounds only affects the results if AutomaticBoundsComputation is off.
|
virtual |
Set / get the region in space in which to place the final graph.
The GraphBounds only affects the results if AutomaticBoundsComputation is off.
|
virtual |
Set / get the region in space in which to place the final graph.
The GraphBounds only affects the results if AutomaticBoundsComputation is off.
|
virtual |
Turn on/off automatic graph bounds calculation.
If this boolean is off, then the manually specified GraphBounds is used. If on, then the input's bounds us used as the graph bounds.
|
virtual |
Turn on/off automatic graph bounds calculation.
If this boolean is off, then the manually specified GraphBounds is used. If on, then the input's bounds us used as the graph bounds.
|
virtual |
Turn on/off automatic graph bounds calculation.
If this boolean is off, then the manually specified GraphBounds is used. If on, then the input's bounds us used as the graph bounds.
|
virtual |
Turn on/off automatic graph bounds calculation.
If this boolean is off, then the manually specified GraphBounds is used. If on, then the input's bounds us used as the graph bounds.
|
virtual |
Set/Get the maximum number of iterations to be used.
The higher this number, the more iterations through the algorithm is possible, and thus, the more the graph gets modified. The default is '50' for no particular reason
|
virtual |
Set/Get the maximum number of iterations to be used.
The higher this number, the more iterations through the algorithm is possible, and thus, the more the graph gets modified. The default is '50' for no particular reason
|
virtual |
Set/Get the number of iterations per layout.
The only use for this ivar is for the application to do visualizations of the layout before it's complete. The default is '50' to match the default 'MaxNumberOfIterations'
|
virtual |
Set/Get the number of iterations per layout.
The only use for this ivar is for the application to do visualizations of the layout before it's complete. The default is '50' to match the default 'MaxNumberOfIterations'
|
virtual |
Set/Get the Cool-down rate.
The higher this number is, the longer it will take to "cool-down", and thus, the more the graph will be modified.
|
virtual |
Set/Get the Cool-down rate.
The higher this number is, the longer it will take to "cool-down", and thus, the more the graph will be modified.
|
virtual |
Turn on/off layout of graph in three dimensions.
If off, graph layout occurs in two dimensions. By default, three dimensional layout is off.
|
virtual |
Turn on/off layout of graph in three dimensions.
If off, graph layout occurs in two dimensions. By default, three dimensional layout is off.
|
virtual |
Turn on/off layout of graph in three dimensions.
If off, graph layout occurs in two dimensions. By default, three dimensional layout is off.
|
virtual |
Turn on/off layout of graph in three dimensions.
If off, graph layout occurs in two dimensions. By default, three dimensional layout is off.
|
virtual |
Turn on/off use of random positions within the graph bounds as initial points.
|
virtual |
Turn on/off use of random positions within the graph bounds as initial points.
|
virtual |
Turn on/off use of random positions within the graph bounds as initial points.
|
virtual |
Turn on/off use of random positions within the graph bounds as initial points.
|
virtual |
Set the initial temperature.
If zero (the default) , the initial temperature will be computed automatically.
|
virtual |
Set the initial temperature.
If zero (the default) , the initial temperature will be computed automatically.
|
overridevirtual |
This strategy sets up some data structures for faster processing of each Layout() call.
Reimplemented from vtkGraphLayoutStrategy.
|
overridevirtual |
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.
Implements vtkGraphLayoutStrategy.
|
inlineoverridevirtual |
I'm an iterative layout so this method lets the caller know if I'm done laying out the graph.
Reimplemented from vtkGraphLayoutStrategy.
Definition at line 206 of file vtkForceDirectedLayoutStrategy.h.
|
protected |
Definition at line 212 of file vtkForceDirectedLayoutStrategy.h.
|
protected |
Definition at line 213 of file vtkForceDirectedLayoutStrategy.h.
|
protected |
Definition at line 214 of file vtkForceDirectedLayoutStrategy.h.
|
protected |
Definition at line 215 of file vtkForceDirectedLayoutStrategy.h.
|
protected |
Definition at line 216 of file vtkForceDirectedLayoutStrategy.h.
|
protected |
Definition at line 217 of file vtkForceDirectedLayoutStrategy.h.
|
protected |
Definition at line 218 of file vtkForceDirectedLayoutStrategy.h.