LibrePCB Developers Documentation
CmdHoleEdit Class Referencefinal

The CmdHoleEdit class. More...

#include <cmdholeedit.h>

+ Inheritance diagram for CmdHoleEdit:
+ Collaboration diagram for CmdHoleEdit:

Public Member Functions

 CmdHoleEdit ()=delete
 
 CmdHoleEdit (const CmdHoleEdit &other)=delete
 
 CmdHoleEdit (Hole &hole) noexcept
 
 ~CmdHoleEdit () noexcept
 
void setPath (const NonEmptyPath &path, bool immediate) noexcept
 
void setPositionOfFirstVertex (const Point &pos, bool immediate) noexcept
 
void translate (const Point &deltaPos, bool immediate) noexcept
 
void snapToGrid (const PositiveLength &gridInterval, bool immediate) noexcept
 
void rotate (const Angle &angle, const Point &center, bool immediate) noexcept
 
void mirror (Qt::Orientation orientation, const Point &center, bool immediate) noexcept
 
void setDiameter (const PositiveLength &diameter, bool immediate) noexcept
 
void setStopMaskConfig (const MaskConfig &config) noexcept
 
CmdHoleEditoperator= (const CmdHoleEdit &rhs)=delete
 
- Public Member Functions inherited from UndoCommand
 UndoCommand ()=delete
 
 UndoCommand (const UndoCommand &other)=delete
 
 UndoCommand (const QString &text) noexcept
 
virtual ~UndoCommand () noexcept
 
const QString & getText () const noexcept
 
bool wasEverExecuted () const noexcept
 This method shows whether that command was ever executed (execute() called successfully) More...
 
bool wasEverReverted () const noexcept
 This method shows whether that command was ever reverted (undo() called at least one time) More...
 
bool isCurrentlyExecuted () const noexcept
 This method shows whether that command is currently executed (redo() called one time more than undo()) More...
 
virtual bool execute () final
 Execute the command (must only be called once) More...
 
virtual void undo () final
 Undo the command. More...
 
virtual void redo () final
 Redo the command. More...
 
UndoCommandoperator= (const UndoCommand &rhs)=delete
 

Private Member Functions

bool performExecute () override
 Execute the command the first time. More...
 
void performUndo () override
 Undo the command. More...
 
void performRedo () override
 Redo the command. More...
 

Private Attributes

HolemHole
 
NonEmptyPath mOldPath
 
NonEmptyPath mNewPath
 
PositiveLength mOldDiameter
 
PositiveLength mNewDiameter
 
MaskConfig mOldStopMaskConfig
 
MaskConfig mNewStopMaskConfig
 

Additional Inherited Members

virtual bool performExecute ()=0
 Execute the command the first time. More...
 
virtual void performUndo ()=0
 Undo the command. More...
 
virtual void performRedo ()=0
 Redo the command. More...
 

Detailed Description

The CmdHoleEdit class.

Constructor & Destructor Documentation

◆ CmdHoleEdit() [1/3]

CmdHoleEdit ( )
delete

◆ CmdHoleEdit() [2/3]

CmdHoleEdit ( const CmdHoleEdit other)
delete

◆ CmdHoleEdit() [3/3]

CmdHoleEdit ( Hole hole)
explicitnoexcept

◆ ~CmdHoleEdit()

~CmdHoleEdit ( )
noexcept
+ Here is the call graph for this function:

Member Function Documentation

◆ setPath()

void setPath ( const NonEmptyPath path,
bool  immediate 
)
noexcept

◆ setPositionOfFirstVertex()

void setPositionOfFirstVertex ( const Point pos,
bool  immediate 
)
noexcept

◆ translate()

void translate ( const Point deltaPos,
bool  immediate 
)
noexcept

◆ snapToGrid()

void snapToGrid ( const PositiveLength gridInterval,
bool  immediate 
)
noexcept
+ Here is the call graph for this function:

◆ rotate()

void rotate ( const Angle angle,
const Point center,
bool  immediate 
)
noexcept

◆ mirror()

void mirror ( Qt::Orientation  orientation,
const Point center,
bool  immediate 
)
noexcept

◆ setDiameter()

void setDiameter ( const PositiveLength diameter,
bool  immediate 
)
noexcept

◆ setStopMaskConfig()

void setStopMaskConfig ( const MaskConfig config)
noexcept

◆ operator=()

CmdHoleEdit & operator= ( const CmdHoleEdit rhs)
delete

◆ performExecute()

bool performExecute ( )
overrideprivatevirtual

Execute the command the first time.

Note
This method must be implemented in all derived classes. If the first time execution is exactly identical to an "redo" action, you can simple call librepcb::editor::UndoCommand::performRedo() in the implementation of this method.
Return values
trueIf the command has done some changes
falseIf the command has done nothing (the command can be deleted)

Implements UndoCommand.

+ Here is the call graph for this function:

◆ performUndo()

void performUndo ( )
overrideprivatevirtual

Undo the command.

Note
This method must be implemented in all derived classes.

Implements UndoCommand.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ performRedo()

void performRedo ( )
overrideprivatevirtual

Redo the command.

Note
This method must be implemented in all derived classes.

Implements UndoCommand.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Member Data Documentation

◆ mHole

Hole& mHole
private

◆ mOldPath

NonEmptyPath mOldPath
private

◆ mNewPath

NonEmptyPath mNewPath
private

◆ mOldDiameter

PositiveLength mOldDiameter
private

◆ mNewDiameter

PositiveLength mNewDiameter
private

◆ mOldStopMaskConfig

MaskConfig mOldStopMaskConfig
private

◆ mNewStopMaskConfig

MaskConfig mNewStopMaskConfig
private

The documentation for this class was generated from the following files: