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 12: Line 12:
 
# [https://www.virtualbox.org/wiki/Downloads Install VirtualBox.]
 
# [https://www.virtualbox.org/wiki/Downloads Install VirtualBox.]
 
# Import and start the VM, log in (the password is "Brlcad!" without the quotes).
 
# Import and start the VM, log in (the password is "Brlcad!" without the quotes).
# Run "svn up brlcad-svn-trunk" and get started!
+
# Run "svn up brlcad.svn" and get started!
  
 
=Pick a Task=
 
=Pick a Task=
Line 59: Line 59:
 
Code:
 
Code:
 
* src/mged/mged.c
 
* src/mged/mged.c
* src/tclscripts/mged/openw.tcl
+
* src/tclscripts/mged/openw.c
  
 
|}
 
|}
 
 
 
 
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== Add MGED key-binding to reopen the command window ===
 +
 +
BRL-CAD has an interactive geometry editor called MGED. It's often the starting point for beginners and allows creation and manipulation of models using commands. When MGED is invoked, it creates 2 windows:  a text-console command window and an interactive graphics window.  If the user closes the text-console command window, they are left with the interactive graphics window.  There is presently no way (correct us if we're wrong) to get the text-console back without restarting mged.  A good way to test this is to run in classic mode and run the 'gui' command:
 +
 +
sushi:~ morrison$ mged -c test.g
 +
BRL-CAD Release 7.22.0  Geometry Editor (MGED)
 +
    Fri, 24 Aug 2012 00:02:42 -0400, Compilation 6
 +
    morrison@sushi.local:/usr/brlcad/rel-7.22.0
 +
 +
attach (nu|X|ogl)[nu]? 
 +
mged> gui
 +
 +
This task involves adding some mechanism, perhaps a simple key binding, to the graphics window so that you can get the command window back on-demand.
 +
 +
Code:
 +
* src/mged/mged.c
 +
* src/tclscripts/mged/openw.c
  
 +
|}
  
 +
 
 
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 
|
 
|
  
=== Implement a primitive centroid function ===
+
=== Implement a primitive surface area function ===
  
 
BRL-CAD provides more than two dozen types of geometry "primitives" such as ellipsoids, boxes, and cones.  Every primitive is described by a collection of callback functions, for example rt_ell_bbox() returns the bounding box dimensions for an ellipsoid.  Wikipedia, Wolfram Mathworld, and various other math sites (and research papers) around the web include the equations for most of our basic primitives while others are a little more tricky to compute.
 
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:
 +
* src/librt/primitives/ehy/ehy.c
 +
 
 +
|}
 +
 
 +
 
 +
{| cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
==== ... surface area function for hyperboloids of one sheet (HYP) ====
 +
 
 +
Code:
 +
* src/librt/primitives/hyp/hyp.c
 +
 
 +
|}
 +
 
 +
 
 +
{| cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
==== ... surface area function for N-faced polysolid (ARBN) ====
  
 
Code:
 
Code:
* src/librt/primitives/table.c
+
* src/librt/primitives/arbn/arbn.c
* src/librt/primitives/[PRIMITIVE]/[PRIMITIVE].c
 
  
 
|}
 
|}
 
 
 
 
 +
{| cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
==== ... surface area function for extruded bitmaps (EBM) ====
  
 +
Code:
 +
* src/librt/primitives/ebm/ebm.c
  
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
+
|}
 +
 
 +
{| cellpadding="20" cellspacing="0" border="2" width="100%"
 
|
 
|
 +
==== ... surface area function for gridded volumes (VOL) ====
  
=== Implement a primitive curvature function ===
+
Code:
 +
* src/librt/primitives/vol/vol.c
  
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 sphere.  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 super ellipsoids (SUPERELL) ====
  
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/superell/superell.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 polygonal meshes (NMG) ====
  
 
Code:
 
Code:
* src/librt/primitives/table.c
+
* src/librt/primitives/nmg/nmg.c
* src/librt/primitives/[PRIMITIVE]/[PRIMITIVE].c
 
  
 
|}
 
|}
 +
 
 
 
 
 +
{| cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
==== ... surface area function for NURBS objects (BREP) ====
 +
 +
Code:
 +
* src/librt/primitives/brep/brep.cpp
  
 +
|}
 +
|}
  
 +
 
 
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 
|
 
|
  
=== Implement a primitive UV-mapping callback ===
+
=== Implement a primitive volume function ===
  
BRL-CAD provides more than two dozen types of geometry "primitives" such as ellipsoids, boxes, and cones.  Every primitive is described by a collection of callback functions, for example rt_ell_bbox() returns the bounding box dimensions for an ellipsoid.  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.
+
BRL-CAD provides more than two dozen types of geometry "primitives" such as ellipsoids, boxes, and cones.  Every primitive is described by a collection of callback functions, for example rt_ell_bbox() returns the bounding box dimensions for an ellipsoid.  Wikipedia, Wolfram Mathworld, and various other math sites (and research papers) around the web include the equations for most of our basic primitives while others are a little more difficult to compute.
  
This task involves implementing a UV-mapping callback for any of the primitives that do not already have a functional UV-callback definedNote 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.
+
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.
  
 
References:
 
References:
* http://en.wikipedia.org/wiki/UV_mapping
+
* http://en.wikipedia.org/wiki/Volume
* src/librt/primitives/[PRIMITIVE]/[PRIMITIVE].c, read the rt_*_uv() function
+
* http://mathworld.wolfram.com/
 +
* http://www.dtic.mil/cgi-bin/GetTRDoc?AD=AD0274936
 +
* include/raytrace.h: See ft_volume callback defined in rt_functab structure
  
 
{| cellpadding="20" cellspacing="0" border="2" width="100%"
 
{| cellpadding="20" cellspacing="0" border="2" width="100%"
 
|
 
|
==== ... UV-mapping for extruded sketches (EXTRUDE) ====
+
==== ... volume function for elliptical hyperboloids (EHY) ====
  
 
Code:
 
Code:
* src/librt/primitives/extrude/extrude.c
+
* src/librt/primitives/ehy/ehy.c
* src/librt/primitives/table.c
 
* include/rtgeom.h
 
  
 
|}
 
|}
 +
 
 
 
 
 +
{| cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
==== ... volume function for superellipsoids (SUPERELL) ====
 +
 +
Code:
 +
* src/librt/primitives/superell/superell.c
  
 
|}
 
|}
 
 
 
 
 +
{| cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
==== ... volume function for extruded bitmaps (EBM) ====
 +
 +
Code:
 +
* src/librt/primitives/ebm/ebm.c
 +
 +
|}
 +
 
 
 
 
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
+
{| cellpadding="20" cellspacing="0" border="2" width="100%"
 
|
 
|
=== Implement a platform independent re-entrant sort function ===
+
==== ... volume function for triangle meshes (BOT) ====
  
The classic C library qsort() does not support a context parameter.  A work around is to store the context information in a static variable.  However, this solution is not thread save and may result in unpredictable behavior.
+
Code:
 +
* src/librt/primitives/bot/bot.c
  
There are platform specific sort functions qsort_r() in incompatible versions for BSD and GNU and qsort_s() for MSVC.  Your task is to implement a bu_sort() function for BRL-CAD which is platform independent.
+
|}
 +
 
 +
{| cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
==== ... volume function for solid polygonal meshes (NMG) ====
  
 
Code:
 
Code:
* src/libbu/sort.c
+
* src/librt/primitives/nmg/nmg.c
  
The new sort function could look like this:
 
void bu_sort(genptr_t array, size_t nummemb, size_t sizememb, int (*compare)(const_genptr_t, const_genptr_t, genptr_t), genptr_t context);
 
 
|}
 
|}
 
 
 
 
 +
{| cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
==== ... volume function for extruded sketches (EXTRUDE) ====
  
----
+
Code:
 +
* src/librt/primitives/extrude/extrude.c
 +
 
 +
|}
  
 
|}
 
|}
 
 
 
 
 
 
 
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 
|
 
|
=== Solve fonts related bug in new wiki theme ===
 
  
BRL-CAD has been working on a new incarnation of the website and has developed a new wiki theme and wordpress theme. Wiki theme uses a font called 'open-sans' from google fonts directory. It's linked via CSS but it does not get loaded (we still see default serif all over the place). So your task will be to debug the CSS code and get Open Sans loaded.  
+
=== Implement a primitive centroid function ===
 +
 
 +
BRL-CAD provides more than two dozen types of geometry "primitives" such as ellipsoids, boxes, and cones.  Every primitive is described by a collection of callback functions, for example rt_ell_bbox() returns the bounding box dimensions for an ellipsoid.  Wikipedia, Wolfram Mathworld, and various other math sites (and research papers) around the web include the equations for most of our basic primitives while others are a little more tricky to compute.
 +
 
 +
This task involves writing a new callback function that takes an rt_db_internal object and calculates its centroid (as a point_t 3D point). There are numerous examples in our code where we compute centroids for other primtiives. The primitives that do not already have a centroid callback are itemized in following.
  
Links:
+
References:
*http://beta.brlcad.org/wiki/Main_Page
+
* 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
  
----
 
  
 +
{| cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
==== ... centroid function for right hyperbolic cylinders (RHC) ====
 +
|}
 +
 
 +
{| cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
==== ... centroid function for gridded volumes (VOL) ====
 +
|}
 +
 
 +
{| cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
==== ... centroid function for N-faced polysolids (ARBN) ====
 +
|}
 +
 
 +
{| cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
==== ... centroid function for extruded sketches (EXTRUDE) ====
 +
|}
 +
 
 +
{| cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
==== ... centroid function for superellipsoids (SUPERELL) ====
 
|}
 
|}
 
 
 
 
 +
{| cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
==== ... centroid function for solid polygonal meshes (NMG) ====
 +
|}
 +
 
 +
 +
|}
 
 
 
 
 
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 
|
 
|
=== Better placement of icons in wiki theme ===
 
  
BRL-CAD has been working on a new incarnation of the website and has developed a new wiki theme and wordpress theme. Wiki theme is responsive but has a small styling problem. On smaller screens icons near the search bar gets misplaced and unaligned. Your task would be to fix that. Task would include diving into sass file that corresponds to styling of this part of theme (given below) and adjusting spacing between icons to keep them aligned even at smaller screens.
+
=== Implement a primitive UV-mapping callback ===
 +
 
 +
BRL-CAD provides more than two dozen types of geometry "primitives" such as ellipsoids, boxes, and cones. Every primitive is described by a collection of callback functions, for example rt_ell_bbox() returns the bounding box dimensions for an ellipsoid. One of those functions describes a UV mapping of the object's surface, which is used for things like texture and bump mapping. An example of this is rt_ell_uv() in the src/librt/primitives/ell/ell.c source file for an ellipsoid.  Several of our more complex primitive types (such as BoT, NMG, and BREP/NURBS) do not presently implement a UV-mapping function leading to unexpected runtime behavior.
  
Links:
+
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.
*http://beta.brlcad.org/wiki/Main_Page
 
  
 +
References:
 +
* http://en.wikipedia.org/wiki/UV_mapping
 +
* src/librt/primitives/[PRIMITIVE]/[PRIMITIVE].c, read the rt_*_uv() function
 +
 +
{| cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
==== ... UV-mapping for extruded sketches (EXTRUDE) ====
 +
 +
Code:
 +
* src/librt/primitives/extrude/extrude.c
 +
* src/librt/primitives/table.c
 +
* include/rtgeom.h
 +
 +
|}
 +
 
 +
 +
|}
 
 
 
 
  
 
----
 
----
|}
 
  
 
== Documentation and Training ==
 
== Documentation and Training ==
Line 219: Line 357:
 
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 
|
 
|
=== Write an article "BRL-CAD for dummies" ===
+
=== Document MGED's 'saveview' command options ===
  
Although BRL-CAD has extensive documentation, still it needs a short and simple document which is particularly built for dummies.
+
BRL-CAD's primary geometry editor (MGED) provides hundreds of commands.  Two of those commands are the savewview and loadview commands that write current view settings out to a text file and read them back in.  The saveview command provides -e -i -l and -o options, but they are not documented.
  
This task involves writing a article named '''BRL-CAD for dummies'''. This article should start with the installation process, if there is any existing installation guide for dummies, provide a link to it. The main motive of this article to empower dummy to make his/her first model using BRL-CAD. One thing to be kept in mind while writing this article is that this article is mainly concentrated for dummies. So use simple language to an extent and if you need to mention some technical term, first explain that term.
+
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.
  
The output of this task can be a pdf, html, doc, odt or any other document file that contains this article. Go through the link provided. Use screenshots and images to make it look attractive so that the reader is not bored.
+
References:
 +
* src/libged/saveview.c
 +
* doc/docbook/system/mann/en/*.xml
  
Reference:
+
Code:
* http://brlcad.org/wiki/Documentation
+
* doc/docbook/system/mann/en/saveview.xml
  
 
|}
 
|}
  
 
 
 
 
 
 
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 
|
 
|
=== 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
 
 
|}
 
 
 
 
 
 
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 
|
 
 
 
=== Write a "BRL-CAD Commands Quick Reference" document ===
 
=== Write a "BRL-CAD Commands Quick Reference" document ===
  
Line 274: 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
  
 
|}
 
|}
Line 284: Line 396:
 
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 
|
 
|
 
 
=== Doxygen cleanup ===
 
=== Doxygen cleanup ===
  
Line 338: Line 449:
 
* misc/Doxyfile
 
* misc/Doxyfile
 
|}
 
|}
 +
|}
 +
 +
 
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== Write a manual page for MGED's "brep" command ===
 +
 +
BRL-CAD's MGED geometry editor provides hundreds of commands.  One of those commands for manipulating and visualizing geometry is the "brep" command.
 +
 +
This task involves writing a manual page for that command in the Docbook XML format.  There are lots of examples to follow.
 +
 +
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.
 +
 
|}
 
|}
  
Line 429: Line 564:
  
 
|}
 
|}
 +
  
 
 
 
 
 
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 
|
 
|
=== Make a step by step tutorial for creating BRL-CAD model ===
+
=== Transcribe a COM-GEOM Geometry Model from a PDF report to an ASCII file ===
  
BRL-CAD is said to have an expert friendly User Interface so new users mostly have a tough time getting around it's UI and making models. So anything link Django poll app tutorial https://docs.djangoproject.com/en/dev/intro/tutorial01/ would be very helpful.  
+
We have scans of a number of reports documenting early geometric models from the analysis system that preceeded BRL-CAD.  These reports often contain the actual geometry defining the model as pages and pages of numbers, but the quality is sufficiently poor that optical character recognition is not reliable.
  
 +
This task is to attempt the manual transcription of the MEP-021A Generator Set model described in the report "A Combinatorial Geometry Computer Description of the MEP-021A Generator Set" (see the References list below for the link that will let you download the PDF).  One possible approach is to use Acrobat Reader or some other PDF reader select and copy the OCR text, paste that to a text file as a starting point, and then manually correct it.  There may also be some patterns that will allow for semi-automated processing (for example, if 5 zeros in a row are commonly replaced with the character "O" instead of 0, a search and replace is in order.)  However you wish to approach it is fine, but remember that the goal is not just the extraction of the OCR text but the production of an accurate transcription of the file.  The OCR text can be used as a starting point but is not likely to be accurate.
  
|}
+
At the end of the day, the goal is to have a file that can be fed to BRL-CAD's comgeom-g importer to generate an accurate .g file.  If the generator conversion goes well, there are a significant number of other models (some of them considerably more complex) that we are interested in that can be used to create more tasks of this nature.
  
 
+
References:
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
+
* http://www.dtic.mil/docs/citations/ADA073408
|
 
=== 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.
+
Code:
 
+
* src/conv/comgeom
Links:
 
https://github.com/BRL-CAD/OGV-meteor/
 
  
 
|}
 
|}
  
 
 
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 
|
 
  
=== Find 5 coding guidelines violations 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, look into code and see if any coding guidelines are violated.
 
 
Links:
 
https://github.com/BRL-CAD/OGV-meteor/
 
 
|}
 
 
 
 
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 
|
 
 
----
 
----
  
Line 477: Line 595:
 
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 
|
 
|
=== 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..
+
=== Investigate permuted vertex lists from g-iges + iges-g ===
  
This task involves importing some NURBS geometry into BRL-CAD and ray tracing that geometry with a profiler watching our prep performanceAny profiler will do, including gprof, but a performance monitor like oprofile or the Mac "Instruments" application (or Shark) are preferred.
+
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.
  
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.
+
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.
  
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
+
Code:
 
+
* src/conv/iges
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.
 
 
|}
 
|}
  
Line 495: Line 610:
 
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 
|
 
|
=== Continue investigating GMP integration ===
+
=== Write article on BRL-CAD's code hardening efforts ===
 +
 
 +
We've been working for several years on "code hardening", improving the quality of BRL-CAD's source code through a variety of best practices and code cleanup efforts.
  
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!):
+
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.
  
http://www.google-melange.com/gci/task/view/google/gci2012/7946218
+
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).
  
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.
+
Resources:
 +
* http://brlcad.org/wiki/Code_Cleanup
 +
* http://brlcad.org/d/node/96
 +
* http://www.coverity.com/library/pdf/coverity-scan-2011-open-source-integrity-report.pdf
  
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.
+
Add the article to http://brlcad.org/wiki/Community_Publication_Portal
  
 
|}
 
|}
 +
  
 
 
 
 
 
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 
|
 
|
=== Design a T-Shirt for BRL-CAD ===
+
=== Write an article soliciting a Windows platform maintainer ===
  
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.
+
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.
  
Logo References
+
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 responsibility.  Come talk to us on IRC for more specific details.
* http://brlcad.org/images/angelov_256.png
+
 
* http://brlcad.org/d/node/92
+
Resources:
 +
* http://svn.code.sf.net/p/brlcad/code/brlcad/trunk/HACKING
 +
(See the release section near the bottom to see what maintainers do)
 +
 
 +
Add the article to http://brlcad.org/wiki/Community_Publication_Portal
  
 
|}
 
|}
Line 523: Line 648:
 
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 
|
 
|
=== Design a coffee mug for BRL-CAD ===
+
=== 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.
  
This task involves designing a coffee mug for BRL-CAD. Make it look good, so that one can use it while working on BRL-CAD. Look over some great coffee mug designs before starting to work on this. It would be great if the design on coffee mug has some special meaning.
+
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.
  
Logo References
+
References:
* http://brlcad.org/images/angelov_256.png
+
* http://brlcad.org/gallery/d/19-4/MGED.jpg
* http://brlcad.org/d/node/92
+
* 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. ;)
 
|}
 
|}
  
Line 536: Line 666:
 
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 
|
 
|
=== Design BRL-CAD sticker ===
+
=== Generate a code coverage report (lcov+gcov) ===
  
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 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:
  
Logo References
+
"benchmark"
* http://brlcad.org/images/angelov_256.png
+
"make test"
* http://brlcad.org/d/node/92
+
"make regress"
 +
Submit the results.
  
 
|}
 
|}
Line 549: Line 680:
 
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 
|
 
|
=== Design BRL-CAD phone/tablet back cover ===
+
=== Model BRL-CAD logo in BRL-CAD ===
 +
 
 +
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..
  
This task involves designing a BRL-CAD phone/tablet cover.
+
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.
While submitting your design, provide the sample phone cover, tablet cover with the design and rendered png or jpg image of the sticker design. Try to have a special meaning of design, and the concept should be creatively illustrated.
 
  
Logo References
+
References:
 
* http://brlcad.org/images/angelov_256.png
 
* http://brlcad.org/images/angelov_256.png
 
* http://brlcad.org/d/node/92
 
* http://brlcad.org/d/node/92
 +
* Introduction to MGED at http://brlcad.org/wiki/Documentation
 +
 +
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.
  
 
|}
 
|}
Line 563: Line 698:
 
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 
|
 
|
=== Design a wallpaper set for BRL-CAD ===
+
=== Profile NURBS prep performance ===
  
This task involves designing a set of wallpapers for BRL-CAD. The central idea of each wallpaper should represent any feature of BRL-CAD. Try to design a minimum of 5 wallpapers but if you have more than 5 designs than you are welcomed.  
+
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 raysOur prep phase is entirely unoptimized so we'd like to know where all the time is presently being spent during prep..
   
 
Try to different resolutions of each wallpaper.
 
  
Check the following wallpapers for inspiration.
+
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.
* http://www.smashingmagazine.com/tag/wallpapers/
 
  
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.
* http://brlcad.org/images/angelov_256.png
 
* http://brlcad.org/d/node/92
 
  
|}
+
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
 
 
 
 
 
 
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 
|
 
=== Create Iron Man Arc Reactor Model in BRL-CAD ===
 
 
 
This task involves creating Arc Reactor as seen in hollywood movie Iron-Man. You will have to create two versions of the Arc Reactor one glowing and another non glowing.
 
 
Check this model for inspiration
 
* http://grabcad.com/library/iron-man-arc-reactor-request
 
  
 +
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.
 
|}
 
|}
 
  
 
 
 
 
 
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 
|
 
|
=== Tweak BRL-CAD logo to wish New Year ===
+
=== Continue investigating GMP integration ===
  
You might have heard and praised those google doodles we occasionally see on google.com on special days. This task is all about tweaking BRL-CAD logo to wish New Year. You may have a look at google doodles but don't entirely copy their style. I am sure your creative mind will get something much better.
+
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!):
Make sure this tweak should be tweaked version of current logo and not entirely new logo.
 
  
Tip: Search for some global events occurring in 2015 and design accordingly. Also keep the letters 2,0,1,5 in mind while designing. ;)
+
http://www.google-melange.com/gci/task/view/google/gci2012/7946218
  
Also output of this task shall be the png file of your work and the raw file but don't upload the raw file(.psd, .xcf or some other) for review of this task. We will ask for it later, when the design is finalized.
+
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.
 
 
Gallery of all google doodles
 
* http://www.google.com/doodles
 
  
 +
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.
  
 
|}
 
|}
 
  
 
 
 
 
 
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 
|
 
|
=== Tweak BRL-CAD logo to wish Merry Christmas ===
+
=== Create prototype 2D Drawing ===
  
You might have heard and praised those google doodles we occasionally see on google.com on special days. This task is all about tweaking BRL-CAD logo to wish Christmas. You may have a look at google doodles but don't entirely copy their style. I am sure your creative mind will get something much better.
+
BRL-CAD provides limited services for drafting features including the production of 2D CAD drawings (blueprints).
Make sure the output of this task should be tweaked version of current logo and not entirely new logo.
 
  
Also output of this task shall be the png file of your work and the raw file but don't upload the raw file(.psd, .xcf or some other) for review of this task. We will ask for it later, when the design is finalized.
+
This task involves designing a 2D CAD drawing prototype. The prototype MUST capture a set of design requirements and follows industry conventions.
  
Gallery of all google doodles
+
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.  
* http://www.google.com/doodles
 
  
 +
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.
 +
 +
References:
 +
* http://brlcad.org/design/drafting
 +
* 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
 +
 +
Note that this is a "redo" of a previous GCI task.  Read the discussion thread and his work to help ensure you don't make similar mistakes. ;-)
 +
 +
http://www.google-melange.com/gci/task/view/google/gci2012/7985229
  
 
|}
 
|}
 +
  
 
----
 
----
Line 696: Line 823:
 
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 
|
 
|
=== Create a utility library (LIBBU) API unit test ===
+
=== Create an 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 711: Line 838:
 
* src/libbu/tests/CMakeLists.txt
 
* src/libbu/tests/CMakeLists.txt
  
 
+
{| cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
==== ... unit test for LIBBU badmagic.c ====
 +
|}
 +
 
 
{| cellpadding="20" cellspacing="0" border="2" width="100%"
 
{| cellpadding="20" cellspacing="0" border="2" width="100%"
 
|
 
|
Line 721: Line 852:
 
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 
|
 
|
 
+
=== 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 733: Line 863:
 
* 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:
 
* src/libbn/tests/[TEST].c
 
* src/libbn/tests/[TEST].c
 
* src/libbn/tests/CMakeLists.txt
 
* src/libbn/tests/CMakeLists.txt
 
<b> Note </b>
 
A valid task will constitute writing a basic test for each function in the following libbn/ files.
 
  
 
{| cellpadding="20" cellspacing="0" border="2" width="100%"
 
{| cellpadding="20" cellspacing="0" border="2" width="100%"
 
|
 
|
==== ... unit tests for LIBBN anim.c ====
+
==== ... unit test for LIBBN axis.c ====
 
|}
 
|}
 
&nbsp;
 
&nbsp;
 
{| cellpadding="20" cellspacing="0" border="2" width="100%"
 
{| cellpadding="20" cellspacing="0" border="2" width="100%"
 
|
 
|
 
+
==== ... unit test for LIBBN qmath.c ====
*Useful resources
 
  ->coming!
 
 
 
==== ... unit tests for LIBBN axis.c ====
 
 
|}
 
|}
 
&nbsp;
 
&nbsp;
 
{| cellpadding="20" cellspacing="0" border="2" width="100%"
 
{| cellpadding="20" cellspacing="0" border="2" width="100%"
 
|
 
|
==== ... unit tests for LIBBN qmath.c ====
+
==== ... unit test for LIBBN rand.c ====
|}
 
&nbsp;
 
{| cellpadding="20" cellspacing="0" border="2" width="100%"
 
|
 
 
 
 
 
*Useful links and Resources
 
-> Coming!
 
 
 
==== ... unit tests for LIBBN rand.c ====
 
|}
 
&nbsp;
 
{| cellpadding="20" cellspacing="0" border="2" width="100%"
 
|
 
==== ... unit tests for LIBBN vector.c ====
 
 
|}
 
|}
 
|}
 
|}
Line 781: Line 888:
 
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 
|
 
|
 
*Useful links and resources
 
-> To be added.
 
 
 
=== Find, reliably reproduce, and report any bug in Archer ===
 
=== Find, reliably reproduce, and report any bug in Archer ===
  
Line 818: Line 921:
 
''Tasks related to user experience research or user interface design and interaction''
 
''Tasks related to user experience research or user interface design and interaction''
  
 +
&nbsp;
 +
{| 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;
 
&nbsp;
Line 850: Line 969:
 
* A spreadsheet template will be provided.
 
* A spreadsheet template will be provided.
  
 +
|}
 +
 +
&nbsp;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== Redesign MGED/Archer's Menu ===
 +
 +
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.
 +
 +
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.
 +
 +
References:
 +
* mged
 +
* archer
 +
 +
Provide screenshots or detailed text indicating what menu options should be available and what exactly is on each menu.
 +
 +
|}
 +
 +
&nbsp;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== Create Wordpress theme for BRL-CAD website ===
 +
 +
BRL-CAD's website was recently redesigned.  The current website uses Drupal and Mediawiki.  Our new website will be using Wordpress and Mediawiki.
 +
 +
This task involves creating a custom Wordpress theme based on our new website design.
 +
 +
References:
 +
* http://cpp-tricks.com/brlcad/
 +
 +
|}
 +
 +
&nbsp;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== Migrate Drupal site to Wordpress ===
 +
 +
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.
 +
 +
This task involves setting up an installation of Wordpress on our production server and migrating the data from Drupal into the Wordpress site.
 +
 +
References:
 +
* http://brlcad.org/d/
 +
 +
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;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== Create a CSS only version of BRL-CAD Logo ===
 +
 +
BRL-CAD's logo is very simple and can be easily created with CSS3, such a logo would be a great asset to the new design of BRL-CAD's website.
 +
 +
This task involves at minimum creating a bunch of CSS styles (preferrably a SASS mixin) which result into BRL-CAD's logo. You can take inspiration from
 +
 +
http://css-tricks.com/examples/ShapesOfCSS/
 +
 +
You can check the logo at
 +
 +
http://cpp-tricks.com/brl-cad/
 +
 +
|}
 +
 +
&nbsp;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== Create a CAD inspired icon-set for BRL-CAD website ===
 +
 +
BRL-CAD's new website design uses lot of icons. It would be great if these icons have the look and feel of CAD/CAM in it.
 +
 +
So the task consists of making an icon set including icons for:-
 +
* All the menu buttons (About,Downloads,Documentation,Community, Blog, Gallery)
 +
* Sign-Up & Log-In icons
 +
* Major Social Media Icons
 +
 +
Few things to keep in mind:-
 +
*All icons should somehow adopt the look and feel of CAD.
 +
*They all should be in PNG/AI/SVG format.
 +
*The icons need not be complexed or textured, though long shadowed flat icons would be appreciated.
 +
 +
References
 +
*http://www.awwwards.com/flat-long-shadows-step-by-step-tutorial-resources-and-examples.html
 +
* http://cpp-tricks.com/brlcad/
 +
|}
 +
 +
&nbsp;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== Create a graphical mock-up for wiki pages of BRL-CAD ===
 +
 +
BRL-CAD's website is undergoing a change. BRL-CAD needs a new design for it's wiki pages.
 +
 +
This task requires you to create a graphical (png or jpeg) mock-up of BRL-CAD's wiki pages in any Graphics Manipulations software like GIMP. The mock up should have a color scheme based on the new logo of BRL-CAD, and a design that's consistent with the new website design (http://cpp-tricks.com/brlcad/). As the whole website design is responsive (adapts to the different screen sizes) so design for wiki is expected the same way.
 +
 +
Take a look at wiki pages here
 +
*http://brlcad.org/wiki/Main_Page
 +
|}
 +
 +
&nbsp;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== Create a graphical mock-up for BRL-CAD's Blog ===
 +
 +
BRL-CAD's website is undergoing a change. BRL-CAD needs a new design for it's Blog pages.
 +
 +
This task requires you to create a graphical (png or jpeg) mock-up of BRL-CAD's blog in any Graphics Manipulations software like GIMP. The mock up should have a color scheme based on the new logo of BRL-CAD, and a design that's consistent with the new website design (http://cpp-tricks.com/brlcad/). As the whole website design is responsive (adapts to the different screen sizes) so blog design is expected the same way. You have to make design for
 +
* Blog Archives
 +
* Blog Post Excerpts (paginated)
 +
* A single Post with comments
 +
 +
A typographically well set, clean and minimal design will be appreciated.
 +
 +
|}
 +
 +
&nbsp;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== Create a graphical mock-up for BRL-CAD's Documentation pages ===
 +
 +
Documentation is part of wiki pages as per now, you can see it at
 +
http://brlcad.org/wiki/Documentation
 +
 +
The task requires you to create a graphical or HTML & CSS/SASS mockup for the  documentation page of BRL-CAD. As it is a wiki page so the mock up created for wiki pages can be used. It should be consistent with main wiki design but at same time different from rest of wiki pages. You can incorporate some content from BRL-CAD's doc book too. 
 +
 +
|}
 +
 +
&nbsp;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== Create a custom wikimedia skin for BRL-CAD ===
 +
 +
BRL-CAD's website is undergoing a change. BRL-CAD needs a new design for it's Wiki pages.
 +
 +
BRL-CAD uses media-wiki as the underlying software for the wiki. This taks needs you to create a custom media-wiki skin for BRL-CAD. This media-wiki skin must be based on the graphical mock-up created for it (though there are no restrictions in improvising) and consistent with new website design.
 +
 +
References
 +
*http://cpp-tricks.com/brlcad/
 +
*http://www.mediawiki.org/wiki/Manual:Skinning/Tutorial
 +
 +
|}
 +
 +
&nbsp;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== Create a web based interactive timeline giving historical tour of BRL-CAD ===
 +
 +
BRL-CAD has history of decades. It would be great to show that history in form of an interactive timeline.
 +
 +
You can do it using any web technology you are comfortable with. I would prefer something like http://plugins.jquery.com/b1njTimeline/ to ease your work. It should be interactive, I should be able to browse through and click on dates and get the details of the events. The color scheme used should be in consistent with the website design. Usage of appropriate imagery would be preferred.
 
|}
 
|}
  
Line 908: Line 1,178:
 
|}
 
|}
  
 
&nbsp;
 
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 
|
 
=== Loading Google charts from API  ===
 
 
A basic wrapper of GCharts has been implemented a while ago : https://bitbucket.org/suryajith/benchmark/src/a27dd8c05d6819a527650e06a63076599d2e0d66/libs/charting.py?at=default With the google charts improving their API system which wasn't around then, see if the code could be optimized so to get the charts the optimal way.
 
 
Reference:
 
*https://developers.google.com/chart/interactive/docs/index
 
 
 
|}
 
 
=== Design a hall of fame for BRL-CAD developers ===
 
 
We love our developers and want to have a special place in it's website to thank and motivate hard working folks behind BRL-CAD. Your task would be to use an image manipulation software such as GIMP or Photoshop and design a hall of fame page for developers. It should have avatars and names of all the developers. For inspiration you can take a look at http://underscores.me/. You are free to experiment and design anyway you want, just make sure that the color scheme and font-scheme is consistent with the new BRL-CAD web design.
 
 
Links:
 
* http://cpp-tricks.com/brlcad/
 
* http://underscores.me/
 
 
 
|}
 
 
----
 
----
  

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)