KiCad PCB EDA Suite
APERTURE Class Reference

#include <plotter.h>

Public Types

enum  APERTURE_TYPE {
  AT_CIRCLE = 1, AT_RECT = 2, AT_PLOTTING = 3, AT_OVAL = 4,
  AT_REGULAR_POLY = 5, AT_REGULAR_POLY3, AT_REGULAR_POLY4, AT_REGULAR_POLY5,
  AT_REGULAR_POLY6, AT_REGULAR_POLY7, AT_REGULAR_POLY8, AT_REGULAR_POLY9,
  AT_REGULAR_POLY10, AT_REGULAR_POLY11, AT_REGULAR_POLY12
}
 

Public Member Functions

void SetSize (const wxSize &aSize)
 
const wxSize GetSize ()
 
void SetDiameter (int aDiameter)
 
int GetDiameter ()
 
void SetVerticeCount (int aCount)
 
int GetVerticeCount ()
 
void SetRotation (double aRotDegree)
 
double GetRotation ()
 

Public Attributes

APERTURE_TYPE m_Type
 
wxSize m_Size
 
int m_DCode
 
int m_ApertureAttribute
 

Detailed Description

Definition at line 1055 of file plotter.h.

Member Enumeration Documentation

◆ APERTURE_TYPE

Enumerator
AT_CIRCLE 
AT_RECT 
AT_PLOTTING 
AT_OVAL 
AT_REGULAR_POLY 
AT_REGULAR_POLY3 
AT_REGULAR_POLY4 
AT_REGULAR_POLY5 
AT_REGULAR_POLY6 
AT_REGULAR_POLY7 
AT_REGULAR_POLY8 
AT_REGULAR_POLY9 
AT_REGULAR_POLY10 
AT_REGULAR_POLY11 
AT_REGULAR_POLY12 

Definition at line 1058 of file plotter.h.

1058  {
1059  AT_CIRCLE = 1, // round aperture, to flash pads
1060  AT_RECT = 2, // rect aperture, to flash pads
1061  AT_PLOTTING = 3, // round aperture, to plot lines
1062  AT_OVAL = 4, // oval aperture, to flash pads
1063  AT_REGULAR_POLY = 5,// Regular polygon (n vertices, n = 3 .. 12, with rotation)
1064  AT_REGULAR_POLY3, // Regular polygon 3 vertices, with rotation
1065  AT_REGULAR_POLY4, // Regular polygon 4 vertices, with rotation
1066  AT_REGULAR_POLY5, // Regular polygon 5 vertices, with rotation
1067  AT_REGULAR_POLY6, // Regular polygon 6 vertices, with rotation
1068  AT_REGULAR_POLY7, // Regular polygon 7 vertices, with rotation
1069  AT_REGULAR_POLY8, // Regular polygon 8 vertices, with rotation
1070  AT_REGULAR_POLY9, // Regular polygon 9 vertices, with rotation
1071  AT_REGULAR_POLY10, // Regular polygon 10 vertices, with rotation
1072  AT_REGULAR_POLY11, // Regular polygon 11 vertices, with rotation
1073  AT_REGULAR_POLY12, // Regular polygon 12 vertices, with rotation
1074  };

Member Function Documentation

◆ GetDiameter()

int APERTURE::GetDiameter ( )
inline

Definition at line 1091 of file plotter.h.

1092  {
1093  return m_Size.x;
1094  }
wxSize m_Size
Definition: plotter.h:1129

References m_Size.

◆ GetRotation()

double APERTURE::GetRotation ( )
inline

Definition at line 1117 of file plotter.h.

1118  {
1119  // The rotation is stored in 1/1000 degree
1120  return m_Size.y / 1000.0;
1121  }
wxSize m_Size
Definition: plotter.h:1129

References m_Size.

◆ GetSize()

const wxSize APERTURE::GetSize ( )
inline

Definition at line 1081 of file plotter.h.

1082  {
1083  return m_Size;
1084  }
wxSize m_Size
Definition: plotter.h:1129

References m_Size.

◆ GetVerticeCount()

int APERTURE::GetVerticeCount ( )
inline

Definition at line 1106 of file plotter.h.

1107  {
1108  return m_Type - AT_REGULAR_POLY3 + 3;
1109  }
APERTURE_TYPE m_Type
Definition: plotter.h:1124

References AT_REGULAR_POLY3, and m_Type.

◆ SetDiameter()

void APERTURE::SetDiameter ( int  aDiameter)
inline

Definition at line 1086 of file plotter.h.

1087  {
1088  m_Size.x = aDiameter;
1089  }
wxSize m_Size
Definition: plotter.h:1129

References m_Size.

◆ SetRotation()

void APERTURE::SetRotation ( double  aRotDegree)
inline

Definition at line 1111 of file plotter.h.

1112  {
1113  // The rotation is stored in 1/1000 degree
1114  m_Size.y = int( aRotDegree * 1000.0 );
1115  }
wxSize m_Size
Definition: plotter.h:1129

References m_Size.

◆ SetSize()

void APERTURE::SetSize ( const wxSize &  aSize)
inline

Definition at line 1076 of file plotter.h.

1077  {
1078  m_Size = aSize;
1079  }
wxSize m_Size
Definition: plotter.h:1129

References m_Size.

◆ SetVerticeCount()

void APERTURE::SetVerticeCount ( int  aCount)
inline

Definition at line 1096 of file plotter.h.

1097  {
1098  if( aCount < 3 )
1099  aCount = 3;
1100  else if( aCount > 12 )
1101  aCount = 12;
1102 
1103  m_Type = (APERTURE_TYPE)(AT_REGULAR_POLY3 - 3 + aCount);
1104  }
APERTURE_TYPE
Definition: plotter.h:1058
APERTURE_TYPE m_Type
Definition: plotter.h:1124

References AT_REGULAR_POLY3, and m_Type.

Member Data Documentation

◆ m_ApertureAttribute

int APERTURE::m_ApertureAttribute

Definition at line 1137 of file plotter.h.

Referenced by GERBER_PLOTTER::GetOrCreateAperture().

◆ m_DCode

int APERTURE::m_DCode

Definition at line 1132 of file plotter.h.

Referenced by GERBER_PLOTTER::GetOrCreateAperture().

◆ m_Size

wxSize APERTURE::m_Size

◆ m_Type

APERTURE_TYPE APERTURE::m_Type

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