iPIX(R) Java(R) Viewer5.0
April 18, 2005

File Contents
1. Introduction & New features
2. Minimum Client System Requirements
3. Using the IPIX Java Viewer
4. Files Required for Posting
5. Troubleshooting



1.  Introduction

Thank you for choosing the IPIX(R) Java(TM) Viewer 5.0 from Internet Pictures Corporation.  This release of the IPIX Java Viewer 5.0 contains several new features which are designed to allow our users greater flexibility in customizing their content for individual web sites. 





PLEASE NOTE: Beginning with the iPIX Wizard 2.3 and iPIX Builder 4.1 software, iPIX image outputs (.ipx files) are compatible with the iPIX Java Viewer 3.1 and higher. This allows higher resolution iPIX immersive images to be viewed without a browser plug-in.

This software is subject to license restrictions as stated in the included license.txt file. For technical support with IPIX products, please call toll-free at (888) 425-0048 or email technical_support@ipix.com. Please have your HTML code posted on the Web for viewing by the Support Technician.
 
IPIXand the IPIX logo are registered trademarks or trademarks of IPIX Corporation. Java is a registered trademark of Sun Microsystems, Inc. Netscape is a registered trademark of Netscape Communications Corporation.  Microsoft, Windows, and Internet Explorer are registered trademarks of Microsoft Corporation. Other products and brand names may be trademarks or registered trademarks of their respective owners.


2.  Minimum Client System Requirements

To view iPIX immersive images with the IPIX Java Viewer, your computer must meet certain requirements. Older computers may load larger image files (including high and unscaled resolution images) more slowly. 

· Windows:  Microsoft Windows 98 or better running Internet Explorer 5 or better, or Netscape 6 or better with java installed. 

· Macintosh: Macintosh OS 10.2 or better running Safari with Java 1.4.2 Plug-In (see http://www.apple.com/java).






3. Using the iPIX Java Viewer 



The following HTML code is inserted on the Web page to launch the applet:
<APPLET name="IpixViewer"
		code="IpixViewer.class"
		archive="IpixViewer.jar"
		width="320" height="240">
	<PARAM NAME="url" VALUE="YOURIMAGE.ipx">
	<PARAM NAME="toolbar" VALUE="on">
	<PARAM NAME="splash" VALUE="YOURSPLASH.jpg">
	<PARAM NAME="splashbg" VALUE="YOURHEXCOLOR">
	<PARAM NAME="initfov" VALUE="80">
	<PARAM NAME="spinspeed" VALUE="6">
	<PARAM NAME="spinstyle" VALUE="flat">
	<PARAM NAME="helpurl" VALUE="http://www.YUORDOMAIN.com/YOURHELP.htm">
	<PARAM NAME="helpframe" VALUE="_blank">
</APPLET>


Adding a codebase line to the applet lets you store the JAR file in one place on the server and reference them from any page on your Web site (on the same server). This code requires the iPIX image and the Web page to be in the same directory. To maintain compatibility with older browsers, the Codebase line should contain an absolute address to the directory of the applet as shown below: 
 <APPLET name="IpixViewer"	code="IpixViewer.class"	archive="IpixViewer.jar"	
 	codebase="http://www.yourdomain.com/directoryofapplet" 	width="320" height="240">
	<PARAM NAME="url" VALUE="YOURIMAGE.ipx">
	<PARAM NAME="toolbar" VALUE="on">
	<PARAM NAME="splash" VALUE="YOURSPLASH.jpg">
	<PARAM NAME="splashbg" VALUE="YOURHEXCOLOR">
	<PARAM NAME="initfov" VALUE="80">
	<PARAM NAME="spinspeed" VALUE="6">
	<PARAM NAME="spinstyle" VALUE="flat">
	<PARAM NAME="helpurl" VALUE="http://www.YUORDOMAIN.com/YOURHELP.htm">
	<PARAM NAME="helpframe" VALUE="_blank">
</APPLET>

 	

Note: Width and height values can be modified. On older computer, larger window sizes will pan slowly. 

Applet parameters are defined as follows and are not case sensitive:

Paramter: Width
Description: Width in pixels of applet window.
Values: 1...???

Parameter: Height
Description: Height in pixels of applet window.
Values: 1...???

Parameter: URL
Description: The URL of the iPIX image to be displayed.
Values: <Full URL of iPIX Image>

Parameter: SpinSpeed
Description: Indicates speed and direction of initial spin as well as the speed and direction the image will spin when "Spin" is selected from the popup menu.
Values: -10 ... 10

Parameter: SpinStyle
Description: Indicates style of spin -- sinusoidal or flat -- as well as the style of spin used when "Spin" is selected from the popup menu.
Values: wave | flat

Parameter: Splash
Description: Custom splash screen image.  The image can be of any format supported natively by Java.  The image must reside in a path relative to the applet.  If the image height is greater than 60% of the applet height or 100% of the applet width, the image will be scaled to fit this region, preserving the aspect ratio.  If the image is smaller than these limits, it will not be scaled.  A "Powered by iPIX" logo will automaticaly be placed at the lower right of the image.
Values: <relative URL of image file>

Parameter: SplashBG
Description: Custom background color for the splash screen.  This parameter is ignored unless the Splash parameter has also been specified. DO NOT use the # sign with your hex value.
Values: RRGGBB (Hexidecimal representation).

Parameter: Toolbar
Description: Indicates whether the toolbar should be shown be default.  If this parameter is not specified the toolbar will be shown by default.
Values: on | off

Parameter: HelpURL
Description: The URL of a Web page that will be displayed when "Help" is selceted from the popup menu or when F1 is pressed.  If this parameter is not specified, the applet will use the Help page on iPIX's server.
Values: <Full URL of Help page>

Parameter: HelpFrame
Description: An optional frame in which the Help Web page will be displayed.  This should specify a frame that exists in the page that embeds the applet.
Values: <Frame Name>

Parameter: InitFOV
Description: Allows Web page developer to override the initial zoom level specified in the iPIX Image file.  This is a field of view value in degrees indicating how much of the image should be visible initially.
Values: 0...115

Parameter: UpSample
Description: The applet will, by default, upsample smaller iPIX Images to improve image quality when viewing.  This flag indicates that the applet should not perform this upsampling.
Values: no


4.  Files Required for Posting

With this code, you must have the JAR file and the iPIX image file on the same server as your HTML page that uses this code.


IpixViewer.jar

 
Other included files: 
readme.txt -- this file
license.txt -- please read the license



5.  Troubleshooting

1. Both the applet and IPIX immersive image must reside on the same server (http://www.yourdomain.com).
2. Maintain correct spelling and capitalization when posting, especially on case-sensitive Web servers.
3. When running from a dynamic html Web server, it may be necessary to use absolute addressing for the URL parameter -- http://www.yourdomain.com/foldername/filename.ipx. 


Detailed instructions for posting iPIX immersive images can be found under the SUPPORT section of the IPIX Web site, at http://www.ipix.com/products/support/posting/postimages.shtml. Please note, these instructions are for release versions of the java viewer. This means certain listed parameters may not be applicable for the IPIX Java Viewer 5.0.