LibrePCB Developers Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
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
 
bool isSelectable () const noexceptoverride
 
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 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 noexceptoverride
 
const PointgetPosition () const noexceptoverride
 
bool getIsMirrored () const noexceptoverride
 
QPainterPath getGrabAreaScenePx () const noexceptoverride
 
void setSelected (bool selected) noexceptoverride
 
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
 
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.

Author
ubruhin
Date
2017-11-19

Member Enumeration Documentation

enum ConnectStyle
strong
Enumerator
None 

do not connect pads/vias to plane

Solid 

completely connect pads/vias to plane

Constructor & Destructor Documentation

BI_Plane ( )
delete
BI_Plane ( const BI_Plane other)
delete
BI_Plane ( Board board,
const BI_Plane other 
)

+ Here is the call graph for this function:

BI_Plane ( Board board,
const SExpression node 
)

+ Here is the call graph for this function:

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 ( )
noexcept

Member Function Documentation

const Uuid& getUuid ( ) const
inlinenoexcept
const GraphicsLayerName& getLayerName ( ) const
inlinenoexcept

+ Here is the caller graph for this function:

NetSignal& getNetSignal ( ) const
inlinenoexcept

+ Here is the caller graph for this function:

const UnsignedLength& getMinWidth ( ) const
inlinenoexcept

+ Here is the caller graph for this function:

const UnsignedLength& getMinClearance ( ) const
inlinenoexcept

+ Here is the caller graph for this function:

bool getKeepOrphans ( ) const
inlinenoexcept

+ Here is the caller graph for this function:

int getPriority ( ) const
inlinenoexcept
ConnectStyle getConnectStyle ( ) const
inlinenoexcept
const Path& getOutline ( ) const
inlinenoexcept

+ Here is the caller graph for this function:

const QVector<Path>& getFragments ( ) const
inlinenoexcept

+ Here is the caller graph for this function:

bool isSelectable ( ) const
overridevirtualnoexcept

Implements BI_Base.

+ Here is the caller graph for this function:

void setOutline ( const Path outline)
noexcept

+ Here is the caller graph for this function:

void setLayerName ( const GraphicsLayerName layerName)
noexcept

+ Here is the caller graph for this function:

void setNetSignal ( NetSignal netsignal)

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void setMinWidth ( const UnsignedLength minWidth)
noexcept

+ Here is the caller graph for this function:

void setMinClearance ( const UnsignedLength minClearance)
noexcept

+ Here is the caller graph for this function:

void setConnectStyle ( BI_Plane::ConnectStyle  style)
noexcept

+ Here is the caller graph for this function:

void setPriority ( int  priority)
noexcept

+ Here is the caller graph for this function:

void setKeepOrphans ( bool  keepOrphans)
noexcept

+ Here is the caller graph for this function:

void addToBoard ( )
overridevirtual

Implements BI_Base.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void removeFromBoard ( )
overridevirtual

Implements BI_Base.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void clear ( )
noexcept
void rebuild ( )
noexcept

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

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:

Type_t getType ( ) const
inlineoverridevirtualnoexcept

Implements BI_Base.

const Point& getPosition ( ) const
inlineoverridevirtualnoexcept

Implements BI_Base.

+ Here is the caller graph for this function:

bool getIsMirrored ( ) const
inlineoverridevirtualnoexcept

Implements BI_Base.

QPainterPath getGrabAreaScenePx ( ) const
overridevirtualnoexcept

Implements BI_Base.

+ Here is the caller graph for this function:

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:

BI_Plane& operator= ( const BI_Plane rhs)
delete
bool operator< ( const BI_Plane rhs) const
noexcept
void boardAttributesChanged ( )
privateslot

+ Here is the caller graph for this function:

void init ( )
private

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

Member Data Documentation

Uuid mUuid
private
GraphicsLayerName mLayerName
private
NetSignal* mNetSignal
private
Path mOutline
private
UnsignedLength mMinWidth
private
UnsignedLength mMinClearance
private
bool mKeepOrphans
private
int mPriority
private
ConnectStyle mConnectStyle
private
QScopedPointer<BGI_Plane> mGraphicsItem
private
QVector<Path> mFragments
private

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