How to Use the Documentation
The documentation for the SDK is an on-line help file. This format provides easy hypertext jumping between related topics. The on-line format also allows developers to copy source code from the documentation to paste into plug-ins. This is especially handy in the Reference sections.
The on-line help is broken into three modules: Orientation, Guidance, and Reference.
The Orientation module gives you an overview of how to get started with the SDK. It lists what hardware and software is needed to develop 3ds max plug-in applications. This module discusses what technical expertise is required. There is a section on recommended reading in C++, CG and Windows programming.
This module also provides an introduction to the types of plug-ins developers may create using the SDK. Most of the descriptions in this section allow hyperlink jumps to the main classes these plug-ins are derived from. Additionally, relevant sample code available in the SDK is listed here.
The Guidance module is intended to enable you to learn to accomplish a specific task. It begins with a description of the 3ds max plug-in architecture that provides a diagram of the principal classes. There is a section describing information common to all plug-in development.
There is a section for experienced 3D Studio IPAS programmers making the transition to MAX. This section discusses the similarities and differences in the IPAS and 3ds max programming architectures. The changes in development environment, plug-in/system control flow, user interface, and graphics programming support are reviewed. This section also discusses the six types of IPAS routines possible under 3D Studio DOS and how analogous plug-ins may be implemented under the 3ds max architecture.
The General Terminology section defines terms used throughout the SDK documentation. These terms also appear as popup help in other parts of the documentation.
The Advanced Topics section presents detailed information about key concepts in using the APIs. The topics presented in this section cross class boundaries, and are instead based on specific implementation issues developers need to understand when designing plug-ins for MAX. Developers getting started with the SDK should take a look through the various Advanced Topics sections. This will help in becoming familiar with what information is available.
The Reference module delivers comprehensive reference information about each class used in the API. At the beginning of each class description is an overview of the purpose of the class. All the methods and operators used by each class are documented.
This section also has a class list organized by category. This provides an organized way to jump to the many classes in the SDK. These categories are: Main Plug-In Classes, Interface Classes, Geometry Classes, User Interface Classes, and Miscellaneous Utility Classes.