Next Previous Contents

# Ayam

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

20. Mar 2012

This is the documentation of Ayam 1.20 – a free 3D modelling environment for the RenderMan interface. Please note, that this document is 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 (LinuxDoc) 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. In addition, one can use the provided SGML-source to generate other formats.

## 1. Introduction

- 1.1 About this Manual
- 1.2 About Ayam

## 2. The Ayam GUI

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

## 3. Modelling Actions

- 3.1 Modelling Actions Overview
- 3.2 Transforming Objects or Selected Points
- 3.3 Moving Objects or Selected Points
- 3.4 Rotating Objects or Selected Points
- 3.5 Rotating Objects or Selected Points About a Point
- 3.6 Scaling Objects or Selected Points
- 3.7 Scaling Objects or Selected Points About a Point
- 3.8 Setting the Mark
- 3.9 Selecting/Tagging Points
- 3.10 Editing Points
- 3.11 Snapping Points to the Grid
- 3.12 Snapping Points to the Mark
- 3.13 Snapping Objects to the Mark
- 3.14 Inserting or Deleting Points
- 3.15 Manipulating the Multiplicity of Points
- 3.16 Finding Points on Curves
- 3.17 Finding Points on Surfaces
- 3.18 Interactively Splitting Curves
- 3.19 Editing in Local Spaces

## 4. Objects, Properties, and Tags

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

## 5. NURBS Modelling Tools

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

## 6. Scripting Interface

- 6.1 Global Variables and Arrays
- 6.2 Index of Procedures and Commands
- 6.3 Expression Support in Dialog Entries
- 6.4 Scripting Interface Examples
- 6.5 Helper Scripts
- 6.6 JavaScript Scripting Interface

## 7. Import and Export

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

## 8. Miscellaneous

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

## 9. Index

Next Previous Contents