LibrePCB Developers Documentation
CmdBoardPolygonEdit Class Referencefinal

The CmdBoardPolygonEdit class. More...

#include <cmdboardpolygonedit.h>

+ Inheritance diagram for CmdBoardPolygonEdit:
+ Collaboration diagram for CmdBoardPolygonEdit:

Public Member Functions

 CmdBoardPolygonEdit ()=delete
 
 CmdBoardPolygonEdit (const CmdBoardPolygonEdit &other)=delete
 
 CmdBoardPolygonEdit (BI_Polygon &polygon) noexcept
 
 ~CmdBoardPolygonEdit () noexcept
 
BI_PolygongetObj () const noexcept
 
void setLayer (const Layer &layer, bool immediate) noexcept
 
void setLineWidth (const UnsignedLength &width, bool immediate) noexcept
 
void setIsFilled (bool filled, bool immediate) noexcept
 
void setIsGrabArea (bool grabArea, bool immediate) noexcept
 
void setPath (const Path &path, 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 mirrorGeometry (Qt::Orientation orientation, const Point &center, bool immediate) noexcept
 
void mirrorLayer (int innerLayerCount, bool immediate) noexcept
 
void setLocked (bool locked) noexcept
 
CmdBoardPolygonEditoperator= (const CmdBoardPolygonEdit &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

BI_PolygonmPolygon
 
BoardPolygonData mOldData
 
BoardPolygonData mNewData
 

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

Constructor & Destructor Documentation

◆ CmdBoardPolygonEdit() [1/3]

CmdBoardPolygonEdit ( )
delete

◆ CmdBoardPolygonEdit() [2/3]

CmdBoardPolygonEdit ( const CmdBoardPolygonEdit other)
delete

◆ CmdBoardPolygonEdit() [3/3]

CmdBoardPolygonEdit ( BI_Polygon polygon)
explicitnoexcept

◆ ~CmdBoardPolygonEdit()

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

Member Function Documentation

◆ getObj()

BI_Polygon & getObj ( ) const
inlinenoexcept

◆ setLayer()

void setLayer ( const Layer layer,
bool  immediate 
)
noexcept

◆ setLineWidth()

void setLineWidth ( const UnsignedLength width,
bool  immediate 
)
noexcept
+ Here is the caller graph for this function:

◆ setIsFilled()

void setIsFilled ( bool  filled,
bool  immediate 
)
noexcept

◆ setIsGrabArea()

void setIsGrabArea ( bool  grabArea,
bool  immediate 
)
noexcept

◆ setPath()

void setPath ( const Path path,
bool  immediate 
)
noexcept

◆ translate()

void translate ( const Point deltaPos,
bool  immediate 
)
noexcept

◆ snapToGrid()

void snapToGrid ( const PositiveLength gridInterval,
bool  immediate 
)
noexcept

◆ rotate()

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

◆ mirrorGeometry()

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

◆ mirrorLayer()

void mirrorLayer ( int  innerLayerCount,
bool  immediate 
)
noexcept

◆ setLocked()

void setLocked ( bool  locked)
noexcept

◆ operator=()

CmdBoardPolygonEdit & operator= ( const CmdBoardPolygonEdit 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

◆ mPolygon

BI_Polygon& mPolygon
private

◆ mOldData

BoardPolygonData mOldData
private

◆ mNewData

BoardPolygonData mNewData
private

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