Internet

This documentation explains how to build for Web target (embedded in a browser) with the ShiVa Authoring Tool.

This publishing allows to create a webpage with the 3d included using the ShiVa3D web plugin.

Prerequisites

The web plugin allows to display a stk file generated with ShiVa Editor on a webpage, the stk file can be online, on a server, or offline on your hard drive.

A progress bar will be displayed first while the stk file is being loaded, if the progress bar behaviour is bad, please check on your server if the headers are sent, the important one is the 'content-lenght' header. You can use Http Live Header under Firefox to check that.

Step1 : Content

Location
The path to the stk file, starting with 'http://' for online file, and 'file://' for local file. We recommend to enter the absolute path to the file.

Width & Height
The width and height of the 3d frame. Can be in pixels (for instance "640", without the "px" suffix) or a percentage (for instance "50%").
Do not forget to use css on div used by the system if you intended to use percentage : http://codesnippets.joyent.com/posts/show/938

Use a light-box system
Use a light-box system ( SqueezeBox ) to display the 3d in an overlay box.
Caution: to use this mode, witdh and height must be in pixels (percent is not supported).

Please link to your website if you want a full control of the display, the php file on player.stonetrip.com is here only to prototype the behaviour.

Step2 : Authoring

Rendering

Shadows
If checked, application uses dynamic shadows.

Reflection
If checked, application uses reflection/refraction.

Post render effects
If checked application uses PRE like Bloom, depth-of-field, saturation, monochrome, etc.

Antialias level
Reduces the square effect on 3d models sides. 4X provides the better rendering but the lower performances.
2X means that the render buffer is twice the application's resolution.

System

Force fail safe
Windows only. Forces application to use the DirectX Engine, to ensure stability.
Note that you may loose advanced rendering techniques such as normal map, bloom, etc.

Allow full screen
If checked, user can switch to full-screen using the right click menu.

Allow right click
If checked, user can use the right click menu to switch to full-screen, disable sound, access engine properties,etc.

Use beta engine
If checked, application uses the latest engine version available. For testing mode only, do not use in production.

Smart cache
If 'true', allows multiple sockets for data streaming (cf api ). If 'false', the cacheManager will not check for files updates on the server.

Environment

Alternative loader
URL of loader that replaces the default Stonetrip loader. The file must be a lightweight stk, the 3d view will stay black until the file is downloaded.

Please check the following tutorial : how to create a custom loader

Need a server
URL to the authentication server, please check the environment concept for more information.

Custom plugin
URL to another engine version.
Engines are located at http://www.stonetrip.com/players/1.8.1/engine/ since the version 2.1.7.0.
For instance: http://www.stonetrip.com/players/1.8.1/engine/2.1.7.0

Redirect on quit
URL where to redirect user when aplication invokes application.quit() function.

Redirect on error
URL where to redirect user when an error is raised while your application invokes log.error() function.

Startup environment variables

Specify startup environment variable (for instance to use in a custom loader). Please check the environment concept for more information.

Plugin Installation

Background color
Used for the installation, engine update and data loading. Use the html color code.

Exemple with color=000000:

Exemple with color=ffffff:

Custom Installation pictures

Picture Folder URL
The folder URL where the custom pictures are located.
The folder on the server should look like that :

Download the samples and psd files from the original loader

Format
The image extension: jpg, png or gif.

Language
If you change the language, you must create pictures in that language plus the pictures in English.

Alternative content
You can also specify an Alternative content if you prefer to have instruction is flash for instance.

Console

When building the target, the console display the html code.
Note that you can edit this code in the console directly then click on Save Generated Html, so save the code in a file.

Stkobject.js documentation

A complete documentation about the js itself is available here : http://www.stonetrip.com/developer/doc/authoringtool/stkobject