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>

Inheritance diagram for KIGFX::PREVIEW::MULTISTEP_GEOM_MANAGER:

Public Member Functions
virtual	~MULTISTEP_GEOM_MANAGER ()

void	AddPoint (const VECTOR2I &aPt, bool aLockIn)
	Add a point to the construction manager.

void	RemoveLastPoint ()
	Undo the last point, and move the manager back to the previous step.

bool	IsReset () const

virtual void	Reset ()
	Reset the manager to the initial state.

bool	IsComplete () const

VECTOR2I	GetLastPoint () const
	Get the last point added (locked in or not).

bool	HasGeometryChanged () const

void	ClearGeometryChanged ()
	Clear the geometry changed flag, call after the client code has updated everything as needed.

Protected Member Functions
void	setGeometryChanged ()
	Mark the geometry as changed for clients to notice.

int	getStep () const
	Get the current stage of the manager.

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.

virtual bool	rejectRegresses () const

virtual int	getMaxStep () const =0
	The highest step this manager has - used to recognize completion and to clamp the step as it advances.

void	performStep (bool aForward)
	Moves the manager forward or backward through the stages.

Private Attributes
bool	m_changed = false
	Has the geometry changed such that a client should redraw?

VECTOR2I	m_lastPoint
	The last (raw) point added, which is usually the cursor position.

int	m_step = 0
	The current manager step, from 0 to some highest number that depends on the manager.

Detailed Description

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:

Set origin
Set start point
Set end point

The exact steps and how the points translate to geometry depends on the subclass.

Definition at line 43 of file multistep_geom_manager.h.

Constructor & Destructor Documentation

◆ ~MULTISTEP_GEOM_MANAGER()

virtual KIGFX::PREVIEW::MULTISTEP_GEOM_MANAGER::~MULTISTEP_GEOM_MANAGER ( )

inlinevirtual

Definition at line 46 of file multistep_geom_manager.h.

Member Function Documentation

◆ acceptPoint()

virtual bool KIGFX::PREVIEW::MULTISTEP_GEOM_MANAGER::acceptPoint ( const VECTOR2I & aPt )

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, KIGFX::PREVIEW::BEZIER_GEOM_MANAGER, and KIGFX::PREVIEW::ELLIPSE_GEOM_MANAGER.

Referenced by AddPoint(), and RemoveLastPoint().

◆ AddPoint()

void KIGFX::PREVIEW::MULTISTEP_GEOM_MANAGER::AddPoint	(	const VECTOR2I &	aPt,
		bool	aLockIn )

inline

Add a point to the construction manager.

Parameters

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 57 of file multistep_geom_manager.h.

References acceptPoint(), m_lastPoint, performStep(), rejectRegresses(), and setGeometryChanged().

Referenced by KIGFX::PREVIEW::ARC_GEOM_MANAGER::SetMode().

◆ ClearGeometryChanged()

void KIGFX::PREVIEW::MULTISTEP_GEOM_MANAGER::ClearGeometryChanged ( )

inline

Clear the geometry changed flag, call after the client code has updated everything as needed.

Definition at line 137 of file multistep_geom_manager.h.

References m_changed.

◆ GetLastPoint()

VECTOR2I KIGFX::PREVIEW::MULTISTEP_GEOM_MANAGER::GetLastPoint ( ) const

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 120 of file multistep_geom_manager.h.

References m_lastPoint.

Referenced by RemoveLastPoint(), KIGFX::PREVIEW::ARC_GEOM_MANAGER::SetMode(), and KIGFX::PREVIEW::ARC_GEOM_MANAGER::ToggleClockwise().