KiCad PCB EDA Suite
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  DIMENSION_BASE
 Abstract dimension API. More...
 
class  ALIGNED_DIMENSION
 For better understanding of the points that make a dimension: More...
 
class  ORTHOGONAL_DIMENSION
 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  LEADER
 A leader is a dimension-like object pointing to a specific point. More...
 
class  CENTER_DIMENSION
 Marks the center of a circle or arc with a cross shape The size and orientation of the cross is adjustable. More...
 

Enumerations

enum  DIM_UNITS_FORMAT { DIM_UNITS_FORMAT::NO_SUFFIX, DIM_UNITS_FORMAT::BARE_SUFFIX, DIM_UNITS_FORMAT::PAREN_SUFFIX }
 How to display the units in a dimension's text. More...
 
enum  DIM_TEXT_POSITION { DIM_TEXT_POSITION::OUTSIDE, DIM_TEXT_POSITION::INLINE, DIM_TEXT_POSITION::MANUAL }
 Where to place the text on a dimension. More...
 
enum  DIM_UNITS_MODE { DIM_UNITS_MODE::INCHES, DIM_UNITS_MODE::MILS, DIM_UNITS_MODE::MILLIMETRES, DIM_UNITS_MODE::AUTOMATIC }
 Used for storing the units selection in the file because EDA_UNITS alone doesn't cut it. More...
 
enum  DIM_TEXT_FRAME { DIM_TEXT_FRAME::NONE, DIM_TEXT_FRAME::RECTANGLE, DIM_TEXT_FRAME::CIRCLE, DIM_TEXT_FRAME::ROUNDRECT }
 Frame to show around dimension text. More...
 

Enumeration Type Documentation

◆ DIM_TEXT_FRAME

enum DIM_TEXT_FRAME
strong

Frame to show around dimension text.

Enumerator
NONE 
RECTANGLE 
CIRCLE 
ROUNDRECT 

Definition at line 68 of file dimension.h.

◆ DIM_TEXT_POSITION

enum 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 47 of file dimension.h.

48 {
49  OUTSIDE,
50  INLINE,
51  MANUAL
52 };
Text placement is manually set by the user.
Text appears outside the dimension line (default)
Text appears in line with the dimension line.

◆ DIM_UNITS_FORMAT

enum 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 dimension.h.

◆ DIM_UNITS_MODE

enum 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 57 of file dimension.h.