Unifeye Viewer package

→Return to Installation Guide

Development and Deployment Xtra

The Unifeye Viewer supports Windows operating systems and Mac operating systems (see the getting started section for details). The according Xtras for both platforms share the same functionality except the following limitations:

• “showPinProperties()” is currently NOT supported on the Mac platform
• “showPropertyPage()” is currently NOT supported on the Mac platform

In general the Xtras for both platforms (Windows, Mac) are available in two versions which offer the exact same functionality except the copy protection/licensing mechanism.

• The development version of the Xtra is intended to be used during the development process only and requires a plugged in WIBU key license dongle. This Xtra is only available within the package you receive when purchasing the Unifeye Viewer. It only reads unencrypted tracking configuration files.
• The deployment version of the Xtra is intended to be used when you deploy your application (e.g. to a web server). It does not require a WIBU license dongle but only reads encrypted tracking configuration files. The encryption of the tracking configuration files is done by metaio and usually requires an according runtime license contract. The deployment version of the Xtra is also hosted on the metaio server where it will be pulled from automatically if a user enters your Unifeye Viewer enabled application/web. More details on the proper configuration for this process to work can be found in 7.2.
  Once the user accepts the download the Shockwave browser plugin will take care of downloading the Xtra and store it in the according location on the target PC. The location of the downloaded Xtra varies across operating systems:
  • Windows:
    %APPDATA%\Adobe\Shockwave Player 11\xtras\download\metaioGmbH
    where %APPDATA% maps on Windows XP to:
    C:\Documents and Settings\<USERNAME>\Application Data\
    and on Vista to:
    C:\Users\<USERNAME>\AppData\LocalLow * Mac:
    ~/Library/Application Support/Adobe/Shockwave Player 11/Xtras/download/metaioGmbH

You can delete the folder metaioGmbH in the according locations if you want to remove the deployment Xtra from the system. After you deleted it, the Unifeye Viewer Xtra download dialog will appear again after you re-enter the page with your Shockwave AR application/movie.

In some case you may want to use the development Xtra in your already deployed application (e.g. for testing purposes). In these cases you can manually replace/overwrite the (downloaded) deployment Xtra with the development Xtra. This allows you to test your application online (i.e. in your web browser) with the development Xtra on your PC. Please note, that in such a case you will also have to change the tracking configuration file you load, as the development Xtra only processes unencrypted tracking configuration files.

Summary

In short, here is the summary for the two Xtra versions:

• Development Xtra:
  • WIBU key license dongle protected (requires WIBU key driver)
  • Reads only unencrypted tracking configuration files
  • For development and (local) testing purposes and not for distribution
• Deployment Xtra:
  • No license dongle protection
  • Available on the metaio server
  • Reads only encrypted tracking configuration files (the encryption is performed by metaio according to a license contract)
  • Will be deployed to the end users PCs automatically (after the confirmation of the user) together with your Shockwave application/movie

Package content overview

The Unifeye Viewer package is shipped as a zip archive. It provides the following files and folders. Please note that the development setup process is described in section 7.

Folder drivers

This folder contains drivers for the WIBU key license dongle.

The folder Mac contains the drivers to be used on Mac systems (Intel processor based Mac PCs with Mac OS version > 10.5).

The folder Windows contains the drivers for Windows based operating systems (Windows XP, Vista, Windows 7) as 32 and 64 bit drivers.

Folder examples

This folder contains two example models within the model subdirectory. The models are provided in w3d format as well as the original 3D Studio Max files. The file UnifeyeViewerLogo.w3d is not animated. The UnifeyeViewer.w3d file contains a simple animation.

The subdirectory ShockwaveARFrame contains a more complex Shockwave application which is described in more detail in section 8. There are two main files: PreMovie.dir is only responsible for downloading the Unifeye Viewer Xtra (if not already installed) and then forwards to the main application ShockwaveARFrame.dir/.dcr. The ShockwaveARFrame application parses a configuration file (ApplicationConfiguration.scef) which can setup a basic AR scene. The folder online contains all the needed files to be placed on a web server in order to run the example. It also contains an index.html page which uses a browser detection/Shockwave detection script which tells the user to download the Shockwave player if it is not already installed. If you want to use it you will have to adjust the URLs within the ApplicationConfiguration.scef according to your needs. This sample application can even be used without programming by just adjusting the ApplicationConfiguration.scef file and uploading the contents of the online folder accordingly. For more details regarding the configuration of the application please refer to section 9.

The subdirectory ShockwaveSimpleAR contains the most basic example showing how to integrate the Unifeye Viewer Xtra into a Shockwave application. For more details, please refer to section 7.5.

Folder UnifeyeViewer _Xtra_Deploy

This folder contains the Unifeye Viewer Xtra and all according dependencies of the deployment version of the Unifeye Viewer Xtra. Usually the deployment version of the Xtra will be pulled from metaio’s web server once you deploy your application and set up the Shockwave project settings within Director accordingly (see section 7).

The subdirectory Mac contains the Mac version of the Xtra, the folder Windows contains the Windows version. If you want to copy the Xtra manually (e.g. when switching between development and deployment versions) do not forget to copy all files in the according directory.

Folder UnifeyeViewer _Xtra_Develop

This folder contains the Unifeye Viewer Xtra and all according dependencies of the development version of the Unifeye Viewer Xtra.

The subdirectory Mac contains the Mac version of the Xtra, the folder Windows contains the Windows version. If you want to copy the Xtra manually (e.g. when switching between development and deployment versions) do not forget to copy all files in the according directory. The setup process of the development environment is described in section 7.

→Return to Installation Guide

-- SupportMetaio - 2010-07-15