mhu/gds-render
1
0
Fork 0
Code Issues 4 Pull Requests Releases 8 Wiki Activity

Doxygen: Update calculate_cell_bounding_box()

Browse Source 
* Add note about problematic behaviour
* Fix typos
This commit is contained in:
Mario Hüttel 2020-04-24 01:02:10 +02:00
parent ceeb67355d
commit 232d025211
1 changed files with 9 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
include/gds-render/geometric/cell-geometrics.h
View File

@ -35,10 +35,16 @@
#include <gds-render/gds-utils/gds-types.h>
/**
* @brief calculate_cell_bounding_box Calculate bounding box of gds cell
* @param box Resulting boundig box. Will be uüdated and not overwritten
* @brief Calculate bounding box of a gds cell.
*
* This function updates a given bounding box with the dimensions of a
* gds_cell. Please note that the handling of path miter points is not complete yet.
* If a path object is the putmost object of your cell at any edge,
* the resulting bounding box might be the wrong size.
*
* @param box Resulting boundig box. Will be updated and not overwritten
* @param cell Toplevel cell
* @warning Path handling not yet implemented correctly.
* @warning Handling of Path graphic objects not yet implemented correctly.
*/
void calculate_cell_bounding_box(union bounding_box *box, struct gds_cell *cell);