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 (C) 2021-2022 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, you may find one here:
20
* http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
21
* or you may search the http://www.gnu.org website for the version 2 license,
22
* or you may write to the Free Software Foundation, Inc.,
23
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
24
*/
25
26
#ifndef CLASS_PL_EDITOR_LAYOUT_H
27
#define CLASS_PL_EDITOR_LAYOUT_H
28
29
#include <
page_info.h
>
30
#include <
title_block.h
>
31
#include <
drawing_sheet/ds_draw_item.h
>
32
33
34
class
PL_EDITOR_LAYOUT
35
{
36
public
:
37
PL_EDITOR_LAYOUT
();
38
~PL_EDITOR_LAYOUT
();
39
40
PAGE_INFO
&
GetPageSettings
() {
return
m_paper
; }
41
const
PAGE_INFO
&
GetPageSettings
()
const
{
return
m_paper
; }
42
void
SetPageSettings
(
const
PAGE_INFO
& aPageSettings ) {
m_paper
= aPageSettings; }
43
44
const
wxPoint&
GetAuxOrigin
()
const
45
{
46
static
wxPoint zero( 0, 0 );
47
return
zero;
48
}
49
50
TITLE_BLOCK
&
GetTitleBlock
() {
return
m_titles
; }
51
const
TITLE_BLOCK
&
GetTitleBlock
()
const
{
return
m_titles
; }
52
void
SetTitleBlock
(
const
TITLE_BLOCK
& aTitleBlock ) {
m_titles
= aTitleBlock; }
53
54
DS_DRAW_ITEM_LIST
&
GetDrawItems
()
55
{
56
return
m_drawItemList
;
57
}
58
64
BOX2I
ComputeBoundingBox
();
65
70
const
BOX2I
GetBoundingBox
()
const
{
return
m_boundingBox
; }
71
72
void
SetBoundingBox
(
const
BOX2I
& aBox ) {
m_boundingBox
= aBox; }
73
74
#if defined(DEBUG)
75
void
Show(
int
nestLevel, std::ostream& os )
const
;
76
#endif
77
78
private
:
79
BOX2I
m_boundingBox
;
80
PAGE_INFO
m_paper
;
81
TITLE_BLOCK
m_titles
;
82
83
DS_DRAW_ITEM_LIST
m_drawItemList
;
84
};
85
86
#endif
// #ifndef CLASS_PL_EDITOR_LAYOUT_H
BOX2< VECTOR2I >
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:401
PAGE_INFO
Describe the page size and margins of a paper page on which to eventually print or plot.
Definition:
page_info.h:59
PL_EDITOR_LAYOUT
Definition:
pl_editor_layout.h:35
PL_EDITOR_LAYOUT::SetPageSettings
void SetPageSettings(const PAGE_INFO &aPageSettings)
Definition:
pl_editor_layout.h:42
PL_EDITOR_LAYOUT::m_boundingBox
BOX2I m_boundingBox
Definition:
pl_editor_layout.h:79
PL_EDITOR_LAYOUT::m_titles
TITLE_BLOCK m_titles
Definition:
pl_editor_layout.h:81
PL_EDITOR_LAYOUT::GetTitleBlock
const TITLE_BLOCK & GetTitleBlock() const
Definition:
pl_editor_layout.h:51
PL_EDITOR_LAYOUT::GetTitleBlock
TITLE_BLOCK & GetTitleBlock()
Definition:
pl_editor_layout.h:50
PL_EDITOR_LAYOUT::PL_EDITOR_LAYOUT
PL_EDITOR_LAYOUT()
Definition:
pl_editor_layout.cpp:29
PL_EDITOR_LAYOUT::GetAuxOrigin
const wxPoint & GetAuxOrigin() const
Definition:
pl_editor_layout.h:44
PL_EDITOR_LAYOUT::GetPageSettings
PAGE_INFO & GetPageSettings()
Definition:
pl_editor_layout.h:40
PL_EDITOR_LAYOUT::GetDrawItems
DS_DRAW_ITEM_LIST & GetDrawItems()
Definition:
pl_editor_layout.h:54
PL_EDITOR_LAYOUT::GetPageSettings
const PAGE_INFO & GetPageSettings() const
Definition:
pl_editor_layout.h:41
PL_EDITOR_LAYOUT::SetTitleBlock
void SetTitleBlock(const TITLE_BLOCK &aTitleBlock)
Definition:
pl_editor_layout.h:52
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:70
PL_EDITOR_LAYOUT::m_paper
PAGE_INFO m_paper
Definition:
pl_editor_layout.h:80
PL_EDITOR_LAYOUT::ComputeBoundingBox
BOX2I ComputeBoundingBox()
Calculate the bounding box containing all Gerber items.
Definition:
pl_editor_layout.cpp:42
PL_EDITOR_LAYOUT::SetBoundingBox
void SetBoundingBox(const BOX2I &aBox)
Definition:
pl_editor_layout.h:72
PL_EDITOR_LAYOUT::~PL_EDITOR_LAYOUT
~PL_EDITOR_LAYOUT()
Definition:
pl_editor_layout.cpp:37
PL_EDITOR_LAYOUT::m_drawItemList
DS_DRAW_ITEM_LIST m_drawItemList
Definition:
pl_editor_layout.h:83
TITLE_BLOCK
Hold the information shown in the lower right corner of a plot, printout, or editing view.
Definition:
title_block.h:41
ds_draw_item.h
page_info.h
title_block.h
src
pagelayout_editor
pl_editor_layout.h
Generated on Sun Dec 22 2024 00:05:25 for KiCad PCB EDA Suite by
1.9.6