KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Public Attributes | Protected Attributes | List of all members
JOB_PCB_RENDER Class Reference

#include <job_pcb_render.h>

Inheritance diagram for JOB_PCB_RENDER:
JOB

Public Types

enum class  FORMAT { PNG , JPEG }
 
enum class  QUALITY { BASIC , HIGH , USER }
 
enum class  BG_STYLE { DEFAULT , TRANSPARENT , OPAQUE }
 
enum class  SIDE {
  TOP , BOTTOM , LEFT , RIGHT ,
  FRONT , BACK
}
 

Public Member Functions

 JOB_PCB_RENDER ()
 
const std::string & GetType () const
 
const std::map< wxString, wxString > & GetVarOverrides () const
 
void SetVarOverrides (const std::map< wxString, wxString > &aVarOverrides)
 
virtual void FromJson (const nlohmann::json &j)
 
virtual void ToJson (nlohmann::json &j) const
 
virtual wxString GetDescription ()
 
const std::vector< JOB_PARAM_BASE * > & GetParams ()
 
void ClearExistingOutputs ()
 
const std::vector< JOB_OUTPUT > & GetOutputs ()
 
void AddOutput (wxString aOutputPath)
 
void SetTempOutputDirectory (const wxString &aBase)
 
void SetOutputPath (const wxString &aPath)
 
wxString GetOutputPath () const
 
wxString GetFullOutputPath () const
 
bool OutputPathFullSpecified () const
 

Public Attributes

wxString m_filename
 
wxString m_outputFile
 
FORMAT m_format = FORMAT::PNG
 
QUALITY m_quality = QUALITY::BASIC
 
BG_STYLE m_bgStyle = BG_STYLE::DEFAULT
 
int m_width = 0
 
int m_height = 0
 
std::string m_colorPreset
 
SIDE m_side = SIDE::TOP
 
double m_zoom = 1.0
 
bool m_perspective = false
 
VECTOR3D m_rotation
 
VECTOR3D m_pan
 
VECTOR3D m_pivot
 
bool m_floor = false
 

Protected Attributes

std::string m_type
 
std::map< wxString, wxString > m_varOverrides
 
wxString m_tempOutputDirectory
 
wxString m_outputPath
 
bool m_outputPathIsDirectory
 
std::vector< JOB_PARAM_BASE * > m_params
 
std::vector< JOB_OUTPUT > m_outputs
 

Detailed Description

Definition at line 31 of file job_pcb_render.h.

Member Enumeration Documentation

◆ BG_STYLE

enum class JOB_PCB_RENDER::BG_STYLE
strong
Enumerator
DEFAULT 
TRANSPARENT 
OPAQUE 

Definition at line 52 of file job_pcb_render.h.

◆ FORMAT

enum class JOB_PCB_RENDER::FORMAT
strong
Enumerator
PNG 
JPEG 

Definition at line 39 of file job_pcb_render.h.

◆ QUALITY

enum class JOB_PCB_RENDER::QUALITY
strong
Enumerator
BASIC 
HIGH 
USER 

Definition at line 45 of file job_pcb_render.h.

◆ SIDE

enum class JOB_PCB_RENDER::SIDE
strong
Enumerator
TOP 
BOTTOM 
LEFT 
RIGHT 
FRONT 
BACK 

Definition at line 59 of file job_pcb_render.h.

Constructor & Destructor Documentation

◆ JOB_PCB_RENDER()

JOB_PCB_RENDER::JOB_PCB_RENDER ( )

Definition at line 25 of file job_pcb_render.cpp.

Member Function Documentation

◆ AddOutput()

void JOB::AddOutput ( wxString  aOutputPath)
inlineinherited

Definition at line 111 of file job.h.

Referenced by PCBNEW_JOBS_HANDLER::JobExportPos().

◆ ClearExistingOutputs()

void JOB::ClearExistingOutputs ( )
inlineinherited

Definition at line 103 of file job.h.

Referenced by JOB_DISPATCHER::RunJob().

◆ FromJson()

void JOB::FromJson ( const nlohmann::json &  j)
virtualinherited

Definition at line 53 of file job.cpp.

References JOB::m_params.

Referenced by from_json().

◆ GetDescription()

wxString JOB::GetDescription ( )
virtualinherited

Reimplemented in JOB_EXPORT_PCB_3D, JOB_EXPORT_PCB_DRILL, JOB_EXPORT_PCB_DXF, JOB_EXPORT_PCB_GERBER, JOB_EXPORT_PCB_GERBERS, JOB_EXPORT_PCB_IPC2581, JOB_EXPORT_PCB_PDF, JOB_EXPORT_PCB_POS, JOB_EXPORT_PCB_SVG, JOB_EXPORT_SCH_BOM, JOB_EXPORT_SCH_NETLIST, JOB_EXPORT_SCH_PLOT_PDF, JOB_EXPORT_SCH_PLOT_DXF, JOB_EXPORT_SCH_PLOT_SVG, JOB_EXPORT_SCH_PLOT_PS, JOB_EXPORT_SCH_PLOT_HPGL, JOB_EXPORT_SCH_PYTHONBOM, JOB_PCB_DRC, JOB_SCH_ERC, and JOB_SPECIAL_EXECUTE.

Definition at line 67 of file job.cpp.

◆ GetFullOutputPath()

wxString JOB::GetFullOutputPath ( ) const
inherited

Definition at line 87 of file job.cpp.

References JOB::m_outputPath, JOB::m_outputPathIsDirectory, JOB::m_tempOutputDirectory, and PrependDirectoryToPath().

Referenced by PCBNEW_JOBS_HANDLER::JobExportDrill(), PCBNEW_JOBS_HANDLER::JobExportDxf(), PCBNEW_JOBS_HANDLER::JobExportGencad(), PCBNEW_JOBS_HANDLER::JobExportGerber(), PCBNEW_JOBS_HANDLER::JobExportGerbers(), PCBNEW_JOBS_HANDLER::JobExportIpc2581(), PCBNEW_JOBS_HANDLER::JobExportPdf(), PCBNEW_JOBS_HANDLER::JobExportPos(), PCBNEW_JOBS_HANDLER::JobExportStep(), PCBNEW_JOBS_HANDLER::JobExportSvg(), and JOBS_RUNNER::runSpecialExecute().

◆ GetOutputPath()

wxString JOB::GetOutputPath ( ) const
inlineinherited

Definition at line 119 of file job.h.

Referenced by DIALOG_EXPORT_2581::DIALOG_EXPORT_2581(), DIALOG_EXPORT_NETLIST::DIALOG_EXPORT_NETLIST(), DIALOG_GEN_FOOTPRINT_POSITION::initDialog(), DIALOG_GENDRILL::InitDisplayParams(), DIALOG_PLOT_SCHEMATIC::initDlg(), EESCHEMA_JOBS_HANDLER::JobExportBom(), PCBNEW_JOBS_HANDLER::JobExportDxf(), PCBNEW_JOBS_HANDLER::JobExportGencad(), PCBNEW_JOBS_HANDLER::JobExportGerber(), EESCHEMA_JOBS_HANDLER::JobExportNetlist(), PCBNEW_JOBS_HANDLER::JobExportPdf(), PCBNEW_JOBS_HANDLER::JobExportPos(), EESCHEMA_JOBS_HANDLER::JobExportPythonBom(), and PCBNEW_JOBS_HANDLER::JobExportStep().

◆ GetOutputs()

const std::vector< JOB_OUTPUT > & JOB::GetOutputs ( )
inlineinherited

Definition at line 107 of file job.h.

◆ GetParams()

const std::vector< JOB_PARAM_BASE * > & JOB::GetParams ( )
inlineinherited

Definition at line 99 of file job.h.

◆ GetType()

const std::string & JOB::GetType ( ) const
inlineinherited

Definition at line 85 of file job.h.

Referenced by JOB_DISPATCHER::HandleJobConfig(), and JOB_DISPATCHER::RunJob().

◆ GetVarOverrides()

const std::map< wxString, wxString > & JOB::GetVarOverrides ( ) const
inlineinherited

Definition at line 87 of file job.h.

Referenced by PCBNEW_JOBS_HANDLER::doFpExportSvg(), EESCHEMA_JOBS_HANDLER::JobExportBom(), PCBNEW_JOBS_HANDLER::JobExportDrc(), PCBNEW_JOBS_HANDLER::JobExportDxf(), PCBNEW_JOBS_HANDLER::JobExportGerber(), PCBNEW_JOBS_HANDLER::JobExportGerbers(), PCBNEW_JOBS_HANDLER::JobExportPdf(), EESCHEMA_JOBS_HANDLER::JobExportPlot(), PCBNEW_JOBS_HANDLER::JobExportRender(), PCBNEW_JOBS_HANDLER::JobExportStep(), PCBNEW_JOBS_HANDLER::JobExportSvg(), and EESCHEMA_JOBS_HANDLER::JobSchErc().

◆ OutputPathFullSpecified()

bool JOB::OutputPathFullSpecified ( ) const
inherited

Definition at line 135 of file job.cpp.

References JOB::m_outputPath, and JOB::m_outputPathIsDirectory.

Referenced by PCBNEW_JOBS_HANDLER::JobExportIpc2581().

◆ SetOutputPath()

void JOB::SetOutputPath ( const wxString &  aPath)
inherited

Definition at line 129 of file job.cpp.

References JOB::m_outputPath.

Referenced by EESCHEMA_JOBS_HANDLER::JobExportBom(), PCBNEW_JOBS_HANDLER::JobExportDxf(), PCBNEW_JOBS_HANDLER::JobExportGencad(), PCBNEW_JOBS_HANDLER::JobExportGerber(), PCBNEW_JOBS_HANDLER::JobExportIpc2581(), EESCHEMA_JOBS_HANDLER::JobExportNetlist(), PCBNEW_JOBS_HANDLER::JobExportPdf(), PCBNEW_JOBS_HANDLER::JobExportPos(), EESCHEMA_JOBS_HANDLER::JobExportPythonBom(), PCBNEW_JOBS_HANDLER::JobExportStep(), DIALOG_EXPORT_NETLIST::NetlistUpdateOpt(), DIALOG_EXPORT_STEP::onExportButton(), DIALOG_GENDRILL::OnGenDrillFile(), DIALOG_GEN_FOOTPRINT_POSITION::OnGenerate(), CLI::PCB_EXPORT_GERBER_COMMAND::populateJob(), JOB_EXPORT_PCB_IPC2581::SetDefaultOutputPath(), JOB_EXPORT_PCB_POS::SetDefaultOutputPath(), DIALOG_SPECIAL_EXECUTE::TransferDataFromWindow(), and DIALOG_EXPORT_2581::TransferDataFromWindow().

◆ SetTempOutputDirectory()

void JOB::SetTempOutputDirectory ( const wxString &  aBase)
inherited

Definition at line 73 of file job.cpp.

References JOB::m_tempOutputDirectory.

◆ SetVarOverrides()

void JOB::SetVarOverrides ( const std::map< wxString, wxString > &  aVarOverrides)
inlineinherited

Definition at line 89 of file job.h.

Referenced by CLI::PCB_EXPORT_GERBER_COMMAND::populateJob().

◆ ToJson()

void JOB::ToJson ( nlohmann::json &  j) const
virtualinherited

Definition at line 60 of file job.cpp.

References JOB::m_params.

Referenced by to_json().

Member Data Documentation

◆ m_bgStyle

BG_STYLE JOB_PCB_RENDER::m_bgStyle = BG_STYLE::DEFAULT

Definition at line 71 of file job_pcb_render.h.

Referenced by PCBNEW_JOBS_HANDLER::JobExportRender().

◆ m_colorPreset

std::string JOB_PCB_RENDER::m_colorPreset

Definition at line 74 of file job_pcb_render.h.

Referenced by PCBNEW_JOBS_HANDLER::JobExportRender().

◆ m_filename

wxString JOB_PCB_RENDER::m_filename

Definition at line 36 of file job_pcb_render.h.

Referenced by PCBNEW_JOBS_HANDLER::JobExportRender().

◆ m_floor

bool JOB_PCB_RENDER::m_floor = false

Definition at line 81 of file job_pcb_render.h.

Referenced by PCBNEW_JOBS_HANDLER::JobExportRender().

◆ m_format

FORMAT JOB_PCB_RENDER::m_format = FORMAT::PNG

Definition at line 69 of file job_pcb_render.h.

Referenced by PCBNEW_JOBS_HANDLER::JobExportRender().

◆ m_height

int JOB_PCB_RENDER::m_height = 0

Definition at line 73 of file job_pcb_render.h.

Referenced by PCBNEW_JOBS_HANDLER::JobExportRender().

◆ m_outputFile

wxString JOB_PCB_RENDER::m_outputFile

Definition at line 37 of file job_pcb_render.h.

Referenced by PCBNEW_JOBS_HANDLER::JobExportRender().

◆ m_outputPath

wxString JOB::m_outputPath
protectedinherited

Definition at line 131 of file job.h.

Referenced by JOB::GetFullOutputPath(), JOB::JOB(), JOB::OutputPathFullSpecified(), and JOB::SetOutputPath().

◆ m_outputPathIsDirectory

bool JOB::m_outputPathIsDirectory
protectedinherited

Definition at line 132 of file job.h.

Referenced by JOB::GetFullOutputPath(), JOB::JOB(), and JOB::OutputPathFullSpecified().

◆ m_outputs

std::vector<JOB_OUTPUT> JOB::m_outputs
protectedinherited

Definition at line 136 of file job.h.

◆ m_pan

VECTOR3D JOB_PCB_RENDER::m_pan

Definition at line 79 of file job_pcb_render.h.

Referenced by PCBNEW_JOBS_HANDLER::JobExportRender().

◆ m_params

std::vector<JOB_PARAM_BASE*> JOB::m_params
protectedinherited

Definition at line 134 of file job.h.

Referenced by JOB::FromJson(), JOB::JOB(), JOB_EXPORT_PCB_3D::JOB_EXPORT_PCB_3D(), JOB_EXPORT_PCB_GERBER::JOB_EXPORT_PCB_GERBER(), JOB_EXPORT_PCB_GERBERS::JOB_EXPORT_PCB_GERBERS(), JOB_EXPORT_PCB_PDF::JOB_EXPORT_PCB_PDF(), JOB_EXPORT_PCB_SVG::JOB_EXPORT_PCB_SVG(), JOB_EXPORT_SCH_BOM::JOB_EXPORT_SCH_BOM(), JOB_SPECIAL_EXECUTE::JOB_SPECIAL_EXECUTE(), JOB::ToJson(), and JOB::~JOB().

◆ m_perspective

bool JOB_PCB_RENDER::m_perspective = false

Definition at line 77 of file job_pcb_render.h.

Referenced by PCBNEW_JOBS_HANDLER::JobExportRender().

◆ m_pivot

VECTOR3D JOB_PCB_RENDER::m_pivot

Definition at line 80 of file job_pcb_render.h.

Referenced by PCBNEW_JOBS_HANDLER::JobExportRender().

◆ m_quality

QUALITY JOB_PCB_RENDER::m_quality = QUALITY::BASIC

Definition at line 70 of file job_pcb_render.h.

Referenced by PCBNEW_JOBS_HANDLER::JobExportRender().

◆ m_rotation

VECTOR3D JOB_PCB_RENDER::m_rotation

Definition at line 78 of file job_pcb_render.h.

Referenced by PCBNEW_JOBS_HANDLER::JobExportRender().

◆ m_side

SIDE JOB_PCB_RENDER::m_side = SIDE::TOP

Definition at line 75 of file job_pcb_render.h.

Referenced by PCBNEW_JOBS_HANDLER::JobExportRender().

◆ m_tempOutputDirectory

wxString JOB::m_tempOutputDirectory
protectedinherited

Definition at line 129 of file job.h.

Referenced by JOB::GetFullOutputPath(), and JOB::SetTempOutputDirectory().

◆ m_type

std::string JOB::m_type
protectedinherited

Definition at line 126 of file job.h.

◆ m_varOverrides

std::map<wxString, wxString> JOB::m_varOverrides
protectedinherited

Definition at line 127 of file job.h.

◆ m_width

int JOB_PCB_RENDER::m_width = 0

Definition at line 72 of file job_pcb_render.h.

Referenced by PCBNEW_JOBS_HANDLER::JobExportRender().

◆ m_zoom

double JOB_PCB_RENDER::m_zoom = 1.0

Definition at line 76 of file job_pcb_render.h.

Referenced by PCBNEW_JOBS_HANDLER::JobExportRender().

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