A default functor that is called before each iteration in the main loop of the ConstrainedFDLayout::run() method. More...
#include <cola.h>
Collaboration diagram for cola::PreIteration:
Public Member Functions | |
| PreIteration (Locks &locks=__locksNotUsed, Resizes &resizes=__resizesNotUsed) | |
| Constructs a PreIteration object that handles locking and resizing of nodes. More... | |
Detailed Description
A default functor that is called before each iteration in the main loop of the ConstrainedFDLayout::run() method.
Override the operator() for things like locking the position of nodes for the duration of the iteration.
If the operator() returns false the subsequent iterations are abandoned, i.e., layout ends immediately. You can make it return true when a user-interrupt is detected, for instance.
Constructor & Destructor Documentation
◆ PreIteration()
|
inline |
Constructs a PreIteration object that handles locking and resizing of nodes.
- Parameters
-
[in] locks A list of nodes (by index) and positions at which they should be locked. [in] resizes A list of nodes (by index) and required dimensions for their bounding rects to be resized to.
The documentation for this class was generated from the following files:
- libcola/cola.h
- libcola/colafd.cpp
