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 (bool aIsCli)
 
const std::string & GetType () const
 
bool IsCli () const
 
const std::map< wxString, wxString > & GetVarOverrides () const
 
void SetVarOverrides (const std::map< wxString, wxString > &aVarOverrides)
 

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
 
bool m_isCli
 
std::map< wxString, wxString > m_varOverrides
 

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 ( bool  aIsCli)

Definition at line 25 of file job_pcb_render.cpp.

Member Function Documentation

◆ GetType()

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

Definition at line 38 of file job.h.

Referenced by JOB_DISPATCHER::RunJob().

◆ GetVarOverrides()

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

Definition at line 41 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().

◆ IsCli()

bool JOB::IsCli ( ) const
inlineinherited

Definition at line 39 of file job.h.

Referenced by PCBNEW_JOBS_HANDLER::JobExportDrc(), PCBNEW_JOBS_HANDLER::JobExportDrill(), PCBNEW_JOBS_HANDLER::JobExportDxf(), PCBNEW_JOBS_HANDLER::JobExportFpSvg(), PCBNEW_JOBS_HANDLER::JobExportFpUpgrade(), PCBNEW_JOBS_HANDLER::JobExportGerber(), PCBNEW_JOBS_HANDLER::JobExportGerbers(), PCBNEW_JOBS_HANDLER::JobExportIpc2581(), PCBNEW_JOBS_HANDLER::JobExportPdf(), PCBNEW_JOBS_HANDLER::JobExportPos(), PCBNEW_JOBS_HANDLER::JobExportRender(), PCBNEW_JOBS_HANDLER::JobExportStep(), and PCBNEW_JOBS_HANDLER::JobExportSvg().

◆ SetVarOverrides()

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

Definition at line 43 of file job.h.

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

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_isCli

bool JOB::m_isCli
protectedinherited

Definition at line 50 of file job.h.

◆ 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_pan

VECTOR3D JOB_PCB_RENDER::m_pan

Definition at line 79 of file job_pcb_render.h.

Referenced by PCBNEW_JOBS_HANDLER::JobExportRender().

◆ 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_type

std::string JOB::m_type
protectedinherited

Definition at line 49 of file job.h.

◆ m_varOverrides

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

Definition at line 51 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: