View source

<div style="float:right">__TOC__</div>

= Prerequisites =
== Flash® configuration ==

Autopano Tour enables you to create virtual tours in Flash® format. Therefore, your computer needs the Flash viewer to be able to display the generated virtual tours. Most of the time, it is already installed on your computer. If not, or if you would like to install the latest version, you can get it on this page: '''[http://get.adobe.com/flashplayer/ Download Flash® Player]'''.

Virtual tours need at least version 9 of Flash® viewer, but we recommand that you use version 10. 3D management has been largely enhanced between version 9 and version 10 ; distortion effects may appear if you use version 9 of the Flash® viewer.

The Flash® files are meant to be used mainly on the Internet and they may be blocked if used locally (i.e. if you want to load them from your computer, not from the Internet). You need to configure 'Trusted Folders' to make the Flash files run locally. The configuration of the 'Trusted Folders' should be made via '''[http://www.macromedia.com/support/documentation/en/flashplayer/help/settings_manager04.html this web interface]'''.

== Technical jargon ==

* '''Flash'''®: A technology of Adobe® enabling to create and display animated content such as virtual tours.
* '''.SWF''': The extension of Flash® files. Virtual tours generated in Autopano Tour are named this way: my-virtual-tour'''.swf'''
* '''Hotspot''': A zone or a point in the virtual tour that enables interaction: moving to another view of the tour, opening a webpage, displaying an image, etc. Hotspots are a very important when creating complete virtual tours, as they let you link the different views of the tour together.
* '''.XML''': The extension of the configuration files that define the options chosen for the virtual tour.

= User Interface =

== Overview ==

[[Image:apt-en-global-interface.png|center]]

Program concepts :
* The central window enables to quickly visualize the entire project and to select editable objects. '''(A)'''
* Top tabs on the right side enable to manually modify selected objects of the main window. '''(B)'''
* Bottom windows enable to graphically edit the current panorama (hotspots '''(C)''', 3D navigation '''(D)''').

=== Toolbar ===

{| style="background-color:#cccccc;" cellpadding="5" cellspacing="1" border="0"
|- style="background-color:#f5f5f5;"
| [[Image:Pano_open.png‎]]
| Open a project file
|- style="background-color:#f5f5f5;"
| [[Image:Pano_save.png‎]]
| Save the current project
|- style="background-color:#f5f5f5;"
| [[Image:banner_close.png‎]]
| Close the current project
|- style="background-color:#f5f5f5;"
| [[Image:Group_addpicture.png‎]]
| Add pictures to the virtual tour
|- style="background-color:#f5f5f5;"
| [[Image:Render.png‎]]
| Export the project in Adobe® Flash® format
|- style="background-color:#f5f5f5;"
| [[Image:whatsthis.png‎]]
| Get quick help on the toolbar icons
|}

== Central window ==

The central window lets you select the different elements of your virtual tour (panoramas or hotspots) to edit them.

[[Image:apt-en-central-window.png|center]]

=== Selection ===

* A single click selects a panorama or a hotspot (white circles for point hotspots, white triangles for zonal hotspots).
* Holding down the '''Ctrl''' key lets you select several items.
* The '''Ctrl+A''' shortcut selects all panoramas and all hotspots.

Each selected element has a black frame. Hotspots are also filled in white to increase the visual contrast.

=== Navigation ===

* The scroll of the mouse enables to modify the size of the items displayed.
* When the scene is not entirely visible, scroll bars are displayed. You can also use the mouse or the arrow keys to move in the visibility zone.
* The name of the panorama appears when hovering over it with the mouse.

=== Edition ===

* Moving panoramas is simple: just drag and drop them.
* Dragging a hotspot on a panorama created a link to the panorama. An arrow symbolizes this link. This arrow is shown only when the panorama is selected.
* To delete a panorama, you can right-click on it or press the '''Suppr''' key.
<u>Attention</u> : the deletion of hotspots can only be done in the hotspot edition window (C), not in the central window.



== Hotspots editor window ==

Dark area shows the area where it’s impossible to draw a hotspot. It prevents you from drawing a polygon with more than 180 degrees FOV.

{| style="background-color:#cccccc;" cellpadding="5" cellspacing="1" border="0"
|- style="background-color:#f5f5f5;"
| [[Image:move_pan.png‎]]
| Move mode: mouse movements while left button is pressed enable to displace editable area. The double click displays the window in full screen.
When the escape touch is down, the move mode is automatically activated.
|- style="background-color:#f5f5f5;"
| [[Image:move_full.png‎]]
| Full screen mode: displays the window in full screen.
* if the window is floating, screen used will be the one where the window is.
* if the window is docked, screen used will be a different one (if exist).
|- style="background-color:#f5f5f5;"
| [[Image:hotspot_polygonal.png‎]]
| Polygonal hotspot: each click adds a point to the current polygon. When the last point is near the first point, the polygon is automatically closed and added to the panorama.
Drawn lines between control points are curved to match the projection of the panorama so that they display correctly when viewing the panorama.
|- style="background-color:#f5f5f5;"
| [[Image:hotspot_image.png‎]]
| Point hotspot: each click adds a point hotspot at the mouse position.
|- style="background-color:#f5f5f5;"
| [[Image:lensflare.png‎]]
| Lens flare mode: each click adds a lens flare effect at the mouse position.
|- style="background-color:#f5f5f5;"
| [[Image:back.png‎]]
| Previous: select the previous panorama
|- style="background-color:#f5f5f5;"
| [[Image:forward.png‎]]
| Next : select the next panorama
|}

Depending on the current mode (polygonal hotspot, point hotspot, lens flare), the editable objects appear in yellow and the non-editable objects appear in white.
When an object is editable, you can:
* Adjust the position of a point hotspot by dragging and dropping it. 
* Drag the intersections of a polygonal hotpoint. To be able to modify a polygon, it needs to be entirely within the editing zone.
* Delete it with the contextual menu (right-click)

You can zoom in the window with the scroll wheel of the mouse even while drawing a hotspot.

== 3D Editor Window ==

{| style="background-color:#cccccc;" cellpadding="5" cellspacing="1" border="0"
|- style="background-color:#f5f5f5;"
| [[Image:move_full.png‎]]
| Full screen mode: displays the window in full screen.
* if the window is floating, screen used will be the one where the window is.
* if the window is docked, screen used will be a different one (if exist).
|- style="background-color:#f5f5f5;"
| [[Image:back.png‎]]
| Previous: select the previous panorama
|- style="background-color:#f5f5f5;"
| [[Image:forward.png‎]]
| Next : select the next panorama
|}

The left button of the mouse and the scroll wheel let you move in the 3D projection of the panorama.

=== Default view of the panorama ===

* Select a panorama in the central window
* Use the mouse to define the default position you want
* Use the contextual menu (right-click) to define the navigation properties of the panorama's final rendering

=== Destination view of a hotspot ===
* Select a hotspot linked to a panorama in the central window
* Use the mouse to define the position you want
* Use the contextual menu (right-click) to define the destination view

This tool lets you define a transition: the view will automatically move from the destination view of the hotspot to the default view of the panorama, when entering in this panorama via this hotspot.

[[Image:apt-en-3D.png|center]]

= Properties =

The options of the properties tabs impact all selected elements of the central window. Some options are directly modifiable via the graphical tools presented just above.

If no element is selected, the options are inactive. When several elements are selected and if their properties differ, the options are displayed in grey but are still editable.

[[Image:apt-en-properties.png|center]]

== Project ==

[[Image:apt-en-project-properties.png|center]]

* '''Display''' :
** '''First Displayed Panorama''': select the panorama to be displayed first in the virtual tour.
** '''Insert navigation menu''' : adds a bar of navigation buttons to the virtual tour.
** '''Add fullscreen button''' : adds a fullscreen button to the navigation bar that enables the user to toggle between initial view and fullscreen view. To enable this functionality you also need to choose a fullscreen HTML template.
** '''Use auto-rotation''' : when selected this enables auto-rotation of the panorama. This can be overidden by the user but when enabled the pano view will return to the original horizon after a short period without user interaction.
** '''Insert panoramas list''' : adds a list box pointing directly to each view of the tour. Only avaible to users with a krpano license.
** '''Logo''':
*** '''File''': enter, or browse to, the name of logo file to insert - PNG, JPEG, GIF, SWF formats are supported.
*** '''Position''': choose where you wish to position the logo.
*** '''Link''': enter the URL of a web page to be opened in a new Tab/Window if the logo is clicked.
* '''Export'''
** '''Embed all data''': when selected, all images are embedded in the exported flash SWF file, otherwise they are placed in a sub directory and loaded dynamically.
<u>Attention</u> : if all data is embedded, the .SWF file generated may be very large and take a long time to download before the panorama is displayed when published to the Internet. If the data is not embedded, don't forget to upload the data subfolder. 
** '''Embed XML files''': makes accessible the XML files generated to create the virtual tour to modify them manually. Only available to users with  krpano license.
** '''HTML Template''': pointed html file will be used to generate a web page including the generated virtual tour. Template files are in the sub directory « Templates/html/ » presents in the installation directory. $(SWF) keyword presents in the template will be replaced by the generated flash file.

== Panorama ==

[[Image:apt-en-pano-properties.png|center]]

* '''Name''': name used in the list box, if displayed.
* '''Field of view''': field of view covered by the panorama. If the panorama was generated with Autopano Giga in a format that includes Exif data (TIFF or JPEG), then the correct data will be entered automatically. Post-procesinmg of stitched panos will typically remove the required EXIF data.
** '''Horizontal''': horizontal angle in degrees.
** '''Vertical''':  vertical angle in degrees.
** '''Vertical offset''': vertical position of panorama horizon in degrees.
* '''Pictures parameters''': define the quality of the output image.
** '''Preview Size''': picture size of the preview displayed while loading the panorama. 
** '''JPEG Quality''': JPEG compression quality (from 0 to 12).
** '''Size''' depending on the type of selected panorama, this property may represent two different concepts: 
*** '''Cube Face Size''' : size of used picture in the construction of 3D cubical panorama when full 360 panorama is selected.
*** '''Partial Panorama Width''' : width of used picture in the construction of 3D spherical panorama when partial panorama is selected (height is automatically computed by respecting picture aspect ratio).
*** '''Compute Optimal Size''' : compute the best fitting size according to input panorama size. Maximum allowed size is however limited :
**** '''Cube Face Size''' : 1024 without krpano license, 5000 with.
**** '''Partial Panorama Width''' : 3072 without krpano license, width allowing 200 000 000 pixels with.
*** '''Multi resolution''' : with a krpano license, when a picture (cube face or partial panorama) exceed 1024 on one of there dimensions, a multi resolution pyramid is automatically computed to allow progressive downloading.
** '''Nadir Patch''': picture to be inserted on nadir cube face, transparency will be respected in formats that support transparency.
** '''Scale''': size of the nadir patch, proportionally to bottom cube face size.
* '''Camera Parameters''': most easily set using the cointext menu in the 3D View/Editor.
** '''Yaw''': horizontal position of the initial view in degrees.
** '''Pitch''': vertical position of the initial view in degrees.
** '''Fov''':  field of view of the initial view in degrees
** '''Min''': minimal field of view when navigating the panorama - that is max. level of zoom-in.
** '''Max''': maximal field of view when navigating the panorama - that is max. level of zoom-out.

== Hotspot ==

[[Image:apt-en-spot-properties.png|center]]

* '''Link''':
** '''Panorama''': the selected panorama will be loaded in the same Tab/Window when the hotspot is clicked.
*** '''Transition'''
**** '''Zoom in hotspot''' : camera zooms in hotspot center before to load the new panorama.
**** '''Yaw, Picth, Fov''' : entering view in the new panorama before to displace the camera to the default view.
** '''URL''': the URL will be loaded in a new Tab/Window when the hotspot is clicked.
** '''HTML''': the URL of an HTML-text file which will be displayed is a window superimposed on the panorama when the hotspot is clicked. The HTML-text file must written in HTML format with very minimalist code as described here : 
http://livedocs.adobe.com/flash/9.0/ActionScriptLangRefV3/flash/text/TextField.html#htmlText
** '''Object''': the graphical object (PNG, JPG, GIF, SWF) which will be displayed when the hotspot is clicked.
*** '''Position''' : object or simplified HTML position
*** '''width, height''' : displaying size in pixel of the object or the simplified HTML. If nothing is setted, default size will be the object size de l'objet or the half of the visit size for simplified HTML.
* '''Display''':
** '''Colour''': the colour used to display the polygonal hotspot, you can also adjust the transparency.
** '''Object''': the graphical object (PNG, JPG, GIF, SWF) which will be displayed at point hotspot position.
** '''Tooltip''': the text which will be displayed when mouse hovers over the hotspot.

[[fr:Autopano Tour]]