KiCad PCB EDA Suite
Loading...
Searching...
No Matches
job_pcb_render.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) 2022 Mark Roszko <[email protected]>
5 * Copyright (C) 2024 Alex Shvartzkop <[email protected]>
6 * Copyright (C) 1992-2024 KiCad Developers, see AUTHORS.txt for contributors.
7 *
8 * This program is free software: you can redistribute it and/or modify it
9 * under the terms of the GNU General Public License as published by the
10 * Free Software Foundation, either version 3 of the License, or (at your
11 * option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful, but
14 * WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License along
19 * with this program. If not, see <http://www.gnu.org/licenses/>.
20 */
21
22#ifndef JOB_PCB_RENDER_H
23#define JOB_PCB_RENDER_H
24
25#include <kicommon.h>
26#include <wx/string.h>
27#include "job.h"
28#include <optional>
29#include <math/vector3.h>
30
32{
33public:
34 JOB_PCB_RENDER( bool aIsCli );
35
36 wxString m_filename;
37 wxString m_outputFile;
38
39 enum class FORMAT
40 {
41 PNG,
42 JPEG
43 };
44
45 enum class QUALITY
46 {
47 BASIC,
48 HIGH,
49 USER
50 };
51
52 enum class BG_STYLE
53 {
54 DEFAULT,
55 TRANSPARENT,
56 OPAQUE
57 };
58
59 enum class SIDE
60 {
61 TOP,
62 BOTTOM,
63 LEFT,
64 RIGHT,
65 FRONT,
66 BACK
67 };
68
69 FORMAT m_format = FORMAT::PNG;
70 QUALITY m_quality = QUALITY::BASIC;
71 BG_STYLE m_bgStyle = BG_STYLE::DEFAULT;
72 int m_width = 0;
73 int m_height = 0;
74 std::string m_colorPreset;
75 SIDE m_side = SIDE::TOP;
76 double m_zoom = 1.0;
77 bool m_perspective = false;
81 bool m_floor = false;
82};
83
84#endif
VECTOR3D m_rotation
wxString m_filename
VECTOR3D m_pivot
std::string m_colorPreset
wxString m_outputFile
An simple container class that lets us dispatch output jobs to kifaces.
Definition: job.h:32
@ USER
The main config directory (e.g. ~/.config/kicad/)
#define KICOMMON_API
Definition: kicommon.h:28