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  ConnectStyle
 
- Public Types inherited from BI_Base
enum  Type_t
 

Public Member Functions

 BI_Plane ()=delete
 
 BI_Plane (const BI_Plane &other)=delete
 
 BI_Plane (Board &board, const BI_Plane &other)
 
 BI_Plane (Board &board, const SExpression &node)
 
 BI_Plane (Board &board, const Uuid &uuid, const GraphicsLayerName &layerName, NetSignal &netsignal, const Path &outline)
 
 ~BI_Plane () noexcept
 
const UuidgetUuid () const noexcept
 
const GraphicsLayerNamegetLayerName () const noexcept
 
NetSignalgetNetSignal () const noexcept
 
const UnsignedLengthgetMinWidth () const noexcept
 
const UnsignedLengthgetMinClearance () const noexcept
 
bool getKeepOrphans () const noexcept
 
int getPriority () const noexcept
 
ConnectStyle getConnectStyle () const noexcept
 
const PathgetOutline () const noexcept
 
const QVector< Path > & getFragments () const noexcept
 
BGI_PlanegetGraphicsItem () noexcept
 
bool isSelectable () const noexcept override
 
bool isVisible () const noexcept
 
void setOutline (const Path &outline) noexcept
 
void setLayerName (const GraphicsLayerName &layerName) noexcept
 
void setNetSignal (NetSignal &netsignal)
 
void setMinWidth (const UnsignedLength &minWidth) noexcept
 
void setMinClearance (const UnsignedLength &minClearance) noexcept
 
void setConnectStyle (ConnectStyle style) noexcept
 
void setPriority (int priority) noexcept
 
void setKeepOrphans (bool keepOrphans) noexcept
 
void setVisible (bool visible) noexcept
 
void addToBoard () override
 
void removeFromBoard () override
 
void clear () noexcept
 
void rebuild () noexcept
 
void serialize (SExpression &root) const override
 Serialize the object into an existing S-Expression node. More...
 
Type_t getType () const noexcept override
 
const PointgetPosition () const noexcept override
 
bool getIsMirrored () const noexcept override
 
QPainterPath getGrabAreaScenePx () const noexcept override
 
void setSelected (bool selected) noexcept override
 
BI_Planeoperator= (const BI_Plane &rhs)=delete
 
bool operator< (const BI_Plane &rhs) const noexcept
 
- 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 bool isSelected () const noexcept
 
BI_Baseoperator= (const BI_Base &rhs)=delete
 
- Public Member Functions inherited from SerializableObject
 SerializableObject () noexcept
 
virtual ~SerializableObject () noexcept
 
SExpression serializeToDomElement (const QString &name) const
 Serialize the object to a new S-Expression node. More...
 

Private Slots

void boardAttributesChanged ()
 

Private Member Functions

void init ()
 

Private Attributes

Uuid mUuid
 
GraphicsLayerName mLayerName
 
NetSignalmNetSignal
 
Path mOutline
 
UnsignedLength mMinWidth
 
UnsignedLength mMinClearance
 
bool mKeepOrphans
 
int mPriority
 
ConnectStyle mConnectStyle
 
QScopedPointer< BGI_PlanemGraphicsItem
 
bool mIsVisible
 
QVector< PathmFragments
 

Additional Inherited Members

- Static Public Member Functions inherited from SerializableObject
template<typename T >
static void serializeObjectContainer (SExpression &root, const T &container, const QString &itemName)
 
template<typename T >
static void serializePointerContainer (SExpression &root, const T &container, const QString &itemName)
 
template<typename T >
static void serializePointerContainerUuidSorted (SExpression &root, const T &container, const QString &itemName)
 
- Protected Member Functions inherited from BI_Base
void addToBoard (QGraphicsItem *item) noexcept
 
void removeFromBoard (QGraphicsItem *item) noexcept
 
- Protected Attributes inherited from BI_Base
BoardmBoard
 

Detailed Description

The BI_Plane class.

Member Enumeration Documentation

◆ ConnectStyle

enum ConnectStyle
strong
Enumerator
None 

do not connect pads/vias to plane

Solid 

completely connect pads/vias to plane

Constructor & Destructor Documentation

◆ BI_Plane() [1/5]

BI_Plane ( )
delete

◆ BI_Plane() [2/5]

BI_Plane ( const BI_Plane other)
delete

◆ BI_Plane() [3/5]

BI_Plane ( Board board,
const BI_Plane other 
)
+ Here is the call graph for this function:

◆ BI_Plane() [4/5]

BI_Plane ( Board board,
const SExpression node 
)
+ Here is the call graph for this function:

◆ BI_Plane() [5/5]

BI_Plane ( Board board,
const Uuid uuid,
const GraphicsLayerName layerName,
NetSignal netsignal,
const Path outline 
)
+ Here is the call graph for this function:

◆ ~BI_Plane()

~BI_Plane ( )
noexcept

Member Function Documentation

◆ getUuid()

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

◆ getLayerName()

const GraphicsLayerName& getLayerName ( ) 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:

◆ getKeepOrphans()

bool getKeepOrphans ( ) 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:

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

◆ getGraphicsItem()

BGI_Plane& getGraphicsItem ( )
inlinenoexcept
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ isSelectable()

bool isSelectable ( ) const
overridevirtualnoexcept

Implements BI_Base.

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

◆ setLayerName()

void setLayerName ( const GraphicsLayerName layerName)
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:

◆ setPriority()

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

◆ setKeepOrphans()

void setKeepOrphans ( bool  keepOrphans)
noexcept
+ Here is the caller graph for this function:

◆ setVisible()

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

◆ addToBoard()

void addToBoard ( )
overridevirtual

Implements BI_Base.

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

◆ removeFromBoard()

void removeFromBoard ( )
overridevirtual

Implements BI_Base.

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

◆ clear()

void clear ( )
noexcept
+ Here is the caller graph for this function:

◆ rebuild()

void rebuild ( )
noexcept
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ serialize()

void serialize ( SExpression root) const
overridevirtual

Serialize the object into an existing S-Expression node.

This method inserts/appends all attributes and childs of the object to an existing S-Expression node. The content which already exists in the given S-Expression node will not be removed.

Note
The generated S-Expression node has always the format of the application's major version (it's not possible to generate DOMs of older versions).
Parameters
rootThe target DOM root node
Exceptions
ExceptionThis method throws an exception if an error occurs.

Implements SerializableObject.

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

◆ getType()

Type_t getType ( ) const
inlineoverridevirtualnoexcept

Implements BI_Base.

◆ getPosition()

const Point& getPosition ( ) const
inlineoverridevirtualnoexcept

Implements BI_Base.

+ Here is the caller graph for this function:

◆ getIsMirrored()

bool getIsMirrored ( ) const
inlineoverridevirtualnoexcept

Implements BI_Base.

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

◆ getGrabAreaScenePx()

QPainterPath getGrabAreaScenePx ( ) const
overridevirtualnoexcept

Implements BI_Base.

+ Here is the caller graph for this function:

◆ setSelected()

void setSelected ( bool  selected)
overridevirtualnoexcept

Reimplemented from BI_Base.

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

◆ operator<()

bool operator< ( const BI_Plane rhs) const
noexcept
+ Here is the caller graph for this function:

◆ boardAttributesChanged

void boardAttributesChanged ( )
privateslot
+ Here is the caller graph for this function:

◆ init()

void init ( )
private
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Member Data Documentation

◆ mUuid

Uuid mUuid
private

◆ mLayerName

GraphicsLayerName mLayerName
private

◆ mNetSignal

NetSignal* mNetSignal
private

◆ mOutline

Path mOutline
private

◆ mMinWidth

UnsignedLength mMinWidth
private

◆ mMinClearance

UnsignedLength mMinClearance
private

◆ mKeepOrphans

bool mKeepOrphans
private

◆ mPriority

int mPriority
private

◆ mConnectStyle

ConnectStyle mConnectStyle
private

◆ mGraphicsItem

QScopedPointer<BGI_Plane> mGraphicsItem
private

◆ mIsVisible

bool mIsVisible
private

◆ mFragments

QVector<Path> mFragments
private

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