LibrePCB Developers Documentation
BI_Plane Class Referencefinal

The BI_Plane class. More...

#include <bi_plane.h>

+ Inheritance diagram for BI_Plane:
+ Collaboration diagram for BI_Plane:

Public Types

enum  Event
 
enum  ConnectStyle
 
typedef Slot< BI_Plane, EventOnEditedSlot
 

Public Member Functions

 BI_Plane ()=delete
 
 BI_Plane (const BI_Plane &other)=delete
 
 BI_Plane (Board &board, const Uuid &uuid, const Layer &layer, NetSignal *netsignal, const Path &outline)
 
 ~BI_Plane () noexcept
 
const UuidgetUuid () const noexcept
 
const LayergetLayer () const noexcept
 
NetSignalgetNetSignal () const noexcept
 
const UnsignedLengthgetMinWidth () const noexcept
 
const UnsignedLengthgetMinClearance () const noexcept
 
bool getKeepIslands () const noexcept
 
int getPriority () const noexcept
 
ConnectStyle getConnectStyle () const noexcept
 
const PositiveLengthgetThermalGap () const noexcept
 
const PositiveLengthgetThermalSpokeWidth () const noexcept
 
const PathgetOutline () const noexcept
 
const QVector< Path > & getFragments () const noexcept
 
bool isLocked () const noexcept
 
bool isVisible () const noexcept
 
void setOutline (const Path &outline) noexcept
 
void setLayer (const Layer &layer) noexcept
 
void setNetSignal (NetSignal *netsignal)
 
void setMinWidth (const UnsignedLength &minWidth) noexcept
 
void setMinClearance (const UnsignedLength &minClearance) noexcept
 
void setConnectStyle (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
 
void setVisible (bool visible) noexcept
 
void setCalculatedFragments (const QVector< Path > &fragments) noexcept
 
void addToBoard () override
 
void removeFromBoard () override
 
void serialize (SExpression &root) const
 Serialize into librepcb::SExpression node. More...
 
BI_Planeoperator= (const BI_Plane &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
 
BI_Baseoperator= (const BI_Base &rhs)=delete
 

Public Attributes

Signal< BI_Plane, EventonEdited
 

Private Attributes

Uuid mUuid
 
const LayermLayer
 Mandatory (never nullptr) More...
 
NetSignalmNetSignal
 Optional (nullptr = no net) More...
 
Path mOutline
 
UnsignedLength mMinWidth
 
UnsignedLength mMinClearance
 
bool mKeepIslands
 
int mPriority
 
ConnectStyle mConnectStyle
 
PositiveLength mThermalGap
 
PositiveLength mThermalSpokeWidth
 
bool mLocked
 
bool mIsVisible
 
QVector< PathmFragments
 

Additional Inherited Members

- Protected Attributes inherited from BI_Base
BoardmBoard
 

Detailed Description

The BI_Plane class.

Member Typedef Documentation

◆ OnEditedSlot

Member Enumeration Documentation

◆ Event

enum Event
strong
Enumerator
OutlineChanged 
LayerChanged 
IsLockedChanged 
VisibilityChanged 
FragmentsChanged 

◆ ConnectStyle

enum ConnectStyle
strong
Enumerator
None 

Do not connect pads to plane.

ThermalRelief 

Add thermal spokes to connect pads to plane.

Solid 

Completely connect pads to plane.

Constructor & Destructor Documentation

◆ BI_Plane() [1/3]

BI_Plane ( )
delete

◆ BI_Plane() [2/3]

BI_Plane ( const BI_Plane other)
delete

◆ BI_Plane() [3/3]

BI_Plane ( Board board,
const Uuid uuid,
const Layer layer,
NetSignal netsignal,
const Path outline 
)

◆ ~BI_Plane()

~BI_Plane ( )
noexcept

Member Function Documentation

◆ getUuid()

const Uuid& getUuid ( ) const
inlinenoexcept
+ Here is the caller graph for this function:

◆ getLayer()

const Layer& getLayer ( ) const
inlinenoexcept
+ Here is the caller graph for this function:

◆ getNetSignal()

NetSignal* getNetSignal ( ) const
inlinenoexcept
+ Here is the caller graph for this function:

◆ getMinWidth()

const UnsignedLength& getMinWidth ( ) const
inlinenoexcept
+ Here is the caller graph for this function:

◆ getMinClearance()

const UnsignedLength& getMinClearance ( ) const
inlinenoexcept
+ Here is the caller graph for this function:

◆ getKeepIslands()

bool getKeepIslands ( ) const
inlinenoexcept
+ Here is the caller graph for this function:

◆ getPriority()

int getPriority ( ) const
inlinenoexcept
+ Here is the caller graph for this function:

◆ getConnectStyle()

ConnectStyle getConnectStyle ( ) const
inlinenoexcept
+ Here is the caller graph for this function:

◆ getThermalGap()

const PositiveLength& getThermalGap ( ) const
inlinenoexcept
+ Here is the caller graph for this function:

◆ getThermalSpokeWidth()

const PositiveLength& getThermalSpokeWidth ( ) const
inlinenoexcept
+ Here is the caller graph for this function:

◆ getOutline()

const Path& getOutline ( ) const
inlinenoexcept
+ Here is the caller graph for this function:

◆ getFragments()

const QVector<Path>& getFragments ( ) const
inlinenoexcept
+ Here is the caller graph for this function:

◆ isLocked()

bool isLocked ( ) const
inlinenoexcept
+ Here is the caller graph for this function:

◆ isVisible()

bool isVisible ( ) const
inlinenoexcept
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setOutline()

void setOutline ( const Path outline)
noexcept
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setLayer()

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

◆ setNetSignal()

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

◆ setMinWidth()

void setMinWidth ( const UnsignedLength minWidth)
noexcept
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setMinClearance()

void setMinClearance ( const UnsignedLength minClearance)
noexcept
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setConnectStyle()

void setConnectStyle ( BI_Plane::ConnectStyle  style)
noexcept
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setThermalGap()

void setThermalGap ( const PositiveLength gap)
noexcept
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setThermalSpokeWidth()

void setThermalSpokeWidth ( const PositiveLength width)
noexcept
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setPriority()

void setPriority ( int  priority)
noexcept
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setKeepIslands()

void setKeepIslands ( bool  keep)
noexcept
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setLocked()

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

◆ setVisible()

void setVisible ( bool  visible)
noexcept
+ Here is the caller graph for this function:

◆ setCalculatedFragments()

void setCalculatedFragments ( const QVector< Path > &  fragments)
noexcept
+ Here is the call graph for this function:
+ 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:

◆ serialize()

void serialize ( SExpression root) const

Serialize into librepcb::SExpression node.

Parameters
rootRoot node to serialize into.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ operator=()

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

Member Data Documentation

◆ onEdited

Signal<BI_Plane, Event> onEdited

◆ mUuid

Uuid mUuid
private

◆ mLayer

const Layer* mLayer
private

Mandatory (never nullptr)

◆ mNetSignal

NetSignal* mNetSignal
private

Optional (nullptr = no net)

◆ mOutline

Path mOutline
private

◆ mMinWidth

UnsignedLength mMinWidth
private

◆ mMinClearance

UnsignedLength mMinClearance
private

◆ mKeepIslands

bool mKeepIslands
private

◆ mPriority

int mPriority
private

◆ mConnectStyle

ConnectStyle mConnectStyle
private

◆ mThermalGap

PositiveLength mThermalGap
private

◆ mThermalSpokeWidth

PositiveLength mThermalSpokeWidth
private

◆ mLocked

bool mLocked
private

◆ mIsVisible

bool mIsVisible
private

◆ mFragments

QVector<Path> mFragments
private

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