Antiprism Resource Files

Antiprism Resources

Antiprism includes a number of resources. These are support files which are used by the program, and can be accessed directly. They are also useful as examples and as a starting point for creating new resources. Nearly all the resources may be used, modified and redistributed without restriction (check the begining of each resource file for details.)

Please, send me any resources that you create and would like to share with other Antiprism users.

Accessing the Resources

If Antiprism has been installed then the resources are automatically available by their names. The resource names are case insensitive. If Antiprism is not installed then set the ANTTIPRISM_DATA environment variable to point to the share directory of the Antiprism distribution.

How to set this variable will depend on your system.

Example DOS command

set ANTIPRISM_DATA="c:\some\dir\antiprism-0.xx\share"

Example bash command

export ANTIPRISM_DATA="/home/user/antiprism-0.xx/share"

Otherwise, the resources are just ordinary files so simply give the full path to the resource you want to use.

When you specify a filename the program will look for the file in three places in this order

The current working directory
The relevant directory in ANTTIPRISM_DATA (if set)
The relevant directory in the installed data directory (if installed)

A data directory may include a file called alt_names.txt. This contains a list of alternative names for the files in that particular data directory. The resource name is searched for in the alternative names if it does not refer to a file in the directory. The format is alt_name = file_name.

Models

Directory: models

Model resource files include

Platonic polyhedra given by their P number (P1 - P5)
Archimedean polyhedra given by their A number (A1 - A13, not using s or d suffix)
Uniform polyhedra given by their U number (U1 - U80) or Bower's short name
Johnson polyhedra given by their J number (J1 - J92)

The following resource models are generated by the program, and don't refer to files in the data directory

Polygon-based polyhedra: three letters followed by the base polygon in form N or N/M e.g. pyr5, pri7/2
- pri - prism
- ant - antiprism
- pyr - pyramid
- dip - dipyramid
- cup - cupola
- ort - orthobicupola
- gyr - gyrobicupola

The resource models may be used by all the Antiprism programs.

Colour Maps

Directory: col_maps

OFF elements may be coloured by index numbers. Colour maps provide a way to convert these index numbers into colour values. As well as the Antiprism colour map format the progams also understand Gimp Palette format and Fractint colour maps. Colour maps are used by off_color -m, antiview -m and n_icons -M.

X11 (549 colours): Broad range of named colours from X11's rgb.txt. The names may also be used to specify colours on the command line.
html (140 colours): Broad range of colours. These are the colours that can be used by name in HTML.
jumble (100 colours): Broad range of colours, with adjacent colours not alike.
5levels (125 colours): The combinations of five levels each of red, green and blue
ms (48 colours): A color map based on the Micosoft color dialog.

More colour maps are available from Colorzilla Palettes.

Lights

Directory: col_lights

Lights are OFF files whose vertex elements are coloured. These colours are taken as lights in the direction of the vertices, and are used to colour the elements of other OFF files. Lights are used by off_color -l.

default: Red, green and blue opposite their complements on the vertices of an octahedron. This makes a rainbow effect on a sphere, and is the default lighting in off_color.
lg3d: Lighting similar to LiveGraphics3D lighting effect.
rgbw: Red, green, blue, and white on the vertices of a tetrahedron.
pastel: Like default but using pastel colours for a softer rainbow effect.

POV-Ray Include Files

Antiprism will convert OFF files to POV-Ray format. The POV-Ray file is written in such a way that much of the final presentation can be modified after the file is written. One way to override the defaults and preset values is with POV-Ray include files. POV-Ray include files are used by off2pov. See especially POV-Ray file structure.

Some include files have user configurable variables. These are described at the start of the file. They can be set in several ways -

on the POV-Ray command line, if the variable holds a floating point e.g.
```
povray Declare=some_val=1.0 file.pov
```
in another include file, which is included earlier. It may be convenient to create the file on the command line e.g.
```
echo "#declare some_tex=texture{T_Brass_4A}">default_pov.inc && povray file.pov
```
in the include file itself, which should be copied elsewhere and the modifications applied to the copy.

rot90.inc: faces are converted to a ring around the face normal at the centroid, struts lead to the face's edge centres. Edges are convverted to a ring around the edge at the edge centre.

Extras

The extra resources are unsupported, and provided for interest only. They may be useful as examples. Programs or scripts may require modification before they will work. For further details see the Extras README file.

Up: Programs and Documentation
Next: Antiprism Resources - Extras

Antiprism Documentation 4.1.2008 - http://www.antiprism.com/