BI_Plane Class Reference

The BI_Plane class. More...

#include <bi_plane.h>

Inheritance diagram for BI_Plane:

Collaboration diagram for BI_Plane:

Public Types
enum class	Event
enum class	ConnectStyle
typedef Slot< BI_Plane, Event >	OnEditedSlot

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 Uuid &	getUuid () const noexcept
const Layer &	getLayer () const noexcept
NetSignal *	getNetSignal () const noexcept
const UnsignedLength &	getMinWidth () const noexcept
const UnsignedLength &	getMinClearance () const noexcept
bool	getKeepIslands () const noexcept
int	getPriority () const noexcept
ConnectStyle	getConnectStyle () const noexcept
const PositiveLength &	getThermalGap () const noexcept
const PositiveLength &	getThermalSpokeWidth () const noexcept
const Path &	getOutline () 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.
BI_Plane &	operator= (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
Project &	getProject () const noexcept
Circuit &	getCircuit () const noexcept
Board &	getBoard () const noexcept
virtual bool	isAddedToBoard () const noexcept
BI_Base &	operator= (const BI_Base &rhs)=delete

Public Attributes
Signal< BI_Plane, Event >	onEdited

Private Attributes
Uuid	mUuid
const Layer *	mLayer
	Mandatory (never nullptr)
NetSignal *	mNetSignal
	Optional (nullptr = no net)
Path	mOutline
UnsignedLength	mMinWidth
UnsignedLength	mMinClearance
bool	mKeepIslands
int	mPriority
ConnectStyle	mConnectStyle
PositiveLength	mThermalGap
PositiveLength	mThermalSpokeWidth
bool	mLocked
bool	mIsVisible
QVector< Path >	mFragments

Additional Inherited Members
Protected Attributes inherited from BI_Base
Board &	mBoard

Detailed Description

The BI_Plane class.

Member Typedef Documentation

OnEditedSlot

typedef Slot<BI_Plane, Event> OnEditedSlot

Member Enumeration Documentation

Event

enum class Event

strong

Enumerator
OutlineChanged
LayerChanged
IsLockedChanged
VisibilityChanged
FragmentsChanged

ConnectStyle

enum class 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 caller graph for this function:

setOutline()

void setOutline ( const Path &  outline )

noexcept

Here is the caller graph for this function:

setLayer()

void setLayer ( const Layer &  layer )

noexcept

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 caller graph for this function:

setMinClearance()

void setMinClearance ( const UnsignedLength &  minClearance )

noexcept

Here is the caller graph for this function:

setConnectStyle()

void setConnectStyle ( BI_Plane::ConnectStyle  style )

noexcept

Here is the caller graph for this function:

setThermalGap()

void setThermalGap ( const PositiveLength &  gap )

noexcept

Here is the caller graph for this function:

setThermalSpokeWidth()

void setThermalSpokeWidth ( const PositiveLength &  width )

noexcept

Here is the caller graph for this function:

setPriority()

void setPriority ( int  priority )

noexcept

Here is the caller graph for this function:

setKeepIslands()

void setKeepIslands ( bool  keep )

noexcept

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

root	Root node to serialize into.

Here is the call graph for this function:

operator=()

BI_Plane & operator= ( const BI_Plane &  rhs )

delete

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:

• /__w/1/s/libs/librepcb/core/project/board/items/bi_plane.h
• /__w/1/s/libs/librepcb/core/project/board/items/bi_plane.cpp