Next Previous Contents

# Ayam

## Randolf Schultz `(randolf.schultz@gmail.com)`

20. Apr 2010

This is the documentation of Ayam 1.17 - a free 3D modelling environment for the RenderMan interface. Please note, that this document is intended to be a reference manual, more detailed explanations of how to actually model with Ayam are given in the tutorials. This document has been written using the SGML-Tools formatting system to generate files in a variety of text formats from one source file. There are HTML and PDF versions of this document prepared for you. In addition, you can use the provided SGML-source to generate other formats.

## 1. Introduction

- 1.1 About Ayam
- 1.2 About this Manual

## 2. The Ayam GUI

- 2.1 Anatomy of the Main Window
- 2.2 The Main Menu
- 2.3 Anatomy of a View
- 2.4 The View Menu
- 2.5 View Window Shortcuts and Actions
- 2.6 Selecting Objects within a View
- 2.7 The Toolbox Window
- 2.8 Preferences

## 3. Interactive Actions (Modelling)

- 3.1 Moving Objects or Selected Points
- 3.2 Rotating Objects or Selected Points
- 3.3 Rotating Objects or Selected Points About a Point
- 3.4 Scaling Objects or Selected Points
- 3.5 Scaling Objects or Selected Points About a Point
- 3.6 Setting the Mark
- 3.7 Selecting Points
- 3.8 Editing Points
- 3.9 Snapping Points to the Grid
- 3.10 Inserting or Deleting Points
- 3.11 Miscellaneous Actions
- 3.12 Editing in Local Space

## 4. Objects, Properties, and Tags

- 4.1 Object Types Overview
- 4.2 Root Object
- 4.3 View Object
- 4.4 Camera Object
- 4.5 Box Object
- 4.6 Quadric Primitives
- 4.7 Level Object
- 4.8 Material Object
- 4.9 Light Object
- 4.10 NCurve (NURBS Curve) Object
- 4.11 NPatch (NURBS Patch) Object
- 4.12 BPatch (Bilinear Patch) Object
- 4.13 PatchMesh Object
- 4.14 PolyMesh Object
- 4.15 SDMesh Object
- 4.16 Instance Object
- 4.17 Clone Object
- 4.18 Revolve Object
- 4.19 Extrude Object
- 4.20 Swing Object
- 4.21 Sweep Object
- 4.22 Birail1 Object
- 4.23 Birail2 Object
- 4.24 Skin Object
- 4.25 Gordon Object
- 4.26 Bevel Object
- 4.27 Cap Object
- 4.28 ICurve (Interpolating Curve) Object
- 4.29 ACurve (Approximating Curve) Object
- 4.30 ConcatNC (Concatenate NURBS Curves) Object
- 4.31 ExtrNC (Extract NURBS Curve) Object
- 4.32 NCircle (NURBS Circle) Object
- 4.33 OffsetNC (Offset NURBS Curves) Object
- 4.34 ConcatNP (Concatenate NURBS Patches) Object
- 4.35 ExtrNP (Extract NURBS Patch) Object
- 4.36 OffsetNP (Offset NURBS Surfaces) Object
- 4.37 Text Object
- 4.38 RiInc Object
- 4.39 RiProc Object
- 4.40 Script Object
- 4.41 Select Object
- 4.42 Trim Object
- 4.43 Custom Objects
- 4.44 Metaball Object
- 4.45 SDNPatch Object
- 4.46 Standard Properties
- 4.47 Tags

## 5. NURBS Modelling Tools

- 5.1 The Closed BSpline Tool
- 5.2 The NURBCircle Tool
- 5.3 The NURBCircleArc Tool
- 5.4 The TrimRect Tool
- 5.5 The NURBSphere Tool
- 5.6 The NURBSphere2 Tool
- 5.7 The Revolve Tool
- 5.8 The Extrude Tool
- 5.9 The Sweep Tool
- 5.10 The Cap Tool
- 5.11 The Birail1 Tool
- 5.12 The Birail2 Tool
- 5.13 The Gordon Tool
- 5.14 The Skin Tool
- 5.15 The Revert Tool
- 5.16 The Concat Tool
- 5.17 The Split Tool
- 5.18 The Trim Tool
- 5.19 The Elevate Tool
- 5.20 The Refine Tool
- 5.21 The Coarsen Tool
- 5.22 The Clamp Tool
- 5.23 The Insert Knot Tool
- 5.24 The Remove Knot Tool
- 5.25 The Plot Curvature Tool
- 5.26 The Shift Closed B-Spline Tool
- 5.27 The To XY Tool
- 5.28 The Make Compatible Tool
- 5.29 The Rescale Knots to Range Tool
- 5.30 The Rescale Knots to Mindist Tool
- 5.31 The Collapse Points Tool
- 5.32 The Explode Points Tool
- 5.33 The Swap UV Tool
- 5.34 The Elevate UV Tool
- 5.35 The Revert U Tool
- 5.36 The Revert V Tool
- 5.37 The Patch Clamp Tool
- 5.38 The Patch Rescale Knots to Range Tool
- 5.39 The Patch Rescale Knots to Mindist Tool
- 5.40 The Patch Insert Knot Tool
- 5.41 The Patch Split Tools
- 5.42 The Extract Curve Tool
- 5.43 The Extract Patch Tool
- 5.44 The Split to Curves Tool
- 5.45 The Build from Curves Tool
- 5.46 The Tesselation Tool

## 6. Scripting Interface

- 6.1 Global Variables and Arrays
- 6.2 Index of Procedures and Commands
- 6.3 Scripting Interface Examples
- 6.4 Helper Scripts

## 7. Import and Export

- 7.1 RenderMan Interface Bytestream (RIB) Import
- 7.2 RenderMan Interface Bytestream (RIB) Export
- 7.3 Mops Import
- 7.4 AutoCAD DXF Import
- 7.5 AutoCAD DXF Export
- 7.6 Wavefront OBJ Import
- 7.7 Wavefront OBJ Export
- 7.8 3DMF (Apple) Import
- 7.9 3DMF (Apple) Export
- 7.10 3DM (Rhino) Import
- 7.11 3DM (Rhino) Export
- 7.12 X3D (Web3D) Import
- 7.13 X3D (Web3D) Export

## 8. Miscellaneous

- 8.1 The Undo System
- 8.2 The Modelling Concept Tool-Objects
- 8.3 Ayamrc File
- 8.4 Environment Variables
- 8.5 Shader Parsing Plugins
- 8.6 Automatic Instancing
- 8.7 Importance Driven Rendering (IDR)
- 8.8 CSG preview using the AyCSG plugin
- 8.9 Increasing drawing speed
- 8.10 Restrictions and Implementation Deficiencies
- 8.11 How to join the fun
- 8.12 References
- 8.13 Acknowledgements

## 9. Index

Next Previous Contents