Revision: 65371
http://sourceforge.net/p/brlcad/code/65371
Author: n_reed
Date: 2015-06-17 22:20:28 +0000 (Wed, 17 Jun 2015)
Log Message:
-----------
add notes on point classes
Modified Paths:
--------------
brlcad/branches/brep-debug/doc/docbook/system/implementation/en/bool_eval_development.xml
Modified:
brlcad/branches/brep-debug/doc/docbook/system/implementation/en/bool_eval_development.xml
===================================================================
---
brlcad/branches/brep-debug/doc/docbook/system/implementation/en/bool_eval_development.xml
2015-06-17 21:26:30 UTC (rev 65370)
+++
brlcad/branches/brep-debug/doc/docbook/system/implementation/en/bool_eval_development.xml
2015-06-17 22:20:28 UTC (rev 65371)
@@ -135,6 +135,27 @@
</warning>
</section>
<section>
+ <title>Geometry</title>
+ <section>
+ <title>2D and 3D Points</title>
+ <para>
+ The <classname>ON_2dPoint</classname> and
<classname>ON_3dPoint</classname> classes implement the expected operators
allowing points to be easily summed and scaled.
+ </para>
+ <para>
+ The <function>operator[]</function> functions are notable because
coordinates are not actually stored as arrays in these classes, but rather in
the named members <varname>x</varname>, <varname>y</varname>, and
<varname>z</varname>. So while accessing coordinates as
<varname>pt[0]</varname>, <varname>pt[1]</varname> is possible, the more
readable <varname>pt.x</varname>, <varname>pt.y</varname>, is more typically
seen.
+ </para>
+
+ <para>
+ The most frequently used member function is
<function><![CDATA[DistanceTo(const ON_3dPoint &p)]]></function>, used to check
inter-point distances, either as part of an intersection test or to identify
closeable gaps or duplicate points.
+ </para>
+ <note>
+ <para>
+ <classname>ON_2dPoint</classname> objects can be, and are, safely
passed to functions that take <classname>ON_3dPoint</classname> arguments. The
<classname>ON_3dPoint</classname> arguments are constructed from the provided
<classname>ON_2dPoint</classname> objects, wth their <varname>z</varname>
coordinates set to 0.
+ </para>
+ </note>
+ </section>
+ </section>
+ <section>
<title>Pitfalls</title>
<para>Mistakes made.</para>
</section>
This was sent by the SourceForge.net collaborative development platform, the
world's largest Open Source development site.
------------------------------------------------------------------------------
_______________________________________________
BRL-CAD Source Commits mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/brlcad-commits
