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:
−
Below are tasks that are a great starting point for anyone interested in contributing to BRL-CAD. Most tasks can be completed in just a couple hours!  '''''No prior experience with BRL-CAD is required.''''' 
+
This is a list of succinct tasks that are expected to take most people less than two hours to complete.  It's a great starting point for anyone interested in contributing to BRL-CAD.
  
−
Some tasks may take longer if you aren't set up or haven't done that type before, but all they all require about the same amount of experienced effort.  Each task has a description, references, and list of files you'll probably need.  Can we make it any easier? [https://brlcad.zulipchat.com Let us know].
+
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?
  
−
= Get Set Up =
+
= Getting Started =
  
−
We suggest you [[Compiling|compile BRL-CAD]] yourself or, if you have trouble with that, there's a virtual image with everything preconfigured, ready to go:
+
Please do contact us (via [[IRC]] or [[Mailing_Lists|brlcad-devel mailing list]]) if you have any questions, corrections, comments, or ideas of your own that you'd like to suggest.
  
−
# [https://sourceforge.net/projects/brlcad/files/BRL-CAD%20for%20Virtual%20Machines/ Download our BRL-CAD Virtual Machine (VM) disk image.]
+
We've made a really awesome virtual disk image that has everything you need included, preconfigured, and ready to be edited.  Here's what you do:
−
# [https://www.virtualbox.org/wiki/Downloads Install VirtualBox.]
+
# [https://sourceforge.net/projects/brlcad/files/BRL-CAD%20for%20Virtual%20Machines/ Download our BRL-CAD Virtual Machine (VM) image.]
−
# Import the disk image, start the VM, and log in (password is "Brlcad!" without quotes).
+
# [https://www.virtualbox.org/wiki/Downloads Download, install, and run VirtualBox.]
−
# Run "svn up brlcad-svn-trunk" and [[Compiling#Configure_your_Build|compile]].
+
# Import the BRL-CAD VM, start it, and log in (the password is "Brlcad!" without the quotes).
 +
# Run "svn up brlcad.svn" and get started compiling!
  
−
= Pick a Task =
+
= When You're Done =
  
−
Once set up, select any task that sounds interesting, read the references, and [https://brlcad.zulipchat.com talk with us] for help.  Don't worry if some words are confusing.  You got this.  All tasks can be completed by '''''anyone''''' but are grouped into the following five interest categories:
+
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:
  
−
* Code (programming)
+
svn co https://brlcad.svn.sourceforge.net/svnroot/brlcad/brlcad/trunk brlcad.edit
−
* Documentation and Training (technical writing)
+
cd brlcad.edit
−
* Outreach and Research (graphics, marketing)
+
# make changes
−
* Quality Assurance (testing)
+
svn diff > ~/my.patch
−
* User Interface (usability, design)
+
# read ~/my.patch file with text editor
 +
cd ..
 +
svn co https://brlcad.svn.sourceforge.net/svnroot/brlcad/brlcad/trunk brlcad.fresh
 +
cd brlcad.fresh
 +
patch -p0 < ~/my.patch
 +
# submit your patch file to our patches tracker
 +
&nbsp;
  
 
__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.
  
 +
&nbsp;
 +
{| style="background-color:#666666;" 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.
  
−
{| style="background-color:#fefefe; border-style: solid; border-width: 4px;" width="100%"
+
Code:
−
| style="padding: 20px;" |
+
* src/librt/primitives/bot/bot.c
−
=== Close MGED only when both windows are closed ===
+
 
 +
|}
 +
&nbsp;
 +
&nbsp;
 +
{| style="background-color:#666666;" 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 for commands and an interactive graphics window.  Currently, if you close the graphics window, it quits the application.
+
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 change behavior so that MGED exits only after closing ''both'' windows.  Closing just the graphics window or text console should not quit MGED.
+
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.tcl
+
* src/tclscripts/mged/openw.c
−
* src/tclscripts/mged/bindings.tcl
 
  
 +
|}
 
&nbsp;
 
&nbsp;
 +
{| style="background-color:#666666;" 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
 +
 
|}
 
|}
 +
 
&nbsp;
 
&nbsp;
 +
{| style="background-color:#666666;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
  
−
{| style="background-color:#fefefe; border-style: solid; border-width: 4px;" width="100%"
+
== Implement a primitive surface area function ==
−
| style="padding: 20px;" |
 
−
=== 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 '''ell'''ipsoid.  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 more tricky to compute.
+
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 primitives.  The primitives that do not already have a centroid callback are itemized in following.
+
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/Centroid
+
* http://en.wikipedia.org/wiki/Surface_area
 
* http://mathworld.wolfram.com/
 
* http://mathworld.wolfram.com/
−
* include/raytrace.h: See ft_centroid callback defined in the rt_functab structure
+
* http://www.dtic.mil/cgi-bin/GetTRDoc?AD=AD0274936
 +
* include/raytrace.h: See ft_surf_area callback defined in the rt_functab structure
 +
 
 +
&nbsp;
 +
{| style="background-color:#222222;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== ... surface area function for elliptical hyperboloids (EHY) ===
  
 
Code:
 
Code:
−
* src/librt/primitives/table.c
+
* src/librt/primitives/ehy/ehy.c
−
* src/librt/primitives/[PRIMITIVE]/[PRIMITIVE].c
+
 
 +
|}
  
 
&nbsp;
 
&nbsp;
 +
{| style="background-color:#222222;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== ... surface area function for hyperboloids of one sheet (HYP) ===
 +
 +
Code:
 +
* src/librt/primitives/hyp/hyp.c
 +
 
|}
 
|}
 +
 
&nbsp;
 
&nbsp;
 +
{| style="background-color:#222222;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== ... surface area function for N-faced polysolid (ARBN) ===
  
−
{| style="background-color:#fefefe; border-style: solid; border-width: 4px;" width="100%"
+
Code:
−
| style="padding: 20px;" |
+
* src/librt/primitives/arbn/arbn.c
−
=== Implement a primitive curvature function ===
 
  
−
BRL-CAD provides more than two dozen types of geometry "primitives" such as ellipsoids, boxes, and cones each described by a collection of callback functions, for example rt_'''sph'''_bbox() returns the bounding box dimensions for a '''sph'''ere.  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.
+
|}
 +
&nbsp;
 +
{| style="background-color:#222222;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== ... surface area function for extruded bitmaps (EBM) ===
  
−
This task involves writing the callback function rt_xxx_curve() that computes the curvature at a given point on the surface of a primitive such as;
+
Code:
−
* superell
+
* src/librt/primitives/ebm/ebm.c
−
* cline
 
−
* extrude
 
−
* grip
 
−
* metaball
 
−
* hrt. 
 
−
There are numerous examples in our code where we compute the curvature for other primitives like the ellipsoid, sphere, elliptical parabola, etc.
 
  
−
References:
+
|}
−
* http://en.wikipedia.org/wiki/Curvature
+
&nbsp;
−
* http://en.wikipedia.org/wiki/Radius_of_curvature_(mathematics)
+
{| style="background-color:#222222;" cellpadding="20" cellspacing="0" border="2" width="100%"
−
* http://mathworld.wolfram.com/
+
|
−
* include/raytrace.h: See the data structure that holds the curvature of a surface at a point (from Line 296) as well as the prototype for ft_curve() callback function defined in the rt_functab structure ( Line 2078).
+
=== ... surface area function for gridded volumes (VOL) ===
  
 
Code:
 
Code:
−
* src/librt/primitives/table.c
+
* src/librt/primitives/vol/vol.c
−
* src/librt/primitives/[PRIMITIVE]/[PRIMITIVE].c
 
  
 +
|}
 
&nbsp;
 
&nbsp;
 +
{| style="background-color:#222222;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== ... surface area function for super ellipsoids (SUPERELL) ===
 +
 +
Code:
 +
* src/librt/primitives/superell/superell.c
 +
 
|}
 
|}
 
&nbsp;
 
&nbsp;
 +
{| style="background-color:#222222;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== ... surface area function for polygonal meshes (NMG) ===
  
−
{| style="background-color:#fefefe; border-style: solid; border-width: 4px;" width="100%"
+
Code:
−
| style="padding: 20px;" |
+
* src/librt/primitives/nmg/nmg.c
−
=== 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 '''ell'''ipsoid.  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.
+
&nbsp;
−
 
+
{| style="background-color:#222222;" cellpadding="20" cellspacing="0" border="2" width="100%"
−
References:
+
|
−
* http://en.wikipedia.org/wiki/UV_mapping
+
=== ... surface area function for NURBS objects (BREP) ===
−
* src/librt/primitives/[PRIMITIVE]/[PRIMITIVE].c, search for rt_*_uv() functions
 
  
 
Code:
 
Code:
−
* src/librt/primitives/extrude/extrude.c
+
* src/librt/primitives/brep/brep.cpp
−
* src/librt/primitives/table.c
 
−
* include/rtgeom.h
 
  
−
&nbsp;
 
 
|}
 
|}
 +
|}
 +
 
&nbsp;
 
&nbsp;
 +
{| style="background-color:#666666;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
  
 +
== Implement a primitive volume function ==
  
−
{| style="background-color:#fefefe; border-style: solid; border-width: 4px;" width="100%"
+
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.
−
| style="padding: 20px;" |
 
−
=== Fix elliptical torus triangulation ===
 
  
−
BRL-CAD has many 3D object types, one of them being an "Elliptical Torus".  If you create a new MGED database and run this sequence of commands, it'll crash due to excessive recursion:
+
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.
  
−
<pre>
+
References:
−
make eto eto
+
* http://en.wikipedia.org/wiki/Volume
−
tol norm 1
+
* http://mathworld.wolfram.com/
−
facetize eto.bot eto
+
* http://www.dtic.mil/cgi-bin/GetTRDoc?AD=AD0274936
−
</pre>
+
* include/raytrace.h: See ft_volume callback defined in rt_functab structure
  
−
This task's goal is to reproduce, identify, and fix the bug so that detailed eto tessellation completes successfully. To get started, see the rt_eto_tess() function in src/librt/primitives/eto/eto.c and the facetize command logic in libged.
+
{| style="background-color:#222222;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== ... volume function for elliptical hyperboloids (EHY) ===
  
 
Code:
 
Code:
−
* src/librt/primitives/eto/eto.c, <- you'll probably need to modify this file
+
* src/librt/primitives/ehy/ehy.c
−
* src/libged/facetize/facetize.cpp
+
 
 +
|}
  
 
&nbsp;
 
&nbsp;
 +
{| style="background-color:#222222;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== ... volume function for superellipsoids (SUPERELL) ===
 +
 +
Code:
 +
* src/librt/primitives/superell/superell.c
 +
 
|}
 
|}
 
&nbsp;
 
&nbsp;
 +
{| style="background-color:#222222;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== ... volume function for extruded bitmaps (EBM) ===
  
−
{| style="background-color:#fefefe; border-style: solid; border-width: 4px;" width="100%"
+
Code:
−
| style="padding: 20px;" |
+
* src/librt/primitives/ebm/ebm.c
−
=== Implement a function that evaluates volume with spherical sampling ===
 
  
−
Implement this function:
+
|}
  
−
    int estimate_volume(struct db_i *dbip,
+
&nbsp;
−
                        struct directory *dp,
+
{| style="background-color:#222222;" cellpadding="20" cellspacing="0" border="2" width="100%"
−
                        size_t min_samples,
+
|
−
                        double confidence);
+
=== ... volume function for triangle meshes (BOT) ===
  
−
For this function, you'll want to read up on some of BRL-CAD's basic data structures by looking at headers in the include/rt directory or by reading our [https://brlcad.org/docs/api/ API documentation]. Calling rt_db_internal() and rt_bound_internal() will get you the bounding box around geometry from which you can calculate a bounding sphere. Once you have the bounding sphere, randomly generate a set of min_samples*2 points on the surface of the sphere. Shoot a ray through those points using rt_shootray(), as in the ray tracing [[Example_Application|example]]. Keep track of a volume estimate and keep shooting sets of min_samples rays until the estimate is less than the specified confidence value.  Volume of a sphere is (4/3 * pi * r^3) so dividing that by num_samples will give a per-ray factor and multiplying all hit thicknesses by that factor will give a running volume estimate.
+
Code:
 +
* src/librt/primitives/bot/bot.c
 +
 
 +
|}
 +
&nbsp;
 +
{| style="background-color:#222222;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== ... volume function for solid polygonal meshes (NMG) ===
  
−
References:
+
Code:
−
* https://brlcad.org/docs/api/
+
* src/librt/primitives/nmg/nmg.c
−
* https://brlcad.org/wiki/Example_Application
 
−
* https://stackoverflow.com/questions/9600801/evenly-distributing-n-points-on-a-sphere
 
−
* https://karthikkaranth.me/blog/generating-random-points-in-a-sphere/
 
  
−
&nbsp;
 
 
|}
 
|}
 
&nbsp;
 
&nbsp;
 +
{| style="background-color:#222222;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== ... volume function for extruded sketches (EXTRUDE) ===
  
−
{| style="background-color:#fefefe; border-style: solid; border-width: 4px;" width="100%"
+
Code:
−
| style="padding: 20px;" |
+
* src/librt/primitives/extrude/extrude.c
  
−
=== Implement a function to return an object's color ===
+
|}
  
−
CAD geometry can have colors specified in a number of ways including directly on that object, in a parent object, and in a lookup table.  For this task, you're going to implement a function that reports the color of an object given a path to that object:
+
|}
 +
&nbsp;
 +
{| style="background-color:#666666;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
  
−
    int get_color(struct db_i *dbip, const char *path, struct bu_color *rgb);
+
== Implement a primitive centroid function ==
  
−
You'll need to iteratively consider each object named on the specified path (e.g., "/car/wheel/tire.r/torus") starting with "car" and working your down the path (i.e., 'wheel', 'tire.r', and then 'torus') to 1) see if a color is set on that object and 2) see if that color overrides lower-level colors (i.e., is inherited down the path), and 3) if it's a region object, whether there is a color set in the region table.  You'll need to db_lookup() each object on the path to get access to its data.
+
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.
  
−
For this function, you'll want to read up on some of BRL-CAD's basic data structures by looking at headers in the include/rt directory or by reading our [https://brlcad.org/docs/api/ API documentation].  This task may seem complicated if you're not familiar with C/C++ APIs, data structures, or hierarchical paths, so don't be shy [https://brlcad.zulipchat.com asking] questions.
+
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:
−
* https://brlcad.org/docs/api/
+
* http://en.wikipedia.org/wiki/Centroid
 +
* http://mathworld.wolfram.com/
 +
* include/raytrace.h: See ft_centroid callback defined in the rt_functab structure
  
−
Code References:
+
Code:
−
* src/libged/display_list.c
+
* src/librt/primitives/table.c
−
* src/libged/color/color.c
+
* src/librt/primitives/[PRIMITIVE]/[PRIMITIVE].c
−
* src/librt/prep.c
 
  
 +
 +
{| style="background-color:#222222;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== ... centroid function for right hyperbolic cylinders (RHC) ===
 +
|}
 +
&nbsp;
 +
{| style="background-color:#222222;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== ... centroid function for gridded volumes (VOL) ===
 +
|}
 +
&nbsp;
 +
{| style="background-color:#222222;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== ... centroid function for N-faced polysolids (ARBN) ===
 +
|}
 +
&nbsp;
 +
{| style="background-color:#222222;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== ... centroid function for extruded sketches (EXTRUDE) ===
 +
|}
 
&nbsp;
 
&nbsp;
 +
{| style="background-color:#222222;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== ... centroid function for superellipsoids (SUPERELL) ===
 +
|}
 +
&nbsp;
 +
{| style="background-color:#222222;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== ... centroid function for solid polygonal meshes (NMG) ===
 
|}
 
|}
 
&nbsp;
 
&nbsp;
  
−
{| style="background-color:#fefefe; border-style: solid; border-width: 4px;" width="100%"
+
|}
−
| style="padding: 20px;" |
+
&nbsp;
 +
{| style="background-color:#666666;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
  
−
=== Stub in an OpenVDB object ===
+
== Implement a primitive UV-mapping callback ==
  
−
BRL-CAD has dozens of distinct primitive object types.  For this task, you're going to implement the bare minimum to necessary to create a new object with the "make" command in MGED.
+
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.
  
−
The best way to achieve this task is by searching for a keyword for another primitive (e.g., 'grep -r -i superell .') and implementing your new object the same way.  Start with the 'make' command itself in src/libged/make/make.c and add "vdb" alongside where you find one of the other primitive types (e.g., superell).  To get that to compile, you'll have to add new symbols you've defined into header files (e.g., include/rt/rtgeom.h). You'll eventually need to implement barebones logic in src/librt/primitives/vdb too.
+
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
 +
 
 +
{| style="background-color:#222222;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== ... UV-mapping for extruded sketches (EXTRUDE) ===
  
 
Code:
 
Code:
−
* include/rt/defines.h <- needs an ID
+
* src/librt/primitives/extrude/extrude.c
−
* include/rt/geom.h <- needs an "internal" i.e., in-memory structure
+
* src/librt/primitives/table.c
−
* src/libged/make/make.c <- needs to recognize "vdb" as a valid type
+
* include/rtgeom.h
−
* src/librt/primitives/table.cpp <- needs an entry
 
−
* src/librt/primtiives/vdb <- needs a dir
 
−
* src/librt/primitives/vdb/vdb.c <- needs _import5/_export5 callbacks, maybe _describe too
 
  
 +
|}
 
&nbsp;
 
&nbsp;
 +
 
|}
 
|}
 
&nbsp;
 
&nbsp;
  
−
== 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:#fefefe; border-style: solid; border-width: 4px;" width="100%"
+
{| style="background-color:#666666;" cellpadding="20" cellspacing="0" border="2" width="100%"
−
| style="padding: 20px;" |
+
|
−
=== Add missing documentation (for any ONE command) ===
+
== Add missing documentation (for any ONE command) ==
  
 
BRL-CAD is an extensive system with more than 400 commands and more than a million pages of documentation, but there are approximately 120 commands that are entirely undocumented:
 
BRL-CAD is an extensive system with more than 400 commands and more than a million pages of documentation, but there are approximately 120 commands that are entirely undocumented:
Line 229: Line 357:
 
* doc/docbook/system/man1/en/*.xml
 
* doc/docbook/system/man1/en/*.xml
  
−
&nbsp;
 
 
|}
 
|}
 +
 
&nbsp;
 
&nbsp;
 +
{| style="background-color:#666666;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
== Document MGED's 'saveview' command options ==
  
−
{| style="background-color:#fefefe; border-style: solid; border-width: 4px;" width="100%"
+
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.
−
| style="padding: 20px;" |
 
−
=== Complete our "Intro to BRL-CAD Modeling" tutorial and extend it ===
 
  
−
We've developed two short and simple tutorials for introducing new users to modeling with BRL-CAD.
+
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.
  
−
This task involves doing one of the tutorials (they take about an hour) and then extending it with a new section or making some other improvement. At the end of the tutorial are several optional advanced "exercise left to the reader", for example.  Write a half-page step-by-step for one of the exercises left to the reader.  Include screenshots and images to make it look nice so the reader is not bored.
+
References:
 +
* src/libged/saveview.c
 +
* doc/docbook/system/mann/en/*.xml
  
−
Reference:
+
Code:
−
* Come [https://brlcad.zulipchat.com talk with us] to make sure you get a copy of the latest version.
+
* doc/docbook/system/mann/en/saveview.xml
−
* https://brlcad.org/w/images/9/90/Intro_to_BRL-CAD.pdf
 
−
* https://brlcad.org/w/images/c/cf/Introduction_to_MGED.pdf
 
−
* ... there's another new one, but you have to ask for it ...
 
  
−
&nbsp;
 
 
|}
 
|}
−
&nbsp;
 
−
 
−
{| style="background-color:#fefefe; border-style: solid; border-width: 4px;" width="100%"
 
−
| style="padding: 20px;" |
 
−
 
−
=== Translate "Contributors Guide To BRL-CAD" To Any Language ===
 
−
 
−
People interested in improving BRL-CAD sometimes find themselves lost in a sea of information. In all, BRL-CAD has more than a million words of documentation across hundreds of manual pages, dozens of tutorials and examples, hundreds of wiki pages, dozens of technical papers, and other resources. There are literally thousands of features and this can sometimes pose problems.
 
−
 
−
In 2013, a team of contributors got to California and worked on an entire book titled "Contributors Guide To BRL-CAD" in just a few days. This great resource needs to be translated to other languages to attract developers from other lingual backgrounds (who don't read English ) to contribute to BRL-CAD.
 
−
 
−
This task involves translating the chapters/sections of the "Contributors Guide To BRL-CAD" into a language of your choice such as Mandarin, French, Chinese, Spanish, German, Hindi, Arabic, Russian, etc. Chapters/Sections include
 
−
 
−
* Feature Overview
 
−
* Working with our Code
 
−
* What code to work on
 
−
* How to contribute
 
−
* .... (Just to name a few )
 
−
 
−
The output of this task can be a pdf, html, doc, odt or any other document file that contains the translated article.Images in the original document (see link in Reference below) should not be changed ! only text should be.
 
−
 
−
Reference:
 
−
* http://en.flossmanuals.net/_booki/contributors-guide-to-brl-cad/contributors-guide-to-brl-cad.pdf
 
  
 
&nbsp;
 
&nbsp;
−
|}
+
{| style="background-color:#666666;" cellpadding="20" cellspacing="0" border="2" width="100%"
−
&nbsp;
+
|
−
 
+
== Write a "BRL-CAD Commands Quick Reference" document ==
−
{| style="background-color:#fefefe; border-style: solid; border-width: 4px;" width="100%"
 
−
| style="padding: 20px;" |
 
−
 
 
−
=== Write a "BRL-CAD Commands Quick Reference" document ===
 
  
 
There is already a command quick reference for BRL-CAD's MGED geometry editing tool, but there is not a similar document for BRL-CAD's 400+ command-line commands.
 
There is already a command quick reference for BRL-CAD's MGED geometry editing tool, but there is not a similar document for BRL-CAD's 400+ command-line commands.
Line 291: Line 391:
 
* 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 git example]
+
* http://appletree.or.kr/quick_reference_cards/CVS-Subversion-Git/git-cheat-sheet-large.png
−
* [http://www.stdout.org/~winston/latex/latexsheet-0.png latex example]
+
* http://www.stdout.org/~winston/latex/latexsheet-0.png
−
* [http://img.docstoccdn.com/thumb/orig/524314.png another example]
+
* http://img.docstoccdn.com/thumb/orig/524314.png
−
* [http://www.inmensia.com/files/pictures/internal/CheatSheetDrupal4.7.png drupal example]
+
* http://www.inmensia.com/files/pictures/internal/CheatSheetDrupal4.7.png
−
* [http://www.phpmagicbook.com/wp-content/uploads/2010/06/php-reference-card.jpg php example]
+
* http://www.phpmagicbook.com/wp-content/uploads/2010/06/php-reference-card.jpg
  
−
&nbsp;
 
 
|}
 
|}
 
&nbsp;
 
&nbsp;
−
 
+
{| style="background-color:#666666;" cellpadding="20" cellspacing="0" border="2" width="100%"
−
{| style="background-color:#fefefe; border-style: solid; border-width: 4px;" width="100%"
+
|
−
| style="padding: 20px;" |
+
== Doxygen cleanup ==
−
 
 
−
=== Doxygen cleanup ===
 
  
 
BRL-CAD uses Doxygen for most API documentation but the comment blocks are not optimally set up for Doxygen output.
 
BRL-CAD uses Doxygen for most API documentation but the comment blocks are not optimally set up for Doxygen output.
Line 315: Line 412:
 
* http://www.stack.nl/~dimitri/doxygen/
 
* http://www.stack.nl/~dimitri/doxygen/
  
−
&nbsp;
+
{| style="background-color:#222222;" cellpadding="20" cellspacing="0" border="2" width="100%"
−
 
+
|
−
{| style="background-color:#efefef; border-style: solid; border-width: 2px;" width="100%"
+
=== ... doxygen cleanup for LIBBU ===
−
| style="padding: 10px;" |
 
−
==== ... doxygen cleanup for LIBBU ====
 
  
 
There are approximately 300 documented API function calls in LIBBU.
 
There are approximately 300 documented API function calls in LIBBU.
Line 328: Line 423:
 
* misc/Doxyfile
 
* misc/Doxyfile
  
−
&nbsp;
 
 
|}
 
|}
 +
 
&nbsp;
 
&nbsp;
−
 
+
{| style="background-color:#222222;" cellpadding="20" cellspacing="0" border="2" width="100%"
−
{| style="background-color:#efefef; border-style: solid; border-width: 2px;" width="100%"
+
|
−
| style="padding: 10px;" |
+
=== ... doxygen cleanup for LIBWDB ===
−
==== ... doxygen cleanup for LIBWDB ====
 
  
 
There are approximately 100 documented API function calls in LIBWDB.  
 
There are approximately 100 documented API function calls in LIBWDB.  
Line 344: Line 438:
 
* misc/Doxyfile
 
* misc/Doxyfile
  
−
&nbsp;
 
 
|}
 
|}
 
&nbsp;
 
&nbsp;
−
 
+
{| style="background-color:#222222;" cellpadding="20" cellspacing="0" border="2" width="100%"
−
{| style="background-color:#efefef; border-style: solid; border-width: 2px;" width="100%"
+
|
−
| style="padding: 10px;" |
+
=== ... doxygen cleanup for LIBRT ===
−
==== ... doxygen cleanup for LIBRT ====
 
  
 
There are approximately 1000 documented API function calls in LIBRT.  
 
There are approximately 1000 documented API function calls in LIBRT.  
Line 361: Line 453:
 
* src/librt/binunif
 
* src/librt/binunif
 
* misc/Doxyfile
 
* misc/Doxyfile
 +
|}
 +
|}
  
−
&nbsp;
+
----
−
|}
 
−
&nbsp;
 
  
−
&nbsp;
+
= Outreach and Research =
−
|}
+
----
−
&nbsp;
+
''Tasks related to community management, outreach/marketing, studying problems, and recommending solutions''
  
−
{| style="background-color:#fefefe; border-style: solid; border-width: 4px;" width="100%"
+
{| style="background-color:#666666;" cellpadding="20" cellspacing="0" border="2" width="100%"
−
| style="padding: 20px;" |
+
|
−
=== Add images to our wiki page on Volumetric objects ===
+
== Write solicitation for new website designer ==
  
−
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.
+
The BRL-CAD website is in need of a design overhaul.
  
−
This task involves adding images to our page for the VOL primitive.  You'll need to first complete the tutorial and save images for each step.  Add the images to the wiki page.
+
This task involves writing up a brief article soliciting new contributor(s) to work on designing a new website.  The article needs to be detailed and specific to our particular website requirements (Drupal+Mediawiki+CSS) to ensure the contributor can design the appropriate stylesheet(s), updated graphics, and new layout.  Provide a title, an image, a short summary (<200 words), and the detailed write-up (>400 words).
  
 
References:
 
References:
−
* http://brlcad.org/wiki/VOL
+
* http://brlcad.org
−
* http://brlcad.org/wiki/DSP
 
−
* http://brlcad.org/wiki/Sketch
 
−
* http://brlcad.org/wiki/EBM
 
  
−
&nbsp;
 
 
|}
 
|}
 
&nbsp;
 
&nbsp;
 +
{| style="background-color:#666666;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
== Model a "B" using BRL-CAD ==
  
−
{| style="background-color:#fefefe; border-style: solid; border-width: 4px;" width="100%"
+
Create an uppercase letter "B" geometry model using BRL-CAD.  You can use the mged or archer geometry editor tools or write a script.  The model should be roughly 1000mm tall, about 500mm wide, and about 100mm deep.  Create it using CSG or other methods, but it cannot be an imported model, polygonal mesh (BOT, NMG), or extruded bitmap (EBM).
−
| style="padding: 20px;" |
 
−
=== Fix Image Formatting in BRL-CAD's DocBook Documentation (any ONE large document or 4 smaller documents) ===
 
  
−
The majority of BRL-CAD's documentation is defined as DocBook files, from which other formats (HTML, PDF, man page, etc.) can be generated.  PDF files present a particular challenge, and have some very specific requirements to achieve "good" formatting.
+
It should be free of modeling errors (no overlaps, run "rtcheck" to verify). It should have interesting shader properties set (suggest stack+plastic+texture), default shader will not be accepted.  Provide the .g geometry file and a 1024x1024 rendering at a "ae 35 25" view to show what it looks like.
 +
 
 +
References:
 +
* Introduction to MGED at http://brlcad.org/wiki/Documentation
 +
|}
  
−
BRL-CAD's DocBook files need to uniformly use a style of image inclusion that is aware of what "role" the image is supposed to serve.  A "basic" image inclusion example looks like this:
+
&nbsp;
 +
{| style="background-color:#666666;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
== Model a "R" using BRL-CAD ==
  
−
  <mediaobject>
+
Create an uppercase letter "R" geometry model using BRL-CAD. You can use the mged or archer geometry editor tools or write a script. The model should be roughly 1000mm tall, about 500mm wide, and about 100mm deep. Create it using CSG or other methods, but it cannot be an imported model, polygonal mesh (BOT, NMG), or extruded bitmap (EBM).
−
    <imageobject>
 
−
      <imagedata align="center" fileref="../../lessons/en/images/img.png" format="PNG"/>
 
−
    </imageobject>
 
−
    <nowiki><caption></nowiki>
 
−
      <para>
 
−
        Caption goes here.
 
−
      </para>
 
−
    </caption>
 
−
  </mediaobject>
 
  
−
This task involves switching image inclusions that use the above style to something like the following:
+
It should be free of modeling errors (no overlaps, run "rtcheck" to verify).  It should have interesting shader properties set (suggest stack+plastic+texture), default shader will not be accepted.  Provide the .g geometry file and a 1024x1024 rendering at a "ae 35 25" view to show what it looks like.
  
−
  <mediaobject>
+
References:
−
    <imageobject role="html">
+
* Introduction to MGED at http://brlcad.org/wiki/Documentation
−
      <imagedata align="center" fileref="../../books/en/images/img.png" format="PNG"/>
+
|}
−
    </imageobject>
 
−
    <imageobject role="fo">
 
−
      <imagedata align="center" fileref="../../books/en/images/img.png" format="PNG"/>
 
−
    </imageobject>
 
−
    <nowiki><caption></nowiki>
 
−
      <para>
 
−
        Caption goes here.
 
−
      </para>
 
−
    </caption>
 
−
</mediaobject>
 
−
 
−
The "role" flag to imageobject provides the opportunity to specify different image formatting options when the output is HTML (role="html") or PDF (role="fo").
 
  
−
The captions should be preserved as above on mediaobjects that have them, but mediaobjects without a caption should also be converted and there is no need to add a caption in such cases.
+
&nbsp;
 +
{| style="background-color:#666666;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
== Model a "L" using BRL-CAD ==
  
−
Any patch that makes changes to the DocBook sources should result in a successful "make doc" build test.  This won't generate PDF documents, but it will validate the XML files and produce HTML - remember that introducing breakage means the patch won't be accepted.
+
Create an uppercase letter "L"  geometry model using BRL-CAD.  You can use the mged or archer geometry editor tools or write a script.  The model should be roughly 1000mm tall, about 500mm wide, and about 100mm deep.  Create it using CSG or other methods, but it cannot be an imported model, polygonal mesh (BOT, NMG), or extruded bitmap (EBM).
  
−
Remember, the tasks are simply to do the above conversion for all images in the file or files, not to introduce PDF specific formatting.  Formatting fixes will be needed, but they are very much "case by case" and will take both additional time and a working Apache FOP installation, as well as knowledge of how to enable PDF generation.  If all image inclusions have been converted successfully and a student is interested in actually fixing the formatting, please discuss it with us on IRC or the mailing list.
+
It should be free of modeling errors (no overlaps, run "rtcheck" to verify).  It should have interesting shader properties set (suggest stack+plastic+texture), default shader will not be accepted.  Provide the .g geometry file and a 1024x1024 rendering at a "ae 35 25" view to show what it looks like.
  
 
References:
 
References:
−
* doc/docbook/books/en/BRL-CAD_Tutorial_Series-VolumeIII.xml
+
* Introduction to MGED at http://brlcad.org/wiki/Documentation
 +
|}
 +
 
 +
&nbsp;
 +
{| style="background-color:#666666;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
== Model a "C" using BRL-CAD ==
 +
 
 +
Create an uppercase letter "C"  geometry model using BRL-CAD.  You can use the mged or archer geometry editor tools or write a script.  The model should be roughly 1000mm tall, about 500mm wide, and about 100mm deep.  Create it using CSG or other methods, but it cannot be an imported model, polygonal mesh (BOT, NMG), or extruded bitmap (EBM).
  
−
Code:
+
It should be free of modeling errors (no overlaps, run "rtcheck" to verify).  It should have interesting shader properties set (suggest stack+plastic+texture), default shader will not be accepted.  Provide the .g geometry file and a 1024x1024 rendering at a "ae 35 25" view to show what it looks like.
−
* doc/docbook
 
  
−
&nbsp;
+
References:
 +
* Introduction to MGED at http://brlcad.org/wiki/Documentation
 
|}
 
|}
 +
 
&nbsp;
 
&nbsp;
 +
{| style="background-color:#666666;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
== Model a "A" using BRL-CAD ==
  
−
{| style="background-color:#fefefe; border-style: solid; border-width: 4px;" width="100%"
+
Create an uppercase letter "A"  geometry model using BRL-CAD.  You can use the mged or archer geometry editor tools or write a script.  The model should be roughly 1000mm tall, about 500mm wide, and about 100mm deep.  Create it using CSG or other methods, but it cannot be an imported model, polygonal mesh (BOT, NMG), or extruded bitmap (EBM).
−
| style="padding: 20px;" |
 
−
=== Find 5 bugs in OGV ===
 
  
−
Online Geometry Viewer is a web based application with which you can see 3D .g models in browser without the use of any plugins. Your task will be to deploy OGV locally and find 5 bugs or errors in it.  
+
It should be free of modeling errors (no overlaps, run "rtcheck" to verify). It should have interesting shader properties set (suggest stack+plastic+texture), default shader will not be accepted.  Provide the .g geometry file and a 1024x1024 rendering at a "ae 35 25" view to show what it looks like.
  
−
Links:
+
References:
−
https://github.com/BRL-CAD/OGV-meteor/
+
* Introduction to MGED at http://brlcad.org/wiki/Documentation
 +
|}
  
 
&nbsp;
 
&nbsp;
 +
{| style="background-color:#666666;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
== Model a "D" using BRL-CAD ==
 +
 +
Create an uppercase letter "D"  geometry model using BRL-CAD.  You can use the mged or archer geometry editor tools or write a script.  The model should be roughly 1000mm tall, about 500mm wide, and about 100mm deep.  Create it using CSG or other methods, but it cannot be an imported model, polygonal mesh (BOT, NMG), or extruded bitmap (EBM).
 +
 +
It should be free of modeling errors (no overlaps, run "rtcheck" to verify).  It should have interesting shader properties set (suggest stack+plastic+texture), default shader will not be accepted.  Provide the .g geometry file and a 1024x1024 rendering at a "ae 35 25" view to show what it looks like.
 +
 +
References:
 +
* Introduction to MGED at http://brlcad.org/wiki/Documentation
 
|}
 
|}
 +
 
&nbsp;
 
&nbsp;
 +
{| style="background-color:#666666;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
== Model new BRL-CAD Logo using BRL-CAD ==
  
−
==Outreach and Research ==
+
The winner of the recent BRL-CAD Logo contest is a clean depiction of two interlocked components. Modeling the new Logo in BRL-CAD in CSG (without NURBS, without polygons) requires some careful arrangement, but can provide an attractive three dimensional rendering.
−
''Tasks related to community management, outreach/marketing, studying problems, and recommending solutions''
 
  
−
{| style="background-color:#fefefe; border-style: solid; border-width: 4px;" width="100%"
+
The output of this task would be a .g file of BRL-CAD logo. The two segments should overlap at the join, but this is your opportunity as an artist and 3D magician to come up with an interesting or faithful interpretation.
−
| style="padding: 20px;" |
 
−
=== Profile NURBS prep performance ===
 
  
−
BRL-CAD implements support for rendering of NURBS representation geometry. If you import a solid 3DM or STEP format model into BRL-CAD, it will import as BREP/NURBS geometry. Opening that geometry in BRL-CAD's MGED editor will tell you what objects are available and our 'rt' tool will raytrace it. When geometry is ray traced, it first goes through a "prep" phase and then it starts shooting rays.  Our prep phase is entirely unoptimized so we'd like to know where all the time is presently being spent during prep..
+
References:
 +
* http://brlcad.org/images/angelov_256.png
 +
* http://brlcad.org/d/node/92
 +
* Introduction to MGED at http://brlcad.org/wiki/Documentation
  
−
This task involves importing some NURBS geometry into BRL-CAD and ray tracing that geometry with a profiler watching our prep performance. Any profiler will do, including gprof, but a performance monitor like oprofile or the Mac "Instruments" application (or Shark) are preferred.
+
|}
 +
&nbsp;
 +
{| style="background-color:#666666;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
== Write BRL-CAD News article on .deb/.rpm builds ==
  
−
Learning how to use a profiler is beyond the scope of this task, so it make take you considerably longer to provide us with useful information if you've never run a profiler before.
+
BRL-CAD's maintainer, Jordi Sayol, manages the .deb and .rpm builds.  Interview the developer, obtain details on how the releases are produced, what platforms are supported, etc, and write up an article for our Community Publication Portal (CPP)
  
−
To capture prep performance, you will need to import some fairly complex geometry. You should be able to search google with "filetype:3dm" or "filetype:step" or find something on grabcad.com to import
+
The output of this task is an article added to our CPP wiki page in a final production-quality review state.
  
−
Running "tops" within mged will tell you what geometry is available for rendering.
+
References:
 +
* http://brlcad.org/wiki/Community_Publication_Portal
  
−
Running "rt -o file.png -s32" on the system command line (not inside mged) should minimize the ray overhead or you can specifically isolate the prep phase we care about.  Prep is the time between when rt is run where it opens a window until the first pixels are fired and pixels start filling in.
 
−
 
−
&nbsp;
 
 
|}
 
|}
 
&nbsp;
 
&nbsp;
 +
{| style="background-color:#666666;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
== Write a BRL-CAD showcase article ==
  
−
{| style="background-color:#fefefe; border-style: solid; border-width: 4px;" width="100%"
+
BRL-CAD has several ongoing development activities developed by community members that showcase the power and applicability of BRL-CAD to various domains.  For this task, you'd be expected to interview one or more individuals to obtain information and pictures about their project, write up a descriptive overview of their model, the goals of the project, and any interesting ancillary information that may be relevant.  There are presently several candidate topics listed in our Community Publication Portal (CPP).
−
| style="padding: 20px;" |
 
−
=== Continue investigating GMP integration ===
 
  
−
BRL-CAD uses a fastf_t typedef for most all math operations that is usually a "double" floating point type. We would like to provide the option for resorting to exact arithmetic if possible by merely redefining fastf_t to a C++ type sufficiently overloaded to behave the same. You should be proficient with C++ operator overloading to take this work on.  This task is a continuation of a prior GCI task (read it in full!):
+
The output of this task is an article added to our CPP wiki page in a final draft review state.
  
−
http://www.google-melange.com/gci/task/view/google/gci2012/7946218
+
References:
−
 
+
* http://brlcad.org/wiki/Community_Publication_Portal
−
This task involves testing compilation with a C++ class with overloaded operators such that vmath macro calls still work as well as a sampling of LIBBN API function calls without major changes to the original code. A perfect example case study would be creating the class then testing whether bn_dist_pt3_pt3() and bn_mat_determinant() compute correctly for values that cannot be exactly represented with floating point arithmetic.
 
−
 
 
−
Building on the previous GCI task work, take it to the next step. Try setting a vector to 1/3, 1/3, 1/3 and 0.1, 0.1, 0.1 and get proper values to print.  Change the V3ARGS() macro if needed.  If that all works, try to get bn_dist_pt3_pt3() to work.  Report and discuss your progress.
 
  
−
&nbsp;
 
 
|}
 
|}
 
&nbsp;
 
&nbsp;
 +
{| style="background-color:#666666;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
== Design a "Commercial CAD Comparison" diagram ==
  
−
{| style="background-color:#fefefe; border-style: solid; border-width: 4px;" width="100%"
+
New users frequently ask how BRL-CAD compares to other major commercial CAD systems such as CATIA, Unigraphics/NX, Pro/ENGINEER, Solidworks, and AutoCAD.  BRL-CAD has many of the same features and it would be very useful to visualize the feature overlap graphically with a diagram.
−
| style="padding: 20px;" |
 
−
=== Upgrade OpenNURBS, report issues ===
 
  
−
BRL-CAD uses a customized OpenNURBS library for advanced geometry but it's out of date.  For this task, you're going to download the latest OpenNURBS code and upgrade the sources we bundle.  The easiest way is probably to move src/other/openNURBS to src/other/openNURBS.backup, and then put the latest OpenNURBS release into src/other/openNURBS.
+
This task involves identifying core significant features of relevance and describing BRL-CAD along with the various major CAD vendors.  The diagram should fit on one page.
  
−
Once that's done, you'll need to add the src/other/openNURBS.backup/CMakeLists.txt file and make sure the list of files it has matches the files in src/other/openNURBS. Last but not least, re-run cmake and make sure it compiles. You may need to consult the newer openNURBS makefile to see if there are other edits needed in the CMakeLists.txt file.
+
References:
 +
* http://brlcad.org/Industry_Diagram.png
 +
* Example feature comparisons (although not a diagram): http://en.wikipedia.org/wiki/Comparison_of_3D_computer_graphics_software
 +
* Additional feature comparisons (also not a diagram): http://en.wikipedia.org/wiki/Comparison_of_CAD_editors_for_CAE
  
−
Save output from any commands you run because you'll probably encounter an error, and that's okay.  Just submit logs of all output so we can figure out next steps.
+
|}
 +
&nbsp;
 +
{| style="background-color:#666666;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
== Investigate performance of setting thread affinity ==
  
−
References:
+
BRL-CAD's raytrace library (LIBRT) is pervasively multithreaded using routines defined in our basic utility library (LIBBU) for detecting an using multiple CPUs/cores/threads. On Linux, BSD, or Mac OS X, you can set the affinity of a process to stay on a processor.
−
* https://github.com/mcneel/opennurbs
+
 
 +
This task involves making minor modifications to the LIBBU parallel interface using sched_setaffinity and/or pthread_attr_setaffinity_np (or similar affinity mechanism depending on the platform) and then evaluating the performance impact using our BRL-CAD Benchmark suite ('benchmark' command).
  
 
Code:
 
Code:
−
* src/other/openNURBS <- replace existing with latest openNURBS from github
+
* src/libbu/parallel.c
 +
* src/libbu/semaphore.c
  
−
&nbsp;
 
 
|}
 
|}
 
&nbsp;
 
&nbsp;
 +
{| style="background-color:#666666;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
== Determine why solids.sh fails on 64-bit ==
  
−
{| style="background-color:#fefefe; border-style: solid; border-width: 4px;" width="100%"
+
BRL-CAD has a regression test script called solids.sh that creates a bunch of primitives, renders an image of those primitives, and then compares that image to a reference image.  On (most?) 64-bit platforms, the test is off by several RGB values for exactly 3 pixels.
−
| style="padding: 20px;" |
 
−
=== Design a T-Shirt for BRL-CAD ===
 
  
−
This task involves designing a T-Shirt for BRL-CAD. Use your designing skills to design a T-Shirt for BRL-CAD. You can use the current BRL-CAD logo, or you may tweak it. Be creative while designing this T-Shirt. It would be good if the design has some special meaning.
+
This task involves figuring out why, exactly, this is occurring. It may be helpful to compare intermediate computation results from a 32-bit environment to see where the computations diverge, however slightly. Ultimately, the goal is to identify the cause and a recommended course of action to fix the divergence problem.
  
−
Logo References
+
Code:
−
* [https://brlcad.org/img/logo_color.png BRL-CAD Logo]
+
* regress/solids.sh
 +
* src/librt
 +
* src/liboptical
  
−
&nbsp;
 
 
|}
 
|}
 
&nbsp;
 
&nbsp;
 +
{| style="background-color:#666666;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
  
−
{| style="background-color:#fefefe; border-style: solid; border-width: 4px;" width="100%"
+
== Investigate permuted vertex lists from g-iges + iges-g ==
−
| style="padding: 20px;" |
 
−
=== Design a coffee mug for BRL-CAD ===
 
  
−
This task involves designing a coffee mug for BRL-CAD. Make it look good or at least interesting, and make it in BRL-CAD. Look over some coffee mug designs before starting to work on this.  Verify that your mug is valid geometry by running the "rtcheck" command.  
+
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.
  
−
Logo References
+
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.
−
* [https://brlcad.org/img/logo_color.png BRL-CAD Logo]
+
 
 +
Code:
 +
* src/conv/iges
  
−
&nbsp;
 
 
|}
 
|}
 
&nbsp;
 
&nbsp;
 +
{| style="background-color:#666666;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
== Investigate GMP integration ==
 +
 +
BRL-CAD uses a fastf_t typedef for most all math operations that is usually a "double" floating point type.  We would like to provide the option for resorting to exact arithmetic if possible by merely redefining fastf_t to a C++ type sufficiently overloaded to behave the same.  You should be proficient with C++ operator overloading to take this task on.
  
−
{| style="background-color:#fefefe; border-style: solid; border-width: 4px;" width="100%"
+
This task involves testing compilation with a C++ class with overloaded operators such that vmath macro calls still work as well as a sampling of LIBBN API function calls without major changes to the original code.  A perfect example case study would be creating the class then testing whether bn_dist_pt3_pt3() and bn_mat_determinant() compute correctly for values that cannot be exactly represented with floating point arithmetic.
−
| style="padding: 20px;" |
 
−
=== Design BRL-CAD sticker ===
 
  
−
This task involves designing a BRL-CAD sticker. The design should be simple and sleek. The concept of sticker should be clear and also it should be creatively presented. Get inspired from some sticker designs but choose your own imagination while designing the sticker. There is no bound for shape of sticker, it can be rectangular, circular or even irregular. The only thing that matters is that it should look good.
+
References:
 +
* http://gmplib.org/
  
−
Logo References
+
Code:
−
* [https://brlcad.org/img/logo_color.png BRL-CAD Logo]
+
* include/vmath.h
 +
* include/bn.h
  
−
&nbsp;
 
 
|}
 
|}
 
&nbsp;
 
&nbsp;
 +
{| style="background-color:#666666;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
== Research status of compiling BRL-CAD on MINGW ==
  
−
{| style="background-color:#fefefe; border-style: solid; border-width: 4px;" width="100%"
+
BRL-CAD compiles on a number of platforms but is rarely compiled under mingw.  A cygwin compilation was last successfuly performed a few years ago with relatively minor effort, but mingw hasn't been tested.
−
| style="padding: 20px;" |
 
−
=== Design a wallpaper / desktop image for BRL-CAD ===
 
  
−
This task involves designing a desktop background for BRL-CAD enthusiasts.  The main idea of your wallpaper should be to showcase one or more features of BRL-CAD.  Be intentional and able to defend/describe your choice of color, layout, and other aspects of the wallpaper design.
+
This task involves attempting to compile BRL-CAD under mingw (AFTER successfully compiling with MSVC).  Follow the CMake documentation and edit our build system accordingly.  Report on what fails and write up a tutorial on the BRL-CAD wiki.
−
   
 
−
Try to make sure the wallpaper works across a broad selection of screen resolutions.
 
  
−
Search the web for wallpapers inspiration such as:
+
References:
−
* http://www.smashingmagazine.com/tag/wallpapers/
+
* http://brlcad.org/wiki/
 +
* http://www.mingw.org/
 +
* http://www.cmake.org/Wiki/CmakeMingw
  
−
Logo References
+
Code:
−
* [https://brlcad.org/img/logo_color.png BRL-CAD Logo]
+
* CMakeLists.txt
 +
* misc/CMake/*
 +
|}
  
 
&nbsp;
 
&nbsp;
−
|}
+
{| style="background-color:#666666;" cellpadding="20" cellspacing="0" border="2" width="100%"
−
&nbsp;
+
|
 +
== Create an awesome screenshot ==
  
−
{| style="background-color:#fefefe; border-style: solid; border-width: 4px;" width="100%"
+
Everyone loves to see screenshots of software in action.  We use screenshots in our marketing and outreach.  See some of the examples below that we already have.
−
| style="padding: 20px;" |
 
−
=== Model a Lightcycle in BRL-CAD using CSG ===
 
  
−
The movie Tron is an iconic computer graphics film that used CSG primitives for a majority of the movie's 3D virtual world.  The film is famous for "lightcycle" vehicles that were allegedly modeled using 57 primitives and/or Boolean operations.  For this task, see if you can recreate the masterpiece in BRL-CAD.
+
Create an awesome screenshot of either mged or archer.  It should be graphically interesting, show wireframe and/or raytraced geometry and give some sense of capability.
−
 
−
See this lightcycle discussion thread
 
−
* http://www.tron-sector.com/forums/default.aspx?a=top&id=336281
 
  
−
&nbsp;
+
References:
 +
* http://brlcad.org/gallery/d/19-4/MGED.jpg
 +
* http://brlcad.org/tmp/archer.png
 +
* http://brlcad.org/gallery/s/screenshots/
 
|}
 
|}
−
&nbsp;
 
  
−
== 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:#fefefe; border-style: solid; border-width: 4px;" width="100%"
+
{| style="background-color:#666666;" cellpadding="20" cellspacing="0" border="2" width="100%"
−
| style="padding: 20px;" |
+
|
−
=== Fix single-precision floating point crash ===
+
== Fix single-precision floating point crash ==
  
 
By default, all of BRL-CAD compiles using double-precision floating point arithmetic.  We provide a simple typedef, however, that converts almost the entire system over to single-precision floating point.  This compilation mode was recently cleaned up and tested, but a bug was found.  The problem is reproduced very simply by compiling in single precision mode and running our "rt" ray tracer tool.
 
By default, all of BRL-CAD compiles using double-precision floating point arithmetic.  We provide a simple typedef, however, that converts almost the entire system over to single-precision floating point.  This compilation mode was recently cleaned up and tested, but a bug was found.  The problem is reproduced very simply by compiling in single precision mode and running our "rt" ray tracer tool.
Line 620: Line 742:
 
* src/liboptical/sh_light.c
 
* src/liboptical/sh_light.c
  
−
&nbsp;
 
 
|}
 
|}
 +
 
&nbsp;
 
&nbsp;
−
 
+
{| style="background-color:#666666;" cellpadding="20" cellspacing="0" border="2" width="100%"
−
{| style="background-color:#fefefe; border-style: solid; border-width: 4px;" width="100%"
+
|
−
| style="padding: 20px;" |
+
== Fix closedb ==
−
=== Fix closedb ===
 
  
 
BRL-CAD geometry editor application (mged) has several hundred commands including two very simple commands for opening and closing a geometry database file.  While the user rarely ever needs to close the file, as all changes are always immediately saved, it can be of use to scripting applications.  However, at some point in the recent past, the ''closedb'' command was horked.  It's undoubtedly something very simple but we haven't bothered to look due to other priorities.  You can fix it.  If you run these simple steps within graphical mged, you should see how commands stop working after calling closedb:
 
BRL-CAD geometry editor application (mged) has several hundred commands including two very simple commands for opening and closing a geometry database file.  While the user rarely ever needs to close the file, as all changes are always immediately saved, it can be of use to scripting applications.  However, at some point in the recent past, the ''closedb'' command was horked.  It's undoubtedly something very simple but we haven't bothered to look due to other priorities.  You can fix it.  If you run these simple steps within graphical mged, you should see how commands stop working after calling closedb:
Line 643: Line 764:
 
Code:
 
Code:
 
* src/mged/mged.c
 
* src/mged/mged.c
 +
 +
|}
  
 
&nbsp;
 
&nbsp;
 +
{| style="background-color:#666666;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
== Create geometry database with one of every primitive ==
 +
 +
BRL-CAD implements 40 different types of 2D, 3D, and non-geometric objects that get stored in a ".g" geometry database file.  For numerous debugging and testing purposes, it'd be useful to have a database with all object types included.  Our ''csgbrep'' procedural geometry database tool creates 21 of them.  Our ''mged'' geometry editor application lets users create them manually using the "make" and "in" commands via the command-line interface.
 +
 +
This task involves running the csgbrep to create a starting set of objects and then creating the remaining ones manually.  Provide a .g file that contains every possible object type.
 +
 +
References:
 +
* http://brlcad.org/wiki/Documentation
 +
* http://brlcad.org/wiki/EBM
 +
* http://brlcad.org/wiki/DSP
 +
* src/librt/primitives <-- lists all object types except comb, binunif, and attribute objects
 +
* csgbrep <-- creates half of what you need
 +
* mged <-- can create the other half
 +
 
|}
 
|}
 
&nbsp;
 
&nbsp;
−
 
+
{| style="background-color:#666666;" cellpadding="20" cellspacing="0" border="2" width="100%"
−
{| style="background-color:#fefefe; border-style: solid; border-width: 4px;" width="100%"
+
|
−
| style="padding: 20px;" |
+
== Create an utility library (LIBBU) API unit test ==
−
=== Create a utility library (LIBBU) API unit test ===
 
  
 
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 tests 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 examples.
+
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 803:
 
* src/libbu/tests/CMakeLists.txt
 
* src/libbu/tests/CMakeLists.txt
  
 +
{| style="background-color:#222222;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== ... unit test for LIBBU argv.c ===
 +
|}
 +
&nbsp;
 +
{| style="background-color:#222222;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== ... unit test for LIBBU avs.c ===
 +
|}
 +
&nbsp;
 +
{| style="background-color:#222222;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== ... unit test for LIBBU backtrace.c ===
 +
|}
 
&nbsp;
 
&nbsp;
 +
{| style="background-color:#222222;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== ... unit test for LIBBU badmagic.c ===
 
|}
 
|}
 
&nbsp;
 
&nbsp;
 +
{| style="background-color:#222222;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== ... unit test for LIBBU bomb.c ===
 +
|}
 +
|}
  
−
{| style="background-color:#fefefe; border-style: solid; border-width: 4px;" width="100%"
+
&nbsp;
−
| style="padding: 20px;" |
+
{| style="background-color:#666666;" cellpadding="20" cellspacing="0" border="2" width="100%"
−
 
+
|
−
=== Create Numerics library (LIBBN) API unit tests ===
+
== Create numerics library (LIBBN) API unit test ==
  
 
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 tests 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 examples.
+
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 843:
 
* include/vmath.h
 
* include/vmath.h
 
* src/libbn/*.c
 
* src/libbn/*.c
−
* src/libbn/tests/*.c <-- check this directory for examples
+
* src/libbu/tests/*.c <-- note libbu, not libbn for examples
−
* src/libbu/tests/*.c <-- Note: Also check this too for more examples.
 
  
 
Code:
 
Code:
Line 690: Line 849:
 
* src/libbn/tests/CMakeLists.txt
 
* src/libbn/tests/CMakeLists.txt
  
−
<b> Note </b>
+
{| style="background-color:#222222;" cellpadding="20" cellspacing="0" border="2" width="100%"
−
A valid task will constitute writing a basic test for each function in the following libbn/ files.
+
|
−
 
+
=== ... unit test for LIBBN list.c ===
 +
|}
 
&nbsp;
 
&nbsp;
−
 
+
{| style="background-color:#222222;" cellpadding="20" cellspacing="0" border="2" width="100%"
−
{| style="background-color:#efefef; border-style: solid; border-width: 4px;" width="100%"
+
|
−
| style="padding: 20px;" |
+
=== ... unit test for LIBBN axis.c ===
−
==== ... unit tests for LIBBN anim.c ====
+
|}
 
&nbsp;
 
&nbsp;
 +
{| style="background-color:#222222;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== ... unit test for LIBBN complex.c ===
 
|}
 
|}
 
&nbsp;
 
&nbsp;
−
 
+
{| style="background-color:#222222;" cellpadding="20" cellspacing="0" border="2" width="100%"
−
{| style="background-color:#efefef; border-style: solid; border-width: 4px;" width="100%"
+
|
−
| style="padding: 20px;" |
+
=== ... unit test for LIBBN qmath.c ===
−
==== ... unit tests for LIBBN axis.c ====
+
|}
 
&nbsp;
 
&nbsp;
 +
{| style="background-color:#222222;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== ... unit test for LIBBN rand.c ===
 
|}
 
|}
 +
|}
 +
 
&nbsp;
 
&nbsp;
 +
{| style="background-color:#666666;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
== Create a COMPREHENSIVE unit test for bn_dist_pt3_pt3() ==
  
−
{| style="background-color:#efefef; border-style: solid; border-width: 4px;" width="100%"
+
There are more than 300 library functions in our LIBBN numerics library. Creating a comprehensive unit test involves exhaustively exploring all possible inputs to the function, testing them for proper behavior, and characterizing the output in a PASS/FAIL fashion.
−
| style="padding: 20px;" |
 
−
==== ... unit tests for LIBBN qmath.c ====
 
−
&nbsp;
 
−
|}
 
−
&nbsp;
 
  
−
{| style="background-color:#efefef; border-style: solid; border-width: 4px;" width="100%"
+
Unlike the other testing framework tasks, the goal of this task is comprehensiveness.  The task must cover all possible inputs including NULL, -inf, +inf, NaN, real numbers, and other values in most if not all possible combinations.
−
| style="padding: 20px;" |
 
−
==== ... unit tests for LIBBN rand.c ====
 
−
&nbsp;
 
−
|}
 
−
&nbsp;
 
  
−
{| style="background-color:#efefef; border-style: solid; border-width: 4px;" width="100%"
+
Code:
−
| style="padding: 20px;" |
+
* include/bn.h
−
==== ... unit tests for LIBBN vector.c ====
+
* src/libbn/plane.c
−
&nbsp;
+
* src/libbn/tests/CMakeLists.txt
 +
* src/libbn/tests/bn_plane.c <-- you write this
 
|}
 
|}
−
&nbsp;
 
  
 
&nbsp;
 
&nbsp;
−
|}
+
{| style="background-color:#666666;" cellpadding="20" cellspacing="0" border="2" width="100%"
−
&nbsp;
+
|
−
 
+
== Find, reliably reproduce, and report any bug in Archer ==
−
{| style="background-color:#fefefe; border-style: solid; border-width: 4px;" width="100%"
 
−
| style="padding: 20px;" |
 
−
 
 
−
=== Find, reliably reproduce, and report any bug in Archer ===
 
  
 
Archer is our new modeling interface and a soon to merge with our long-standing MGED geometry editor.  It undoubtedly has bugs.  It's your job to find one, but do so in a manner that is so obvious that one of the other devs will be able to instantly reproduce the bug given your specific instructions.  Find a way to make archer crash, become unresponsive, or otherwise behave incorrectly.  You will have to explore the tool with minimal documentation.
 
Archer is our new modeling interface and a soon to merge with our long-standing MGED geometry editor.  It undoubtedly has bugs.  It's your job to find one, but do so in a manner that is so obvious that one of the other devs will be able to instantly reproduce the bug given your specific instructions.  Find a way to make archer crash, become unresponsive, or otherwise behave incorrectly.  You will have to explore the tool with minimal documentation.
Line 748: Line 905:
 
* 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
 +
|}
  
 
&nbsp;
 
&nbsp;
−
|}
+
{| style="background-color:#666666;" cellpadding="20" cellspacing="0" border="2" width="100%"
−
&nbsp;
+
|
−
 
+
== Reproduce any 10 unconfirmed open bug reports ==
−
{| style="background-color:#fefefe; border-style: solid; border-width: 4px;" width="100%"
 
−
| style="padding: 20px;" |
 
−
=== Reproduce any 10 unconfirmed open bug reports ===
 
  
 
BRL-CAD presently has approximately 75 open bug reports of which 50 are unassigned.  Read the comments and status to see if the bug has been confirmed/reproduced.   
 
BRL-CAD presently has approximately 75 open bug reports of which 50 are unassigned.  Read the comments and status to see if the bug has been confirmed/reproduced.   
Line 763: Line 918:
 
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
−
 
−
&nbsp;
 
 
|}
 
|}
−
&nbsp;
 
−
 
−
== User Interface ==
 
−
''Tasks related to user experience research or user interface design and interaction''
 
−
 
−
{| style="background-color:#fefefe; border-style: solid; border-width: 4px;" width="100%"
 
−
| style="padding: 20px;" |
 
−
=== Create an ISST screenshot or animation ===
 
−
 
−
Everyone loves to see screenshots and animations of software in action. We use both in our marketing and outreach. See some of the examples below that we already have.
 
−
 
−
Create an awesome screenshot and/or animation of our 'isst' tool in action. It's an interactive geometry viewer interface.  It should be graphically interesting and give some sense of capability.  You should import a visually complex and interesting model with LOTS of polygons and detail.  Note you may have to go through some or the MGED tutorials (see Docs on our website).
 
  
−
References:
 
−
* https://brlcad.org/gallery/index.php?/category/12
 
−
 
−
&nbsp;
 
−
|}
 
 
&nbsp;
 
&nbsp;
 +
{| style="background-color:#666666;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
== Fix documentation XML errors in doc/docbook/articles ==
  
−
{| style="background-color:#fefefe; border-style: solid; border-width: 4px;" width="100%"
+
Some of BRL-CAD's existing documentation has been converted to DocBook format, but not all of the new files pass strict XML validation.  We want to make our existing pages conform strictly.  The simplest way to find documents with errors is to add a CMake configuration flag when preparing to build BRL-CAD that enables a strict check when make is run.  Adding this flag will cause a build failure if there's a syntax error:
−
| style="padding: 20px;" |
 
  
−
=== Categorize commands into a spreadsheet ===
+
-DBRLCAD_EXTRADOCS_VALIDATE=ON
  
−
BRL-CAD is a suite of more than 400 commands, processing tools, image tools, geometry converters, and more.  MGED also has a command-line with hundreds of commands too.  Help us reorganize one of those command sets.
+
Generally, the resulting error message will provide hints that can be used to identify and fix the problem.  Also, once it is clear how to address one particular problem, it is likely that that problem will occur multiple times in different files.  This will make the process faster once initial errors are solved.   
  
−
This task involves creating a spreadsheet that lists all commands and groups them together into a finite set of categories or labels.  This spreadsheet will help us identify places where commands can be consolidated, commands we might want to consider removing, common groupings for documentation, etc.   
+
This task involves preparing a BRL-CAD compilation environment with validation enabled, then cleaning up the DocBook XML files under the doc/docbook/articles directory (e.g., doc/docbook/articles/en/pipes.xml), fixing whatever errors arise and submitting a patch.  You can build test your changes by compiling just a subset of the documentation.  In your ''build'' directory (not source), you can run this:
  
−
&nbsp;
+
# in your build directory
−
|}
+
cd doc/docbook/articles
−
&nbsp;
+
make
  
−
{| style="background-color:#fefefe; border-style: solid; border-width: 4px;" width="100%"
+
Once you're done, make and submit your patch:
−
| style="padding: 20px;" |
+
svn diff ~/brlcad.svn/doc/docbook/articles > xmlfixes.patch
  
−
===  Design a Cover Photo for Facebook (and other social media) ===
+
Keep track of how long this all takes you because we intend to add a lot more tasks like this one.
−
 
 
−
BRL-CAD website and marketing materials are constantly undergoing change.  Effective marketing requires well designed and attractive imagery. Imagery ideally should showcase some feature of BRL-CAD, some highlight, something visually interesting and compelling.
 
  
 
References:
 
References:
−
* https://www.facebook.com/brlcad
+
* doc/docbook/README
 +
* DocBook 5 Reference: http://docbook.org/tdg5/en/html/docbook.html
 +
* Emacs editor: http://www.gnu.org/software/emacs/emacs.html
 +
* nxml Emacs mode: http://www.thaiopensource.com/nxml-mode/
  
−
&nbsp;
+
Code:
 +
* doc/docbook/articles/*/*.xml
 
|}
 
|}
−
&nbsp;
 
  
−
{| style="background-color:#fefefe; border-style: solid; border-width: 4px;" width="100%"
+
----
−
| style="padding: 20px;" |
 
−
=== Create a video for BRL-CAD  ===
 
  
−
Watching someone else use software is incredibly helpful to some.  Create a screen-cast video for BRL-CAD that showcases some  feature, goes over steps involved in creating some model, or shows how to accomplish some other task.
+
= User Interface =
−
 
+
----
−
You'll need to install BRL-CAD on your computer and use it in the video.  Create or import some model and make a recording.
+
''Tasks related to user experience research or user interface design and interaction''
−
 
 
−
&nbsp;
 
−
|}
 
−
&nbsp;
 
−
 
 
−
= 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:
 
−
 
 
−
svn co https://brlcad.svn.sourceforge.net/svnroot/brlcad/brlcad/trunk brlcad.edit
 
−
cd brlcad.edit
 
−
# make changes
 
−
svn diff > ~/my.patch
 
−
# read ~/my.patch file with text editor
 
−
cd ..
 
−
svn co https://brlcad.svn.sourceforge.net/svnroot/brlcad/brlcad/trunk brlcad.fresh
 
−
cd brlcad.fresh
 
−
patch -p0 < ~/my.patch
 
−
# submit your patch file to our patches tracker
 
−
&nbsp;
 

Please note that all contributions to BRL-CAD may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see BRL-CAD:Copyrights for details). Do not submit copyrighted work without permission!

To edit this page, please answer the question that appears below (more info):

Cancel Editing help (opens in new window)
Retrieved from "https://brlcad.org/wiki/Deuces"