KiCad PCB EDA Suite
|
A geometry manager that works by accepting a sequence of points and advancing though stages of geometric construction with each point "locked in". More...
#include <multistep_geom_manager.h>
Public Member Functions | |
virtual | ~MULTISTEP_GEOM_MANAGER () |
void | AddPoint (const VECTOR2I &aPt, bool aLockIn) |
Add a point to the construction manager. More... | |
void | RemoveLastPoint () |
Undo the last point, and move the manager back to the previous step. More... | |
bool | IsReset () const |
void | Reset () |
Reset the manager to the initial state. More... | |
bool | IsComplete () const |
VECTOR2I | GetLastPoint () const |
Get the last point added (locked in or not). More... | |
bool | HasGeometryChanged () const |
void | ClearGeometryChanged () |
Clear the geometry changed flag, call after the client code has updated everything as needed. More... | |
Protected Member Functions | |
void | setGeometryChanged () |
< Mark the geometry as changed for clients to notice More... | |
int | getStep () const |
Private Member Functions | |
virtual bool | acceptPoint (const VECTOR2I &aPt)=0 |
< Function that accepts a point for a stage, or rejects it to return to the previous stage More... | |
virtual int | getMaxStep () const =0 |
The highest step this manager has - used to recognize completion and to clamp the step as it advances. More... | |
void | performStep (bool aForward) |
Has the geometry changed such that a client should redraw? More... | |
Private Attributes | |
bool | m_changed = false |
The last (raw) point added, which is usually the cursor position. More... | |
VECTOR2I | m_lastPoint |
int | m_step = 0 |
The current manager step, from 0 to some highest number that depends on the manager. More... | |
A geometry manager that works by accepting a sequence of points and advancing though stages of geometric construction with each point "locked in".
For example, constructing an arc might go:
The exact steps and how the points translate to geometry depends on the subclass.
Definition at line 46 of file multistep_geom_manager.h.
|
inlinevirtual |
Definition at line 49 of file multistep_geom_manager.h.
|
privatepure virtual |
< Function that accepts a point for a stage, or rejects it to return to the previous stage
Implemented in KIGFX::PREVIEW::ARC_GEOM_MANAGER.
Referenced by AddPoint(), and RemoveLastPoint().
|
inline |
Add a point to the construction manager.
aPt | the new point |
aLockIn | whether to "lock in" the point, and move the geometry manager to the next (or previous) step. False to update geometry and not affect manager state. |
Definition at line 60 of file multistep_geom_manager.h.
References acceptPoint(), m_lastPoint, performStep(), and setGeometryChanged().
Referenced by DRAWING_TOOL::drawArc().
|
inline |
Clear the geometry changed flag, call after the client code has updated everything as needed.
Definition at line 136 of file multistep_geom_manager.h.
References m_changed.
|
inline |
Get the last point added (locked in or not).
This can* be useful when drawing previews, as the point given isn't always what gets locked into the geometry, if that step doesn't have full degrees of freedom.
Definition at line 119 of file multistep_geom_manager.h.
References m_lastPoint.
Referenced by RemoveLastPoint(), and KIGFX::PREVIEW::ARC_ASSISTANT::ViewDraw().
|
privatepure virtual |
The highest step this manager has - used to recognize completion and to clamp the step as it advances.
Moves the manager forward or backward through the stages
Implemented in KIGFX::PREVIEW::ARC_GEOM_MANAGER.
Referenced by IsComplete(), and performStep().
|
inlineprotected |
Definition at line 150 of file multistep_geom_manager.h.
References m_step.
Referenced by KIGFX::PREVIEW::ARC_GEOM_MANAGER::acceptPoint(), and KIGFX::PREVIEW::ARC_GEOM_MANAGER::GetStep().
|
inline |
Definition at line 127 of file multistep_geom_manager.h.
References m_changed.
Referenced by DRAWING_TOOL::drawArc().
|
inline |
Definition at line 108 of file multistep_geom_manager.h.
References getMaxStep(), and m_step.
Referenced by DRAWING_TOOL::drawArc().
|
inline |
Definition at line 91 of file multistep_geom_manager.h.
References m_step.
Referenced by KIGFX::PREVIEW::ARC_ASSISTANT::ViewBBox(), and KIGFX::PREVIEW::ARC_ASSISTANT::ViewDraw().
|
inlineprivate |
Has the geometry changed such that a client should redraw?
Definition at line 168 of file multistep_geom_manager.h.
References getMaxStep(), and m_step.
Referenced by AddPoint(), and RemoveLastPoint().
|
inline |
Undo the last point, and move the manager back to the previous step.
Definition at line 78 of file multistep_geom_manager.h.
References acceptPoint(), GetLastPoint(), performStep(), and setGeometryChanged().
Referenced by DRAWING_TOOL::drawArc().
|
inline |
Reset the manager to the initial state.
Definition at line 99 of file multistep_geom_manager.h.
References m_step, and setGeometryChanged().
|
inlineprotected |
< Mark the geometry as changed for clients to notice
Get the current stage of the manager
Definition at line 144 of file multistep_geom_manager.h.
References m_changed.
Referenced by AddPoint(), RemoveLastPoint(), Reset(), KIGFX::PREVIEW::ARC_GEOM_MANAGER::SetClockwise(), and KIGFX::PREVIEW::ARC_GEOM_MANAGER::ToggleClockwise().
|
private |
The last (raw) point added, which is usually the cursor position.
Definition at line 177 of file multistep_geom_manager.h.
Referenced by ClearGeometryChanged(), HasGeometryChanged(), and setGeometryChanged().
|
private |
Definition at line 180 of file multistep_geom_manager.h.
Referenced by AddPoint(), and GetLastPoint().
|
private |
The current manager step, from 0 to some highest number that depends on the manager.
Definition at line 185 of file multistep_geom_manager.h.
Referenced by getStep(), IsComplete(), IsReset(), performStep(), and Reset().