LibrePCB Developers Documentation
BI_Base Class Referenceabstract

The Board Item Base (BI_Base) class. More...

#include <bi_base.h>

+ Inheritance diagram for BI_Base:
+ Collaboration diagram for BI_Base:

Public Types

enum  Type_t
 

Public Member Functions

 BI_Base ()=delete
 
 BI_Base (const BI_Base &other)=delete
 
 BI_Base (Board &board) noexcept
 
virtual ~BI_Base () noexcept
 
ProjectgetProject () const noexcept
 
CircuitgetCircuit () const noexcept
 
BoardgetBoard () const noexcept
 
virtual Type_t getType () const noexcept=0
 
virtual const PointgetPosition () const noexcept=0
 
virtual bool getIsMirrored () const noexcept=0
 
virtual QPainterPath getGrabAreaScenePx () const noexcept=0
 
virtual bool isAddedToBoard () const noexcept
 
virtual bool isSelectable () const noexcept=0
 
virtual bool isSelected () const noexcept
 
virtual void setSelected (bool selected) noexcept
 
virtual void addToBoard ()=0
 
virtual void removeFromBoard ()=0
 
BI_Baseoperator= (const BI_Base &rhs)=delete
 

Protected Member Functions

void addToBoard (QGraphicsItem *item) noexcept
 
void removeFromBoard (QGraphicsItem *item) noexcept
 

Protected Attributes

BoardmBoard
 

Private Attributes

bool mIsAddedToBoard
 
bool mIsSelected
 

Detailed Description

The Board Item Base (BI_Base) class.

Member Enumeration Documentation

◆ Type_t

Constructor & Destructor Documentation

◆ BI_Base() [1/3]

BI_Base ( )
delete

◆ BI_Base() [2/3]

BI_Base ( const BI_Base other)
delete

◆ BI_Base() [3/3]

BI_Base ( Board board)
noexcept

◆ ~BI_Base()

~BI_Base ( )
virtualnoexcept

Member Function Documentation

◆ getProject()

Project & getProject ( ) const
noexcept
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getCircuit()

Circuit & getCircuit ( ) const
noexcept
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getBoard()

Board& getBoard ( ) const
inlinenoexcept
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getType()

virtual Type_t getType ( ) const
pure virtualnoexcept

Implemented in BI_Device, BI_NetLine, BI_NetSegment, BI_Plane, BI_Footprint, BI_Via, BI_FootprintPad, BI_Polygon, BI_StrokeText, BI_NetPoint, BI_Hole, and BI_AirWire.

+ Here is the caller graph for this function:

◆ getPosition()

virtual const Point& getPosition ( ) const
pure virtualnoexcept

Implemented in BI_Device, BI_NetSegment, BI_NetLine, BI_Plane, BI_Footprint, BI_Via, BI_FootprintPad, BI_StrokeText, BI_Polygon, BI_NetPoint, BI_Hole, and BI_AirWire.

+ Here is the caller graph for this function:

◆ getIsMirrored()

virtual bool getIsMirrored ( ) const
pure virtualnoexcept

Implemented in BI_Device, BI_NetSegment, BI_NetLine, BI_Plane, BI_Footprint, BI_Via, BI_FootprintPad, BI_Polygon, BI_StrokeText, BI_NetPoint, BI_Hole, and BI_AirWire.

+ Here is the caller graph for this function:

◆ getGrabAreaScenePx()

virtual QPainterPath getGrabAreaScenePx ( ) const
pure virtualnoexcept

Implemented in BI_Device, BI_NetSegment, BI_NetLine, BI_Plane, BI_Footprint, BI_Via, BI_FootprintPad, BI_Polygon, BI_StrokeText, BI_NetPoint, BI_Hole, and BI_AirWire.

+ Here is the caller graph for this function:

◆ isAddedToBoard()

virtual bool isAddedToBoard ( ) const
inlinevirtualnoexcept
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ isSelectable()

virtual bool isSelectable ( ) const
pure virtualnoexcept

Implemented in BI_NetSegment, BI_NetLine, BI_Device, BI_Plane, BI_FootprintPad, BI_Footprint, BI_Via, BI_Polygon, BI_StrokeText, BI_AirWire, BI_NetPoint, and BI_Hole.

+ Here is the caller graph for this function:

◆ isSelected()

virtual bool isSelected ( ) const
inlinevirtualnoexcept

Reimplemented in BI_NetSegment.

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

◆ setSelected()

void setSelected ( bool  selected)
virtualnoexcept

Reimplemented in BI_NetSegment, BI_Device, BI_NetLine, BI_Plane, BI_Footprint, BI_Via, BI_FootprintPad, BI_Polygon, BI_StrokeText, BI_NetPoint, BI_Hole, and BI_AirWire.

+ Here is the caller graph for this function:

◆ addToBoard() [1/2]

virtual void addToBoard ( )
pure virtual

Implemented in BI_NetLine, BI_NetSegment, BI_Plane, BI_Device, BI_Footprint, BI_Via, BI_FootprintPad, BI_Polygon, BI_StrokeText, BI_NetPoint, BI_Hole, and BI_AirWire.

+ Here is the caller graph for this function:

◆ removeFromBoard() [1/2]

virtual void removeFromBoard ( )
pure virtual

Implemented in BI_NetLine, BI_NetSegment, BI_Plane, BI_Device, BI_Footprint, BI_Via, BI_FootprintPad, BI_Polygon, BI_StrokeText, BI_NetPoint, BI_Hole, and BI_AirWire.

+ Here is the caller graph for this function:

◆ operator=()

BI_Base& operator= ( const BI_Base rhs)
delete
+ Here is the caller graph for this function:

◆ addToBoard() [2/2]

void addToBoard ( QGraphicsItem *  item)
protectednoexcept
+ Here is the call graph for this function:

◆ removeFromBoard() [2/2]

void removeFromBoard ( QGraphicsItem *  item)
protectednoexcept
+ Here is the call graph for this function:

Member Data Documentation

◆ mBoard

Board& mBoard
protected

◆ mIsAddedToBoard

bool mIsAddedToBoard
private

◆ mIsSelected

bool mIsSelected
private

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