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 familiar with the prerequisites 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 effortEach 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:
+
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 the disk image, start the VM, and log in (password is "Brlcad!" without quotes).
+
# Import and start the VM, log in (the password is "Brlcad!" without the quotes).
# Run "svn up brlcad-svn-trunk" and [[Compiling#Configure_your_Build|compile]].
+
# Run "svn up brlcad.svn" and get started!
  
= Pick a Task =
+
=Pick a Task=
  
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 thisAll tasks can be completed by '''''anyone''''' but are grouped into the following five interest categories:
+
We break down all tasks into one of five categories.  Don't be worried if the tasks all sound confusing to youJust pick one and start reading the references we've providedJoin IRC or our mailing list and ask questions.
  
* Code (programming)
+
# Code (programming)
* Documentation and Training (technical writing)
+
# Documentation and Training (writing)
* Outreach and Research (graphics, marketing)
+
# Outreach and Research (graphics)
* Quality Assurance (testing)
+
# Quality Assurance (testing)
* User Interface (usability, design)
+
# 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:#fefefe; border-style: solid; border-width: 4px;" width="100%"
+
|}
| style="padding: 20px;" |
+
 
=== Close MGED only when both windows are closed ===
+
 
 +
{| 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 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
 
  
 +
|}
 
 
 
 
 +
{| 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%"
 +
|
  
{| 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
 +
 
 +
 
 +
{| 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
+
 
 +
|}
  
 
 
 
 
 +
{| 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) ====
  
{| 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.
+
|}
 +
 
 +
{| 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
+
 
* http://en.wikipedia.org/wiki/Radius_of_curvature_(mathematics)
+
{| 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
 
  
 +
|}
 
 
 
 
 +
{| 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) ====
  
{| 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.
+
 
 
+
{| 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
 
  
 
 
 
|}
 
|}
 +
|}
 +
 
 
 
 
 +
{| style="background-color:#ffffff;" 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 primitivesThe 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.
+
{| 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;
 +
{| cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
==== ... volume function for superellipsoids (SUPERELL) ====
 +
 +
Code:
 +
* src/librt/primitives/superell/superell.c
 +
 
|}
 
|}
 
&nbsp;
 
&nbsp;
 +
{| 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,
+
{| 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
  
References:
+
|}
* https://brlcad.org/docs/api/
+
&nbsp;
* https://brlcad.org/wiki/Example_Application
+
{| cellpadding="20" cellspacing="0" border="2" width="100%"
* https://stackoverflow.com/questions/9600801/evenly-distributing-n-points-on-a-sphere
+
|
* https://karthikkaranth.me/blog/generating-random-points-in-a-sphere/
+
==== ... volume function for solid polygonal meshes (NMG) ====
 +
 
 +
Code:
 +
* src/librt/primitives/nmg/nmg.c
  
&nbsp;
 
 
|}
 
|}
 
&nbsp;
 
&nbsp;
 +
{| 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:#ffffff;" 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 tableYou'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 ellipsoidWikipedia, 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 primtiivesThe 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:
 +
* src/librt/primitives/table.c
 +
* src/librt/primitives/[PRIMITIVE]/[PRIMITIVE].c
  
Code References:
 
* src/libged/display_list.c
 
* src/libged/color/color.c
 
* src/librt/prep.c
 
  
 +
{| cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
==== ... centroid function for right hyperbolic cylinders (RHC) ====
 +
|}
 +
&nbsp;
 +
{| cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
==== ... centroid function for gridded volumes (VOL) ====
 +
|}
 +
&nbsp;
 +
{| cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
==== ... centroid function for N-faced polysolids (ARBN) ====
 +
|}
 
&nbsp;
 
&nbsp;
 +
{| cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
==== ... centroid function for extruded sketches (EXTRUDE) ====
 
|}
 
|}
 
&nbsp;
 
&nbsp;
 +
{| cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
==== ... centroid function for superellipsoids (SUPERELL) ====
 +
|}
 +
&nbsp;
 +
{| cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
==== ... centroid function for solid polygonal meshes (NMG) ====
 +
|}
 +
&nbsp;
 +
 +
|}
 +
&nbsp;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
 +
=== Implement a primitive UV-mapping callback ===
  
{| 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.  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.
| style="padding: 20px;" |
 
  
=== Stub in an OpenVDB object ===
+
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.
  
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.
+
References:
 +
* http://en.wikipedia.org/wiki/UV_mapping
 +
* src/librt/primitives/[PRIMITIVE]/[PRIMITIVE].c, read the rt_*_uv() function
  
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.
+
{| 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:#ffffff;" 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) ===
  
Line 229: Line 352:
 
* doc/docbook/system/man1/en/*.xml
 
* doc/docbook/system/man1/en/*.xml
  
&nbsp;
 
 
|}
 
|}
 +
 
&nbsp;
 
&nbsp;
 +
{| style="background-color:#ffffff;" 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:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
&nbsp;
+
|
 
 
{| style="background-color:#fefefe; border-style: solid; border-width: 4px;" width="100%"
 
| style="padding: 20px;" |
 
 
 
 
=== 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 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:#ffffff;" 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 ===
  
Line 315: Line 407:
 
* http://www.stack.nl/~dimitri/doxygen/
 
* http://www.stack.nl/~dimitri/doxygen/
  
&nbsp;
+
{| 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 LIBBU ====
 
==== ... doxygen cleanup for LIBBU ====
  
Line 328: Line 418:
 
* misc/Doxyfile
 
* misc/Doxyfile
  
&nbsp;
 
 
|}
 
|}
 +
 
&nbsp;
 
&nbsp;
 
+
{| 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 ====
  
Line 344: Line 433:
 
* misc/Doxyfile
 
* misc/Doxyfile
  
&nbsp;
 
 
|}
 
|}
 
&nbsp;
 
&nbsp;
 
+
{| 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 ====
  
Line 361: Line 448:
 
* src/librt/binunif
 
* src/librt/binunif
 
* misc/Doxyfile
 
* misc/Doxyfile
 +
|}
 +
|}
  
 
&nbsp;
 
&nbsp;
 +
{| 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.
 +
 +
References:
 +
* 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:
 +
 +
* 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.
 +
 
|}
 
|}
&nbsp;
 
  
 
&nbsp;
 
&nbsp;
|}
+
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
&nbsp;
+
|
 
+
=== Write up Wiki page tutorial on our Volumetric Primitive ===
{| style="background-color:#fefefe; border-style: solid; border-width: 4px;" width="100%"
 
| style="padding: 20px;" |
 
=== Add images to our wiki page on Volumetric objects ===
 
  
 
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 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 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 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:
 
References:
* http://brlcad.org/wiki/VOL
 
 
* http://brlcad.org/wiki/DSP
 
* http://brlcad.org/wiki/DSP
 
* http://brlcad.org/wiki/Sketch
 
* http://brlcad.org/wiki/Sketch
* http://brlcad.org/wiki/EBM
+
* 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
  
&nbsp;
 
 
|}
 
|}
 +
 
&nbsp;
 
&nbsp;
 +
{| 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 ===
  
{| style="background-color:#fefefe; border-style: solid; border-width: 4px;" width="100%"
+
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.
| style="padding: 20px;" |
+
 
=== Fix Image Formatting in BRL-CAD's DocBook Documentation (any ONE large document or 4 smaller documents) ===
+
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:
 +
* 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
  
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.
+
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.
  
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:
+
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
  
  <mediaobject>
+
|}
    <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:
+
----
  
  <mediaobject>
+
==Outreach and Research ==
    <imageobject role="html">
+
----
      <imagedata align="center" fileref="../../books/en/images/img.png" format="PNG"/>
+
''Tasks related to community management, outreach/marketing, studying problems, and recommending solutions''
    </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:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
  
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.
+
=== Investigate permuted vertex lists from g-iges + iges-g ===
  
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 generationIf 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.
+
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 listsParticularly for geometry already in polygonal format, such as our NMG or BoT geometry, this conversion should result in identical geometry but presently does not.
  
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.
* doc/docbook/books/en/BRL-CAD_Tutorial_Series-VolumeIII.xml
 
  
 
Code:
 
Code:
* doc/docbook
+
* src/conv/iges
  
&nbsp;
 
 
|}
 
|}
 +
 
&nbsp;
 
&nbsp;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== Write article on BRL-CAD's code hardening efforts ===
  
{| style="background-color:#fefefe; border-style: solid; border-width: 4px;" width="100%"
+
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.
| 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.  
+
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.
  
Links:
+
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).
https://github.com/BRL-CAD/OGV-meteor/
 
  
&nbsp;
+
Resources:
|}
+
* http://brlcad.org/wiki/Code_Cleanup
&nbsp;
+
* http://brlcad.org/d/node/96
 +
* http://www.coverity.com/library/pdf/coverity-scan-2011-open-source-integrity-report.pdf
  
==Outreach and Research ==
+
Add the article to http://brlcad.org/wiki/Community_Publication_Portal
''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="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..
 
  
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:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== Write an article soliciting a Windows platform maintainer ===
  
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 runs on a number of platforms and distributes releases many times a year.  Creating a release for any particular binary platform, like Windows or Mac OS X or Linux, is delegated to a "release maintainer".  We currently have maintainers for a number of platforms but do not have one for Windows.  Basically, it's a volunteer job, it's a lot of work, but not very hard and very rewarding.  There are thousands of binary downloads every month, so lots of people benefit from a maintainer's efforts.
  
To capture prep performance, you will need to import some fairly complex geometryYou should be able to search google with "filetype:3dm" or "filetype:step" or find something on grabcad.com to import
+
This task involves writing a brief solicitation article announcing our interest for a maintainer, describing the responsibilities involved, and telling them how to take up this responsibilityCome talk to us on IRC for more specific details.
  
Running "tops" within mged will tell you what geometry is available for rendering.
+
Resources:
 +
* http://svn.code.sf.net/p/brlcad/code/brlcad/trunk/HACKING
 +
(See the release section near the bottom to see what maintainers do)
  
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.
+
Add the article to http://brlcad.org/wiki/Community_Publication_Portal
  
&nbsp;
 
 
|}
 
|}
 +
 
&nbsp;
 
&nbsp;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== 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.
  
{| style="background-color:#fefefe; border-style: solid; border-width: 4px;" width="100%"
+
References:
| style="padding: 20px;" |
+
* http://brlcad.org/gallery/d/19-4/MGED.jpg
=== Continue investigating GMP integration ===
+
* http://brlcad.org/tmp/archer.png
 +
* http://brlcad.org/gallery/s/screenshots/
 +
* http://www.google-melange.com/gci/task/view/google/gci2012/8019211
  
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 onThis task is a continuation of a prior GCI task (read it in full!):
+
Note that we have several screenshot tasks. Note you may have to go through some or our basic MGED tutorials (see docs section on our website) just to be able to display geometryFinally, give others a chance if you already completed one of the other screenshot tasks. ;)
 +
|}
  
http://www.google-melange.com/gci/task/view/google/gci2012/7946218
+
&nbsp;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== Generate a code coverage report (lcov+gcov) ===
  
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.
+
This task involves setting up and generating an lcov code coverage analysis on BRL-CAD.  After learning how to use the tool, discuss with the developers what portion of the code will be most useful to analyze, or scan these:
  
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.
+
"benchmark"
 +
"make test"
 +
"make regress"
 +
Submit the results.
  
&nbsp;
 
 
|}
 
|}
 +
 
&nbsp;
 
&nbsp;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== Model BRL-CAD logo in BRL-CAD ===
  
{| style="background-color:#fefefe; border-style: solid; border-width: 4px;" width="100%"
+
The BRL-CAD Logo depicts two interlocked nodes. 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 that we can use for a number of purposes..
| 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.
+
The output of this task will be a .g file of BRL-CAD logo and a rendered image. The two segments you model MUST be two or more regions, ideally hinged together (you can have center pins or not, you decide)This is your opportunity as an artist and 3D magician to come up with an interesting yet faithful interpretation.
 
 
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/openNURBSLast 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.
 
 
 
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.
 
  
 
References:
 
References:
* https://github.com/mcneel/opennurbs
+
* http://brlcad.org/images/angelov_256.png
 +
* http://brlcad.org/d/node/92
 +
* Introduction to MGED at http://brlcad.org/wiki/Documentation
  
Code:
+
Note that there are other logo modeling tasks and yours must start from scratch and be completely original.  If we get a hint that yours was based off of or used measurements from some other model, you will be barred.
* src/other/openNURBS <- replace existing with latest openNURBS from github
 
  
&nbsp;
 
 
|}
 
|}
 +
 
&nbsp;
 
&nbsp;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== Profile NURBS prep performance ===
  
{| style="background-color:#fefefe; border-style: solid; border-width: 4px;" width="100%"
+
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..
| 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 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.
  
Logo References
+
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.
* [https://brlcad.org/img/logo_color.png BRL-CAD Logo]
 
  
&nbsp;
+
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
 +
 
 +
Running "tops" within mged will tell you what geometry is available for rendering.
 +
 
 +
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;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== Continue investigating GMP integration ===
  
{| style="background-color:#fefefe; border-style: solid; border-width: 4px;" width="100%"
+
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!):
| 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.  
+
http://www.google-melange.com/gci/task/view/google/gci2012/7946218
  
Logo References
+
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.
* [https://brlcad.org/img/logo_color.png BRL-CAD Logo]
+
 
 +
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:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== Create prototype 2D Drawing ===
  
{| style="background-color:#fefefe; border-style: solid; border-width: 4px;" width="100%"
+
BRL-CAD provides limited services for drafting features including the production of 2D CAD drawings (blueprints).
| 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.
+
This task involves designing a 2D CAD drawing prototype. The prototype MUST capture a set of design requirements and follows industry conventions.
  
Logo References
+
If you've never seen a real blueprint drawing before, then this task might be too hard for you.  Your result needs to refer to ISO 128 and/or ASME Y14.41 or other standard drawing elements.  
* [https://brlcad.org/img/logo_color.png BRL-CAD Logo]
 
  
&nbsp;
+
Basically, identifying a style of drawing that we should support including pointing out the critical elements to be included on each drawing, their location, size, placement, etc.
|}
 
&nbsp;
 
  
{| style="background-color:#fefefe; border-style: solid; border-width: 4px;" width="100%"
+
References:
| style="padding: 20px;" |
+
* http://brlcad.org/design/drafting
=== Design a wallpaper / desktop image for BRL-CAD ===
+
* http://en.wikipedia.org/wiki/ISO_128
 +
* http://en.wikipedia.org/wiki/ASME_Y14.41-2003
 +
* http://en.wikipedia.org/wiki/Geometric_Dimensioning_and_Tolerancing
 +
* http://www.ptc.com/WCMS/files/45691/en/4307_FoundationXE_DS.pdf
  
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-CADBe intentional and able to defend/describe your choice of color, layout, and other aspects of the wallpaper design.
+
Note that this is a "redo" of a previous GCI taskRead the discussion thread and his work to help ensure you don't make similar mistakes. ;-)
 
Try to make sure the wallpaper works across a broad selection of screen resolutions.
 
  
Search the web for wallpapers inspiration such as:
+
http://www.google-melange.com/gci/task/view/google/gci2012/7985229
* http://www.smashingmagazine.com/tag/wallpapers/
 
  
Logo References
 
* [https://brlcad.org/img/logo_color.png BRL-CAD Logo]
 
 
&nbsp;
 
 
|}
 
|}
&nbsp;
 
 
{| style="background-color:#fefefe; border-style: solid; border-width: 4px;" width="100%"
 
| 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.
 
 
See this lightcycle discussion thread
 
* http://www.tron-sector.com/forums/default.aspx?a=top&id=336281
 
  
&nbsp;
+
----
|}
 
&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:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
| style="padding: 20px;" |
+
|
 
=== Fix single-precision floating point crash ===
 
=== Fix single-precision floating point crash ===
  
Line 620: Line 722:
 
* src/liboptical/sh_light.c
 
* src/liboptical/sh_light.c
  
&nbsp;
 
 
|}
 
|}
 +
 
&nbsp;
 
&nbsp;
 
+
{| style="background-color:#ffffff;" 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 ===
  
Line 644: Line 745:
 
* src/mged/mged.c
 
* src/mged/mged.c
  
&nbsp;
 
 
|}
 
|}
 +
 
&nbsp;
 
&nbsp;
 
+
{| style="background-color:#ffffff;" 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 765:
 
* src/libbu/tests/CMakeLists.txt
 
* src/libbu/tests/CMakeLists.txt
  
 +
{| cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
==== ... unit test for LIBBU badmagic.c ====
 +
|}
 
&nbsp;
 
&nbsp;
 +
{| cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
==== ... unit test for LIBBU bomb.c ====
 
|}
 
|}
 +
|}
 +
 
&nbsp;
 
&nbsp;
 
+
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
{| style="background-color:#fefefe; border-style: solid; border-width: 4px;" width="100%"
+
|
| style="padding: 20px;" |
+
=== Create numerics library (LIBBN) API unit test ===
 
 
=== Create Numerics library (LIBBN) API unit tests ===
 
  
 
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 790:
 
* 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 796:
 
* src/libbn/tests/CMakeLists.txt
 
* src/libbn/tests/CMakeLists.txt
  
<b> Note </b>
+
{| 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 axis.c ====
&nbsp;
 
 
 
{| style="background-color:#efefef; border-style: solid; border-width: 4px;" width="100%"
 
| style="padding: 20px;" |
 
==== ... unit tests for LIBBN anim.c ====
 
&nbsp;
 
 
|}
 
|}
 
&nbsp;
 
&nbsp;
 
+
{| 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;
 
&nbsp;
 
+
{| 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 rand.c ====
==== ... unit tests for LIBBN qmath.c ====
 
&nbsp;
 
 
|}
 
|}
&nbsp;
 
 
{| style="background-color:#efefef; border-style: solid; border-width: 4px;" width="100%"
 
| style="padding: 20px;" |
 
==== ... unit tests for LIBBN rand.c ====
 
&nbsp;
 
 
|}
 
|}
&nbsp;
 
  
{| style="background-color:#efefef; border-style: solid; border-width: 4px;" width="100%"
 
| style="padding: 20px;" |
 
==== ... unit tests for LIBBN vector.c ====
 
 
&nbsp;
 
&nbsp;
|}
+
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
&nbsp;
+
|
 
 
&nbsp;
 
|}
 
&nbsp;
 
 
 
{| style="background-color:#fefefe; border-style: solid; border-width: 4px;" width="100%"
 
| style="padding: 20px;" |
 
 
 
 
=== Find, reliably reproduce, and report any bug in Archer ===
 
=== Find, reliably reproduce, and report any bug in Archer ===
  
Line 748: Line 826:
 
* 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:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
&nbsp;
+
|
 
 
{| style="background-color:#fefefe; border-style: solid; border-width: 4px;" width="100%"
 
| style="padding: 20px;" |
 
 
=== Reproduce any 10 unconfirmed open bug reports ===
 
=== Reproduce any 10 unconfirmed open bug reports ===
  
Line 763: Line 839:
 
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 ==
 
== 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''
  
{| style="background-color:#fefefe; border-style: solid; border-width: 4px;" width="100%"
+
&nbsp;
| style="padding: 20px;" |
+
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== Design a prototype CAD GUI layout ===
 +
 
 +
BRL-CAD's usability is notoriously complex and "expert friendly". MGED and Archer are the main geometry editors, with drastically different user interfaces.
 +
 
 +
This task involves evaluating the features provided by MGED and Archer, then designing a new GUI layout that encompasses their features while improving usability. Rationale for design decisions and layout should be provided.
 +
 
 +
References:
 +
* http://brlcad.org/design/gui
 +
 
 +
Provide one or more mock-up images (png, pdf, psd, html, whatever)
 +
 
 +
Search for other similar GCI tasks to avoid making a similar design.  You can use any tools, but your work must be original.
 +
|}
 +
 
 +
&nbsp;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 
=== Create an ISST screenshot or animation ===
 
=== 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.
 
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).
+
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.
  
 
References:
 
References:
* https://brlcad.org/gallery/index.php?/category/12
+
* http://brlcad.org/gallery/d/19-4/MGED.jpg
 +
* http://brlcad.org/tmp/archer.png
 +
* http://brlcad.org/gallery/s/screenshots/
 +
* http://www.google-melange.com/gci/task/view/google/gci2012/8019211
 +
 
 +
Note that we have several screenshot tasks.  Note you may have to go through some or our basic MGED tutorials (see docs section on our website) just to be able to display geometry.  Finally, give others a chance if you already completed one of the other screenshot tasks. ;)
 +
 
 +
|}
  
 
&nbsp;
 
&nbsp;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== Categorize all of BRL-CAD's commands into a spreadsheet ===
 +
 +
BRL-CAD is a suite of more than 400 processing tools, image tools, geometry converters, and more. There is an existing spreadsheet that characterizes all of the available commands in terms of inputs, outputs, and options, but there is insufficient characterization of BRL-CAD's commands as to how they logically group and work together.
 +
 +
This task involves building up a spreadsheet that lists all of our commands, describing a finite set of command categories, and characterizing all commands into those categories while filling in the spreadsheet with details for each command.
 +
 +
References:
 +
* A spreadsheet template will be provided.
 +
 
|}
 
|}
 +
 
&nbsp;
 
&nbsp;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== Redesign MGED/Archer's Menu ===
  
{| style="background-color:#fefefe; border-style: solid; border-width: 4px;" width="100%"
+
BRL-CAD's geometry editing applications, like most graphical applications, have an application menu with a variety of features, capabilities, and options, but with little attention to cohesive design.
| style="padding: 20px;" |
 
  
=== Categorize commands into a spreadsheet ===
+
Review the menus for MGED and Archer.  Design a new menu system based on both of them that eliminates confusion, is easier to navigate, and has menu options more logically grouped together.
  
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.
+
References:
 +
* mged
 +
* archer
  
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.
+
Provide screenshots or detailed text indicating what menu options should be available and what exactly is on each menu.
  
&nbsp;
 
 
|}
 
|}
 +
 
&nbsp;
 
&nbsp;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== Create Wordpress theme for BRL-CAD website ===
  
{| style="background-color:#fefefe; border-style: solid; border-width: 4px;" width="100%"
+
BRL-CAD's website was recently redesigned.  The current website uses Drupal and Mediawiki.  Our new website will be using Wordpress and Mediawiki.
| style="padding: 20px;" |
 
  
===  Design a Cover Photo for Facebook (and other social media) ===
+
This task involves creating a custom Wordpress theme based on our new website design.
 
 
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
+
* http://cpp-tricks.com/brlcad/
  
&nbsp;
 
 
|}
 
|}
 +
 
&nbsp;
 
&nbsp;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== Migrate Drupal site to Wordpress ===
  
{| style="background-color:#fefefe; border-style: solid; border-width: 4px;" width="100%"
+
BRL-CAD's main website content runs on Drupal. There are a lot of articles, user accounts, and other information contained within this installation of Drupal.
| 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.
+
This task involves setting up an installation of Wordpress on our production server and migrating the data from Drupal into the Wordpress site.
  
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.
+
References:
 +
* http://brlcad.org/d/
  
&nbsp;
+
This task requires that you establish an account on one of our servers.  There is a setup process involved.  Join us on IRC for details.
 
|}
 
|}
&nbsp;
+
 
 +
----
  
 
= 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:

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)