pcb_dimension.h File Reference

#include <board_item.h>
#include <pcb_text.h>
#include <geometry/shape.h>
#include <geometry/circle.h>

Go to the source code of this file.

Classes
class	PCB_DIMENSION_BASE
	Abstract dimension API. More...
class	PCB_DIM_ALIGNED
	For better understanding of the points that make a dimension: More...
class	PCB_DIM_ORTHOGONAL
	An orthogonal dimension is like an aligned dimension, but the extension lines are locked to the X or Y axes, and the measurement is only taken in the X or Y direction. More...
class	PCB_DIM_RADIAL
	A radial dimension indicates either the radius or diameter of an arc or circle. More...
class	PCB_DIM_LEADER
	A leader is a dimension-like object pointing to a specific point. More...
class	PCB_DIM_CENTER
	Mark the center of a circle or arc with a cross shape. More...

Enumerations
enum class	DIM_UNITS_FORMAT { NO_SUFFIX , BARE_SUFFIX , PAREN_SUFFIX }
	How to display the units in a dimension's text. More...
enum class	DIM_PRECISION {   X = 0 , X_X , X_XX , X_XXX ,   X_XXXX , X_XXXXX , V_VV , V_VVV ,   V_VVVV , V_VVVVV }
enum class	DIM_TEXT_POSITION { OUTSIDE , INLINE , MANUAL }
	Where to place the text on a dimension. More...
enum class	DIM_UNITS_MODE { INCHES , MILS , MILLIMETRES , AUTOMATIC }
	Used for storing the units selection in the file because EDA_UNITS alone doesn't cut it. More...
enum class	DIM_TEXT_BORDER { NONE , RECTANGLE , CIRCLE , ROUNDRECT }
	Frame to show around dimension text. More...

Enumeration Type Documentation

DIM_PRECISION

enum class DIM_PRECISION

strong

Enumerator
X
X_X
X_XX
X_XXX
X_XXXX
X_XXXXX
V_VV
V_VVV
V_VVVV
V_VVVVV

Definition at line 46 of file pcb_dimension.h.

{
 X = 0, // 0
 X_X, // 0.0
 X_XX, // 0.00
 X_XXX, // 0.000
 X_XXXX, // 0.0000
 X_XXXXX, // 0.00000
 V_VV, // 0.00 / 0 / 0.0
 V_VVV, // 0.000 / 0 / 0.00
 V_VVVV, // 0.0000 / 0.0 / 0.000
 V_VVVVV // 0.00000 / 0.00 / 0.0000
};

DIM_TEXT_BORDER

enum class DIM_TEXT_BORDER

strong

Frame to show around dimension text.

Enumerator
NONE
RECTANGLE
CIRCLE
ROUNDRECT

Definition at line 82 of file pcb_dimension.h.

{
 NONE,
 RECTANGLE,
 CIRCLE,
 ROUNDRECT
};

DIM_TEXT_POSITION

enum class DIM_TEXT_POSITION

strong

Where to place the text on a dimension.

Enumerator
OUTSIDE	Text appears outside the dimension line (default)
INLINE	Text appears in line with the dimension line.
MANUAL	Text placement is manually set by the user.

Definition at line 61 of file pcb_dimension.h.

{
 OUTSIDE, 
 INLINE, 
 MANUAL 
};

DIM_UNITS_FORMAT

enum class DIM_UNITS_FORMAT

strong

How to display the units in a dimension's text.

Enumerator
NO_SUFFIX
BARE_SUFFIX
PAREN_SUFFIX

Definition at line 39 of file pcb_dimension.h.

{
 NO_SUFFIX, // 1234.0
 BARE_SUFFIX, // 1234.0 mm
 PAREN_SUFFIX // 1234.0 (mm)
};

DIM_UNITS_MODE

enum class DIM_UNITS_MODE

strong

Used for storing the units selection in the file because EDA_UNITS alone doesn't cut it.

Enumerator
INCHES
MILS
MILLIMETRES
AUTOMATIC

Definition at line 71 of file pcb_dimension.h.

{
 INCHES,
 MILS,
 MILLIMETRES,
 AUTOMATIC
};