luke/klayout
1
0
Fork 0
mirror of https://github.com/KLayout/klayout.git synced 2026-09-02 19:28:37 +02:00
Code Issues Packages Projects Releases Wiki Activity

Clarify documentation.

Browse Source
This commit is contained in:
Matthias Koefferlein
2026-08-20 09:44:24 +02:00
parent 6b4e3b6e2a
commit 1b48dcb4cd
2 changed files with 5 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/db/db/dbBoxScanner.h
+3 -3
View File
@@ -297,10 +297,10 @@ public:
* @brief Get the interactions between the stored objects
*
* Two objects interact if the boxes of the objects enlarged by the given value overlap.
* The enlargement is specified in units of width and height, i.e. half of the enlargement
* is applied to one side before the overlap check.
*
* An enlargement of 1 means that boxes have to touch only in order to get an interaction.
* An enlargement of 1 means that boxes have to touch in order to get an interaction.
* An enlargement of 0 means that boxes have to overlap in order to get an interaction.
* To capture interactions between object precisely spaced d, use d+1 for the enlargement.
*
* The box scanner will report all interactions to the receiver object. See box_scanner_receiver
* for details about the methods that this object must provide.
src/db/db/dbLocalOperation.h
+2 -1
View File
@@ -114,7 +114,8 @@ public:
/**
* @brief Gets the interaction distance
* A distance of means the shapes must overlap in order to interact.
* A distance of zero means the shapes must overlap in order to interact.
* A distance of 1 means the shapes need to touch in order to interact.
*/
virtual db::Coord dist () const { return 0; }