KiCad PCB EDA Suite
Public Member Functions | Private Attributes | List of all members
PL_EDITOR_LAYOUT Class Reference

#include <pl_editor_layout.h>

Public Member Functions

 PL_EDITOR_LAYOUT ()
 
 ~PL_EDITOR_LAYOUT ()
 
PAGE_INFO & GetPageSettings ()
 
const PAGE_INFO & GetPageSettings () const
 
void SetPageSettings (const PAGE_INFO &aPageSettings)
 
const wxPoint & GetAuxOrigin () const
 
TITLE_BLOCK & GetTitleBlock ()
 
const TITLE_BLOCK & GetTitleBlock () const
 
void SetTitleBlock (const TITLE_BLOCK &aTitleBlock)
 
DS_DRAW_ITEM_LIST & GetDrawItems ()
 
BOX2I ComputeBoundingBox ()
 Calculate the bounding box containing all Gerber items. More...
 
const BOX2I GetBoundingBox () const
 Called soon after ComputeBoundingBox() to return the same BOX2I, as long as the CLASS_PL_EDITOR_LAYOUT has not changed. More...
 
void SetBoundingBox (const BOX2I &aBox)
 

Private Attributes

BOX2I m_boundingBox
 
PAGE_INFO m_paper
 
TITLE_BLOCK m_titles
 
DS_DRAW_ITEM_LIST m_drawItemList
 

Detailed Description

Definition at line 34 of file pl_editor_layout.h.

Constructor & Destructor Documentation

◆ PL_EDITOR_LAYOUT()

PL_EDITOR_LAYOUT::PL_EDITOR_LAYOUT ( )

Definition at line 29 of file pl_editor_layout.cpp.

30{
31 PAGE_INFO pageInfo( wxT( "A4" ) );
32 SetPageSettings( pageInfo );
33}
PAGE_INFO
Describe the page size and margins of a paper page on which to eventually print or plot.
Definition: page_info.h:54
PL_EDITOR_LAYOUT::SetPageSettings
void SetPageSettings(const PAGE_INFO &aPageSettings)
Definition: pl_editor_layout.h:42

References SetPageSettings().

◆ ~PL_EDITOR_LAYOUT()

PL_EDITOR_LAYOUT::~PL_EDITOR_LAYOUT ( )

Definition at line 36 of file pl_editor_layout.cpp.

37{
38}

Member Function Documentation

◆ ComputeBoundingBox()

BOX2I PL_EDITOR_LAYOUT::ComputeBoundingBox ( )

Calculate the bounding box containing all Gerber items.

Returns
the full item list bounding box.

Definition at line 41 of file pl_editor_layout.cpp.

42{
43 BOX2I bbox;
44
45 SetBoundingBox( bbox );
46 return bbox;
47}
PL_EDITOR_LAYOUT::SetBoundingBox
void SetBoundingBox(const BOX2I &aBox)
Definition: pl_editor_layout.h:72

References SetBoundingBox().

◆ GetAuxOrigin()

const wxPoint & PL_EDITOR_LAYOUT::GetAuxOrigin ( ) const
inline

Definition at line 44 of file pl_editor_layout.h.

45 {
46 static wxPoint zero( 0, 0 );
47 return zero;
48 }

◆ GetBoundingBox()

const BOX2I PL_EDITOR_LAYOUT::GetBoundingBox ( ) const
inline

Called soon after ComputeBoundingBox() to return the same BOX2I, as long as the CLASS_PL_EDITOR_LAYOUT has not changed.

Definition at line 70 of file pl_editor_layout.h.

70{ return m_boundingBox; }
PL_EDITOR_LAYOUT::m_boundingBox
BOX2I m_boundingBox
Definition: pl_editor_layout.h:79

References m_boundingBox.

◆ GetDrawItems()

DS_DRAW_ITEM_LIST & PL_EDITOR_LAYOUT::GetDrawItems ( )
inline

Definition at line 54 of file pl_editor_layout.h.

55 {
56 return m_drawItemList;
57 }
PL_EDITOR_LAYOUT::m_drawItemList
DS_DRAW_ITEM_LIST m_drawItemList
Definition: pl_editor_layout.h:83

References m_drawItemList.

◆ GetPageSettings() [1/2]

PAGE_INFO & PL_EDITOR_LAYOUT::GetPageSettings ( )
inline

Definition at line 40 of file pl_editor_layout.h.

40{ return m_paper; }
PL_EDITOR_LAYOUT::m_paper
PAGE_INFO m_paper
Definition: pl_editor_layout.h:80

References m_paper.

Referenced by PL_EDITOR_FRAME::GetPageSettings(), PL_EDITOR_FRAME::GetPageSizeIU(), and DIALOG_INSPECTOR::ReCreateDesignList().

◆ GetPageSettings() [2/2]

const PAGE_INFO & PL_EDITOR_LAYOUT::GetPageSettings ( ) const
inline

Definition at line 41 of file pl_editor_layout.h.

41{ return m_paper; }

References m_paper.

◆ GetTitleBlock() [1/2]

TITLE_BLOCK & PL_EDITOR_LAYOUT::GetTitleBlock ( )
inline

Definition at line 50 of file pl_editor_layout.h.

50{ return m_titles; }
PL_EDITOR_LAYOUT::m_titles
TITLE_BLOCK m_titles
Definition: pl_editor_layout.h:81

References m_titles.

Referenced by PL_EDITOR_FRAME::GetTitleBlock().

◆ GetTitleBlock() [2/2]

const TITLE_BLOCK & PL_EDITOR_LAYOUT::GetTitleBlock ( ) const
inline

Definition at line 51 of file pl_editor_layout.h.

51{ return m_titles; }

References m_titles.

◆ SetBoundingBox()

void PL_EDITOR_LAYOUT::SetBoundingBox ( const BOX2I &  aBox)
inline

Definition at line 72 of file pl_editor_layout.h.

72{ m_boundingBox = aBox; }

References m_boundingBox.

Referenced by ComputeBoundingBox().

◆ SetPageSettings()

void PL_EDITOR_LAYOUT::SetPageSettings ( const PAGE_INFO &  aPageSettings)
inline

Definition at line 42 of file pl_editor_layout.h.

42{ m_paper = aPageSettings; }

References m_paper.

Referenced by PL_EDITOR_LAYOUT(), and PL_EDITOR_FRAME::SetPageSettings().

◆ SetTitleBlock()

void PL_EDITOR_LAYOUT::SetTitleBlock ( const TITLE_BLOCK &  aTitleBlock)
inline

Definition at line 52 of file pl_editor_layout.h.

52{ m_titles = aTitleBlock; }

References m_titles.

Referenced by PL_EDITOR_FRAME::SetTitleBlock().

Member Data Documentation

◆ m_boundingBox

BOX2I PL_EDITOR_LAYOUT::m_boundingBox
private

Definition at line 79 of file pl_editor_layout.h.

Referenced by GetBoundingBox(), and SetBoundingBox().

◆ m_drawItemList

DS_DRAW_ITEM_LIST PL_EDITOR_LAYOUT::m_drawItemList
private

Definition at line 83 of file pl_editor_layout.h.

Referenced by GetDrawItems().

◆ m_paper

PAGE_INFO PL_EDITOR_LAYOUT::m_paper
private

Definition at line 80 of file pl_editor_layout.h.

Referenced by GetPageSettings(), and SetPageSettings().

◆ m_titles

TITLE_BLOCK PL_EDITOR_LAYOUT::m_titles
private

Definition at line 81 of file pl_editor_layout.h.

Referenced by GetTitleBlock(), and SetTitleBlock().

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