Home > Articles > Home & Office Computing > eBay/Yahoo/Google

Like this article? We recommend JavaScript File

JavaScript File

The second half of this application is the JavaScript file, gettingstarted.js:

// loading O3D libraries is done via the require function
o3djs.require('o3djs.util');
o3djs.require('o3djs.math');
o3djs.require('o3djs.rendergraph');
o3djs.require('o3djs.camera');
o3djs.require('o3djs.pack');
o3djs.require('o3djs.scene');

window.onload = init;

var g_o3d;
var g_math;
var g_client;
var g_viewInfo;
var g_pack;

function init()
{
 // Create the O3D object inside divs whose id starts with o3d, and call initStep2 when done
 o3djs.util.makeClients(initStep2);
}

function initStep2(clientElements)
{
 // Initializes global variables and libraries.
 var o3dElement = clientElements[0];
 g_o3d = o3dElement.o3d;
 g_math = o3djs.math;
 g_client = o3dElement.client;

 // Creates a pack to manage our resources/assets
 g_pack = g_client.createPack();

 // Create the render graph for a view.
 g_viewInfo = o3djs.rendergraph.createBasicView(
 g_pack,
 g_client.root,
 g_client.renderGraphRoot);

 // Get our full path to the scene
 var scenePath = o3djs.util.getCurrentURI() + 'assets/teapot.o3dtgz';

 // Load the file given the full path, and call the callback function
 // when it's done loading.
 o3djs.scene.loadScene(g_client, g_pack, g_client.root, scenePath, callback);

 function callback(pack, parent, exception)
 {
 if (exception)
 {
 alert('Could not load: ' + scenePath + '\n' + exception);
 return;
 }
 // Get a CameraInfo (an object with a view and projection matrix)
 // using our JavaScript library function
 var cameraInfo = o3djs.camera.getViewAndProjectionFromCameras(
 parent,
 g_client.width,
 g_client.height);

 // Copy the view and projection to the draw context.
 g_viewInfo.drawContext.view = cameraInfo.view;
 g_viewInfo.drawContext.projection = cameraInfo.projection;

 // Generate draw elements and set up material draw lists.
 o3djs.pack.preparePack(pack, g_viewInfo);
 }
}

Let's break down this code. As mentioned previously, O3D includes the JavaScript utility library. Before these functions can be used, they need to be initialized by calling the require function:

o3djs.require('o3djs.util');
o3djs.require('o3djs.math');
o3djs.require('o3djs.rendergraph');
o3djs.require('o3djs.camera');
o3djs.require('o3djs.pack');
o3djs.require('o3djs.scene');

The file o3djs/base.js defines the require function, which is why it was included in the HTML file before gettingstarted.js.

O3D will be initialized once the window has loaded, so the onload event needs to be set up to trigger the init function:

window.onload = init;

Next, we define some global variables for the sake of convenience:

var g_o3d;
var g_math;
var g_client;
var g_viewInfo;
var g_pack;

This isn't strictly necessary in this application, because only one function refers to these variables (initStep2). However, in more complicated applications, having global variables will save some typing.

Two functions are defined in this application. The first function, init, has one statement: a call to makeClients. Here is where the DIV element that was defined earlier in the HTML file is modified to include the code necessary to display the O3D plug-in (see Figure 1).

function init()
{
 // create the O3D object inside divs whose id starts with o3d, and call initStep2 when done
 o3djs.util.makeClients(initStep2);
}

The default ID of the DIV element can be changed from something that starts with o3d to any other string, by supplying the appropriate parameters to the makeClients function (although there's little reason to do so).

Figure 1 The o3d DIV element gets a new child node once makeClients is called.

The second function, initStep2, is passed to the makeClients function, and is called once the plug-in is ready to be used. The real work of initializing O3D occurs in this function.

First, some of the global variables are initialized:

var o3dElement = clientElements[0];
g_o3d = o3dElement.o3d;
g_math = o3djs.math;
g_client = o3dElement.client;

Again, these are mostly for convenience:

  • The o3dElement variable references the OBJECT element that has been added as a child of the DIV element.
  • g_client is the entry point of the O3D application.
  • g_o3d is the namespace for O3D.
  • g_math is the namespace for the math library.

Next, a Pack is created:

g_pack = g_client.createPack();

Packs are used for memory management, and contain methods that allow new O3D objects to be created. Any object created by a function like Pack.createSomething is automatically placed in the Pack, and objects placed into a Pack can have the reference that the Pack holds to them cleaned up in bulk by calling Pack.destroy.

In order to draw a 3D scene, a render graph needs to be created. A render graph is actually a collection of objects that work in sequence to render the 3D elements in the scene to the 2D display (that is, the web page), which will show the final result. These objects and their relationships are shown in Figure 2. The good news is that these objects are all initialized by calling o3djs.rendergraph.createBasicView. Some advanced functions require creating a custom render graph, but for the majority of proposes the render graph created by calling createBasicView is sufficient. The value returned by createBasicView, a ViewInfo object, is stored in the global variable g_viewInfo.

g_viewInfo = o3djs.rendergraph.createBasicView(
 g_pack,
 g_client.root,
 g_client.renderGraphRoot);

Figure 2 The default render graph created by calling createBasicView.

To display a 3D model, it first has to be loaded. Preparing a 3D model to be loaded in an O3D application is an article in itself, but suffice to say that tools exist to create packages that can be loaded easily by the O3D utility library. This application will display the famous teapot model, contained in the teapot.o3dtgz file, which has been obtained from the assets directory of the sample.zip file mentioned above. This o3dtgz package can be loaded with a simple call to o3djs.scene.loadScene.

var scenePath = o3djs.util.getCurrentURI() + 'assets/teapot.o3dtgz';
o3djs.scene.loadScene(g_client, g_pack, g_client.root, scenePath, callback);

Once the scene has been loaded, the callback function is called. If there were any errors, the exception parameter is set, at which point the user is notified that something went wrong:

if (exception)
{
 alert('Could not load: ' + scenePath + '\n' + exception);
 return;
}

If there was no problem loading the scene, a "camera" needs to be created to view the scene. Much like OpenGL or DirectX, O3D is a low-level API, and doesn't define the concept of a camera. For most applications, though, the idea of viewing the 3D scene through a camera makes sense and is easy to visualize. Thankfully, the utility library has a number of classes and functions that allow for the easy creation and manipulation of a camera object.

In order to view the 3D scene, two matrices are needed: view and projection. The view matrix can be thought of as representing the viewer inside the 3D scene; the projection matrix takes the 3D coordinates of the objects in the scene and translates them into the 2D coordinates that are displayed on the screen. It's entirely possible to create and maintain these two matrices manually, but for a simple application like this, the o3djs.camera.getViewAndProjectionFromCameras function can be called to create a CameraInfo object whose view and transform matrixes are automatically calculated to generate a final view that encompasses the entire scene (in this case, the teapot model):

var cameraInfo = o3djs.camera.getViewAndProjectionFromCameras(
 g_client.root,
 g_client.width,
 g_client.height);

The view and projection matrixes that have been calculated by the call to getViewAndProjectionFromCameras and stored in the cameraInfo variable need to be assigned to the render graph. It's possible to have many cameras, but only one camera can be rendered by a render graph. By assigning the view and projection matrixes of the CameraInfo object to the corresponding matrixes in the render graph's drawContext property, the scene is effectively rendered from the point of view of that camera.

g_viewInfo.drawContext.view = cameraInfo.view;
g_viewInfo.drawContext.projection = cameraInfo.projection;

The final step is to prepare the pack that the scene was loaded into for rendering. Again, the O3D utility library has a function called o3djs.pack.preparePack that makes this process quite simple:

o3djs.pack.preparePack(pack, g_viewInfo);

The end result is a static view of the teapot model. (For further study, see the live demo of this application and download its source code.)

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.

Overview


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.

Surveys

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.

Newsletters

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.

Security


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

Children


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

Marketing


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.

Choice/Opt-out


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.

Links


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