KiCad PCB EDA Suite
Loading...
Searching...
No Matches
KICAD_DIFF::SCENE_SHAPE Struct Reference

Shared rendering model consumed by both the GAL renderer (interactive widget) and the plotter renderer (headless PNG/SVG output). More...

#include <diff_scene.h>

Public Types

using PolygonList = std::vector<std::vector<std::vector<VECTOR2I>>>
 

Public Attributes

BOX2I bbox
 
KIGFX::COLOR4D color
 
wxString label
 
KIID_PATH changeId
 Stable identifier of the ITEM_CHANGE that produced this shape.
 
PolygonList polygons
 

Detailed Description

Shared rendering model consumed by both the GAL renderer (interactive widget) and the plotter renderer (headless PNG/SVG output).

The scene is a flat list of "shapes to draw" derived from a DOCUMENT_DIFF. Currently each shape is just a colored rectangle around the changed item's bbox; a future revision can pull the actual item geometry from the source board/schematic for a true overlay render.

Color palette is set by the consumer (UI colors come from the user's theme; CLI uses a fixed printable-on-light-bg default).

Definition at line 89 of file diff_scene.h.

Member Typedef Documentation

◆ PolygonList

using KICAD_DIFF::SCENE_SHAPE::PolygonList = std::vector<std::vector<std::vector<VECTOR2I>>>

Definition at line 101 of file diff_scene.h.

Member Data Documentation

◆ bbox

BOX2I KICAD_DIFF::SCENE_SHAPE::bbox

◆ changeId

KIID_PATH KICAD_DIFF::SCENE_SHAPE::changeId

Stable identifier of the ITEM_CHANGE that produced this shape.

Used by the interactive widgets to cross-probe between change tree selection and the rendered scene without relying on bbox equality (two distinct changes can share an enclosing rectangle).

Definition at line 99 of file diff_scene.h.

Referenced by WIDGET_DIFF_CANVAS::onMotion(), and DIALOG_KICAD_MERGE_3WAY::rebuildCanvas().

◆ color

KIGFX::COLOR4D KICAD_DIFF::SCENE_SHAPE::color

◆ label

wxString KICAD_DIFF::SCENE_SHAPE::label

Definition at line 93 of file diff_scene.h.

Referenced by BOOST_AUTO_TEST_CASE().

◆ polygons

PolygonList KICAD_DIFF::SCENE_SHAPE::polygons

Definition at line 102 of file diff_scene.h.


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