LibrePCB Developers Documentation
Loading...
Searching...
No Matches
CmdBoardPadEdit Class Referencefinal

The CmdBoardPadEdit class. More...

#include <cmdboardpadedit.h>

+ Inheritance diagram for CmdBoardPadEdit:
+ Collaboration diagram for CmdBoardPadEdit:

Public Member Functions

 CmdBoardPadEdit (BI_Pad &pad) noexcept
 
 ~CmdBoardPadEdit () noexcept
 
void setComponentSideAndHoles (Pad::ComponentSide side, const PadHoleList &holes, bool immediate)
 
void setFunction (Pad::Function function, bool immediate) noexcept
 
void setShape (Pad::Shape shape, bool immediate) noexcept
 
void setWidth (const PositiveLength &width, bool immediate) noexcept
 
void setHeight (const PositiveLength &height, bool immediate) noexcept
 
void setRadius (const UnsignedLimitedRatio &radius, bool immediate) noexcept
 
void setCustomShapeOutline (const Path &outline) noexcept
 
void setStopMaskConfig (const MaskConfig &config, bool immediate) noexcept
 
void setSolderPasteConfig (const MaskConfig &config) noexcept
 
void setCopperClearance (const UnsignedLength &clearance, bool immediate) noexcept
 
void setPosition (const Point &pos, bool immediate) noexcept
 
void translate (const Point &deltaPos, bool immediate) noexcept
 
void snapToGrid (const PositiveLength &gridInterval, bool immediate) noexcept
 
void setRotation (const Angle &angle, bool immediate) noexcept
 
void rotate (const Angle &angle, const Point &center, bool immediate) noexcept
 
void mirror (const Point &center, Qt::Orientation orientation, bool immediate)
 
void setLocked (bool locked) noexcept
 
- 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)
 
bool wasEverReverted () const noexcept
 This method shows whether that command was ever reverted (undo() called at least one time)
 
bool isCurrentlyExecuted () const noexcept
 This method shows whether that command is currently executed (redo() called one time more than undo())
 
virtual bool execute () final
 Execute the command (must only be called once)
 
virtual void undo () final
 Undo the command.
 
virtual void redo () final
 Redo the command.
 
UndoCommandoperator= (const UndoCommand &rhs)=delete
 

Private Member Functions

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

Private Attributes

BI_PadmPad
 
BoardPadData mOldProperties
 
BoardPadData mNewProperties
 

Additional Inherited Members

- Protected Attributes inherited from UndoCommand
QString mText
 

Detailed Description

The CmdBoardPadEdit class.

Constructor & Destructor Documentation

◆ CmdBoardPadEdit()

CmdBoardPadEdit ( BI_Pad pad)
explicitnoexcept

◆ ~CmdBoardPadEdit()

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

Member Function Documentation

◆ setComponentSideAndHoles()

void setComponentSideAndHoles ( Pad::ComponentSide  side,
const PadHoleList holes,
bool  immediate 
)
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setFunction()

void setFunction ( Pad::Function  function,
bool  immediate 
)
noexcept

◆ setShape()

void setShape ( Pad::Shape  shape,
bool  immediate 
)
noexcept

◆ setWidth()

void setWidth ( const PositiveLength width,
bool  immediate 
)
noexcept

◆ setHeight()

void setHeight ( const PositiveLength height,
bool  immediate 
)
noexcept

◆ setRadius()

void setRadius ( const UnsignedLimitedRatio radius,
bool  immediate 
)
noexcept

◆ setCustomShapeOutline()

void setCustomShapeOutline ( const Path outline)
noexcept

◆ setStopMaskConfig()

void setStopMaskConfig ( const MaskConfig config,
bool  immediate 
)
noexcept

◆ setSolderPasteConfig()

void setSolderPasteConfig ( const MaskConfig config)
noexcept

◆ setCopperClearance()

void setCopperClearance ( const UnsignedLength clearance,
bool  immediate 
)
noexcept

◆ setPosition()

void setPosition ( const Point pos,
bool  immediate 
)
noexcept
+ Here is the caller graph for this function:

◆ translate()

void translate ( const Point deltaPos,
bool  immediate 
)
noexcept

◆ snapToGrid()

void snapToGrid ( const PositiveLength gridInterval,
bool  immediate 
)
noexcept

◆ setRotation()

void setRotation ( const Angle angle,
bool  immediate 
)
noexcept
+ Here is the caller graph for this function:

◆ rotate()

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

◆ mirror()

void mirror ( const Point center,
Qt::Orientation  orientation,
bool  immediate 
)
+ Here is the call graph for this function:

◆ setLocked()

void setLocked ( bool  locked)
noexcept

◆ 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

◆ mPad

BI_Pad& mPad
private

◆ mOldProperties

BoardPadData mOldProperties
private

◆ mNewProperties

BoardPadData mNewProperties
private

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