From 6e25a00dae726fd8d6c6cd10f09fc20c48927de2 Mon Sep 17 00:00:00 2001 From: Thomas Fischer <thomas.fischer@ufz.de> Date: Tue, 28 Apr 2015 12:57:40 +0200 Subject: [PATCH] [GL] Improved docu for Newell alg. --- Documentation/Doxyfile.in | 2 +- Documentation/bibliography.bib | 8 ++++++++ GeoLib/AnalyticalGeometry.h | 3 ++- 3 files changed, 11 insertions(+), 2 deletions(-) create mode 100644 Documentation/bibliography.bib diff --git a/Documentation/Doxyfile.in b/Documentation/Doxyfile.in index c0bf72cf239..014864e6146 100644 --- a/Documentation/Doxyfile.in +++ b/Documentation/Doxyfile.in @@ -692,7 +692,7 @@ LAYOUT_FILE = ${CMAKE_SOURCE_DIR}/Documentation/DoxygenLayout.xml # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the # search path. See also \cite for info how to create references. -CITE_BIB_FILES = +CITE_BIB_FILES = ${PROJECT_SOURCE_DIR}/Documentation/bibliography #--------------------------------------------------------------------------- # Configuration options related to warning and progress messages diff --git a/Documentation/bibliography.bib b/Documentation/bibliography.bib new file mode 100644 index 00000000000..04937bd17ca --- /dev/null +++ b/Documentation/bibliography.bib @@ -0,0 +1,8 @@ +@book{Ericson:2004:RCD:1121584, + author = {Ericson, Christer}, + title = {Real-Time Collision Detection (The Morgan Kaufmann Series in Interactive 3-D Technology) (The Morgan Kaufmann Series in Interactive 3D Technology)}, + year = {2004}, + isbn = {1558607323}, + publisher = {Morgan Kaufmann Publishers Inc.}, + address = {San Francisco, CA, USA}, +} \ No newline at end of file diff --git a/GeoLib/AnalyticalGeometry.h b/GeoLib/AnalyticalGeometry.h index aea8be332bb..e07a73b4609 100644 --- a/GeoLib/AnalyticalGeometry.h +++ b/GeoLib/AnalyticalGeometry.h @@ -55,7 +55,8 @@ Orientation getOrientation (const GeoLib::Point* p0, /** * compute a supporting plane (represented by plane_normal and the value d) for the polygon * Let \f$n\f$ be the plane normal and \f$d\f$ a parameter. Then for all points \f$p \in R^3\f$ of the plane - * it holds \f$ n \cdot p + d = 0\f$ + * it holds \f$ n \cdot p + d = 0\f$. The Newell algorithm is described in + * \cite Ericson:2004:RCD:1121584 . * @param pnts points of a closed polyline describing a polygon * @param plane_normal the normal of the plane the polygon is located in * @param d parameter from the plane equation -- GitLab