KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Namespaces | Functions | Variables
kiapi::common Namespace Reference

Namespaces

namespace  project
 
namespace  types
 

Functions

void PackTextAttributes (types::TextAttributes &aOutput, const TEXT_ATTRIBUTES &aInput, const EDA_IU_SCALE &aScale)
 
void UnpackTextAttributes (TEXT_ATTRIBUTES &aOutput, const types::TextAttributes &aInput, const EDA_IU_SCALE &aScale)
 
KICOMMON_API ApiResponseStatus MakeResponseStatus (ApiStatusCode aCode, const std::string &aMessage)
 
KICOMMON_API std::optional< KICAD_T > TypeNameFromAny (const google::protobuf::Any &aMessage)
 
KICOMMON_API LIB_ID UnpackLibId (const types::LibraryIdentifier &aId)
 
KICOMMON_API void PackLibId (types::LibraryIdentifier *aOutput, const LIB_ID &aId)
 
KICOMMON_API void PackVector2 (types::Vector2 &aOutput, const VECTOR2I &aInput, const EDA_IU_SCALE &aScale)
 
KICOMMON_API VECTOR2I UnpackVector2 (const types::Vector2 &aInput, const EDA_IU_SCALE &aScale)
 
KICOMMON_API void PackVector3D (types::Vector3D &aOutput, const VECTOR3D &aInput)
 
KICOMMON_API VECTOR3D UnpackVector3D (const types::Vector3D &aInput)
 
KICOMMON_API void PackBox2 (types::Box2 &aOutput, const BOX2I &aInput, const EDA_IU_SCALE &aScale)
 
KICOMMON_API BOX2I UnpackBox2 (const types::Box2 &aInput, const EDA_IU_SCALE &aScale)
 
KICOMMON_API void PackDistance (types::Distance &aOutput, int aInput, const EDA_IU_SCALE &aScale)
 
KICOMMON_API int UnpackDistance (const types::Distance &aInput, const EDA_IU_SCALE &aScale)
 
KICOMMON_API void PackPolyLine (types::PolyLine &aOutput, const SHAPE_LINE_CHAIN &aSlc, const EDA_IU_SCALE &aScale)
 
KICOMMON_API SHAPE_LINE_CHAIN UnpackPolyLine (const types::PolyLine &aInput, const EDA_IU_SCALE &aScale)
 
KICOMMON_API void PackPolySet (types::PolySet &aOutput, const SHAPE_POLY_SET &aInput, const EDA_IU_SCALE &aScale)
 
KICOMMON_API SHAPE_POLY_SET UnpackPolySet (const types::PolySet &aInput, const EDA_IU_SCALE &aScale)
 
KICOMMON_API void PackColor (types::Color &aOutput, const KIGFX::COLOR4D &aInput)
 
KICOMMON_API KIGFX::COLOR4D UnpackColor (const types::Color &aInput)
 
KICOMMON_API void PackSheetPath (types::SheetPath &aOutput, const KIID_PATH &aInput)
 
KICOMMON_API KIID_PATH UnpackSheetPath (const types::SheetPath &aInput)
 
KICOMMON_API void PackStroke (types::StrokeAttributes &aOutput, const STROKE_PARAMS &aInput, const EDA_IU_SCALE &aScale)
 
KICOMMON_API void UnpackStroke (STROKE_PARAMS &aOutput, const types::StrokeAttributes &aInput, const EDA_IU_SCALE &aScale)
 
KICOMMON_API void PackLineEnding (types::LineEnding &aOutput, const LINE_ENDING &aInput, const EDA_IU_SCALE &aScale)
 
KICOMMON_API LINE_ENDING UnpackLineEnding (const types::LineEnding &aInput, const EDA_IU_SCALE &aScale)
 
KICOMMON_API void PackProject (types::ProjectSpecifier &aOutput, const PROJECT &aInput)
 
KICOMMON_API bool PackKiwayApiMessage (const google::protobuf::Message &aMessage, std::string &aBytes)
 
KICOMMON_API void PackCustomProperties (google::protobuf::RepeatedPtrField< types::CustomProperty > *aOutput, const EDA_ITEM &aItem)
 
KICOMMON_API void UnpackCustomProperties (const google::protobuf::RepeatedPtrField< types::CustomProperty > &aInput, EDA_ITEM &aItem)
 
KICOMMON_API void PackStroke (kiapi::common::types::StrokeAttributes &aOutput, const STROKE_PARAMS &aInput, const EDA_IU_SCALE &aScale=pcbIUScale)
 
KICOMMON_API void UnpackStroke (STROKE_PARAMS &aOutput, const kiapi::common::types::StrokeAttributes &aInput, const EDA_IU_SCALE &aScale=pcbIUScale)
 
KICOMMON_API void PackLineEnding (kiapi::common::types::LineEnding &aOutput, const LINE_ENDING &aInput, const EDA_IU_SCALE &aScale=pcbIUScale)
 
KICOMMON_API LINE_ENDING UnpackLineEnding (const kiapi::common::types::LineEnding &aInput, const EDA_IU_SCALE &aScale=pcbIUScale)
 
void PackTextAttributes (kiapi::common::types::TextAttributes &aOutput, const TEXT_ATTRIBUTES &aInput, const EDA_IU_SCALE &aScale=pcbIUScale)
 
void UnpackTextAttributes (TEXT_ATTRIBUTES &aOutput, const kiapi::common::types::TextAttributes &aInput, const EDA_IU_SCALE &aScale=pcbIUScale)
 

Variables

const KICOMMON_API std::string KiwayClientName = "org.kicad.internal.kiway"
 
const KICOMMON_API std::string StandaloneCrossProbeClientName = "org.kicad.internal.crossprobe"
 

Function Documentation

◆ MakeResponseStatus()

KICOMMON_API ApiResponseStatus kiapi::common::MakeResponseStatus ( ApiStatusCode aCode,
const std::string & aMessage )

Definition at line 39 of file api_utils.cpp.

References KICOMMON_API.

Referenced by API_HANDLER_PCB::handleAddVariant(), API_HANDLER_SCH::handleAddVariant(), API_HANDLER_PCB::handleCopyVariant(), API_HANDLER_SCH::handleCopyVariant(), API_HANDLER_PCB::handleDeleteVariant(), API_HANDLER_SCH::handleDeleteVariant(), API_HANDLER_PCB::handleGetCurrentVariant(), API_HANDLER_SCH::handleGetCurrentVariant(), API_HANDLER_PCB::handleGetVariants(), API_HANDLER_SCH::handleGetVariants(), API_HANDLER_PCB::handleRenameVariant(), API_HANDLER_SCH::handleRenameVariant(), API_HANDLER_PCB::handleSetCurrentVariant(), API_HANDLER_SCH::handleSetCurrentVariant(), API_HANDLER_PCB::handleSetVariantDescription(), and API_HANDLER_SCH::handleSetVariantDescription().

◆ PackBox2()

KICOMMON_API void kiapi::common::PackBox2 ( types::Box2 & aOutput,
const BOX2I & aInput,
const EDA_IU_SCALE & aScale )

Definition at line 168 of file api_utils.cpp.

References BOX2< Vec >::GetOrigin(), BOX2< Vec >::GetSize(), KICOMMON_API, and PackVector2().

Referenced by API_HANDLER_BOARD::handleGetBoundingBox().

◆ PackColor()

KICOMMON_API void kiapi::common::PackColor ( types::Color & aOutput,
const KIGFX::COLOR4D & aInput )

Definition at line 285 of file api_utils.cpp.

References KIGFX::COLOR4D::a, KIGFX::COLOR4D::b, KIGFX::COLOR4D::g, KICOMMON_API, and KIGFX::COLOR4D::r.

Referenced by PackStroke(), PackTextAttributes(), BOARD_STACKUP::Serialize(), EDA_SHAPE::Serialize(), NETCLASS::Serialize(), SCH_BUS_ENTRY_BASE::Serialize(), SCH_JUNCTION::Serialize(), SCH_LINE::Serialize(), SCH_SHEET::Serialize(), and SCH_TEXTBOX::Serialize().

◆ PackCustomProperties()

KICOMMON_API void kiapi::common::PackCustomProperties ( google::protobuf::RepeatedPtrField< types::CustomProperty > * aOutput,
const EDA_ITEM & aItem )

Definition at line 413 of file api_utils.cpp.

References EDA_ITEM::GetCustomProperties(), and KICOMMON_API.

Referenced by FOOTPRINT::Serialize(), PAD::Serialize(), PCB_ARC::Serialize(), PCB_BARCODE::Serialize(), PCB_CONSTRAINT::Serialize(), PCB_DIMENSION_BASE::Serialize(), PCB_FIELD::Serialize(), PCB_GRID_ITEM::Serialize(), PCB_GROUP::Serialize(), PCB_POINT::Serialize(), PCB_REFERENCE_IMAGE::Serialize(), PCB_SHAPE::Serialize(), PCB_TABLE::Serialize(), PCB_TABLECELL::Serialize(), PCB_TEXT::Serialize(), PCB_TEXTBOX::Serialize(), PCB_TRACK::Serialize(), PCB_VIA::Serialize(), SCH_BITMAP::Serialize(), SCH_BUS_ENTRY_BASE::Serialize(), SCH_DIRECTIVE_LABEL::Serialize(), SCH_FIELD::Serialize(), SCH_GROUP::Serialize(), SCH_HIERLABEL::Serialize(), SCH_JUNCTION::Serialize(), SCH_LABEL::Serialize(), SCH_LINE::Serialize(), SCH_NO_CONNECT::Serialize(), SCH_PIN::Serialize(), SCH_RULE_AREA::Serialize(), SCH_SHAPE::Serialize(), SCH_SHEET::Serialize(), SCH_SYMBOL::Serialize(), SCH_TABLE::Serialize(), SCH_TABLECELL::Serialize(), SCH_TEXT::Serialize(), SCH_TEXTBOX::Serialize(), and ZONE::Serialize().

◆ PackDistance()

KICOMMON_API void kiapi::common::PackDistance ( types::Distance & aOutput,
int aInput,
const EDA_IU_SCALE & aScale )

Definition at line 181 of file api_utils.cpp.

References EDA_IU_SCALE::IUToNm(), and KICOMMON_API.

Referenced by PackLineEnding(), PackStroke(), PackTextAttributes(), EDA_SHAPE::Serialize(), LIB_SYMBOL::Serialize(), NETCLASS::Serialize(), PCB_DRILL_CHART::Serialize(), PCB_DRILL_MAP::Serialize(), PCB_GRID_ITEM::Serialize(), SCH_BUS_ENTRY_BASE::Serialize(), SCH_DIRECTIVE_LABEL::Serialize(), SCH_JUNCTION::Serialize(), SCH_LINE::Serialize(), SCH_NO_CONNECT::Serialize(), SCH_PIN::Serialize(), SCH_SHEET::Serialize(), SCH_SYMBOL::Serialize(), SCH_TABLE::Serialize(), and SCH_TEXTBOX::Serialize().

◆ PackKiwayApiMessage()

KICOMMON_API bool kiapi::common::PackKiwayApiMessage ( const google::protobuf::Message & aMessage,
std::string & aBytes )

Definition at line 400 of file api_utils.cpp.

References KICOMMON_API, and KiwayClientName.

Referenced by EDA_3D_CANVAS::OnLeftUp(), PCB_EDIT_FRAME::SendCrossProbeItem(), PCB_EDIT_FRAME::SendCrossProbeNetName(), sendHighlightNets(), SCH_EDIT_FRAME::SendSelectItemsToPcb(), and PCB_EDIT_FRAME::SendSelectItemsToSch().

◆ PackLibId()

KICOMMON_API void kiapi::common::PackLibId ( types::LibraryIdentifier * aOutput,
const LIB_ID & aId )

Definition at line 134 of file api_utils.cpp.

References LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), and KICOMMON_API.

Referenced by PackSymbol(), LIB_SYMBOL::Serialize(), PCB_GROUP::Serialize(), SCH_SYMBOL::Serialize(), and FOOTPRINT::SerializeDefinition().

◆ PackLineEnding() [1/2]

KICOMMON_API void kiapi::common::PackLineEnding ( kiapi::common::types::LineEnding & aOutput,
const LINE_ENDING & aInput,
const EDA_IU_SCALE & aScale = pcbIUScale )

References KICOMMON_API, and pcbIUScale.

◆ PackLineEnding() [2/2]

KICOMMON_API void kiapi::common::PackLineEnding ( types::LineEnding & aOutput,
const LINE_ENDING & aInput,
const EDA_IU_SCALE & aScale )

Definition at line 347 of file api_utils.cpp.

References LINE_ENDING::GetLength(), LINE_ENDING::GetStroke(), LINE_ENDING::GetStrokeWidth(), LINE_ENDING::GetStyle(), LINE_ENDING::GetWidth(), KICOMMON_API, PackDistance(), PackStroke(), and ToProtoEnum().

Referenced by EDA_SHAPE::Serialize(), and SCH_LINE::Serialize().

◆ PackPolyLine()

KICOMMON_API void kiapi::common::PackPolyLine ( types::PolyLine & aOutput,
const SHAPE_LINE_CHAIN & aSlc,
const EDA_IU_SCALE & aScale )

Definition at line 193 of file api_utils.cpp.

References SHAPE_LINE_CHAIN::Arc(), SHAPE_LINE_CHAIN::ArcIndex(), SHAPE_LINE_CHAIN::CPoint(), SHAPE_ARC::GetArcMid(), SHAPE_ARC::GetP0(), SHAPE_ARC::GetP1(), SHAPE_LINE_CHAIN::IsArcStart(), SHAPE_LINE_CHAIN::IsClosed(), SHAPE_LINE_CHAIN::IsPtOnArc(), KICOMMON_API, PackVector2(), and SHAPE_LINE_CHAIN::PointCount().

Referenced by API_HANDLER_BOARD::handleGetPadShapeAsPolygon(), and PackPolySet().

◆ PackPolySet()

KICOMMON_API void kiapi::common::PackPolySet ( types::PolySet & aOutput,
const SHAPE_POLY_SET & aInput,
const EDA_IU_SCALE & aScale )

Definition at line 241 of file api_utils.cpp.

References KICOMMON_API, SHAPE_POLY_SET::OutlineCount(), PackPolyLine(), and SHAPE_POLY_SET::Polygon().

Referenced by EDA_SHAPE::Serialize(), and ZONE::Serialize().

◆ PackProject()

KICOMMON_API void kiapi::common::PackProject ( types::ProjectSpecifier & aOutput,
const PROJECT & aInput )

Definition at line 385 of file api_utils.cpp.

References PROJECT::GetProjectName(), PROJECT::GetProjectPath(), and KICOMMON_API.

Referenced by CLI::API_SERVER_COMMAND::doPerform(), and API_HANDLER_SCH::handleGetOpenDocuments().

◆ PackSheetPath()

KICOMMON_API void kiapi::common::PackSheetPath ( types::SheetPath & aOutput,
const KIID_PATH & aInput )

Definition at line 304 of file api_utils.cpp.

References KICOMMON_API.

Referenced by BOOST_AUTO_TEST_CASE(), ERC_EXCLUSION::FromLegacyStrings(), API_HANDLER_SCH::handleGetOpenDocuments(), API_HANDLER_SCH::handleGetSchematicNetlist(), PackSheet(), API_HANDLER_SCH::packSheetInstance(), PackSheetPath(), PackSymbol(), SCH_EDIT_FRAME::SendSelectItemsToPcb(), and FOOTPRINT::Serialize().

◆ PackStroke() [1/2]

KICOMMON_API void kiapi::common::PackStroke ( kiapi::common::types::StrokeAttributes & aOutput,
const STROKE_PARAMS & aInput,
const EDA_IU_SCALE & aScale = pcbIUScale )

References KICOMMON_API, and pcbIUScale.

◆ PackStroke() [2/2]

KICOMMON_API void kiapi::common::PackStroke ( types::StrokeAttributes & aOutput,
const STROKE_PARAMS & aInput,
const EDA_IU_SCALE & aScale )

Definition at line 323 of file api_utils.cpp.

References STROKE_PARAMS::GetColor(), STROKE_PARAMS::GetLineStyle(), STROKE_PARAMS::GetWidth(), KICOMMON_API, PackColor(), PackDistance(), ToProtoEnum(), and KIGFX::COLOR4D::UNSPECIFIED.

Referenced by PackLineEnding(), EDA_SHAPE::Serialize(), PCB_TABLE::Serialize(), and SCH_TABLE::Serialize().

◆ PackTextAttributes() [1/2]

void kiapi::common::PackTextAttributes ( kiapi::common::types::TextAttributes & aOutput,
const TEXT_ATTRIBUTES & aInput,
const EDA_IU_SCALE & aScale = pcbIUScale )

References pcbIUScale.

◆ PackTextAttributes() [2/2]

void kiapi::common::PackTextAttributes ( types::TextAttributes & aOutput,
const TEXT_ATTRIBUTES & aInput,
const EDA_IU_SCALE & aScale )

Definition at line 31 of file api_text_attributes.cpp.

References EDA_ANGLE::AsDegrees(), KIFONT::FONT::GetName(), TEXT_ATTRIBUTES::m_Angle, TEXT_ATTRIBUTES::m_Bold, TEXT_ATTRIBUTES::m_Color, TEXT_ATTRIBUTES::m_Font, TEXT_ATTRIBUTES::m_Halign, TEXT_ATTRIBUTES::m_Italic, TEXT_ATTRIBUTES::m_KeepUpright, TEXT_ATTRIBUTES::m_LineSpacing, TEXT_ATTRIBUTES::m_Mirrored, TEXT_ATTRIBUTES::m_Multiline, TEXT_ATTRIBUTES::m_Size, TEXT_ATTRIBUTES::m_StrokeWidth, TEXT_ATTRIBUTES::m_Underlined, TEXT_ATTRIBUTES::m_Valign, PackColor(), PackDistance(), PackVector2(), ToProtoEnum(), and KIGFX::COLOR4D::UNSPECIFIED.

Referenced by EDA_TEXT::Serialize(), and PCB_TEXTBOX::Serialize().

◆ PackVector2()

KICOMMON_API void kiapi::common::PackVector2 ( types::Vector2 & aOutput,
const VECTOR2I & aInput,
const EDA_IU_SCALE & aScale )

Definition at line 141 of file api_utils.cpp.

References EDA_IU_SCALE::IUToNm(), KICOMMON_API, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), ERC_EXCLUSION::FromLegacyStrings(), API_HANDLER_PCB::handleGetBoardOrigin(), API_HANDLER_EDITOR::handleGetPageSettings(), API_HANDLER_COMMON::handleGetTextAsShapes(), API_HANDLER_EDITOR::handleSetPageSettings(), PackBox2(), packLabel(), PackPolyLine(), PackTextAttributes(), EDA_SHAPE::Serialize(), EDA_TEXT::Serialize(), NETCLASS::Serialize(), PAD::Serialize(), PADSTACK::Serialize(), PCB_BARCODE::Serialize(), PCB_DIM_ALIGNED::Serialize(), PCB_DIM_CENTER::Serialize(), PCB_DIM_LEADER::Serialize(), PCB_DIM_ORTHOGONAL::Serialize(), PCB_DIM_RADIAL::Serialize(), PCB_DRILL_MAP::Serialize(), PCB_GRID_ITEM::Serialize(), PCB_POINT::Serialize(), PCB_REFERENCE_IMAGE::Serialize(), PCB_TEXT::Serialize(), PCB_TEXTBOX::Serialize(), SCH_BITMAP::Serialize(), SCH_BUS_ENTRY_BASE::Serialize(), SCH_FIELD::Serialize(), SCH_GLOBALLABEL::Serialize(), SCH_JUNCTION::Serialize(), SCH_LINE::Serialize(), SCH_NO_CONNECT::Serialize(), SCH_PIN::Serialize(), SCH_SHEET::Serialize(), SCH_SHEET_PIN::Serialize(), SCH_SYMBOL::Serialize(), SCH_TEXT::Serialize(), SCH_TEXTBOX::Serialize(), ZONE::Serialize(), ToProto(), and ToProto().

◆ PackVector3D()

KICOMMON_API void kiapi::common::PackVector3D ( types::Vector3D & aOutput,
const VECTOR3D & aInput )

Definition at line 154 of file api_utils.cpp.

References KICOMMON_API, VECTOR3< T >::x, VECTOR3< T >::y, and VECTOR3< T >::z.

Referenced by FOOTPRINT::SerializeDefinition().

◆ TypeNameFromAny()

KICOMMON_API std::optional< KICAD_T > kiapi::common::TypeNameFromAny ( const google::protobuf::Any & aMessage)

Definition at line 50 of file api_utils.cpp.

References KICOMMON_API, PCB_ARC_T, PCB_BARCODE_T, PCB_CONSTRAINT_T, PCB_DIMENSION_T, PCB_DRILL_CHART_T, PCB_DRILL_MAP_T, PCB_FIELD_T, PCB_FOOTPRINT_T, PCB_GRID_ITEM_T, PCB_GROUP_T, PCB_PAD_T, PCB_POINT_T, PCB_REFERENCE_IMAGE_T, PCB_SHAPE_T, PCB_TABLE_T, PCB_TABLECELL_T, PCB_TEXT_T, PCB_TEXTBOX_T, PCB_TRACE_T, PCB_VIA_T, PCB_ZONE_T, SCH_BITMAP_T, SCH_BUS_BUS_ENTRY_T, SCH_BUS_WIRE_ENTRY_T, SCH_DIRECTIVE_LABEL_T, SCH_FIELD_T, SCH_GLOBAL_LABEL_T, SCH_GROUP_T, SCH_HIER_LABEL_T, SCH_JUNCTION_T, SCH_LABEL_T, SCH_LINE_T, SCH_NO_CONNECT_T, SCH_PIN_T, SCH_RULE_AREA_T, SCH_SHAPE_T, SCH_SHEET_T, SCH_SYMBOL_T, SCH_TABLE_T, SCH_TABLECELL_T, SCH_TEXT_T, SCH_TEXTBOX_T, and traceApi.

Referenced by LIB_SYMBOL::Deserialize(), SCH_SYMBOL::Deserialize(), FOOTPRINT::DeserializeDefinition(), API_HANDLER_BOARD::handleCreateUpdateItemsInternal(), and API_HANDLER_SCH::handleCreateUpdateItemsInternal().

◆ UnpackBox2()

KICOMMON_API BOX2I kiapi::common::UnpackBox2 ( const types::Box2 & aInput,
const EDA_IU_SCALE & aScale )

Definition at line 175 of file api_utils.cpp.

References KICOMMON_API, and UnpackVector2().

◆ UnpackColor()

KICOMMON_API KIGFX::COLOR4D kiapi::common::UnpackColor ( const types::Color & aInput)

Definition at line 294 of file api_utils.cpp.

References KICOMMON_API.

Referenced by EDA_SHAPE::Deserialize(), NETCLASS::Deserialize(), SCH_BUS_ENTRY_BASE::Deserialize(), SCH_JUNCTION::Deserialize(), SCH_LINE::Deserialize(), SCH_SHEET::Deserialize(), SCH_TEXTBOX::Deserialize(), UnpackStroke(), and UnpackTextAttributes().

◆ UnpackCustomProperties()

KICOMMON_API void kiapi::common::UnpackCustomProperties ( const google::protobuf::RepeatedPtrField< types::CustomProperty > & aInput,
EDA_ITEM & aItem )

Definition at line 425 of file api_utils.cpp.

References KICOMMON_API, and EDA_ITEM::SetCustomProperties().

Referenced by FOOTPRINT::Deserialize(), PAD::Deserialize(), PCB_ARC::Deserialize(), PCB_BARCODE::Deserialize(), PCB_CONSTRAINT::Deserialize(), PCB_DIMENSION_BASE::Deserialize(), PCB_FIELD::Deserialize(), PCB_GRID_ITEM::Deserialize(), PCB_POINT::Deserialize(), PCB_REFERENCE_IMAGE::Deserialize(), PCB_SHAPE::Deserialize(), PCB_TABLE::Deserialize(), PCB_TABLECELL::Deserialize(), PCB_TEXT::Deserialize(), PCB_TEXTBOX::Deserialize(), PCB_TRACK::Deserialize(), PCB_VIA::Deserialize(), SCH_BITMAP::Deserialize(), SCH_BUS_ENTRY_BASE::Deserialize(), SCH_DIRECTIVE_LABEL::Deserialize(), SCH_GLOBALLABEL::Deserialize(), SCH_HIERLABEL::Deserialize(), SCH_JUNCTION::Deserialize(), SCH_LABEL::Deserialize(), SCH_LINE::Deserialize(), SCH_NO_CONNECT::Deserialize(), SCH_PIN::Deserialize(), SCH_RULE_AREA::Deserialize(), SCH_SHAPE::Deserialize(), SCH_SHEET::Deserialize(), SCH_SYMBOL::Deserialize(), SCH_TABLE::Deserialize(), SCH_TABLECELL::Deserialize(), SCH_TEXT::Deserialize(), SCH_TEXTBOX::Deserialize(), ZONE::Deserialize(), PCB_GROUP::DeserializeGroup(), and SCH_GROUP::DeserializeGroup().

◆ UnpackDistance()

KICOMMON_API int kiapi::common::UnpackDistance ( const types::Distance & aInput,
const EDA_IU_SCALE & aScale )

Definition at line 187 of file api_utils.cpp.

References KICOMMON_API, and EDA_IU_SCALE::NmToIU().

Referenced by EDA_SHAPE::Deserialize(), LIB_SYMBOL::Deserialize(), NETCLASS::Deserialize(), PCB_DRILL_CHART::Deserialize(), PCB_DRILL_MAP::Deserialize(), PCB_GRID_ITEM::Deserialize(), SCH_BUS_ENTRY_BASE::Deserialize(), SCH_DIRECTIVE_LABEL::Deserialize(), SCH_JUNCTION::Deserialize(), SCH_LINE::Deserialize(), SCH_NO_CONNECT::Deserialize(), SCH_PIN::Deserialize(), SCH_SHEET::Deserialize(), SCH_SYMBOL::Deserialize(), SCH_TABLE::Deserialize(), SCH_TEXTBOX::Deserialize(), UnpackLineEnding(), UnpackStroke(), and UnpackTextAttributes().

◆ UnpackLibId()

KICOMMON_API LIB_ID kiapi::common::UnpackLibId ( const types::LibraryIdentifier & aId)

Definition at line 128 of file api_utils.cpp.

References KICOMMON_API.

Referenced by applySymbolVariants(), LIB_SYMBOL::Deserialize(), SCH_SYMBOL::Deserialize(), FOOTPRINT::DeserializeDefinition(), PCB_GROUP::DeserializeGroup(), CLI::API_SERVER_COMMAND::doPerform(), API_HANDLER_PCB::handlePlaceFootprintFromLibrary(), and API_HANDLER_SCH::handlePlaceSymbolFromLibrary().

◆ UnpackLineEnding() [1/2]

KICOMMON_API LINE_ENDING kiapi::common::UnpackLineEnding ( const kiapi::common::types::LineEnding & aInput,
const EDA_IU_SCALE & aScale = pcbIUScale )

References KICOMMON_API, KiwayClientName, pcbIUScale, and StandaloneCrossProbeClientName.

◆ UnpackLineEnding() [2/2]

KICOMMON_API LINE_ENDING kiapi::common::UnpackLineEnding ( const types::LineEnding & aInput,
const EDA_IU_SCALE & aScale )

Definition at line 362 of file api_utils.cpp.

References FromProtoEnum(), KICOMMON_API, LINE_ENDING::SetLength(), LINE_ENDING::SetStroke(), LINE_ENDING::SetStyle(), LINE_ENDING::SetWidth(), UnpackDistance(), and UnpackStroke().

Referenced by EDA_SHAPE::Deserialize(), and SCH_LINE::Deserialize().

◆ UnpackPolyLine()

KICOMMON_API SHAPE_LINE_CHAIN kiapi::common::UnpackPolyLine ( const types::PolyLine & aInput,
const EDA_IU_SCALE & aScale )

Definition at line 216 of file api_utils.cpp.

References SHAPE_LINE_CHAIN::Append(), KICOMMON_API, SHAPE_LINE_CHAIN::SetClosed(), and UnpackVector2().

Referenced by UnpackPolySet().

◆ UnpackPolySet()

KICOMMON_API SHAPE_POLY_SET kiapi::common::UnpackPolySet ( const types::PolySet & aInput,
const EDA_IU_SCALE & aScale )

Definition at line 265 of file api_utils.cpp.

References SHAPE_POLY_SET::AddPolygon(), KICOMMON_API, and UnpackPolyLine().

Referenced by EDA_SHAPE::Deserialize(), and ZONE::Deserialize().

◆ UnpackSheetPath()

KICOMMON_API KIID_PATH kiapi::common::UnpackSheetPath ( const types::SheetPath & aInput)

Definition at line 312 of file api_utils.cpp.

References KICOMMON_API.

Referenced by FOOTPRINT::Deserialize(), kiapi::board::FindItemsFromSyncSelection(), SCH_MARKER::FromProto(), API_HANDLER_SCH::handleCreateUpdateItemsInternal(), API_HANDLER_SCH::handleExpandTextVariables(), API_HANDLER_SCH::handleGetDocumentModifiedState(), API_HANDLER_SCH::handleGetItems(), API_HANDLER_SCH::handleGetItemsById(), API_HANDLER_SCH::handlePlaceSymbolFromLibrary(), API_HANDLER_SCH::resolveScreenFromDocument(), and API_HANDLER_SCH::validateDocumentInternal().

◆ UnpackStroke() [1/2]

KICOMMON_API void kiapi::common::UnpackStroke ( STROKE_PARAMS & aOutput,
const kiapi::common::types::StrokeAttributes & aInput,
const EDA_IU_SCALE & aScale = pcbIUScale )

References KICOMMON_API, and pcbIUScale.

◆ UnpackStroke() [2/2]

KICOMMON_API void kiapi::common::UnpackStroke ( STROKE_PARAMS & aOutput,
const types::StrokeAttributes & aInput,
const EDA_IU_SCALE & aScale )

Definition at line 334 of file api_utils.cpp.

References FromProtoEnum(), KICOMMON_API, STROKE_PARAMS::SetColor(), STROKE_PARAMS::SetLineStyle(), STROKE_PARAMS::SetWidth(), UnpackColor(), UnpackDistance(), and KIGFX::COLOR4D::UNSPECIFIED.

Referenced by EDA_SHAPE::Deserialize(), PCB_TABLE::Deserialize(), SCH_TABLE::Deserialize(), and UnpackLineEnding().

◆ UnpackTextAttributes() [1/2]

void kiapi::common::UnpackTextAttributes ( TEXT_ATTRIBUTES & aOutput,
const kiapi::common::types::TextAttributes & aInput,
const EDA_IU_SCALE & aScale = pcbIUScale )

References pcbIUScale.

◆ UnpackTextAttributes() [2/2]

void kiapi::common::UnpackTextAttributes ( TEXT_ATTRIBUTES & aOutput,
const types::TextAttributes & aInput,
const EDA_IU_SCALE & aScale )

Definition at line 56 of file api_text_attributes.cpp.

References DEGREES_T, FromProtoEnum(), KIFONT::FONT::GetFont(), TEXT_ATTRIBUTES::m_Angle, TEXT_ATTRIBUTES::m_Bold, TEXT_ATTRIBUTES::m_Color, TEXT_ATTRIBUTES::m_Font, TEXT_ATTRIBUTES::m_Halign, TEXT_ATTRIBUTES::m_Italic, TEXT_ATTRIBUTES::m_KeepUpright, TEXT_ATTRIBUTES::m_LineSpacing, TEXT_ATTRIBUTES::m_Mirrored, TEXT_ATTRIBUTES::m_Multiline, TEXT_ATTRIBUTES::m_Size, TEXT_ATTRIBUTES::m_StrokeWidth, TEXT_ATTRIBUTES::m_Underlined, TEXT_ATTRIBUTES::m_Valign, UnpackColor(), UnpackDistance(), UnpackVector2(), and KIGFX::COLOR4D::UNSPECIFIED.

Referenced by EDA_TEXT::Deserialize(), and PCB_TEXTBOX::Deserialize().

◆ UnpackVector2()

KICOMMON_API VECTOR2I kiapi::common::UnpackVector2 ( const types::Vector2 & aInput,
const EDA_IU_SCALE & aScale )

Definition at line 148 of file api_utils.cpp.

References KICOMMON_API, and EDA_IU_SCALE::NmToIU().

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), EDA_SHAPE::Deserialize(), EDA_TEXT::Deserialize(), PAD::Deserialize(), PADSTACK::Deserialize(), PCB_BARCODE::Deserialize(), PCB_DIM_ALIGNED::Deserialize(), PCB_DIM_CENTER::Deserialize(), PCB_DIM_LEADER::Deserialize(), PCB_DIM_ORTHOGONAL::Deserialize(), PCB_DIM_RADIAL::Deserialize(), PCB_DRILL_MAP::Deserialize(), PCB_GRID_ITEM::Deserialize(), PCB_POINT::Deserialize(), PCB_REFERENCE_IMAGE::Deserialize(), PCB_TEXT::Deserialize(), PCB_TEXTBOX::Deserialize(), SCH_BITMAP::Deserialize(), SCH_BUS_ENTRY_BASE::Deserialize(), SCH_FIELD::Deserialize(), SCH_JUNCTION::Deserialize(), SCH_LINE::Deserialize(), SCH_NO_CONNECT::Deserialize(), SCH_PIN::Deserialize(), SCH_SHEET::Deserialize(), SCH_SHEET_PIN::Deserialize(), SCH_SYMBOL::Deserialize(), SCH_TEXT::Deserialize(), SCH_TEXTBOX::Deserialize(), ZONE::Deserialize(), PCB_MARKER::FromProto(), SCH_MARKER::FromProto(), API_HANDLER_COMMON::handleGetTextAsShapes(), API_HANDLER_EDITOR::handleHitTest(), API_HANDLER_PCB::handlePlaceFootprintFromLibrary(), API_HANDLER_SCH::handlePlaceSymbolFromLibrary(), API_HANDLER_PCB::handleSetBoardOrigin(), API_HANDLER_EDITOR::handleSetPageSettings(), UnpackBox2(), PADSTACK::unpackCopperLayer(), unpackLabel(), UnpackPolyLine(), and UnpackTextAttributes().

◆ UnpackVector3D()

KICOMMON_API VECTOR3D kiapi::common::UnpackVector3D ( const types::Vector3D & aInput)

Definition at line 162 of file api_utils.cpp.

References KICOMMON_API.

Referenced by FOOTPRINT::DeserializeDefinition(), and API_HANDLER_PCB::handleRunBoardJobExportRender().

Variable Documentation

◆ KiwayClientName

const KICOMMON_API std::string kiapi::common::KiwayClientName = "org.kicad.internal.kiway"

Definition at line 395 of file api_utils.cpp.

Referenced by API_HANDLER_PCB::handleHighlightNets(), API_HANDLER_SCH::handleHighlightNets(), PackKiwayApiMessage(), and UnpackLineEnding().

◆ StandaloneCrossProbeClientName

const KICOMMON_API std::string kiapi::common::StandaloneCrossProbeClientName = "org.kicad.internal.crossprobe"

Definition at line 396 of file api_utils.cpp.

Referenced by API_HANDLER_PCB::handleHighlightNets(), API_HANDLER_SCH::handleHighlightNets(), sendRequest(), and UnpackLineEnding().