iSeeMedia Viewers - Java Versions Developer's Guide v4.0

The iSeeMedia Viewers - Java Versions are designed to display specific types of Web page content, including ZOOM 2D Flashpix images, Image Objects and Panoramic images. Having separate Java viewers for each type of content makes the downloads small and fast. For the most current updates to the iSeeMedia ZOOM Viewer - Java Versions and to see content examples, visit the iSeeMedia Web site at www.iSeeMedia.com

Click the links below to view the contents list for each Java viewer:

* An image object is a collection of photographic images of a real-world 3D object, taken from various angles around the object. During playback, you can manipulate the image object to determine which image to show. This simulates the experience of examining an actual 3D object. For more information about creating image objects using iSeeMedia Photovista 3D Objects, visit the Products section of the iSeeMedia Web site.

*Please pay attention throughout this document. Most of the information is relevant to all viewers. Information that is relevant to a specific viewer will be noted.


Contents

A word about Java

About the Flashpix format

Minimum system requirements

Windows
Macintosh

Getting Started

Setting up the iSeeMedia ZOOM Server
Serving Java Viewers and IVR files from the iSeeMedia ZOOM Server
Specifying a remote path for Flashpix images
Security authentication

Using the iSeeMedia ZOOM viewer

Placing the iSeeMedia Java viewer in your Web page

iSeeMedia ZOOM 2D Viewer

iSeeMedia ZOOM Object Viewer

iSeeMedia ZOOM Pano Viewer

iSeeMedia Object Viewer

iSeeMedia Pano Viewer


iSeeMedia ZOOM 2D Viewer Contents List

Specifying parameters:

backGroundColor
backGroundImage,leftMargin,topMargin,displayWidth,displayHeight
enableZOOMPastMax
Hotspot
initialView

JavaScript methods

Action methods:

CenterZOOMIn()
CenterZOOMOut()
getAppletInfo()
HideHotSpots()
MoveRelative(x,y)
Reset()
SetView(frame,x1,y1,x2,y2)
showHotSpots
ShowInfo

Methods to reset the viewer:

Add_hotspot(id,value)
ClearParameters()
ResetApplet()
Set_backgroundColor(value)
Set_backgroundImage(value)
Set_displayHeight(value)
Set_displayWidth(value)
Set_enableZoomPastMax(value)
Set_initialView(value)
Set_leftMargin(value)
Set_showHotspots(value)
Set_topMargin(value)


iSeeMedia ZOOM Object Viewer Contents List

Using image objects created with the Photovista 3D Objects 1.0

Fixing IVR files created with the Photovista 3D Objects 1.0

Removing padding from image object frames created with the Photovista 3D Objects 1.0

Known issues

Specifying parameters:

autoSpin
backGroundColor
backGroundImage,leftMargin,topMargin,displayWidth,displayHeight,foreGroundFrame
enableZOOMPastMax
file
Hotspot
initialView
showHotspots

JavaScript methods

Action methods:

CenterZOOMIn()
CenterZOOMOut()
getAppletInfo()
HideHotSpots()
MoveRelative(x,y)
Reset()
SetView(frame,x1,y1,x2,y2)
ShowHotSpots
ShowInfo

Methods to reset the viewer:

Add_hotspot(id,value)
ClearParameters()
ResetApplet()
Set_autospin(value)
Set_backgroundColor(value)
Set_backgroundImage(value)
Set_displayHeight(value)
Set_displayWidth(value)
Set_enableZoomPastMax(value)
Set_file(value)
Set_foregroundFrame(value)
Set_initialView(value)
Set_leftMargin(value)
Set_showHotspots(value)
Set_topMargin(value)


iSeeMedia ZOOM Pano Viewer Contents List

Using the codebase tag

Specifying parameters:

autoSpin
backGroundColor
backGroundImage,leftMargin,topMargin,displayWidth,displayHeight,foreGroundFrame
file
Hotspot
initialView
minZoomAngle
showHotspots

JavaScript methods

Action methods:

CenterZOOMIn()
CenterZOOMOut()
getAppletInfo()
HideHotSpots()
Reset()
SetView(vertical_angle,horizontal_angle,zoom_angle,transition_time)
ShowHotSpots
ShowInfo

Methods to reset the viewer:

Add_hotspot(id,value)
ClearParameters()
ResetApplet()
Set_autoSpin(value)
Set_backgroundColor(value)
Set_backgroundImage(value)
Set_displayHeight(value)
Set_displayWidth(value)
Set_file(value)
Set_foregroundFrame(value)
Set_initialView(value)
Set_leftMargin(value)
Set_minZoomAngle(value)
Set_showHotspots(value)
Set_topMargin(value)


iSeeMedia Object Viewer Contents List

Using image objects created by the Photovista 3D Objects 1.0

Fixing IVR files created with the Photovista 3D Objects 1.0

Removing padding from image object frames created with the Photovista 3D Objects 1.0

Known Issues

Specifying parameters:

autoSpin
backGroundColor
backGroundImage,leftMargin,topMargin,displayWidth,displayHeight,foreGroundFrame
enableZOOMPastMax
file
Hotspot
initialView
showHotspots

JavaScript methods

Action methods:

CenterZOOMIn()
CenterZOOMOut()
getAppletInfo()
HideHotSpots()
moveRelative(x,y)
Reset()
SetView(frame,x1,y1,x2,y2)
ShowHotSpots
ShowInfo

Methods to reset the viewer:

Add_hotspot(id,value)
ClearParameters()
ResetApplet()
Set_autoSpin(value)
Set_backgroundColor(value)
Set_backgroundImage(value)
Set_displayHeight(value)
Set_displayWidth(value)
Set_enableZoomPastMax(value)
Set_file(value)
Set_foregroundFrame(value)
Set_initialView(value)
Set_leftMargin(value)
Set_showHotspots(value)
Set_topMargin(value)


iSeeMedia Pano Viewer Content List

Using the codebase tag

Specifying parameters:

autoSpin
backGroundImage,leftMargin,topMargin,displayWidth,displayHeight,foreGroundFrame
file
Hotspot
initialView
minZoomAngle
showHotSpots
JavaScript methods

Action methods:

CenterZOOMIn()
CenterZOOMOut()
getAppletInfo()
HideHotSpots()
Reset()
SetView(vertical_angle,horizontal_angle,zoom_angle,transition_time)
ShowHotSpots
ShowInfo

Methods to reset the viewer:

Add_hotspot(id,value)
ClearParameters()
ResetApplet()
Set_autoSpin(value)
Set_backgroundColor(value)
Set_backgroundImage(value)
Set_displayHeight(value)
Set_displayWidth(value)
Set_file(value)
Set_foregroundFrame(value)
Set_initialView(value)
Set_leftMargin(value)
Set_minZoomAngle(value)
Set_showHotspots(value)
Set_topMargin(value)

Enhancing performance and resolution tips for panoramic images


A word about Java

The iSeeMedia Viewers—Java Versions are written entirely in the Java programming language and benefit a wide audience:

  • Web site visitors do not have to wait through lengthy download and installation times, because these viewers are Java applets. If their browser can handle Java, the iSeeMedia Viewer and your image appear automatically. And because the Viewer is automatically stored in the browser's cache, your site visitors download it only once, even if your site contains several pages with image objects, 2D images or panoramas.
  • Web designers can easily add controls to the images, such as hotspots and links, by adding a few lines to their HTML pages.
  • Web administrators can easily update all of the iSeeMedia Viewers from the iSeeMedia Web site.

About the Flashpix format

The Flashpix format is a multi-resolution digital image file format, which offers an ideal way to view and print high-quality, high-resolution images in real time. The Flashpix format is a trademark of the Digital Imaging Group (DIG). Visit the DIG web site at www.digitalimaging.org for more information.

Note: Printing of Flashpix images is not available from Java applets. If you would like to offer the printing capability, you can use the iSeeMedia ZOOM Plug-in Viewer or the iSeeMedia ZOOM Control Viewer. For more information, visit the iSeeMedia Web site at www.iseemedia.com.


Minimum system requirements

The following minimum hardware and software are needed to use the iSeeMedia ZOOM Viewer.

Windows

  • Pentium® computer running Windows 95, or Pentium 166 computer running Windows NT
  • 16MB RAM for Windows 95, 32 MB RAM for Windows NT
  • Any Java 1.02 compliant browser such as Netscape® Navigator 4.04 or higher, or Internet Explorer® 4.0 or higher
  • 65,000 colors minimum (24-bit true color recommended)

Macintosh

  • Macintosh OS 8.5
  • 14MB RAM allocated to the Web browser
  • Any Java 1.02 compliant browser such as Internet Explorer® 4.5 or higher. Also, the Macintosh OS Runtime for Java 2.2 (MRJ 2.2) is required. The MRJ 2.2 is available from Apple's web site.
  • 65,000 colors minimum (24-bit true color recommended)

Note: To use the JavaScript methods that use strings, you must be running Netscape Communicator 4.01 or higher.


Getting Started

This section describes what you need to use the iSeeMedia ZOOM Viewer.

  • Setting up the iSeeMedia ZOOM Server
  • Creating a directory structure for the viewer files
  • Specifying a remote path for your Flashpix images on the iSeeMedia ZOOM Server
  • Using tips for optimal viewing

Setting up the iSeeMedia ZOOM Server

The iSeeMedia ZOOM Server stores and delivers Flashpix images, objects and panoramas using IIP (Internet Imaging Protocol). Before you can create a page using the iSeeMedia ZOOM Viewer, you must install the iSeeMedia ZOOM Server on your Web server, or use an Internet Service Provider (ISP) that has the iSeeMedia ZOOM Server installed. If you are setting up your own server, see the iSeeMedia ZOOM Server Administrator's Guide for complete setup information.

The iSeeMedia ZOOM Server Startup Guide contains important design considerations for enhancing your Web pages using Flashpix images, including how to choose a iSeeMedia ZOOM Viewer to suit your needs in different situations. You can find this HTML guide on your Image Server CD.

The Java security model requires that the Java viewers and any data they download must come from the same domain. This affects where the viewers and data files are located in order for them to work correctly.

There are two basic configurations. In the first configuration, the iSeeMedia ZOOM Server and the Web server reside on the same IP address. In this case, the iSeeMedia ZOOM Java Viewers and any associated IVR files can be located on the Web server and be referenced directly in the HTML pages. In the second configuration, the ZOOM Server and the Web server reside on different IP addresses. This might occur if you have access to a iSeeMedia ZOOM Server, but your HTML pares are on a Web server running from a different Internet domain. In this case, the iSeeMedia ZOOM Server must deliver the iSeeMedia ZOOM Java Viewers and the IVR files. This is explained in the following section.

Serving Java Viewers and IVR files from the iSeeMedia ZOOM Server

The Java viewer package files are in your iSeeMedia ZOOM Server in a directory named servercomponents/Code, then place the IVR files used by the Java viewers in the iSeeMedia ZOOM Server images directory. This more efficient scheme, lets you reference the same viewer files over and over, without needing multiple sets. It also lets you quickly update the viewer files as they become available from iSeeMedia. Specify the location of the viewer file and the location of the IVR file in your HTML page using the following syntax.

<applet archive=zoompanoapplet.jar code=zoompanoapplet
codebase="http://image_server_host_id:image_server_port/obj=delivery,1.0&cmd=retrieve&fif=code"
<param name=file value="http://image_server_host_id:image_server_port/obj=delivery,1.0&cmd=retrieve&fif=stitched_result.ivr">

where:

  • image_server_host_id is the IP address or host name of the iSeeMedia ZOOM Server.
  • image_server_port is the port for the iSeeMedia ZOOM Server, which is configurable. The default port number is 8087.
  • obj=delivery,1.0&cmd=retrieve&fif=servercomponents/Code tells the iSeeMedia ZOOM Server to delivery Java applets from a folder named "code" in the iSeeMedia ZOOM Server image directory. You can use whatever folder name you wish instead of "code" as long as you create this directory in the servercomponents Directory.
  • <param name=file value="http://image_server_host_id:image_server_port/obj=delivery,1.0&cmd=retrieve&fif=stitched_result.ivr">Tells the iSeeMedia ZOOM Server to deliver the IVR file to the Java applet.

The following example shows how to embed the iSeeMedia ZOOM Pano Viewer in an HTML page, where the HTML page is delivered by a web server but the Java applet and the IVR file are delivered by the iSeeMedia ZOOM Server.

<applet archive=zoompanoapplet.jar code=zoompanoapplet
codebase="http://127.0.0.1:8087/obj=delivery,1.0&cmd=retrieve&fif=servercomponents/Code"
width=400 height=300>)
<param name=file value="http://127.0.0.1:8087/obj=delivery,1.0&cmd=retrieve&fif=servercomponents/Code/FreeFlow.ivr">
</applet>

Specifying a remote path for Flashpix images

Your Flashpix images must reside in a special directory on the iSeeMedia ZOOM Server, not in the same directory as your HTML pages. Typically, it is the server "root image directory". Make sure that you specify the correct and complete remote path for each Flashpix image on the iSeeMedia ZOOM Server. The default images directory is defined during the server installation. For more information, see the iSeeMedia ZOOM Server Administrator's Guide.

You must use the entire URL to the document root directory and not just the relative path. The URL is as follows:

<PARAM NAME="URL"VALUE="http://image_server_host_id:image_server_port/fif=image">

where:

  • image_server_host_id is the IP address or host name of the iSeeMedia ZOOM Server.
  • Image_server_port is the port for the iSeeMedia ZOOM Server, which is configurable. The default port number is 8087.
  • fif= is a literal string identifying the file to show.
  • Image is the name of the Flashpix file you want to display. The file must reside in the root image directory or one below it. If you do not supply a path, the image server assumes the file is in the root image directory.

Security authentication

If your Flashpix images are secure, a dialog box appears requesting a user name and password the first time in a session that a user tries to view one of the images using the iSeeMedia Java viewer.


Using the iSeeMedia ZOOM Viewer

Note: Java viewers do not support printing.

iSeeMedia Object Viewer toolbar and keyboard shortcuts

Toolbar Button Function Keyboard Shortcut
Zoom In
Zooms into the image object. Click Zoom In, then click anywhere in the viewer window.

Note: If you try to zoom past the maximum image object resolution, the Maximum Zoom icon appears will flash in the upper left corner of the viewer window.

A or Shift+Click or Page Up
Zoom Out
Zooms out of the image object. Click Zoom Out, then click anywhere in the viewer window. Z or Control+Click or Page Down
Rotate Image Object
Lets you drag across the image object to rotate it and view all sides.

Right and left Arrow keys

For multi-row image objects, you can also use the up and down Arrow keys.

Pan Image Object
Lets you drag the image object around the viewer window. Control+Click and drag or Control+Arrow keys to pan 3 pixels at a time.
Control+Shift+Arrow keys to pan 15 pixels at a time.
Initial View
Returns the image object to initial view after you have zoomed in. V
Show Hotspots
Shows any hotspot links.
Note: Click the hotspot to activate it or, when the pointer is over the hotspot, press Enter.
H
Information
Shows an HTML document with information about the iSeeMedia Object Viewer. I

iSeeMedia Pano Viewer toolbar and keyboard shortcuts

Toolbar Button Function Keyboard Shortcut
Zoom in
Zooms into the Panorama. Click Zoom In, then click anywhere in the viewer window.

Note: If you try to zoom past the maximum panoramic resolution, the Maximum Zoom icon will flash in the upper left corner of the viewer window.

A or Shift+Click or Page Up
Zoom out
Zooms out of the Panorama. Click Zoom Out, then click anywhere in the viewer window. Z or Control+Click or Page Down
Pan
Lets you click the image and drag to view a new section. Click and drag or use Arrow keys.
Initial View
Returns the panorama to initial view after you've zoomed in. V
View hotspots
Shows any hotspot links.
Note: Click the hotspot to activate it or, when the pointer is over the hotspot, press Enter.
H
Information
Shows an HTML document with information about the iSeeMedia Pano Viewer. I

 

iSeeMedia ZOOM 2D Viewer toolbar and keyboard shortcuts

Toolbar Button Function Keyboard Shortcut
Zoom In
Zooms into the image. Click Zoom In, then click anywhere in the viewer window. To zoom in continuously, hold down the mouse button.

Note: If you try to zoom past the maximum image resolution, the Maximum Zoom icon appears in the upper left corner of the viewer window.

Page Up
Zoom Out
Zooms out of the image. Click Zoom Out, then click anywhere in the viewer window. To zoom out continuously, hold down the mouse button. Page Down
Pan Image
Lets you click the image and drag to view a new segment of the image. Use the Arrow keys to move 3 pixels at a time. Use SHIFT + Arrow keys to move 15 pixels at a time.
Initial View
Returns a Flashpix image to initial view after you've zoomed in. V
Show Hotspots
Shows any hotspot links. H
Magnifying Glass
Shows the area within the box at the next zoom level of the image. Click and drag the mouse to a magnify the desired section.  
Information
Shows an HTML document with information about the iSeeMedia ZOOM 2D Viewer. I

iSeeMedia ZOOM Object Viewer toolbar and keyboard shortcuts

Toolbar Button Function Keyboard Shortcut
Zoom In
Zooms into the image objectimage object. Click Zoom In, then click anywhere in the viewer window.

Note: If you try to zoom past the maximum image object resolution, the Maximum Zoom icon appears in the upper left corner of the viewer window.

 
Zoom Out
Zooms out of the image object. Click Zoom Out, then click anywhere in the viewer window.  
Rotate Image Object

Lets you drag across the image object to rotate it and view all sides. Also, another function of the rotate feature is to view the image object in different aspects and rotate it to view its sides.

Note: You must have created the image object with multiple rows to view it from different aspects.

Right and left Arrow keys

Pan Image Object
Lets you click the image and drag to view a new segment of the image.  
Initial View
Returns the image object to initial view after you've zoomed in. V
Show Hotspots
Shows any hotspot links.
Note: Click the hotspot to activate it or, when the pointer is over the hotspot, press ENTER.
H
Information
Shows an HTML document with information about the iSeeMedia ZOOM Object Viewer.  I

iSeeMedia ZOOM Pano Viewer toolbar and keybaord shortcut

Toolbar Button Function Keyboard Shortcut
Zoom In
Zooms into the panorama. Click Zoom In, then click anywhere in the viewer window. A
Zoom Out
Zooms out of the panorama. Click Zoom Out, then click anywhere in the viewer window. Z
Pan
Lets you click the image and drag to view a new segment of the image. Click and drag or use Arrow keys
Initial View
Returns the panorama to initial view after you've zoomed in. V
Show Hotspots
Shows any hotspot links. Click the hotspot to activate it. H
Information
Shows an HTML document with information about the iSeeMedia ZOOM Pano Viewer.  I

 

Note: When the viewer is downloading information from the server, an hourglass symbol appears. Press ESC to stop downloading information from the server.


Placing the iSeeMedia Java viewer in your Web pages

The following example shows the HTML you need to place the iSeeMedia ZOOM 2D viewer in your Web pages. You can cut and paste this code into your HTML document; if you do, be sure to change file and directory names, the "www.myserver.com" tag to reflect your domain, and the dimensions you want for the viewer window. The url parameter is required to specify the Flashpix file for the viewer to load. In the example below, it is in blue text.

<applet archive="zoom2dapplet.jar" code="zoom2dapplet" width=300 height=200>
<PARAM name=url value="http://www.myserver.com:8087/fif=test.fpx>
</applet>

Note: For optimal results, keep the viewer window size to less than 300 x 300 pixels. Larger dimensions result in larger downloads and slower performance. However, the viewer window must be at least 200 pixels wide to display the entire toolbar.


This section applies only to the iSeeMedia ZOOM Object Viewer and the iSeeMedia Object Viewer.

Using image objects created with Photovista 3D Objects 1.0

Photovista 3D Objects 1.0 produces four-channel Flashpix image objects. However, the iSeeMedia ZOOM Viewer can only view three-channel image objects. A four-channel image object has four channels of color information (Red, Green, Blue, and Alpha). The Alpha channel contains opacity information, which cannot be decompressed by the iSeeMedia ZOOM Viewer. To convert a four-channel image object to a three-channel image object, you need to remove the Alpha channel. The easiest way to do this is using iSeeMedia's LivePix™ 2.0 image-editing application, as follows:

  1. Open the four-channel Flashpix image object in LivePix and choose Save As from the File menu. The Save dialog box appears.
  2. In the Save dialog, type a file name, choose Flashpix as the type, and click Save. The Save As Flashpix Options dialog box appears.
  3. Leave the resolution setting as is. Set the compression to High Quality/Low Compression or Good Quality/Medium Compression.
  4. Click OK. LivePix saves as a three-channel Flashpix image object.

Fixing IVR files created with Photovista 3D Objects 1.0

You might need to edit the IVR file you created with Photovista 3D Objects 1.0 to work with the iSeeMedia ZOOM Viewer. This is necessary if you specified a remote path for your image in your exported IVR file. When you specified the remote path, two URLs were placed into the IVR file—one to the remote version of the image and one to the local version. Both URLs are contained within one set of brackets. You need to remove one of the URLs and omit the surrounding brackets.

For example:

url ["http://www.iseemedia.com/fif=foo.fpx" "foo.fpx"] would change to: url "http://www.iseemedia.com/fif=foo.fpx"

Removing padding from image object frames created with Photovista 3D Objects 1.0

Note: This is an optional procedure to increase viewing efficiency, as desired.

Photovista 3D Objects 1.0 pads each image in the image object to a power of two; for example: 256, 512, 1024, and so on. This padding is necessary if you use the image object as a 3-D panel (World image object) in Reality Studio. However, this padding is not efficient or necessary if you plan only on using the image object with the iSeeMedia ZOOM Viewer. You can manually remove the padding from image objects that are less than 4000 x 4000 pixels by editing the frames in Photoshop and placing them edge-to-edge vertically and horizontally. When you remove the padding from the frames, be sure to edit the IVR file to turn off the padding option, as follows:

  • Open the IVR file using any text editor, find the line that contains "padded = true", and change this setting to "padded = false".

Known issues with the iSeeMedia Object Viewer

  • The iSeeMedia Viewer—Java Version for JPEG Objects limits the size of the JPEG image object, up to 1.2 million pixels (1000 x 1200). The size limit depends on the amount of memory that is available for Java and the Web browser.
  • When using some Web browsers on Macintosh, the JPEG decompressor that is built into Java might fail on very wide images. If you run into this problem, you'll need to use an image-editing application to reduce the width of your JPEG image. Rearrange the frames in your image so that there are more rows and fewer columns. Be sure to preserve the order of the frames.

    For example, if the object has 10 square frames (each 300 x 300 pixels) lined up side by side in one row, the resulting JPEG image will be 3,000 x 300 pixels. This image might not work in all Macintosh Web browsers. You can resize this image to be 1,500 x 600 pixels by making two rows of five images each.

    In the example below, the original JPEG image consists of 18 frames in one row. When the image is edited into two rows of 9 frames, the resulting image is half the width of the original.

This section applies only to the iSeeMedia ZOOM Pano Viewer and the iSeeMedia Pano Viewer.

Using the codebase tag

If you are linking panoramas together or have several pages of panoramas, you will need to keep your viewer files (panoapplet.jar) in a separate directory from the HTML pages with the panorama files. In this case, you will use the codebase tag to reference the files. See the example below.

Important: When implementing the codebase tag, do not use any carriage returns in the line of code that references the codebase. Keep in mind that JavaScript expressions end in a semicolon (;).

<applet code=panoappletscript language="JavaScript">
  codebase="http://www.MyWebSite.com/MyCodeBase"
  height=420
  name=FPViewer1 width=400
  archive = panoapplet.jar>
  <param name=file value="Detroit.ivr">
</applet>

Specifying parameters

Mix and match the parameters in this section to get the effects you want. You define these parameters in HTML, so you can use your usual HTML editing tool to add these simple, yet powerful parameters. For best results across platforms, pay attention to case-sensitivity when specifying parameters.

autoSpin

(this parameter is used only by the iSeeMedia ZOOM Object and Pano Viewers and the iSeeMedia Object and Pano Viewers)

Function: This parameter controls whether or not the image object or panorama rotates automatically and at what speed.

Syntax: <PARAM NAME="autoSpin"value=speed>

Values: Speed is a floating point value, which is the number of seconds required for one complete revolution of the image object or panorama. A negative value reverses the direction of rotation. Higher numbers cause the image object or panorama to rotate slower; lower numbers cause it to rotate faster. For best results, use a value between -10 and +10. If you omit this parameter, the image object or panorama will not rotate.

Comments: The image object or panorama rotates automatically until you interact with it by Zooming in or out, dragging the pointer over it, or activating hotspots. This stops the automatic, continuous rotation. When you reload the HTML page, the image object or panorama rotates automatically again. You can use autoSpin with panoramas that are not 360 degrees. In this case, the panorama bounces from one end of the panorama to the other.

backGroundColor

(this parameter is used only by the iSeeMedia ZOOM 2D, Object and Pano Viewers and the iSeeMedia Object Viewer)

Function: This parameter defines the background color to be used by the viewer for images, objects and panoramas that do not completely fill the viewer window.

Syntax: <PARAM NAME="backgroundColor" VALUE="r, g, b">

Values: The values are integers between 0 and 255. For example, the default value is "255, 255, 255", which is white.

backGroundImage, leftMargin, topMargin, displayWidth, displayHeight, foregroundFrame

(these parameters are used by all the viewers except for the foregroundFrame parameter which is used only by the iSeeMedia ZOOM Object and Pano Viewer and the iSeeMedia Object Viewer)

Function: These parameters let you use your own customized image as a background to surround an image, object or panorama. The foregroundFrame parameter gives you the option of placing the background image as a transparent GIF in front of an object or panorama.

Syntax: PARAM name=backgroundImage value="imageURL"

<PARAM name=leftMargin value="pixels">

<PARAM name=topMargin value="pixels">

<PARAM name=displayWidth value="pixels">

<PARAM name=displayHeight value="pixels">

<PARAM name="foregroundFrame" value="true|false">

where:

  • imageURL is the location of the image, relative to the Java viewer location.
  • displayWidth is the width of the image.
  • displayHeight is the height of the image.
  • leftMargin is the amount of space between the left edge of the image and the left edge of the background image.
  • topMargin is the amount of space between the top edge of the image and the top edge of the background image.
  • foregroundFrame values are true or false. If the value is true, the background image is drawn on front of the view and must be a transparent GIF. If the value is false, the background image is drawn behind the view and the object or panorama is drawn on top.

Values: The values are integers that represent pixels. Note that the sum of the displayWidth and leftMargin values should not exceed the width dimension in the <APPLET> tag. Similarly, the sum of the displayHeight and topMargin values should not exceed the height dimension.

Comments: You can use JPEG or GIF images as background images. The image is resized automatically to fit the viewer window (as defined in the <APPLET> tag). To optimize download times, make the part of the background image that is covered by the sub-window a solid color. This achieves better compression ratios.

enableZOOMPastMax

(this parameter is used by the iSeeMedia ZOOM 2D and Object Viewer and the iSeeMedia Object Viewer)

Function: This parameter lets you set whether or not to allow Zooming in past the maximum resolution of an image or object.

Syntax: <PARAM NAME="enableZOOMPastMax" VALUE="on/off">

Values: The values are "on" or "off". The default value is "off", which prevents you from Zooming past the maximum resolution of the image or object.

file

(this parameter is used by the iSeeMedia ZOOM Object and Pano Viewers and the iSeeMedia Object and Pano Viewer)

Function: This parameter is required to specify the IVR file for the viewer to load. See Placing the iSeeMedia Java viewer in your Web pages.

Syntax: <PARAM name=file value="test.ivr">

Value: The value is the name of the IVR file.

Hotspot

(this parameter is used by all Java viewers)

Function: This parameter lets you define hotspots in images, objects and panoramas. Hotspots are areas in the image that, when clicked, cause a new action. You can use hotspots to link images, object and panoramas together, load a new HTML page, play audio clips, and more.

Syntax (for the iSeeMedia ZOOM 2D Viewer only): You must put a number after the hotspot name. The number zero is not valid. The syntax includes required and optional parameters. A generic example of this parameter is:

<PARAM NAME="hotSpot1" VALUE="x1, y1, x2, y2, URL, description, target_frame, visibilitySize, allowDisplayOfHotSpot">

where:

  • x1, x2, y1, y2 is a required parameter, specifying the upper left and lower right coordinates for the hotspot.
  • URL is a required parameter, specifying the URL that loads when you click the hotspot.

Here is a specific example of the hotspot parameter with the values defined:

<PARAM NAME="hotSpot1"VALUE="0.35,0.6,0.45,0.7,http://www.iseemedia.com/,The Fish, NEWWINDOW,300,false">

Syntax (for the iSeeMedia ZOOM Object Applet and Object Viewers only): You must put a number after the hotspot name. The number zero is not valid. The syntax includes required and optional parameters. A generic example of this parameter is:

<PARAM NAME="hotSpot1" VALUE="frameNumber, x1, y1, x2, y2, URL, description, target_frame, visibilitySize, deactivation, allowDisplayOfHotSpot">

where:

  • framenumber is a required parameter that indicates the frame of the image object in which the hotspot is active. If you set this number to zero, the hotspot will be active in all frames of the image object.
  • x1, x2, y1, y2 is a required parameter, specifying the upper left and lower right coordinates for the hotspot.
  • URL is a required parameter, specifying the URL that loads when you click the hotspot.

Here is a specific example of the hotspot parameter with the values defined:

Syntax (for the iSeeMedia ZOOM Pano Applet and Pano Viewers only): You must put a number after the hotspot name. The number zero is not valid. The syntax includes required and optional parameters. A generic example of this parameter is:

<PARAM NAME="hotSpot1" VALUE="x1, y1, x2, y2, URL, description, target_frame, allowDisplayOfHotSpot">

where:

  • framenumber is a required parameter that indicates the frame of the image object in which the hotspot is active. If you set this number to zero, the hotspot will be active in all frames of the image object.
  • x1, x2, y1, y2 is a required parameter, specifying the upper left and lower right coordinates for the hotspot.
  • URL is a required parameter, specifying the URL that loads when you click the hotspot.

Here is a specific example of the hotspot parameter with the values defined:

<PARAM NAME="hotSpot1"VALUE="0.35,0.6,0.45,0.7,http://www.iseemedia.com/,The Fish, NEWWINDOW,300,false">

Defining the coordinates: If you are not sure of the coordinates to use for hotspots, you can use an image-editing application to obtain image size in pixels and pixel coordinates so you can translate them into relative coordinates.

  1. In your image editor, take note of the image dimensions (for example, 500 x 300).
  2. Drag out the area for the hotspot, noting the pixel coordinates of the upper left and lower right corners of the area. For example, 106, 66 (upper left corner) and 346, 196 (lower right corner).
  3. Divide the horizontal pixel coordinates by the image width, and the vertical pixel coordinates by the image height. The results in the following example are rounded to a single decimal point, but you can specify more precise coordinates if you want.
Example:

106 (x1) ÷ 500 = .2, 66 (y1) ÷ 300 = .2

346 (x2) ÷ 500 = .7, 196 (y2) ÷ 300 = .7

 

The relative values for this upper left coordinate are 0.2, 0.2

The relative values for this lower right coordinate are 0.7, 0.7

Optional Parameters: The following table describes the optional parameters you can use in the hotspot syntax after you specify the URL.

Note: If you omit an optional parameter, you must place a space between the commas. For example:

<PARAM NAME="hotSpot1" VALUE="0.35,0.6,0.45,0.7,http://www.iseemedia.com/ , , , ,">

Optional parameter Description
description This parameter lets you display text in the browser status bar when the pointer passes over a hotspot.
target_frame This parameter lets you specify the frame into which the URL should be loaded.
visibilitySize This parameter lets you specify the minimum size of a hotspot to be displayed by the viewer. Note that a hotspot can be tiny when the user views the entire image, but grow bigger when a user Zooms in. A value of 25 will tell the viewer not to display the hotspot if it takes less than 25 pixels on the screen. The default value is 9 pixels.
deactivation This parameter complements the visibilitySize parameter by letting you specify the maximum size of a hotspot to be displayed by the viewer. Note that a hotspot can fill the entire window, forcing you to trigger the hotspot even if you want to continue Zooming in The value is a floating point, with a default of 0.5, which tells the viewer not to display the hotspot if it takes up more than 50 percent of the window.
allowDisplayOfHotSpot This parameter lets you show or hide the hotspot. The values are true or false. If you do not specify a value, the default is true to show the hotspot.

Comments: You can create several hotspots by numbering them sequentially, such as hotspot1, hotspot2, and so on, where zero (0) is not valid. The figure below illustrates how to place hotspots on top of each other. Notice how the first hotspot defined in the HTML is in the foreground, while the next hotspots are layered from the foreground to the background.

<APPLET code="Main.class" width=320 height=280>
<PARAM name=hotSpot1 value="etc.">
<PARAM name=hotSpot2 value="etc.">
<PARAM name=hotSpot3 value="etc.">
<PARAM name=hotSpot4 value="etc.">
</APPLET>

Note: If you adjust the coordinates of the hotspots and want to see the results in your browser, press Reload or Refresh to see the changes take effect.

initialView

(this parameter is used by all the Java viewers)

Function: This parameter is the initial viewpoint within an image, object or panorama.

Syntax (for the ZOOM 2D Viewer): <PARAM NAME="initialView" VALUE=".2,.2,.4,.4">
Syntax (for the ZOOM Object Viewer and the Object Viewer): <PARAM NAME="initialview;VALUE="frameNumber, x1, y1, x2,y2">
Syntax (for the ZOOM Pano Viewer and the Pano Viewer): <PARAM NAME="initialview;VALUE="vertical_angle, horizontal_angle, zoom_angle">

where:

  • frameNumber is the an integer that represent the number of the frame of the image object you want to show.

  • vertical_angle is looking up toward the sky or down toward the ground.

  • horizontal_angle is looking at any point along the horizon.

  • zoom_angle is being close enough to look at a single point or far away enough to look at the sky and the ground at the same time.

Values: The values are floating point and represent "x1, y1, x2, y2," which are the coordinates for the initial view area. The values can be 0 to 1.0. The value (0,0) represents the upper left point of the image, and (1,1) represents the lower right point. The values of the integers can be zero, positive or negative. The angles can be between -90 and +90 for the vertical_angle. For the horizontal_angle, the angle values can be between 0 and 360 and for the zoom_angle, the angle values can be between 0 and 120 degrees. See Defining the coordinates.

Comments: The value ranges described above for vertical_angle, horizontal_angle, and zoom_angle are valid if your panorama is a full sphere. If your panorama is a cylinder, the vertical_angle and zoom_angle are limited by the size of your panorama. The iSeeMedia ZOOM Viewer automatically adjusts the parameters if you enter a value greater than what the panorama size can accept. This means that you can have a cylindrical panorama and enter a vertical angle of -90 so that the camera looks downward. The iSeeMedia ZOOM Viewer automatically adjusts the -90 value to the maximum value the panorama is capable of handling.

minZoomAngle

(this parameter is used by the iSeeMedia ZOOM Pano Viewer and the iSeeMedia Pano Viewer)

Function: This parameter lets you set the field of view angle to limit how far you can Zoom into an image. This is useful if you want to prevent users from Zooming in so much that the image pixelates. As you decrease the field of view angle, the level of Zoom capability increases.

Syntax: <PARAM NAME="minZoomAngle" VALUE="angle">

Values: The angle is a floating point between 0 and 120 degrees. Zero represents the smallest Zoomable point and 120 represents the maximum angle the user can view. A value between 5 and 10 is optimum if you are trying to avoid pixelation. If you omit this parameter entirely, the minimum Zoom angle defaults to 5.

Comments:The minZoomAngle value overrules any other Zoom angle value set in the initialView or hotspot parameters. For example, if the Zoom angle in the initialView value would cause the Zoom factor to go beyond the minZoomAngle limit, then the minZoomAngle takes precedence. Make sure that x2 > x1 and y2 > y1. If you omit this parameter, the viewer will show the full image, corresponding to (0.0, 0.0, 1.0, 1.0).

showHotspots

(this parameter is used by all the Java viewers)

Function: This parameter sets the initial state to show or hide the hotspots on the image object or panorama when the viewer starts.

Syntax: <PARAM NAME="showHotspots" value="true|false">

Values: The default value is false, which hides the hotspots until you click the Hotspot button in the toolbar or use a keyboard command. When you set the value to true, the hotspots appear when the image object or panorama opens in the viewer.


JavaScript methods

The iSeeMedia Viewer supports the following JavaScript methods:

  • Methods that cause actions to happen while the viewer is playing
  • Methods that are equivalent to the viewer parameters and are used to reset the viewer to load new content

Action methods

These JavaScript methods cause an action to happen while the viewer is playing, such as hiding hotspots or launching an HTML page.

(this method is used by all the Java viewers)

Function: This method sets the viewer to Zoom in on the center of the image, object or panorama.

(this method is used by all the Java viewers)

Function: This method sets the viewer to Zoom out on the center of the image, object or panorama.

getAppletInfo()

(this method is used by all the Java viewers)

Function: This method returns the Java applet version information as a string.

HideHotSpots()

(this method is used by all the Java viewers)

Function: This method hides the hotspots on the image, object or panorama.

MoveRelative(x,y)

(this method is used by the iSeeMedia ZOOM 2D and Object Viewers and the iSeeMedia Object Viewer)

Function: This method pans the image or object horizontally and vertically.

Values: The values are integers that represent pixels along the x (horizontal) and y (vertical) axes.

Reset()

(this method is used by all the Java viewers)

Function: This method displays the image, object or panorama according to the initial view settings.

SetView(frame,x1,y1,x2,y2)

(this method is used by the iSeeMedia ZOOM 2D (except for the frame value) and Object Viewers and the iSeeMedia Object viewer)

Function: This method lets you change the view of the Flashpix image dynamically upon user interaction. For instance, you can add an interactive button in the HTML page that redirects the image view to a specific area of interest.

Syntax: document.name_of_the_applet.SetView(frame,x1,y1,x2,y2);

Values: frame is the frame of the image, object or panorama you want to show. x1, y1, x2, y2 define the new viewer in the same way as the initialView parameter.

Comments: This method can be used with hyperlinks and buttons. Here is what the HTML looks like for these two examples:

  • Hyperlinks:
    <A HREF="javascript:{document.myImage.SetView(0.0,0.0,0.5,0.5);you can add new SetView functions here }"> Link_text </A>
  • Buttons:
    <FORM> <INPUT type=button value="ButtonName"onClick={document.myImage.SetView(0.0,0.0,0.5,0.5); you can add new SetView functions here}> </FORM>

SetView(vertical_angle, horizontal_angle, zoom_angle, transition_time)

(this method is used by the iSeeMedia ZOOM Pano Viewer and the iSeeMedia Pano Viewer)

Function: This method lets you change the view of the panorama dynamically upon user interaction. For instance, you can add an interactive button in the HTML page that redirects the view to a specific area of interest.

Syntax: document.name_of_the_panorama.SetView(vertical_angle, horizontal_angle, zoom_angle, transition_time);

Values: The values are integers that can be zero, positive, or negative.

  • Vertical_angle can be between -90 and +90 if your panorama is sphere-shaped; -90 points the camera to the ground, 0 points it straight at the horizon, and +90 points it to the sky.
  • Horizontal_angle can be between 0 and 360.
  • Zoom_angle can be between 0 and 120.
Note that if you omit the above parameters entirely, the camera position defaults to (0, 180, 50).
  • For transition_time a value of zero causes the camera to jump instantaneously to the new position; a value of 9000 (9000 milliseconds = 9 seconds) causes the camera to pan and Zoom smoothly to the new position.
  • name_of_the_panorama is the name defined in the <applet>  tag as shown in the following example:

    <applet name=myPanorama code="panoapplet archive=panoapplet.jar" width=320 height=280>

    Note that the name is case sensitive:myPanorama is not the same as MyPanorama.

ShowHotSpots()

(this method is used by all the Java viewers)

Function: This method shows the hotspots on the image, object and panorama while the viewer is playing.

ShowInfo()

(this method is used by all the Java viewers)

Function: This method shows the information page for the iSeeMedia Viewer—Java Version for images, objects and panoramas. This is the same page that is linked to the Info button in the toolbar.


Methods to reset the viewer

All of the viewer parameters have JavaScript equivalents, with a Set_ or Add_ appended to the front of the parameter name. The calls ClearParameters() and ResetApplet() let you change the contents of the viewer without reloading it in the Web page. ClearParameters() causes the viewer to clear any parameters that are currently in memory. ResetApplet()causes the viewer to use the last set of parameters it received to restart and show new content.

Note: Remember that JavaScript function names are case sensitive.

Add_hotspot(id, value)

(this method is used by all the Java viewers)

Function: See hotspot. Make sure to add an extra parameter for this method to indicate the number of the hotspot. For example: Add_hotspot (1, "2, 0.35,0.6,0.45,0.7, http://www.iSeeMedia.com , , , , ,">

(this method is used by all the Java viewers)

Function: This method lets you change the contents of the viewer without reloading the applet by clearing the parameters that are currently in the applet memory.

(this method is used by all the Java viewers)

Function: This method lets you change the contents of the viewer without having to reload the applet. When a ResetApplet call is made, the applet uses the last parameters that it was given to restart itself.

(this method is used by the iSeeMedia ZOOM Object and Pano Viewers and the iSeeMedia Object and Pano Viewer)

Function: This method controls whether or not the image object or panorama rotates automatically and at what speed. See autospin.

Set_backgroundColor(value)

(this method is used by all the Java viewers)

Function: This method defines the background color to be used by the viewer when it fills the window. See backgroundColor.

Set_backgroundImage(value)

(this method is used by all the Java viewers)

Function: This method lets you use your own customized image as a background to surround a 2D image, image object or panorama. See backGroundImage, leftMargin, topMargin, displayWidth, displayHeight, foregroundFrame.

Set_displayHeight(value)

(this method is used by all the Java viewers)

Function: This method sets the height of the 2D image, image object or the panorama relative to a background image. See backGroundImage, leftMargin, topMargin, displayWidth, displayHeight, foregroundFrame.

Set_displayWidth(value)

(this method is used by all the Java viewers)

Function: This method determines the width of the Flashpix image, image object relative to a background image or panorama. See backGroundImage, leftMargin, topMargin, displayWidth, displayHeight, foregroundFrame.

Set_enableZoomPastMax(value)

(this method is used by the iSeeMedia ZOOM 2D Image and the Object Viewer and the iSeeMedia Object Viewer)

Function: This method lets you show or hide the Maximum Zoom icon , which appears by default when you Zoom to the maximum resolution of the Flashpix image or image object. See enableZoomPastMax.

Set_file(value)

(this method is used by all the Java viewers)

Function: This method sets the IVR file for the viewer to load. See Placing the iSeeMedia Java viewer in your Web pages.

Set_foregroundFrame(value)

(this method is used by the iSeeMedia ZOOM Object and Pano Viewers and the iSeeMedia Object and Pano Viewer)

Function: This method defines where a background image is drawn. See backGroundImage, leftMargin, topMargin, displayWidth, displayHeight, foregroundFrame.

Set_initialView(value)

(this method is used by all the Java viewers)

Function: This method is the initial viewpoint within the image object or panorama, which is what you first see when the viewer displays the image object or panorama. See initialView.

Set_leftMargin(value)

(this method is used by all the Java viewers)

Function: This method determines the amount of space between the left edge of the image object or panorama and the left edge of a background image. See backGroundImage, leftMargin, topMargin, displayWidth, displayHeight, foregroundFrame.

Set_minZoomAngle(value)

(this method is used by the iSeeMedia ZOOM Pano Viewer and the iSeeMedia Pano Viewer))

Function: This method sets the minimum field of view angle. See minZoomAngle.

Set_showHotspots(value)

(this method is used by all the Java viewers)

Function: This method sets the initial state to show or hide the hotspots on the image object or panorama when the viewer starts up. See showHotspots.

Set_topMargin(value)

(this method is used by all the Java viewers)

Function: This method determines the amount of space between the top edge of the image object or panorama and the top edge of a background image. See backGroundImage, leftMargin, topMargin, displayWidth, displayHeight, foregroundFrame.


This section applies only to the iSeeMedia Pano Viewer.

Enhancing performance and resolution tips for panoramic images

The iSeeMedia Viewer—Java Version for JPEG Panoramas works best under the following conditions:

  • Size the viewer window displaying the panorama to 450 x 450 pixels or less. The panorama will not pan as smoothly if you size the window larger than these dimensions.  
  • Limit the size of the JPEG panoramic image to less than 500,000 pixels if you intend to put one panorama on your Web site. If you intend to use several panoramas or link panoramas together, each JPEG panoramic image should not exceed 300,000 pixels. Using dimensions higher than these results in different behaviors depending on the platform. On Macintosh computers, the applet might not display anything at all or might display an "Out of Memory" error message. On Windows, you might notice increasingly slower performance.
Maximum dimensions of the JPEG panoramic image: 500,000 pixels

Width in pixels

Height in pixels

1000 500
1200 417
1400 357
1600 313
1800 278
2000 250

 

Resolution tips

  • You can give Windows users a better image resolution by going up to as much as 600,000 pixels. You can include a simple set of JavaScript lines (compatible with both Netscape and Microsoft browsers in both Macintosh and Windows) in the HTML to automatically choose which image resolution to download, depending on if the visitor is using a Macintosh or Windows system. All of the examples in this document use this technique.
  • While designing a Web page that uses the Viewer, you can improve your productivity by using a low resolution version of your panorama (200,000 pixels for example). This helps your page load much more quickly as you make changes to it. When you are through designing the page and are ready to post it on your server, replace the low resolution panorama with a higher resolution version using the same filename. Because the viewer uses relative coordinates rather than absolute pixel coordinates, you will not have to make any changes to the HTML using this method.

Getting updates

The iSeeMedia Viewer - Java Version family is updated regularly. For the most current Java viewers and information, visit the iSeeMedia Web site at www.iSeeMedia.com

Legal © 2002 iSeeMedia Inc.