Next: Future Plans Up: User Guide Previous: Solving Puzzles  Contents
Subsections

Reporting with BurrTools

BURRTOOLS comes with some extra features to assist you in making puzzle solution sheets, either for your personal archives or to be issued with your exchange puzzles and commercially produced puzzles. Currently, these capabilities are very basic and need to be improved in a future update of the program. So, don't expect too much from them right now, but rather consider them to be merely a preview of comming attractions.

Adding Comments

The Edit Comment entry on the menu bar opens a new window that allows you to add textual information to the puzzle file. It can be used to append extra information such as the name of the designer, or a 'to do' list for your own designs.

Exporting Images

The Export - Images entry on the menu opens a window that allows you to export a portion of the current puzzle to (a list of) images (see Figure ImageExport). On the right the window has a 3D view, and on the left it has input elements that control what is being created. On the very bottom of these controls you can select what you want to create images of. Depending on what is present in the puzzle, the following things can be exported:


Figure:The image export window

Shape
An image of a single shape (a shape that was made on the entities tab) is created. You can select which shape with the shape selector below.
Problem
An image containing all shapes that are used for a problem is created. Again you will find the problem selector below that is used to select which problem you are going to create images of.
Assembly
An image showing the positions of the pieces in an assembly is created. You can select the problem. The first assembly of that problem is exported.
Solution
An image containing all steps necessary to disassemble a problem is created. In this case you also select the problem with the selector below. The images will be created for the last solution of that problem.

What to export is the first thing that you have to select. Naturally only the choices are available for which the puzzle has data. So if you have not run the solver on the current puzzle, it is impossible to export solutions or assemblies.

Above these selectors you find the file output parameters. First the name and the path to where the images are supposed to be created. If you give no path, the images are put into the working directory of the program. The file name is just a prefix, so if you keep 'test' as file name you get files of the form 'test000.png', 'test001.png', ... . (BURRTOOLS creates only PNG image files)

Finally, you can say how many images you intend to create. BURRTOOLS will try to do so, but might use less. If you only have one assembly to export, only one page can be created. The Number of images entry is ignored by the software for the time being, it will be used later on.

Above these input elements you find the last section that defines your output. Here you can define the quality and some additional parameters that influence how the images look, but not what is to be seen.

In the top left corner you find the definition of the background of the image. You can choose between transparent or white. Transparent is useful if you want to have a background with patterns or want to further edit the images.

Below you find the settings for the oversampling factor. The higher that is, the smoother the images will look, but the more memory and calculation time is required.

Below you can choose whether you want to use the constraint colours for the output or rather the default colour of the shapes.

The checkbox Dim static pieces makes BURRTOOLS draw pieces that are not involved in the current move in a lighter colour, so that the pieces actually moving are easier to spot. This, of course, only works when exporting solutions.

Finally there are the parameters for the image size that the program creates. There are 2 choices: either define the pixel size directly, or define the size of the image in millimetres and the DPI printer resolution. If you want to create A4 or letter sized images for printing, you can use the predefined sizes.

To position the shapes in the output images, you can use the 3D view at the right of the export window. All images exported will use the same settings for angle and zoom as in that 3D view. If the shapes reach above or below the 3D view they will be trimmed. Left and right is different. The width of the images to generate is not fixed. So the program will make them quite a bit wider to accommodate the horizontal spread of the pieces.

When you have finished with all settings, press Export Image(s). You will see a flurry of images in the 3-D view. The program draws the shapes there and grabs the content from the display. This may take a while. First the size of the images is determined, then the images are drawn in the required high resolution for the output. The progress can be seen on the left beside the 2 buttons. You will see how many images are finished and how many there are overall.

Hint: If you get unexpected results and broken images, try to do nothing while the images are exported. On Linux it is forbidden to change the virtual desktop because then nothing is drawn.

The export facilities are far from what we want them to be, many important features are missing, so you can expect some progress in later versions of BURRTOOLS.

Exporting Vector Images

As well as the bitmap images explained in the section above BURRTOOLS can also export vector images in various different formats. These images have the advantage of beeing freely scalable without loss of precision. The vector image export doesn't have functionality to export a complete assembly or disassembly sequence, but only one image. The image exported is the one currently visible in the 3D view. To export that display into a vecotr image select Vector Image from the Export menu. A small window will open which lets you select the possible image format and the filename. You have to append the right extension to the filename on your own. The export may take a while (a few seconds up to a minute or so) and within that time the application is unresponsive so please be patient.

Exporting to STL

STL, which stands for Standard Triangulation Language or Standard Tesselation Language is a file format used by stereolithography software. STL-Files describe the surface of 3-dimensional objects. BURRTOOLS can export single shapes into STL files so that 3D printers can quickly fabricate prototypes of them.

The main menu entry Export - STL opens the window seen in Figure StlExportWindow. The window has shape selector, a 3-D view of the selected shape and some parameters that control the shapes created. The exact parameters depend on the grid of the current puzzle.


Figure:The STL-Export window

Filename and Path control the name and position of the generated file. Cube Size controls the base length of the created cubes. Bevel controls the size of the bevel and Shrink allows a gap between the pieces, so that it is actually possible to assemble them. If the shapes were made to correct sizes they would touch, making movement impossible.

For spheres the parameters are as follows:

The STL-Export right now works only for cubes and shperes. Triangles and the rhombic grid are not supported. Also the shapes to export must not contain any variable voxels.


Next: Future Plans Up: User Guide Previous: Solving Puzzles  Contents