LibrePCB Developers Documentation
Polygon Class Referencefinal

The Polygon class. More...

#include <polygon.h>

+ Collaboration diagram for Polygon:

Public Types

enum  Event
 
typedef Slot< Polygon, EventOnEditedSlot
 

Public Member Functions

 Polygon ()=delete
 
 Polygon (const Polygon &other) noexcept
 
 Polygon (const Uuid &uuid, const Polygon &other) noexcept
 
 Polygon (const Uuid &uuid, const Layer &layer, const UnsignedLength &lineWidth, bool fill, bool isGrabArea, const Path &path) noexcept
 
 Polygon (const SExpression &node)
 
 ~Polygon () noexcept
 
const UuidgetUuid () const noexcept
 
const LayergetLayer () const noexcept
 
const UnsignedLengthgetLineWidth () const noexcept
 
bool isFilled () const noexcept
 
bool isGrabArea () const noexcept
 
const PathgetPath () const noexcept
 
Path getPathForRendering () const noexcept
 
bool setLayer (const Layer &layer) noexcept
 
bool setLineWidth (const UnsignedLength &width) noexcept
 
bool setIsFilled (bool isFilled) noexcept
 
bool setIsGrabArea (bool isGrabArea) noexcept
 
bool setPath (const Path &path) noexcept
 
void serialize (SExpression &root) const
 Serialize into librepcb::SExpression node. More...
 
bool operator== (const Polygon &rhs) const noexcept
 
bool operator!= (const Polygon &rhs) const noexcept
 
Polygonoperator= (const Polygon &rhs) noexcept
 

Public Attributes

Signal< Polygon, EventonEdited
 

Private Attributes

Uuid mUuid
 
const LayermLayer
 
UnsignedLength mLineWidth
 
bool mIsFilled
 
bool mIsGrabArea
 
Path mPath
 

Detailed Description

The Polygon class.

Member Typedef Documentation

◆ OnEditedSlot

Member Enumeration Documentation

◆ Event

enum Event
strong
Enumerator
UuidChanged 
LayerChanged 
LineWidthChanged 
IsFilledChanged 
IsGrabAreaChanged 
PathChanged 

Constructor & Destructor Documentation

◆ Polygon() [1/5]

Polygon ( )
delete

◆ Polygon() [2/5]

Polygon ( const Polygon other)
noexcept

◆ Polygon() [3/5]

Polygon ( const Uuid uuid,
const Polygon other 
)
noexcept

◆ Polygon() [4/5]

Polygon ( const Uuid uuid,
const Layer layer,
const UnsignedLength lineWidth,
bool  fill,
bool  isGrabArea,
const Path path 
)
noexcept

◆ Polygon() [5/5]

Polygon ( const SExpression node)
explicit

◆ ~Polygon()

~Polygon ( )
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:

◆ getLineWidth()

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

◆ isFilled()

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

◆ isGrabArea()

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

◆ getPath()

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

◆ getPathForRendering()

Path getPathForRendering ( ) const
noexcept
+ Here is the call graph for this function:
+ 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:

◆ setIsFilled()

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

◆ setIsGrabArea()

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

◆ setPath()

bool setPath ( const Path path)
noexcept
+ 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==()

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

◆ operator!=()

bool operator!= ( const Polygon rhs) const
inlinenoexcept
+ Here is the call graph for this function:

◆ operator=()

Polygon & operator= ( const Polygon rhs)
noexcept
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Member Data Documentation

◆ onEdited

Signal<Polygon, Event> onEdited

◆ mUuid

Uuid mUuid
private

◆ mLayer

const Layer* mLayer
private

◆ mLineWidth

UnsignedLength mLineWidth
private

◆ mIsFilled

bool mIsFilled
private

◆ mIsGrabArea

bool mIsGrabArea
private

◆ mPath

Path mPath
private

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