Home > Articles

Building a Simple API for Model Creation in Director

This sample chapter from Director's Third Dimension: Fundamentals of 3D Programming in Director 8.5 uses Lingo to build a suite of custom handlers to deal with many common tasks. The handlers presented create the basic primitives, such as boxes and spheres, and some variations on those primitives, such as cones and pyramids.
This chapter is from the book

Application Programming Interface (API) is the term used to refer to the commands of a programming language that allow you to control the inner workings of the operating system. This term is also used to refer to a group of commands built from a programming language that extend the capabilities of that language. Sometimes this is referred to as a toolkit, but I think the term API is more concise. I will use this term as we use Lingo to build a suite of custom handlers to deal with many common tasks. Among these tasks is the process of creating primitives, as discussed in Chapter 2, "Creating Models from Scratch via Lingo." We know that the creation of a primitive from scratch involves several steps that can become repetitive. Rather than bloating our code by typing these commands over and over, we will build custom handlers to deal with frequently repeated tasks. The elegance of building custom handlers to deal with these tasks is that you can make the handlers as specific as you need them to be.

The handlers that I present in this chapter create the basic primitives, such as boxes and spheres, and some variations on those primitives, such as cones and pyramids. The needs of your project will dictate which of these handlers you require and whether you need to customize them further.

World Cleanup Utilities

Attempting to perform operations on a 3D Castmember before it is fully downloaded will result in a script error. This does not mean that it is not possible to stream in 3D Data. The 3D Castmember contains 3D Data—and your movies may contain several 3D Castmembers. At this point, we are working with 3D Castmembers that are devoid of any Models and are therefore quite small (about 500 bytes). Our main concern is that the 3D Castmembers are fully downloaded and ready for commands to be called on them. You can also work with 3D Castmembers from external casts, loading them as is required. This is a good method of approach for both online and offline work. We will explore streaming in Movies using 3D in Chapter 20, "Download Optimization."

When you're working with generated Models, there are two tasks you should handle at the beginning of any movie: making sure that the 3D Castmembers are fully loaded and resetting the 3D world. This is important in Authoring, Projectors, and Shockwave mode. Although this will become slightly modified when you learn to import Models, the overall schematic is the same.

To ensure that our 3D Castmember is fully downloaded, our efforts must be concentrated on this task from the very beginning of the movie. Recall that the order of events at the instantiation of a movie is as follows:

  1. PrepareMovie() (sets up globals)

  2. BeginSprite() (all Sprites in frame 1 initiate)

  3. PrepareFrame() (occurs before anything is drawn on stage)

  4. StartMovie() (suggest initializing non-3D elements here)

Figure 3.1 illustrates a sample score setup for a movie intended to run online or offline. The CD-ROM accompanying this book contains a file called "basic world setup." The illustration of the score in Figure 3.1 is derived from this file.

Figure 3.1 Example of a possible Score strategy for Movie download and initialization.

This movie contains two custom handlers designed to streamline the task of checking to ensure that the 3D Castmember is fully downloaded. One reason why I leave the first frame empty is because the 3D Castmember sometimes takes a moment to begin. If there is going to be a pause at the very beginning of the movie, you want to be able to control what the users see during that pause. They will see whatever was drawn on stage in the previous frame. If there is no previous frame, they will see the Macromedia load bar. Even if you are going to leave frame 1 empty, controlling the moment when the pause happens will allow you to make the process of beginning the movie more transparent to the user. The Behavior script attached to frame 2 contains an exitframe() handler. This handler calls upon a custom handler called check3Dready() that is used to determine whether the SW3D is ready. Here's the code:

1:on check3Dready(whichSW3D)
-- a state of 4 tells you the media is ready
2:if whichSW3D.state = 4 then
-- if it is ready, return true (for error checking & debugging)
3:return true
--if it isn't ready return false (for error checking & debugging)
5:return false
6:end if

This handler returns either true or false, depending on whether the 3D Castmember is ready. This information is used in the exitframe() handler attached to frame 2. The reason for this encapsulation is to create custom handlers that are robust enough to be used in several situations. In this case, check3Dready() is being used to determine whether we loop on a frame or jump to a new marker.

Line 2 of the check3Dready() handler refers to the State property of the 3D Castmember. The State property of a 3D Castmember contains information pertaining to the loading of that Castmember into RAM. Although we are primarily concerned with Castmembers fully downloading, the State property can be used to make sure that CD- or HD-based Director Movies are loaded correctly. The State property has six possible values that it can return, as indicated in Table 3.1.

Table 3.1 Values of 3D Castmember State Property

State Value



Error loading file


Not loaded


Loading has begun


High-priority Models downloading




Media is ready for all 3D commands

When the State setting of a Castmember is 4, all 3D commands can be run on the Castmember without worry. It is possible to run some commands on 3D Castmembers with a State setting of 2 or 3. However, resetworld() should not be called unless the Castmember's State setting is 4.


The priority of Model loading applies to Castmembers that contain Models created externally from Director. Check in Appendix A, "3D Studio MAX W3D Exporter," for information about changing the stream priority of Models.

The check3Dready() custom handler reports false when the 3D Castmember's State setting is not 4. The State property applies to other Castmember types as well as SW3D Castmembers. The State values for 3D Castmembers are unique to 3D Castmembers and do not reflect values for Shockwave Audio or Flash Castmembers.

When the 3D Castmember's State setting is 4, the exitframe() handler sends the Playback Head to the "init" marker. At init, the "call initialize" script contains an enterframe() handler. This handler calls a custom handler called initialize() and then sends the Playback Head to the "run" marker. The reason for all this jumping is to ensure that we have a specific moment that we can refer to when the initialize() handler will be called.

This strategy also allows us to separate the initialization of 3D and non-3D elements in our Movies. For example, although this demo does not contain a Startmovie event, it is a good location to initialize the non-3D portions of our Movie.


This strategy can also be helpful if you want to "restart" a movie without stopping at some point by sending the Playback Head to the init marker.

Currently, the only operation of our initialize custom handler is to call yet another custom handler, shown here, called clearworld():

1: on clearworld(whichSW3D)
-- last minute double checking to make sure SW3D is ready
2: if check3Dready(whichSW3D) then
-- if everything is ready, reset the world to default values
3: whichSW3D.resetworld()
-- return true (for error checking & debugging)
4: return true
5: else
-- SW3D not ready, return false (for error checking) 
6: return false
7: end if
8: end

The clearworld() custom handler is designed to make one final check to see whether the 3D Castmember's State property is ready, and then it calls the resetworld() function. Notice how in line 2 I call the check3Dready() custom handler to find out whether State is set to 4. This is a prime example of the reusability of the custom handlers we are building.

Most of the work of this handler occurs in line 3, where the resetworld() function is called. The resetworld() function is used to reinitialize a 3D Castmember to its default state. This means that after you call resetworld() on a 3D Castmember, it will only contain the defaults of one Camera, one Modelresource, one Shader, one Texture and two Lights.

If your 3D Castmember was created externally from Director, you should not use resetworld(). Rather, the reverttoworlddefaults() command reinitializes the 3D Castmember to its "saved" state. Chapter 9, "Working with Prebuilt Scenes and Behaviors," examines methods of working with 3D Castmembers created outside of Director.

One final precaution that we can take to avoid script errors is to actually turn off the streaming functionality for the Movie. You can accomplish this by editing your Movie Playback properties as noted in Figure 3.2.

Figure 3.2 Turning off the Play While Downloading Movie option from the Modify Movie menu.

You can set the Movie Playback properties from the Modify, Movie menu to make sure that the movie fully downloads before playing. This is another method of ensuring that you or your users will not encounter script errors at the beginning of your movie due to bandwidth. However, this method does not take advantage of the ability to stream your data in dynamically.

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information

To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.


Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.


If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information

Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.


This site is not directed to children under the age of 13.


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information

If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information

Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents

California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure

Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact

Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice

We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020