Editing Deuces
From BRL-CAD
Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.
The edit can be undone.
Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.
Latest revision | Your text | ||
Line 1: | Line 1: | ||
− | + | This is a list of succinct tasks that are expected to take most people familiar with the prerequisites less than two hours to complete. It's a great starting point for anyone interested in contributing to BRL-CAD. | |
− | + | The tasks are all roughly the same complexity with '''''no prior BRL-CAD experience expected'''''. A description is provided along with a list of references and files you'll probably need to edit. Can we make it any easier? | |
− | = | + | = Getting Started = |
− | + | Contact us (via [[IRC]] or [[Mailing_Lists|brlcad-devel mailing list]]) if you have questions, comments, or ideas of your own you'd like to suggest. | |
+ | |||
+ | We've made an awesome virtual disk image that has everything you need preconfigured and ready to go: | ||
# [https://sourceforge.net/projects/brlcad/files/BRL-CAD%20for%20Virtual%20Machines/ Download our BRL-CAD Virtual Machine (VM) disk image.] | # [https://sourceforge.net/projects/brlcad/files/BRL-CAD%20for%20Virtual%20Machines/ Download our BRL-CAD Virtual Machine (VM) disk image.] | ||
# [https://www.virtualbox.org/wiki/Downloads Install VirtualBox.] | # [https://www.virtualbox.org/wiki/Downloads Install VirtualBox.] | ||
− | # Import | + | # Import and start the VM, log in (the password is "Brlcad!" without the quotes). |
− | # Run "svn up brlcad | + | # Run "svn up brlcad.svn" and get started! |
− | = Pick a Task = | + | =Pick a Task= |
− | + | We break down all tasks into one of five categories. Don't be worried if the tasks all sound confusing to you. Just pick one and start reading the references we've provided. Join IRC or our mailing list and ask questions. | |
− | + | # Code (programming) | |
− | + | # Documentation and Training (writing) | |
− | + | # Outreach and Research (graphics) | |
− | + | # Quality Assurance (testing) | |
− | + | # User Interface (designing) | |
__TOC__ | __TOC__ | ||
+ | ---- | ||
== Code == | == Code == | ||
+ | ---- | ||
''Tasks related to writing or refactoring code'' | ''Tasks related to writing or refactoring code'' | ||
See the When You're Done section above for details on submitting your changes. | See the When You're Done section above for details on submitting your changes. | ||
+ | | ||
+ | {| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%" | ||
+ | | | ||
+ | === Fix bounding box function for our polygonal mesh (BoT) primitive === | ||
+ | |||
+ | BRL-CAD provides functions for its geometric primitives that define a bounding box - a box that completely encloses the volume described by the primitive. Ideally, these boxes are as small as possible while still enclosing the primitive. Currently the routine for BoTs is incorrect. You can use stl-g, obj-g, or any of our other *-g converters to import BoT geometry for testing. | ||
+ | |||
+ | This task involves studying the current code for the function rt_bot_bbox() and determining what is causing the current inaccuracies (the mged 'bb' command is a good way to visualize primitive bounding boxes). Make changes to produce a more optimal bounding box. Reimplement it from scratch if you like. The raytracing prep code in rt_bot_prep does prepare a better bounding box, so that is one place to check. | ||
+ | |||
+ | Code: | ||
+ | * src/librt/primitives/bot/bot.c | ||
− | {| style="background-color:# | + | |} |
− | + | | |
− | === Close MGED | + | |
+ | {| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%" | ||
+ | | | ||
+ | === Close MGED when both windows are closed === | ||
− | BRL-CAD has an interactive geometry editor called MGED. It's often the starting point for beginners and allows creation and manipulation of models using commands. When ''mged'' is run, it creates 2 windows: a text console | + | BRL-CAD has an interactive geometry editor called MGED. It's often the starting point for beginners and allows creation and manipulation of models using commands. When ''mged'' is run, it creates 2 windows: a text-console command window and an interactive graphics window. When the user closes one of those windows, there is a bug. Closing the graphics window closes the command window. |
− | This task involves | + | This task involves fixing this behavior so that ONLY closing ''both'' windows terminates the process properly and that closing either window does not take the other along with it. |
Code: | Code: | ||
* src/mged/mged.c | * src/mged/mged.c | ||
− | * src/tclscripts/mged/openw. | + | * src/tclscripts/mged/openw.c |
− | |||
+ | |} | ||
| | ||
+ | {| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%" | ||
+ | | | ||
+ | === Add MGED key-binding to reopen the command window === | ||
+ | |||
+ | BRL-CAD has an interactive geometry editor called MGED. It's often the starting point for beginners and allows creation and manipulation of models using commands. When MGED is invoked, it creates 2 windows: a text-console command window and an interactive graphics window. If the user closes the text-console command window, they are left with the interactive graphics window. There is presently no way (correct us if we're wrong) to get the text-console back without restarting mged. A good way to test this is to run in classic mode and run the 'gui' command: | ||
+ | |||
+ | sushi:~ morrison$ mged -c test.g | ||
+ | BRL-CAD Release 7.22.0 Geometry Editor (MGED) | ||
+ | Fri, 24 Aug 2012 00:02:42 -0400, Compilation 6 | ||
+ | morrison@sushi.local:/usr/brlcad/rel-7.22.0 | ||
+ | |||
+ | attach (nu|X|ogl)[nu]? | ||
+ | mged> gui | ||
+ | |||
+ | This task involves adding some mechanism, perhaps a simple key binding, to the graphics window so that you can get the command window back on-demand. | ||
+ | |||
+ | Code: | ||
+ | * src/mged/mged.c | ||
+ | * src/tclscripts/mged/openw.c | ||
+ | |||
|} | |} | ||
+ | |||
| | ||
+ | {| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%" | ||
+ | | | ||
− | + | === Implement a primitive surface area function === | |
− | |||
− | === Implement a primitive | ||
− | BRL-CAD provides more than two dozen types of geometry "primitives" such as ellipsoids, boxes, and cones. Every primitive is described by a collection of callback functions, for example | + | BRL-CAD provides more than two dozen types of geometry "primitives" such as ellipsoids, boxes, and cones. Every primitive is described by a collection of callback functions, for example rt_ell_bbox() returns the bounding box dimensions for an ellipsoid. Wikipedia, Wolfram Mathworld, and various other math sites (and research papers) around the web include the equations for most of our basic primitives while others are a little more tricky to compute. |
− | This task involves writing a new callback function that takes an rt_db_internal object and calculates | + | This task involves writing a new callback function that takes an rt_db_internal object and calculates the surface area (units are mm^2). There are numerous examples in our code where we compute surface area for other primitives. The primitives that do not already have a centroid callback are itemized in following. |
References: | References: | ||
− | * http://en.wikipedia.org/wiki/ | + | * http://en.wikipedia.org/wiki/Surface_area |
* http://mathworld.wolfram.com/ | * http://mathworld.wolfram.com/ | ||
− | * include/raytrace.h: See | + | * http://www.dtic.mil/cgi-bin/GetTRDoc?AD=AD0274936 |
+ | * include/raytrace.h: See ft_surf_area callback defined in the rt_functab structure | ||
+ | |||
+ | | ||
+ | {| cellpadding="20" cellspacing="0" border="2" width="100%" | ||
+ | | | ||
+ | ==== ... surface area function for elliptical hyperboloids (EHY) ==== | ||
Code: | Code: | ||
− | * src/librt/primitives/ | + | * src/librt/primitives/ehy/ehy.c |
− | + | ||
+ | |} | ||
| | ||
+ | {| cellpadding="20" cellspacing="0" border="2" width="100%" | ||
+ | | | ||
+ | ==== ... surface area function for hyperboloids of one sheet (HYP) ==== | ||
+ | |||
+ | Code: | ||
+ | * src/librt/primitives/hyp/hyp.c | ||
+ | |||
|} | |} | ||
+ | |||
| | ||
+ | {| cellpadding="20" cellspacing="0" border="2" width="100%" | ||
+ | | | ||
+ | ==== ... surface area function for N-faced polysolid (ARBN) ==== | ||
− | + | Code: | |
− | + | * src/librt/primitives/arbn/arbn.c | |
− | |||
− | + | |} | |
+ | | ||
+ | {| cellpadding="20" cellspacing="0" border="2" width="100%" | ||
+ | | | ||
+ | ==== ... surface area function for extruded bitmaps (EBM) ==== | ||
− | + | Code: | |
− | * | + | * src/librt/primitives/ebm/ebm.c |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | + | |} | |
− | + | | |
− | + | {| cellpadding="20" cellspacing="0" border="2" width="100%" | |
− | + | | | |
− | + | ==== ... surface area function for gridded volumes (VOL) ==== | |
Code: | Code: | ||
− | * src/librt/primitives/ | + | * src/librt/primitives/vol/vol.c |
− | |||
+ | |} | ||
| | ||
+ | {| cellpadding="20" cellspacing="0" border="2" width="100%" | ||
+ | | | ||
+ | ==== ... surface area function for super ellipsoids (SUPERELL) ==== | ||
+ | |||
+ | Code: | ||
+ | * src/librt/primitives/superell/superell.c | ||
+ | |||
|} | |} | ||
| | ||
+ | {| cellpadding="20" cellspacing="0" border="2" width="100%" | ||
+ | | | ||
+ | ==== ... surface area function for polygonal meshes (NMG) ==== | ||
− | + | Code: | |
− | + | * src/librt/primitives/nmg/nmg.c | |
− | |||
− | + | |} | |
− | + | | |
− | + | {| cellpadding="20" cellspacing="0" border="2" width="100%" | |
− | + | | | |
− | + | ==== ... surface area function for NURBS objects (BREP) ==== | |
− | |||
Code: | Code: | ||
− | * src/librt/primitives/ | + | * src/librt/primitives/brep/brep.cpp |
− | |||
− | |||
− | |||
|} | |} | ||
+ | |} | ||
+ | |||
| | ||
+ | {| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%" | ||
+ | | | ||
+ | === Implement a primitive volume function === | ||
− | + | BRL-CAD provides more than two dozen types of geometry "primitives" such as ellipsoids, boxes, and cones. Every primitive is described by a collection of callback functions, for example rt_ell_bbox() returns the bounding box dimensions for an ellipsoid. Wikipedia, Wolfram Mathworld, and various other math sites (and research papers) around the web include the equations for most of our basic primitives while others are a little more difficult to compute. | |
− | |||
− | |||
− | + | This task involves writing a new callback function that takes an rt_db_internal object and calculates the volume (units are mm^3). There are numerous examples in our code where we compute volume for other primitives. The primitives that do not already have a volume callback are itemized in following. | |
− | + | References: | |
− | + | * http://en.wikipedia.org/wiki/Volume | |
− | + | * http://mathworld.wolfram.com/ | |
− | + | * http://www.dtic.mil/cgi-bin/GetTRDoc?AD=AD0274936 | |
− | + | * include/raytrace.h: See ft_volume callback defined in rt_functab structure | |
− | + | {| cellpadding="20" cellspacing="0" border="2" width="100%" | |
+ | | | ||
+ | ==== ... volume function for elliptical hyperboloids (EHY) ==== | ||
Code: | Code: | ||
− | * src/librt/primitives/ | + | * src/librt/primitives/ehy/ehy.c |
− | + | ||
+ | |} | ||
| | ||
+ | {| cellpadding="20" cellspacing="0" border="2" width="100%" | ||
+ | | | ||
+ | ==== ... volume function for superellipsoids (SUPERELL) ==== | ||
+ | |||
+ | Code: | ||
+ | * src/librt/primitives/superell/superell.c | ||
+ | |||
|} | |} | ||
| | ||
+ | {| cellpadding="20" cellspacing="0" border="2" width="100%" | ||
+ | | | ||
+ | ==== ... volume function for extruded bitmaps (EBM) ==== | ||
− | + | Code: | |
− | + | * src/librt/primitives/ebm/ebm.c | |
− | |||
− | + | |} | |
− | + | | |
− | + | {| cellpadding="20" cellspacing="0" border="2" width="100%" | |
− | + | | | |
− | + | ==== ... volume function for triangle meshes (BOT) ==== | |
− | + | Code: | |
+ | * src/librt/primitives/bot/bot.c | ||
+ | |||
+ | |} | ||
+ | | ||
+ | {| cellpadding="20" cellspacing="0" border="2" width="100%" | ||
+ | | | ||
+ | ==== ... volume function for solid polygonal meshes (NMG) ==== | ||
− | + | Code: | |
− | * | + | * src/librt/primitives/nmg/nmg.c |
− | |||
− | |||
− | |||
− | |||
|} | |} | ||
| | ||
+ | {| cellpadding="20" cellspacing="0" border="2" width="100%" | ||
+ | | | ||
+ | ==== ... volume function for extruded sketches (EXTRUDE) ==== | ||
− | + | Code: | |
− | + | * src/librt/primitives/extrude/extrude.c | |
− | + | |} | |
− | + | |} | |
+ | | ||
+ | {| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%" | ||
+ | | | ||
− | + | === Implement a primitive centroid function === | |
− | + | BRL-CAD provides more than two dozen types of geometry "primitives" such as ellipsoids, boxes, and cones. Every primitive is described by a collection of callback functions, for example rt_ell_bbox() returns the bounding box dimensions for an ellipsoid. Wikipedia, Wolfram Mathworld, and various other math sites (and research papers) around the web include the equations for most of our basic primitives while others are a little more tricky to compute. | |
− | + | This task involves writing a new callback function that takes an rt_db_internal object and calculates its centroid (as a point_t 3D point). There are numerous examples in our code where we compute centroids for other primtiives. The primitives that do not already have a centroid callback are itemized in following. | |
References: | References: | ||
− | * | + | * http://en.wikipedia.org/wiki/Centroid |
+ | * http://mathworld.wolfram.com/ | ||
+ | * include/raytrace.h: See ft_centroid callback defined in the rt_functab structure | ||
− | Code | + | Code: |
− | * src/ | + | * src/librt/primitives/table.c |
− | * src/ | + | * src/librt/primitives/[PRIMITIVE]/[PRIMITIVE].c |
− | |||
+ | |||
+ | {| cellpadding="20" cellspacing="0" border="2" width="100%" | ||
+ | | | ||
+ | ==== ... centroid function for right hyperbolic cylinders (RHC) ==== | ||
+ | |} | ||
+ | | ||
+ | {| cellpadding="20" cellspacing="0" border="2" width="100%" | ||
+ | | | ||
+ | ==== ... centroid function for gridded volumes (VOL) ==== | ||
+ | |} | ||
| | ||
+ | {| cellpadding="20" cellspacing="0" border="2" width="100%" | ||
+ | | | ||
+ | ==== ... centroid function for N-faced polysolids (ARBN) ==== | ||
|} | |} | ||
| | ||
+ | {| cellpadding="20" cellspacing="0" border="2" width="100%" | ||
+ | | | ||
+ | ==== ... centroid function for extruded sketches (EXTRUDE) ==== | ||
+ | |} | ||
+ | | ||
+ | {| cellpadding="20" cellspacing="0" border="2" width="100%" | ||
+ | | | ||
+ | ==== ... centroid function for superellipsoids (SUPERELL) ==== | ||
+ | |} | ||
+ | | ||
+ | {| cellpadding="20" cellspacing="0" border="2" width="100%" | ||
+ | | | ||
+ | ==== ... centroid function for solid polygonal meshes (NMG) ==== | ||
+ | |} | ||
+ | | ||
+ | |||
+ | |} | ||
+ | | ||
+ | {| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%" | ||
+ | | | ||
− | + | === Implement a primitive UV-mapping callback === | |
− | |||
− | + | BRL-CAD provides more than two dozen types of geometry "primitives" such as ellipsoids, boxes, and cones. Every primitive is described by a collection of callback functions, for example rt_ell_bbox() returns the bounding box dimensions for an ellipsoid. One of those functions describes a UV mapping of the object's surface, which is used for things like texture and bump mapping. An example of this is rt_ell_uv() in the src/librt/primitives/ell/ell.c source file for an ellipsoid. Several of our more complex primitive types (such as BoT, NMG, and BREP/NURBS) do not presently implement a UV-mapping function leading to unexpected runtime behavior. | |
− | + | This task involves implementing a UV-mapping callback for any of the primitives that do not already have a functional UV-callback defined. Note that this is an advanced task that might take you more than a couple hours if you don't have solid coding skills, but it's ultimately just a few lines of code. See other primitives that already implement a UV-mapping callback for reference. | |
− | + | References: | |
+ | * http://en.wikipedia.org/wiki/UV_mapping | ||
+ | * src/librt/primitives/[PRIMITIVE]/[PRIMITIVE].c, read the rt_*_uv() function | ||
+ | |||
+ | {| cellpadding="20" cellspacing="0" border="2" width="100%" | ||
+ | | | ||
+ | ==== ... UV-mapping for extruded sketches (EXTRUDE) ==== | ||
Code: | Code: | ||
− | * | + | * src/librt/primitives/extrude/extrude.c |
− | + | * src/librt/primitives/table.c | |
− | + | * include/rtgeom.h | |
− | * src/librt/primitives/table. | ||
− | * | ||
− | |||
+ | |} | ||
| | ||
+ | |||
|} | |} | ||
| | ||
+ | |||
+ | ---- | ||
== Documentation and Training == | == Documentation and Training == | ||
− | + | ---- | |
''Tasks related to creating/editing documents and helping others learn more about BRL-CAD'' | ''Tasks related to creating/editing documents and helping others learn more about BRL-CAD'' | ||
− | {| style="background-color:# | + | {| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%" |
− | + | | | |
=== Add missing documentation (for any ONE command) === | === Add missing documentation (for any ONE command) === | ||
Line 229: | Line 352: | ||
* doc/docbook/system/man1/en/*.xml | * doc/docbook/system/man1/en/*.xml | ||
− | |||
|} | |} | ||
+ | |||
| | ||
+ | {| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%" | ||
+ | | | ||
+ | === Document MGED's 'saveview' command options === | ||
− | + | BRL-CAD's primary geometry editor (MGED) provides hundreds of commands. Two of those commands are the savewview and loadview commands that write current view settings out to a text file and read them back in. The saveview command provides -e -i -l and -o options, but they are not documented. | |
− | |||
− | |||
− | + | This task involves writing documentation for those missing options. Consult the source code to see what they do and add the corresponding sections into our Docbook XML doc just like we do in our other documentation files. Test compilation to make sure your XML syntax is correct. | |
− | + | References: | |
+ | * src/libged/saveview.c | ||
+ | * doc/docbook/system/mann/en/*.xml | ||
− | + | Code: | |
− | * | + | * doc/docbook/system/mann/en/saveview.xml |
− | |||
− | |||
− | |||
− | |||
|} | |} | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
| | ||
− | + | {| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%" | |
− | {| style="background-color:# | + | | |
− | | | ||
− | |||
=== Write a "BRL-CAD Commands Quick Reference" document === | === Write a "BRL-CAD Commands Quick Reference" document === | ||
Line 291: | Line 386: | ||
* http://brlcad.org/wiki/Documentation | * http://brlcad.org/wiki/Documentation | ||
* http://brlcad.org/w/images/5/52/MGED_Quick_Reference_Card.pdf | * http://brlcad.org/w/images/5/52/MGED_Quick_Reference_Card.pdf | ||
− | * | + | * http://appletree.or.kr/quick_reference_cards/CVS-Subversion-Git/git-cheat-sheet-large.png |
− | * | + | * http://www.stdout.org/~winston/latex/latexsheet-0.png |
− | * | + | * http://img.docstoccdn.com/thumb/orig/524314.png |
− | * | + | * http://www.inmensia.com/files/pictures/internal/CheatSheetDrupal4.7.png |
− | * | + | * http://www.phpmagicbook.com/wp-content/uploads/2010/06/php-reference-card.jpg |
− | |||
|} | |} | ||
| | ||
− | + | {| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%" | |
− | {| style="background-color:# | + | | |
− | | | ||
− | |||
=== Doxygen cleanup === | === Doxygen cleanup === | ||
Line 315: | Line 407: | ||
* http://www.stack.nl/~dimitri/doxygen/ | * http://www.stack.nl/~dimitri/doxygen/ | ||
− | + | {| cellpadding="20" cellspacing="0" border="2" width="100%" | |
− | + | | | |
− | {| | ||
− | |||
==== ... doxygen cleanup for LIBBU ==== | ==== ... doxygen cleanup for LIBBU ==== | ||
Line 328: | Line 418: | ||
* misc/Doxyfile | * misc/Doxyfile | ||
− | |||
|} | |} | ||
+ | |||
| | ||
− | + | {| cellpadding="20" cellspacing="0" border="2" width="100%" | |
− | {| | + | | |
− | |||
==== ... doxygen cleanup for LIBWDB ==== | ==== ... doxygen cleanup for LIBWDB ==== | ||
Line 344: | Line 433: | ||
* misc/Doxyfile | * misc/Doxyfile | ||
− | |||
|} | |} | ||
| | ||
− | + | {| cellpadding="20" cellspacing="0" border="2" width="100%" | |
− | {| | + | | |
− | |||
==== ... doxygen cleanup for LIBRT ==== | ==== ... doxygen cleanup for LIBRT ==== | ||
Line 361: | Line 448: | ||
* src/librt/binunif | * src/librt/binunif | ||
* misc/Doxyfile | * misc/Doxyfile | ||
− | |||
− | |||
|} | |} | ||
− | |||
− | |||
− | |||
|} | |} | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
| | ||
− | | | + | {| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%" |
− | + | | | |
+ | === Write a manual page for MGED's "brep" command === | ||
− | + | BRL-CAD's MGED geometry editor provides hundreds of commands. One of those commands for manipulating and visualizing geometry is the "brep" command. | |
− | |||
− | |||
− | + | This task involves writing a manual page for that command in the Docbook XML format. There are lots of examples to follow. | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | This task involves | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
References: | References: | ||
− | * doc/docbook/ | + | * doc/docbook/system/mann/en/*.xml |
+ | * http://brlcad.org/wiki/Documentation (contains intro to mged and cheat sheets) | ||
+ | * bin/mged (you'll need to run this to use the "brep" command) | ||
+ | * bin/csgbrep (will create a slew of 'brep'/nurbs objects for the "brep" command) | ||
Code: | Code: | ||
− | |||
− | + | * doc/docbook/system/mann/en/brep.xml (you write this) | |
− | + | * doc/docbook/system/mann/en/CMakeLists.txt (you edit this) | |
− | |||
− | + | Running "make" in a build directory will compile your documentation into html and man page format so you can validate the syntax and formatting. See [[Compiling]] for help. | |
− | |||
− | |||
− | + | |} | |
− | |||
− | |||
− | |||
− | |||
− | |||
| | ||
+ | {| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%" | ||
+ | | | ||
+ | === Write up Wiki page tutorial on our Volumetric Primitive === | ||
− | + | BRL-CAD provides a couple dozen distinct primitives. Each primitive is defined by a set of parameters. Several of the more complex primitives have a wiki page describing them in more detail with an example on how to create them. | |
− | |||
− | + | This task involves writing up a page on the VOL primitive. Figure out how to use it (see the "in" command), create an example input data set, and write up a wiki page on exactly what steps are needed similar to our other wiki pages: | |
− | |||
− | |||
− | + | References: | |
+ | * http://brlcad.org/wiki/DSP | ||
+ | * http://brlcad.org/wiki/Sketch | ||
+ | * http://brlcad.org/wiki/EBM <-- particularly useful as the data is similar for VOL | ||
− | + | Show how to create a VOL with at least two layers/slices. Include images like the other examples. Put the write-up at http://brlcad.org/wiki/VOL | |
− | + | |} | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
| | ||
− | | | + | {| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%" |
− | + | | | |
+ | === Write article on BRL-CAD's code hardening efforts === | ||
− | + | We've been working for several years on "code hardening", improving the quality of BRL-CAD's source code through a variety of best practices and code cleanup efforts. | |
− | |||
− | |||
− | + | This task has you write an article that succinctly summarizes all of our efforts. You'll need to become familiar with our HACKING file as well as read up on our various hardening efforts. You're welcome to ask our devs questions over IRC for more information too. | |
− | + | Include at least one picture. Article should be 300-900 words long and be fully proof-read before submitting (check for grammar and spelling mistakes, please). | |
− | + | Resources: | |
+ | * http://brlcad.org/wiki/Code_Cleanup | ||
+ | * http://brlcad.org/d/node/96 | ||
+ | * http://www.coverity.com/library/pdf/coverity-scan-2011-open-source-integrity-report.pdf | ||
− | + | Add the article to http://brlcad.org/wiki/Community_Publication_Portal | |
− | |||
|} | |} | ||
+ | |||
| | ||
+ | {| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%" | ||
+ | | | ||
+ | === Write a wiki tutorial on how to create a polygonal mesh (NMG) manually === | ||
− | + | BRL-CAD provides a couple dozen distinct primitives. Each primitive is defined by a set of parameters. Several of the more complex primitives have a wiki page describing them in more detail with an example on how to create them. | |
− | |||
− | |||
− | |||
− | BRL-CAD | ||
− | + | This task involves writing up a page on the NMG polygonal mesh primitive. Figure out how to use it (not a simple task, will require some trial and error), create an example input, and write up a wiki page on exactly what steps are needed similar to our other wiki pages: | |
− | |||
− | |||
References: | References: | ||
− | * | + | * http://brlcad.org/wiki/DSP |
+ | * http://brlcad.org/wiki/EBM | ||
+ | * http://brlcad.org/wiki/Sketch <-- particularly useful as neither NMG nor sketch are meant to be created manually | ||
− | + | Note the "facetize" command in mged will convert an existing object into NMG format. The get/put commands should help from there like the sketch tutorial. | |
− | |||
− | + | Show how to create an NMG cube or wedge or similar simple shape. Include images like the other examples. Put the write-up at http://brlcad.org/wiki/NMG | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|} | |} | ||
− | |||
− | + | ---- | |
− | |||
− | |||
− | + | ==Outreach and Research == | |
− | + | ---- | |
− | + | ''Tasks related to community management, outreach/marketing, studying problems, and recommending solutions'' | |
− | |||
| | ||
− | | | + | {| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%" |
− | + | | | |
− | + | === Investigate permuted vertex lists from g-iges + iges-g === | |
− | |||
− | |||
− | + | BRL-CAD has a geometry exporter and importer for the International Graphics Exchange Standard (IGES) file format. If you run our g-iges exporter on some geometry, then run iges-g on that same geometry to import it back to BRL-CAD format, the geometry will have permuted vertex lists. Particularly for geometry already in polygonal format, such as our NMG or BoT geometry, this conversion should result in identical geometry but presently does not. | |
− | + | This task involves investigating why this occurs, reporting (in detail) why it occurs, and if obvious, making a recommendation on how to fix the problem. | |
− | |||
− | + | Code: | |
− | + | * src/conv/iges | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|} | |} | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | + | ---- | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
== Quality Assurance == | == Quality Assurance == | ||
+ | ---- | ||
''Tasks related to testing and ensuring code is of high quality'' | ''Tasks related to testing and ensuring code is of high quality'' | ||
− | {| style="background-color:# | + | {| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%" |
− | + | | | |
=== Fix single-precision floating point crash === | === Fix single-precision floating point crash === | ||
Line 620: | Line 594: | ||
* src/liboptical/sh_light.c | * src/liboptical/sh_light.c | ||
− | |||
|} | |} | ||
+ | |||
| | ||
− | + | {| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%" | |
− | {| style="background-color:# | + | | |
− | |||
=== Fix closedb === | === Fix closedb === | ||
Line 644: | Line 617: | ||
* src/mged/mged.c | * src/mged/mged.c | ||
− | |||
|} | |} | ||
+ | |||
| | ||
− | + | {| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%" | |
− | {| style="background-color:# | + | | |
− | + | === Create an utility library (LIBBU) API unit test === | |
− | === Create | ||
There are more than 300 library functions in our core LIBBU library. As a core library used by nearly every one of BRL-CAD's tools, testing those functions for correct behavior is important. | There are more than 300 library functions in our core LIBBU library. As a core library used by nearly every one of BRL-CAD's tools, testing those functions for correct behavior is important. | ||
− | This task involves implementing new unit | + | This task involves implementing a new unit test for any of LIBBU's source files that do not already have a unit test defined. The test should run all of the public functions and be hooked into our build system. We have lots of existing unit tests to follow as an example. |
References: | References: | ||
Line 665: | Line 637: | ||
* src/libbu/tests/CMakeLists.txt | * src/libbu/tests/CMakeLists.txt | ||
+ | {| cellpadding="20" cellspacing="0" border="2" width="100%" | ||
+ | | | ||
+ | ==== ... unit test for LIBBU badmagic.c ==== | ||
+ | |} | ||
| | ||
+ | {| cellpadding="20" cellspacing="0" border="2" width="100%" | ||
+ | | | ||
+ | ==== ... unit test for LIBBU bomb.c ==== | ||
|} | |} | ||
+ | |} | ||
+ | |||
| | ||
− | + | {| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%" | |
− | {| style="background-color:# | + | | |
− | | | + | === Create numerics library (LIBBN) API unit test === |
− | |||
− | === Create | ||
There are more than 300 library functions in our core LIBBN library. As a core library used by nearly every one of BRL-CAD's tools, testing those functions for correct behavior is important. | There are more than 300 library functions in our core LIBBN library. As a core library used by nearly every one of BRL-CAD's tools, testing those functions for correct behavior is important. | ||
− | This task involves implementing new unit | + | This task involves implementing a new unit test for any of LIBBN's source files that do not already have a unit test defined. The test should run all of the public functions and be hooked into our build system. We have lots of existing unit tests to follow as an example. |
References: | References: | ||
Line 683: | Line 662: | ||
* include/vmath.h | * include/vmath.h | ||
* src/libbn/*.c | * src/libbn/*.c | ||
− | * src/ | + | * src/libbu/tests/*.c <-- note libbu, not libbn for examples |
− | |||
Code: | Code: | ||
Line 690: | Line 668: | ||
* src/libbn/tests/CMakeLists.txt | * src/libbn/tests/CMakeLists.txt | ||
− | + | {| cellpadding="20" cellspacing="0" border="2" width="100%" | |
− | + | | | |
− | + | ==== ... unit test for LIBBN axis.c ==== | |
− | |||
− | |||
− | {| | ||
− | |||
− | ==== ... unit | ||
− | |||
|} | |} | ||
| | ||
− | + | {| cellpadding="20" cellspacing="0" border="2" width="100%" | |
− | {| | + | | |
− | + | ==== ... unit test for LIBBN qmath.c ==== | |
− | ==== ... unit | ||
− | |||
|} | |} | ||
| | ||
− | + | {| cellpadding="20" cellspacing="0" border="2" width="100%" | |
− | {| | + | | |
− | + | ==== ... unit test for LIBBN rand.c ==== | |
− | ==== ... unit | ||
− | |||
|} | |} | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|} | |} | ||
− | |||
| | ||
− | + | {| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%" | |
− | + | | | |
− | |||
− | {| style="background-color:# | ||
− | | | ||
− | |||
=== Find, reliably reproduce, and report any bug in Archer === | === Find, reliably reproduce, and report any bug in Archer === | ||
Line 748: | Line 698: | ||
* BUGS file in any source/binary distribution | * BUGS file in any source/binary distribution | ||
* http://sourceforge.net/tracker/?atid=640802&group_id=105292&func=browse | * http://sourceforge.net/tracker/?atid=640802&group_id=105292&func=browse | ||
+ | |} | ||
| | ||
− | + | {| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%" | |
− | + | | | |
− | |||
− | {| style="background-color:# | ||
− | |||
=== Reproduce any 10 unconfirmed open bug reports === | === Reproduce any 10 unconfirmed open bug reports === | ||
Line 763: | Line 711: | ||
References: | References: | ||
* https://sourceforge.net/tracker/?limit=100&func=&group_id=105292&atid=640802&assignee=100&status=1&submit=Filter | * https://sourceforge.net/tracker/?limit=100&func=&group_id=105292&atid=640802&assignee=100&status=1&submit=Filter | ||
− | |||
− | |||
|} | |} | ||
− | + | ---- | |
== User Interface == | == User Interface == | ||
+ | ---- | ||
''Tasks related to user experience research or user interface design and interaction'' | ''Tasks related to user experience research or user interface design and interaction'' | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
= When You're Done = | = When You're Done = | ||
+ | ---- | ||
For non-code, just send us your file(s). For code changes, you will be expected to [[Patches|provide a patch file]]. Make sure you ''read'' your patch file before submitting it. Make sure your patch file will apply cleanly to an unmodified checkout of BRL-CAD: | For non-code, just send us your file(s). For code changes, you will be expected to [[Patches|provide a patch file]]. Make sure you ''read'' your patch file before submitting it. Make sure your patch file will apply cleanly to an unmodified checkout of BRL-CAD: |