kiapi::common Namespace Reference

Functions
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	PackProject (types::ProjectSpecifier &aOutput, const PROJECT &aInput)

Function Documentation

PackBox2()

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

Definition at line 143 of file api_utils.cpp.

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

Referenced by API_HANDLER_PCB::handleGetBoundingBox().

PackColor()

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

Definition at line 263 of file api_utils.cpp.

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

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

PackDistance()

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

Definition at line 156 of file api_utils.cpp.

References EDA_IU_SCALE::IUToNm(), and KICOMMON_API.

Referenced by EDA_SHAPE::Serialize(), EDA_TEXT::Serialize(), NETCLASS::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(), and SCH_TEXTBOX::Serialize().

PackLibId()

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

Definition at line 109 of file api_utils.cpp.

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

Referenced by FOOTPRINT::Serialize(), and SCH_SYMBOL::Serialize().

PackPolyLine()

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

Definition at line 168 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, SHAPE_LINE_CHAIN::NextShape(), PackVector2(), and SHAPE_LINE_CHAIN::PointCount().

Referenced by API_HANDLER_PCB::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 219 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 300 of file api_utils.cpp.

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

Referenced by API_HANDLER_SCH::handleGetOpenDocuments().

PackSheetPath()

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

Definition at line 282 of file api_utils.cpp.

References KICOMMON_API.

Referenced by API_HANDLER_SCH::handleGetOpenDocuments(), API_HANDLER_SCH::handleGetSchematicNetlist(), PackSheet(), API_HANDLER_SCH::packSheetInstance(), PackSymbol(), and FOOTPRINT::Serialize().

PackVector2()

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

Definition at line 116 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(), API_HANDLER_PCB::handleGetBoardOrigin(), API_HANDLER_EDITOR::handleGetPageSettings(), API_HANDLER_COMMON::handleGetTextAsShapes(), API_HANDLER_EDITOR::handleSetPageSettings(), PackBox2(), packLabel(), PackPolyLine(), 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_REFERENCE_IMAGE::Serialize(), PCB_TEXT::Serialize(), PCB_TEXTBOX::Serialize(), SCH_BITMAP::Serialize(), SCH_BUS_ENTRY_BASE::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(), and ZONE::Serialize().

PackVector3D()

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

Definition at line 129 of file api_utils.cpp.

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

Referenced by FOOTPRINT::Serialize().

TypeNameFromAny()

KICOMMON_API std::optional< KICAD_T > kiapi::common::TypeNameFromAny

(

const google::protobuf::Any &

aMessage

)

Definition at line 35 of file api_utils.cpp.

References KICOMMON_API, PCB_ARC_T, PCB_BARCODE_T, PCB_DIMENSION_T, PCB_FIELD_T, PCB_FOOTPRINT_T, PCB_GROUP_T, PCB_PAD_T, PCB_REFERENCE_IMAGE_T, PCB_SHAPE_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_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_SHAPE_T, SCH_SHEET_T, SCH_SYMBOL_T, SCH_TABLE_T, SCH_TEXT_T, SCH_TEXTBOX_T, and traceApi.

Referenced by FOOTPRINT::Deserialize(), SCH_SYMBOL::Deserialize(), API_HANDLER_PCB::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 150 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 272 of file api_utils.cpp.

References KICOMMON_API.

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

UnpackDistance()

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

Definition at line 162 of file api_utils.cpp.

References KICOMMON_API, and EDA_IU_SCALE::NmToIU().

Referenced by EDA_SHAPE::Deserialize(), EDA_TEXT::Deserialize(), NETCLASS::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(), and SCH_TEXTBOX::Deserialize().

UnpackLibId()

KICOMMON_API LIB_ID kiapi::common::UnpackLibId

(

const types::LibraryIdentifier &

aId

)

Definition at line 103 of file api_utils.cpp.

References KICOMMON_API.

Referenced by FOOTPRINT::Deserialize(), and SCH_SYMBOL::Deserialize().

UnpackPolyLine()

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

Definition at line 194 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 243 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 290 of file api_utils.cpp.

References KICOMMON_API, and output.

Referenced by FOOTPRINT::Deserialize(), API_HANDLER_SCH::handleCreateUpdateItemsInternal(), API_HANDLER_SCH::handleGetItems(), API_HANDLER_SCH::handleGetItemsById(), UnpackSheet(), UnpackSymbol(), and API_HANDLER_SCH::validateDocumentInternal().

UnpackVector2()

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

Definition at line 123 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_REFERENCE_IMAGE::Deserialize(), PCB_TEXT::Deserialize(), PCB_TEXTBOX::Deserialize(), SCH_BITMAP::Deserialize(), SCH_BUS_ENTRY_BASE::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(), API_HANDLER_COMMON::handleGetTextAsShapes(), API_HANDLER_EDITOR::handleHitTest(), API_HANDLER_PCB::handleSetBoardOrigin(), API_HANDLER_EDITOR::handleSetPageSettings(), UnpackBox2(), PADSTACK::unpackCopperLayer(), unpackLabel(), and UnpackPolyLine().

UnpackVector3D()

KICOMMON_API VECTOR3D kiapi::common::UnpackVector3D

(

const types::Vector3D &

aInput

)

Definition at line 137 of file api_utils.cpp.

References KICOMMON_API.

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