LibrePCB Developers Documentation
CmdBoardPlaneEdit Class Referencefinal

The CmdBoardPlaneEdit class. More...

#include <cmdboardplaneedit.h>

+ Inheritance diagram for CmdBoardPlaneEdit:
+ Collaboration diagram for CmdBoardPlaneEdit:

Public Member Functions

 CmdBoardPlaneEdit (BI_Plane &plane) noexcept
 
 ~CmdBoardPlaneEdit () 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 (const Point &center, Qt::Orientation orientation, int innerLayerCount, bool immediate) noexcept
 
void setOutline (const Path &outline, bool immediate) noexcept
 
void setLayer (const Layer &layer, bool immediate) noexcept
 
void setNetSignal (NetSignal *netsignal) noexcept
 
void setMinWidth (const UnsignedLength &minWidth) noexcept
 
void setMinClearance (const UnsignedLength &minClearance) noexcept
 
void setConnectStyle (BI_Plane::ConnectStyle style) noexcept
 
void setThermalGap (const PositiveLength &gap) noexcept
 
void setThermalSpokeWidth (const PositiveLength &width) noexcept
 
void setPriority (int priority) noexcept
 
void setKeepIslands (bool keep) noexcept
 
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) 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_PlanemPlane
 
Path mOldOutline
 
Path mNewOutline
 
const LayermOldLayer
 
const LayermNewLayer
 
NetSignalmOldNetSignal
 
NetSignalmNewNetSignal
 
UnsignedLength mOldMinWidth
 
UnsignedLength mNewMinWidth
 
UnsignedLength mOldMinClearance
 
UnsignedLength mNewMinClearance
 
BI_Plane::ConnectStyle mOldConnectStyle
 
BI_Plane::ConnectStyle mNewConnectStyle
 
PositiveLength mOldThermalGap
 
PositiveLength mNewThermalGap
 
PositiveLength mOldThermalSpokeWidth
 
PositiveLength mNewThermalSpokeWidth
 
int mOldPriority
 
int mNewPriority
 
bool mOldKeepIslands
 
bool mNewKeepIslands
 
bool mOldLocked
 
bool mNewLocked
 

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 CmdBoardPlaneEdit class.

Constructor & Destructor Documentation

◆ CmdBoardPlaneEdit()

CmdBoardPlaneEdit ( BI_Plane plane)
explicitnoexcept

◆ ~CmdBoardPlaneEdit()

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

Member Function Documentation

◆ 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

◆ mirror()

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

◆ setOutline()

void setOutline ( const Path outline,
bool  immediate 
)
noexcept

◆ setLayer()

void setLayer ( const Layer layer,
bool  immediate 
)
noexcept

◆ setNetSignal()

void setNetSignal ( NetSignal netsignal)
noexcept
+ Here is the caller graph for this function:

◆ setMinWidth()

void setMinWidth ( const UnsignedLength minWidth)
noexcept

◆ setMinClearance()

void setMinClearance ( const UnsignedLength minClearance)
noexcept

◆ setConnectStyle()

void setConnectStyle ( BI_Plane::ConnectStyle  style)
noexcept

◆ setThermalGap()

void setThermalGap ( const PositiveLength gap)
noexcept

◆ setThermalSpokeWidth()

void setThermalSpokeWidth ( const PositiveLength width)
noexcept

◆ setPriority()

void setPriority ( int  priority)
noexcept

◆ setKeepIslands()

void setKeepIslands ( bool  keep)
noexcept

◆ 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:

◆ 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

◆ mPlane

BI_Plane& mPlane
private

◆ mOldOutline

Path mOldOutline
private

◆ mNewOutline

Path mNewOutline
private

◆ mOldLayer

const Layer* mOldLayer
private

◆ mNewLayer

const Layer* mNewLayer
private

◆ mOldNetSignal

NetSignal* mOldNetSignal
private

◆ mNewNetSignal

NetSignal* mNewNetSignal
private

◆ mOldMinWidth

UnsignedLength mOldMinWidth
private

◆ mNewMinWidth

UnsignedLength mNewMinWidth
private

◆ mOldMinClearance

UnsignedLength mOldMinClearance
private

◆ mNewMinClearance

UnsignedLength mNewMinClearance
private

◆ mOldConnectStyle

BI_Plane::ConnectStyle mOldConnectStyle
private

◆ mNewConnectStyle

BI_Plane::ConnectStyle mNewConnectStyle
private

◆ mOldThermalGap

PositiveLength mOldThermalGap
private

◆ mNewThermalGap

PositiveLength mNewThermalGap
private

◆ mOldThermalSpokeWidth

PositiveLength mOldThermalSpokeWidth
private

◆ mNewThermalSpokeWidth

PositiveLength mNewThermalSpokeWidth
private

◆ mOldPriority

int mOldPriority
private

◆ mNewPriority

int mNewPriority
private

◆ mOldKeepIslands

bool mOldKeepIslands
private

◆ mNewKeepIslands

bool mNewKeepIslands
private

◆ mOldLocked

bool mOldLocked
private

◆ mNewLocked

bool mNewLocked
private

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