KiCad PCB EDA Suite
Loading...
Searching...
No Matches
GRID Struct Reference

Common grid settings, available to every frame. More...

#include <grid_settings.h>

Public Member Functions

bool operator== (const GRID &aOther) const
 
wxString MessageText (EDA_IU_SCALE aScale, EDA_UNITS aUnits, bool aDisplayUnits=true) const
 Returns a string representation of the grid in specified units.
 
wxString UserUnitsMessageText (UNITS_PROVIDER *aProvider, bool aDisplayUnits=true) const
 Returns a string representation of the grid in the user's units.
 
VECTOR2D ToDouble (EDA_IU_SCALE aScale) const
 

Public Attributes

wxString name
 
wxString x
 
wxString y
 

Detailed Description

Common grid settings, available to every frame.

Definition at line 33 of file grid_settings.h.

Member Function Documentation

◆ MessageText()

wxString GRID::MessageText ( EDA_IU_SCALE  aScale,
EDA_UNITS  aUnits,
bool  aDisplayUnits = true 
) const

Returns a string representation of the grid in specified units.

Will reduce to a single dimension if the grid is square.

Definition at line 28 of file grid_settings.cpp.

References EDA_UNIT_UTILS::UI::DoubleValueFromString(), EDA_UNIT_UTILS::UI::MessageTextFromValue(), x, and y.

Referenced by GRID_MENU::BuildChoiceList(), and UserUnitsMessageText().

◆ operator==()

bool GRID::operator== ( const GRID aOther) const

Definition at line 62 of file grid_settings.cpp.

References name, x, and y.

◆ ToDouble()

VECTOR2D GRID::ToDouble ( EDA_IU_SCALE  aScale) const

◆ UserUnitsMessageText()

wxString GRID::UserUnitsMessageText ( UNITS_PROVIDER aProvider,
bool  aDisplayUnits = true 
) const

Returns a string representation of the grid in the user's units.

Will reduce to a single dimension if the grid is square.

Definition at line 47 of file grid_settings.cpp.

References UNITS_PROVIDER::GetIuScale(), UNITS_PROVIDER::GetUserUnits(), and MessageText().

Member Data Documentation

◆ name

◆ x

◆ y


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