#include <diff_scene.h>

Public Attributes
DOC_KIND	docKind = DOC_KIND::PCB
	Source document type.

BOX2I	documentBBox

std::vector< SCENE_SHAPE >	addedShapes

std::vector< SCENE_SHAPE >	removedShapes

std::vector< SCENE_SHAPE >	modifiedShapes

std::vector< SCENE_SHAPE >	conflictShapes

DOCUMENT_GEOMETRY	referenceGeometry
	Background geometry from the two source documents.

DOCUMENT_GEOMETRY	comparisonGeometry

Detailed Description

Definition at line 219 of file diff_scene.h.

Member Data Documentation

◆ addedShapes

std::vector<SCENE_SHAPE> KICAD_DIFF::DIFF_SCENE::addedShapes

Definition at line 230 of file diff_scene.h.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), KICAD_DIFF::BuildScene(), and KICAD_DIFF::ShapesFor().

◆ comparisonGeometry

DOCUMENT_GEOMETRY KICAD_DIFF::DIFF_SCENE::comparisonGeometry

Definition at line 240 of file diff_scene.h.

Referenced by BOOST_AUTO_TEST_CASE(), DIALOG_KICAD_DIFF::DIALOG_KICAD_DIFF(), KICAD_DIFF::EmitDiffResult(), KICAD_DIFF::ExpandBBoxToGeometry(), DIALOG_KICAD_DIFF::Reload(), KICAD_DIFF::RenderSceneToOverlay(), KICAD_DIFF::RenderSceneToPng(), and KICAD_DIFF::RenderSceneToSvg().

◆ conflictShapes

std::vector<SCENE_SHAPE> KICAD_DIFF::DIFF_SCENE::conflictShapes

Definition at line 233 of file diff_scene.h.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), KICAD_DIFF::BuildScene(), DIALOG_KICAD_MERGE_3WAY::rebuildCanvas(), and KICAD_DIFF::ShapesFor().

◆ docKind

DOC_KIND KICAD_DIFF::DIFF_SCENE::docKind = DOC_KIND::PCB

Source document type.

Selects the internal-unit scale the headless plotter renderer uses to size its viewport; PCB and schematic carry different IU-per-distance ratios, so a scene built from schematic coordinates must say so or the PNG/SVG output mis-scales. The GAL overlay renderer works in raw IU and ignores this. Defaults to PCB so existing board scenes keep their current output.

Definition at line 227 of file diff_scene.h.

Referenced by KICAD_DIFF::EmitDiffResult(), KICAD_DIFF::RenderSceneToPng(), and KICAD_DIFF::RenderSceneToSvg().

◆ documentBBox

BOX2I KICAD_DIFF::DIFF_SCENE::documentBBox

Definition at line 229 of file diff_scene.h.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), KICAD_DIFF::BuildScene(), KICAD_DIFF::ExpandBBoxToGeometry(), KICAD_DIFF::RenderSceneToPng(), and KICAD_DIFF::RenderSceneToSvg().

◆ modifiedShapes

std::vector<SCENE_SHAPE> KICAD_DIFF::DIFF_SCENE::modifiedShapes

Definition at line 232 of file diff_scene.h.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), KICAD_DIFF::BuildScene(), and KICAD_DIFF::ShapesFor().

◆ referenceGeometry

DOCUMENT_GEOMETRY KICAD_DIFF::DIFF_SCENE::referenceGeometry

Background geometry from the two source documents.

Optional — the scene renders fine without it (just the change rectangles). When populated, renderers draw these first, in a dimmed style, so the diff rectangles read as annotations on the actual content.

Definition at line 239 of file diff_scene.h.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), DIALOG_KICAD_DIFF::DIALOG_KICAD_DIFF(), KICAD_DIFF::EmitDiffResult(), KICAD_DIFF::ExpandBBoxToGeometry(), DIALOG_KICAD_MERGE_3WAY::rebuildCanvas(), DIALOG_KICAD_DIFF::Reload(), KICAD_DIFF::RenderSceneToOverlay(), KICAD_DIFF::RenderSceneToPng(), and KICAD_DIFF::RenderSceneToSvg().

◆ removedShapes

std::vector<SCENE_SHAPE> KICAD_DIFF::DIFF_SCENE::removedShapes

Definition at line 231 of file diff_scene.h.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), KICAD_DIFF::BuildScene(), and KICAD_DIFF::ShapesFor().

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

diff_scene.h

Public Attributes