LibrePCB Developers Documentation
BI_Polygon Class Referencefinal

The BI_Polygon class. More...

#include <bi_polygon.h>

+ Inheritance diagram for BI_Polygon:
+ Collaboration diagram for BI_Polygon:

Public Types

enum class  Event
 
typedef Slot< BI_Polygon, EventOnEditedSlot
 

Public Member Functions

 BI_Polygon ()=delete
 
 BI_Polygon (const BI_Polygon &other)=delete
 
 BI_Polygon (Board &board, const BoardPolygonData &data)
 
 ~BI_Polygon () noexcept
 
const BoardPolygonDatagetData () const noexcept
 
bool setLayer (const Layer &layer) noexcept
 
bool setLineWidth (const UnsignedLength &width) noexcept
 
bool setPath (const Path &path) noexcept
 
bool setIsFilled (bool isFilled) noexcept
 
bool setIsGrabArea (bool isGrabArea) noexcept
 
bool setLocked (bool locked) noexcept
 
void addToBoard () override
 
void removeFromBoard () override
 
BI_Polygonoperator= (const BI_Polygon &rhs)=delete
 
- Public Member Functions inherited from BI_Base
 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 bool isAddedToBoard () const noexcept
 
virtual void addToBoard ()
 
virtual void removeFromBoard ()
 
BI_Baseoperator= (const BI_Base &rhs)=delete
 

Public Attributes

Signal< BI_Polygon, EventonEdited
 

Private Member Functions

void invalidatePlanes (const Layer &layer) noexcept
 

Private Attributes

BoardPolygonData mData
 

Additional Inherited Members

- Protected Attributes inherited from BI_Base
BoardmBoard
 

Detailed Description

The BI_Polygon class.

Member Typedef Documentation

◆ OnEditedSlot

Member Enumeration Documentation

◆ Event

enum class Event
strong
Enumerator
LayerChanged 
LineWidthChanged 
IsFilledChanged 
IsGrabAreaChanged 
IsLockedChanged 
PathChanged 

Constructor & Destructor Documentation

◆ BI_Polygon() [1/3]

BI_Polygon ( )
delete

◆ BI_Polygon() [2/3]

BI_Polygon ( const BI_Polygon other)
delete

◆ BI_Polygon() [3/3]

BI_Polygon ( Board board,
const BoardPolygonData data 
)

◆ ~BI_Polygon()

~BI_Polygon ( )
noexcept

Member Function Documentation

◆ getData()

const BoardPolygonData & getData ( ) const
inlinenoexcept
+ Here is the caller graph for this function:

◆ setLayer()

bool setLayer ( const Layer layer)
noexcept
+ Here is the caller graph for this function:

◆ setLineWidth()

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

◆ setPath()

bool setPath ( const Path path)
noexcept
+ Here is the caller graph for this function:

◆ setIsFilled()

bool setIsFilled ( bool  isFilled)
noexcept
+ Here is the caller graph for this function:

◆ setIsGrabArea()

bool setIsGrabArea ( bool  isGrabArea)
noexcept
+ Here is the caller graph for this function:

◆ setLocked()

bool setLocked ( bool  locked)
noexcept
+ Here is the caller graph for this function:

◆ addToBoard()

void addToBoard ( )
overridevirtual

Reimplemented from BI_Base.

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

◆ removeFromBoard()

void removeFromBoard ( )
overridevirtual

Reimplemented from BI_Base.

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

◆ operator=()

BI_Polygon & operator= ( const BI_Polygon rhs)
delete

◆ invalidatePlanes()

void invalidatePlanes ( const Layer layer)
privatenoexcept
+ Here is the caller graph for this function:

Member Data Documentation

◆ onEdited

Signal<BI_Polygon, Event> onEdited

◆ mData

BoardPolygonData mData
private

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