Ayam

Reference Manual

Randolf Schultz (randolf.schultz@gmail.com)

Overview

1. Introduction  (TOC)
2. The Ayam GUI  (TOC)
3. Modelling Actions  (TOC)
4. Objects, Properties, and Tags  (TOC)
5. NURBS Modelling Tools  (TOC)
6. Scripting Interface  (TOC)
7. Import and Export  (TOC)
8. Miscellaneous  (TOC)
9. Index  (TOC)

Contents

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 Drawing Modes
• 2.8 The Toolbox
• 2.9 Object Search
• 2.10 Preferences
• 2.11 GUI Scaling

3. Modelling Actions

• 3.1 Modelling Actions Overview
• 3.2 Transforming Objects or Selected Points
• 3.3 Selecting Objects by Picking
• 3.4 Selecting/Tagging Points
• 3.5 Setting the Mark
• 3.6 Intermediate Parameter GUIs
• 3.7 Moving Objects or Selected Points
• 3.8 Rotating Objects or Selected Points
• 3.9 Rotating Objects or Selected Points about a Point
• 3.10 Scaling Objects or Selected Points
• 3.11 Scaling Objects or Selected Points about a Point
• 3.12 Editing Points
• 3.13 Editing Weights
• 3.14 Snapping Points to the Grid
• 3.15 Snapping Objects to the Grid
• 3.16 Snapping Points to the Mark
• 3.17 Snapping Objects to the Mark
• 3.18 Inserting or Deleting Points
• 3.19 Manipulating the Multiplicity of Points
• 3.20 Finding Points on Curves
• 3.21 Finding Points on Surfaces
• 3.22 Selecting Boundary Curves
• 3.23 Interactively Splitting Curves
• 3.24 Selecting/Tagging Boundary Points
• 3.25 Selecting Faces
• 3.26 Editing in Local Spaces

4. Objects, Properties, and Tags

• 4.1 Object Types Overview
• 4.2 Scene Organization Objects
• 4.3 CSG / Solid Primitives
• 4.4 Freeform Curve Objects
• 4.5 Curve Tool Objects
• 4.6 Freeform Surface Objects
• 4.7 Surface Tool Objects
• 4.8 Polygonal and Subdivision Objects
• 4.9 Script and Custom Objects
• 4.10 Standard Properties
• 4.11 Tags

5. NURBS Modelling Tools

• 5.1 General Remarks
• 5.2 Curve Creation Tools
• 5.3 Curve Modification Tools
• 5.4 Surface Creation Tools
• 5.5 Surface Modification Tools
• 5.6 Conversion Tools

6. Scripting Interface

• 6.1 Global Variables and Arrays
• 6.2 Procedures and Commands
• 6.3 Expression Support in Dialog Entries
• 6.4 Scripting Interface Examples
• 6.5 Distributed Helper Scripts
• 6.6 Distributed Script Objects
• 6.7 JavaScript Scripting Interface
• 6.8 Lua 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 Command Line Arguments
• 8.6 Environment Variables
• 8.7 Plugins Overview
• 8.8 Shader Parsing Plugins
• 8.9 Viewport Rendering
• 8.10 Automatic Instancing
• 8.11 Importance Driven Rendering (IDR)
• 8.12 CSG preview using the AyCSG plugin
• 8.13 Increasing Drawing Speed
• 8.14 Modelling Without Views
• 8.15 Restrictions and Implementation Deficiencies
• 8.16 How to Join the Fun
• 8.17 References
• 8.18 Acknowledgements
• 8.19 Trademarks

9. Index