1. Introduction

1.1 About Ayam

Ayam is a free 3D modeling environment for the RenderMan Interface.

Ayam was formerly known as "The Mops".

Ayam is primarily aimed at the Linux, IRIX, and Win32 platforms. On those platforms BMRT (Blue Moon Rendering Tools, a RenderMan compliant renderer by Larry Gritz) is available. Even though the distribution of BMRT is stopped it is still the recommended renderer for Ayam. Despite of this, Ayam may be used on many more platforms with any RenderMan compliant renderer.

For platforms where BMRT is not available (e.g. FreeBSD or NetBSD), Ayam may be compiled with code from the Affine Toolkit with limited functionality (see also the file INSTALL). In this case, no parsing of slc compiled shaders will be possible. Since Ayam 1.6 it is also possible to completely replace BMRT shader parsing and RIB writing by code from the Aqsis project, thus completely eliminating the need for BMRT. Furthermore, shader parsing plugins are available for all major RenderMan compliant renderers allowing a tight integration of Ayam.

Here is a short summary of the Ayam feature set:

• RIB (RenderMan Interface Bytestream) export and import.
• Support for NURBS curves, interpolating curves, (trimmed) NURBS surfaces, bilinear and bicubic patches and patch meshes, Boxes, Quadrics (Sphere, Disk, Cylinder, Cone, Hyperboloid, Paraboloid and Torus), MetaBalls, polygonal meshes, subdivision meshes and more.
• All primitives may be combined with the common CSG-operations: Intersection, Difference, and Union.
• NURBS modeling includes extrude, revolve, sweep, birail, skin, and gordon operations (with caps, holes, and bevels) realized as Tool-Objects.
• Wavefront OBJ export and import, Rhino 3DM export and import.
• Custom objects that may freely implement their representations (using OpenGL and RIB) and even small GUIs to edit their type specific parameters may be written by the user and dynamically loaded at runtime.
• Scripting interface: Tcl.
• Script objects.
• Misc: instancing, arbitrary number of modeling views, object clipboard, independent property clipboard, console, n level undo.

Due to limitations in the Win32 operating system(s) (no backlinking) and the current implementation of Ayam, dynamic loading of custom objects is currently not available on the Win32 platform!

1.2 About this manual

How should one read this manual?

Since this manual is intended to be a reference manual, it is probably pointless to read it from the beginning to the end (except maybe for the next section, explaining the basics). Instead, just look up the documentation of the things you are interested in via the table of contents or the index. Cross references will then guide you to other important parts of the documentation. Again: this manual has a rather large index, please use it!

In this manual, the following typographic conventions are used:

• keyboard shortcuts: <Ctrl+c>, for shortcuts like <Ctrl+Shift+t> an abbreviated version: <Ctrl+T> will be used
• names (of object types, menu entries, properties, or property elements): "A Name"
• Tcl code examples:

  ---

  set riopt(runtime) { a b }
  

  ---

• Object hierarchies:

  ---

  +-Parent_Object(Type)
   | First_Child_Object(Type)
   | Second_Child_Object(Type)
   | [Third_Child_Object_may_be_present_or_not(Type)]
   | Empty_Level(Level)
   +-Sub_Level(Level)
   | | First_Child_Object_of_Sub_Level(Type)
   | \ Last_Child_Object_of_Sub_Level(Type)
   \ Last_Child_Object(Type)
  

  ---