KiCad PCB EDA Suite
Loading...
Searching...
No Matches
pl_editor_layout.h
Go to the documentation of this file.
1
/*
2
* This program source code file is part of KiCad, a free EDA CAD application.
3
*
4
* Copyright (C) 2013 CERN
5
* Copyright The KiCad Developers, see AUTHORS.txt for contributors.
6
* @author Jean-Pierre Charras, jp.charras at wanadoo.fr
7
*
8
* This program is free software; you can redistribute it and/or
9
* modify it under the terms of the GNU General Public License
10
* as published by the Free Software Foundation; either version 2
11
* of the License, or (at your option) any later version.
12
*
13
* This program is distributed in the hope that it will be useful,
14
* but WITHOUT ANY WARRANTY; without even the implied warranty of
15
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16
* GNU General Public License for more details.
17
*
18
* You should have received a copy of the GNU General Public License
19
* along with this program. If not, see <https://www.gnu.org/licenses/>.
20
*/
21
22
#ifndef CLASS_PL_EDITOR_LAYOUT_H
23
#define CLASS_PL_EDITOR_LAYOUT_H
24
25
#include <
page_info.h
>
26
#include <
title_block.h
>
27
#include <
drawing_sheet/ds_draw_item.h
>
28
29
30
class
PL_EDITOR_LAYOUT
31
{
32
public
:
33
PL_EDITOR_LAYOUT
();
34
~PL_EDITOR_LAYOUT
();
35
36
PAGE_INFO
&
GetPageSettings
() {
return
m_paper
; }
37
const
PAGE_INFO
&
GetPageSettings
()
const
{
return
m_paper
; }
38
void
SetPageSettings
(
const
PAGE_INFO
& aPageSettings ) {
m_paper
= aPageSettings; }
39
40
const
wxPoint&
GetAuxOrigin
()
const
41
{
42
static
wxPoint zero( 0, 0 );
43
return
zero;
44
}
45
46
TITLE_BLOCK
&
GetTitleBlock
() {
return
m_titles
; }
47
const
TITLE_BLOCK
&
GetTitleBlock
()
const
{
return
m_titles
; }
48
void
SetTitleBlock
(
const
TITLE_BLOCK
& aTitleBlock ) {
m_titles
= aTitleBlock; }
49
50
DS_DRAW_ITEM_LIST
&
GetDrawItems
()
51
{
52
return
m_drawItemList
;
53
}
54
60
BOX2I
ComputeBoundingBox
();
61
66
const
BOX2I
GetBoundingBox
()
const
{
return
m_boundingBox
; }
67
68
void
SetBoundingBox
(
const
BOX2I
& aBox ) {
m_boundingBox
= aBox; }
69
70
#if defined(DEBUG)
71
void
Show(
int
nestLevel, std::ostream& os )
const
;
72
#endif
73
74
private
:
75
BOX2I
m_boundingBox
;
76
PAGE_INFO
m_paper
;
77
TITLE_BLOCK
m_titles
;
78
79
DS_DRAW_ITEM_LIST
m_drawItemList
;
80
};
81
82
#endif
// #ifndef CLASS_PL_EDITOR_LAYOUT_H
BOX2I
BOX2< VECTOR2I > BOX2I
Definition
box2.h:918
DS_DRAW_ITEM_LIST
Store the list of graphic items: rect, lines, polygons and texts to draw/plot the title block and fra...
Definition
ds_draw_item.h:397
PAGE_INFO
Describe the page size and margins of a paper page on which to eventually print or plot.
Definition
page_info.h:75
PL_EDITOR_LAYOUT::SetPageSettings
void SetPageSettings(const PAGE_INFO &aPageSettings)
Definition
pl_editor_layout.h:38
PL_EDITOR_LAYOUT::m_boundingBox
BOX2I m_boundingBox
Definition
pl_editor_layout.h:75
PL_EDITOR_LAYOUT::m_titles
TITLE_BLOCK m_titles
Definition
pl_editor_layout.h:77
PL_EDITOR_LAYOUT::GetTitleBlock
const TITLE_BLOCK & GetTitleBlock() const
Definition
pl_editor_layout.h:47
PL_EDITOR_LAYOUT::GetTitleBlock
TITLE_BLOCK & GetTitleBlock()
Definition
pl_editor_layout.h:46
PL_EDITOR_LAYOUT::PL_EDITOR_LAYOUT
PL_EDITOR_LAYOUT()
Definition
pl_editor_layout.cpp:25
PL_EDITOR_LAYOUT::GetAuxOrigin
const wxPoint & GetAuxOrigin() const
Definition
pl_editor_layout.h:40
PL_EDITOR_LAYOUT::GetPageSettings
PAGE_INFO & GetPageSettings()
Definition
pl_editor_layout.h:36
PL_EDITOR_LAYOUT::GetDrawItems
DS_DRAW_ITEM_LIST & GetDrawItems()
Definition
pl_editor_layout.h:50
PL_EDITOR_LAYOUT::GetPageSettings
const PAGE_INFO & GetPageSettings() const
Definition
pl_editor_layout.h:37
PL_EDITOR_LAYOUT::SetTitleBlock
void SetTitleBlock(const TITLE_BLOCK &aTitleBlock)
Definition
pl_editor_layout.h:48
PL_EDITOR_LAYOUT::GetBoundingBox
const BOX2I GetBoundingBox() const
Called soon after ComputeBoundingBox() to return the same BOX2I, as long as the CLASS_PL_EDITOR_LAYOU...
Definition
pl_editor_layout.h:66
PL_EDITOR_LAYOUT::m_paper
PAGE_INFO m_paper
Definition
pl_editor_layout.h:76
PL_EDITOR_LAYOUT::ComputeBoundingBox
BOX2I ComputeBoundingBox()
Calculate the bounding box containing all Gerber items.
Definition
pl_editor_layout.cpp:38
PL_EDITOR_LAYOUT::SetBoundingBox
void SetBoundingBox(const BOX2I &aBox)
Definition
pl_editor_layout.h:68
PL_EDITOR_LAYOUT::~PL_EDITOR_LAYOUT
~PL_EDITOR_LAYOUT()
Definition
pl_editor_layout.cpp:33
PL_EDITOR_LAYOUT::m_drawItemList
DS_DRAW_ITEM_LIST m_drawItemList
Definition
pl_editor_layout.h:79
TITLE_BLOCK
Hold the information shown in the lower right corner of a plot, printout, or editing view.
Definition
title_block.h:37
ds_draw_item.h
page_info.h
title_block.h
src
pagelayout_editor
pl_editor_layout.h
Generated on Fri Jun 26 2026 00:05:38 for KiCad PCB EDA Suite by
1.13.2