Tour Task Reference Guide

Tour Builder Tasks For SOSx
SOSx 1.4
Task TabTask NameNEISSOSxDescription
FlyToxxFly the camera to the location given by latitude, longitude, and altitude in miles. If 'animated' is true, the fly to takes a few seconds as the Earth appears to rotate.

If 'animated' is false, the camera moves instantaneously to the given coordinates. For example, to fly to Boulder Colorado at altitude 500 miles:
lat: 40.015, lon: -105.27, altmi: 500

Longitudes west of Greenwich are negative. For example, -105.27 for Boulder while the longitude of Beijing (east of Greenwich) is 116.41. Minimum altitude is 50 miles.
Reset Camera Zoom OutxxThis resets the camera to look straight down and zooms out so you can see the entire globe. If the world is in map view, this task is ignored.
Tilt/Rotate CameraxxTilts and rotates the camera to the given coordinates. Useful for looking at the horizon.

If animated=true, it animates the tilt/rotation. If animated=false, the world immediately rotates/tilts to the given coordinates.
Dataset AnimationxxTurns dataset animation on or off, animating any currently loaded datasets at the given frames per second (fps). Additional options allow you to animate a portion of the dataset. Defaults to AnimationType=full (which means animate all data).

If you want to limit the data that is animated, set AnimationType=absolute and set an AbsoluteStartTime and AbsoluteEndTime to animation the portion of the dataset that falls within the given time range.

If you select AnimationType=relative, you can set also set the RelativeDuration. For example, 7.00:00:00 mean the duration should be 7 days, 0 hours, 0 minutes, 0 seconds
Load DatasetxxLoads a dataset. For example:
Title: Age of the Seafloor (vegetation)
ActiveLayer: Basemap
ShowLegend: true
Legend Position X (%): 15
Legend Position Y (%): 60
Legend Width (%): 10
Legend Height (%): 35
WorldIndex: 2

The ActiveLayer will only be editable if the dataset is layered (i.e. a dropdown appears in the SOSx search panel for that dataset). The example above loads the Age of the Seafloot (Basemap), sets the legend size and location, and sets 'worldIndex' to 2nd globe.

If the default values for legend percentages (-1) are selected, SOSx/NEIS will automatically decide where to place the legend and how large it will be.
Unload All DatasetsxxUnloads any and all datasets that are currently loaded
CloudsxxIf 'on', the latest real-time clouds are displayed over the Earth.
DayNight LightingxxIf 'on', day/night lighting appears--part of the globe is lit (day) and part of the globe is in shadow (night).

If False, all the world is lit (like day).
StarsxxIf 'on', stars are visible in space around the Earth.
SunxxIf 'on', the Sun is visible in space (if the Earth is rotated to the correct position).
EarthIf 'on', the Earth is shown
Set ViewxxSets the number of visible globes or sets (flat) map view.

Value can be one of the following: map, 1globe, 2globes, 4globes
Set Globe Rotation RatexxStarts rotating the globe (or multiple globes) at the given rate. Valid rates range from 0.0 to 2.0.
World BorderxxShows or hides the world borders lines (political boundaries between nations plus the 50 states within the U.S.). You can also set the color of the borders.
Load Tour (Editable Copy)xxLoads editable copy of another tour (basically merges the other tour/subtour tasks into the current tour at the given location). It makes a copy (or subtour) of the other tour as a subdirectory in your tour directory and you can edit any of the subtour tasks.
Load Tour (Read-only)xxLoads read-only copy of another tour (basically merges the other tour/subtour tasks into the current tour at the given location). You cannot edit the subtour tasks.
Loop To BeginningxxShould be the last task added to a tour since it loops back to the start of the tour. This is useful if you want a tour to play over and over in a loop (like at a kiosk or an unattended computer at a conference booth).
Pause For InputxxThis task pauses the tour until user either clicks the play button or hits the space bar on the keyboard.
Pause SecondsxxPauses the tour for the specified number of seconds.
QuestionxxDisplays a window with a question and multiple choice buttons. Create the jpg or png images yourself using a image editor. The imgQuestionFilename (the image with the questions) and imgAnswerFilename (the image with the answers) should be identical in size (e.g. 1600x900 pixels).

The correct answer (given by the zero-based correctAnswerIndex), with further elaboration, is displayed after the user makes his guess. Note that X Position (%) and Y Position (%) are calculated from the center of the image. So, for example, if both values are both 50%, then the center of the image will be in the middle of the screen.

For example:
ImgQuestionFilename: question1.png
ImgAnswerFilename: answer1.png
NumberOfAnswers: 5
CorrectAnswerIndex: 2
Width (%): 60
Height (%): 50

The question1.png image might have a background image of a star field with the following text within the image:

Which of the following is the largest volcano in the solar system?
A) Mauna Loa
B) Mount Everest
C) Olympus Mons
D) Volcanus Rex
E) Olympus Maximus

The corresponding answer1.png might have the same star field background image, plus an image of Olympus Mons in the foreground, along with the following text:

Olympus Mons on Mars is the largest known volcano in the solar system and rises 16 miles (25 km) above the surrounding plain. It is much larger than Mauna Loa which rises 6.3 miles (10 km) above the sea floor in Hawaii.

The correct answer for this question is "C) Olympus Mons" which is CorrectAnswerIndex=2 (0=A, 1=B, 2=C, 3=D, 4=E)
Play AudioxxPlays an audio clip. If asynchronous is 'false', then task waits until it finishes before advancing to the next task. If 'true', the audio begins playing and the next task begins immediately. The file needs to be in the same directory as the tour json (e.g. /local-datasets/MyTour).

For example:
Filename: ocean-sound.wav
Asynchronous: true
Stop AudioStops any currently playing audio
Play VideoxxMust be in the ogv, avi, mp4, or wmv video format. The file needs to be in the same directory as the tour json (e.g. /local-datasets/myTour). Note: when you select a Filename by clicking on that field, the file browser will automatically copy whatever video you select into your tour directory).

Specify the location of the popup video window with X Position (%) and Y Position (%) where X/Y ranges from 0 to 100 with an X Position (%) of 20 indicating that the x position of the center of the window should be 20% from the left side of the window, and Y Position (%) = 50 indicates the middle of the window in the Y coordinate).

Size (%) determines how large the video is (range from 0 to 100%)
If ShowControls=True, then video controls (e.g. stop/play/pause) appear on the screen.
You can also set the volume of your video (default is 100%)
Hide VideoxxHides the video (if it is playing).
Show ImagexxPops up an image at the given screen location. For example, to display an image in the center of the window, that is resizable and closable, and that takes up 40% of the width of the screen and 30% of the height of the screen:

filename: sample-image.png
X Position (%): 50
Y Position (%): 50
Width (%): 40
Height (%): 30
IsAspectRatioLocked: true
IsDraggable: true
IsResizable: true
IsClosable: true
Caption: My Image
CaptionPos: bottom
CaptionBestFit: true
FontSize: 20
FontColor: white

If IsAspectRatioLocked=true, then any change to the Width (%) will automatically adjust the Height (%), and vice-versa, to maintain the original aspect ratio of the image.
You can set a caption (text that appears next to the image) with options for position, CaptionBestFit (automatic sizing), or FontSize/Color.
Hide ImagexxHides the image (if it is visible).
Show Popup HTMLxxDisplays a popup HTML window with either the supplied url or with the supplied html text. For example, to open a simple inline web page on the left side of the screen:
Html: <html>My simple web page</html>
X Position (%): 20
Y Position (%): 50
Width (%): 50
Height (%): 50

Either Url or Html must be supplied (but not both).

To popup a NOAA web page in the middle of the screen, for example:
X Position (%): 50
Y Position (%): 50
Width (%): 50
Height (%): 50
Hide Popup HTMLxxHides the popup html window (if one is visible).
ResourcesAdd 360 MediaThis adds a 360 degree media (sort of like a bubble the user can fly into to look around) to your tour.
You specify the location on Earth for your bubble via Latitude/Longitude/Alt. You can optionally specify an initial direction in which to look after entering the bubble.
The 360 Media field is where you specify either the 360 degree image (png, jpg, or dds), or you can specify a 360 degree video (mp4, wmv, or ogv format)
If AutoFlyTo=true, when this tour task is reached during play, the tour will automatically fly into the 360 content (bubble).
Hide360MediaHides the bubble with the ID given by "HideBubble"
Add PlacemarkxxAdds a placemark icon (similar to Google Maps placemark) at the given latitude, longitude and with the given attributes. For example
Latitude: 40.015
Longitude: -105.27
IconFilename: placemark-icon.png
Name: Boulder, CO
Scale : 1

The placemark iconFilename is required. Longitudes west of Greenwich are negative. For example, -105.27 for Boulder while the longitude of Beijing (east of Greenwich) is 116.41. If you want the placemark to be larger on the screen, increase the Scale above the default value of 1.
Hide PlacemarkxxHides a placemark with the given ID. For example:
Add Ground OverlayAdds a ground overlay image (similar to KML) that is wrapped over part of the Earth within the given Lat-Lon bounding box. For example, you might add a ground overlay image over part of the Pacific ocean to indicate that it is a whale breeding ground. Images can be JPG or PNG.
Hide Ground OverlayHides the ground overlay with the given groundOverayID. For example HideGroundOverlay: groundOverlay1
Show Info ButtonxxDisplays a button on the center right side of display one with links to related content. For example:
infoBtnID: infoBtn3
type: webpage
icon: myicon.jpg
caption: SOS Homepage

infoBtnID should be a unique value within a tour. Type can be video, graph, webpage, image, game, quiz. Content is either a URL or a filename of a file within the same directory as the tour. The icon attribute is optional, but if present will show a custom image inside the button. Caption is the text below the button and should be kept short.
Hide Info ButtonxxHides a button on the center right side of display that was previously created with showInfoBtn.

The ID should match the one previously created. For example:
hideInfoBtn: infoBtn3
Hide All Info ButtonsxxHides all buttons on the center right side of display that were previously created with showInfoBtn.
Text BoxxxDraws a box, with optional caption text, on the screen. For example, to draw a box that is 25% of the total screen size, centered in the middle, with a caption that is displayed to the right of the box:
Text Box ID: textbox1
X Position (%): 50
Y Position (%): 50
Width (%): 25
Height (%): 25
Caption: My Text Box
CaptionPos: center
CaptionBestFit: False
FontColor: white
ShowBorder: False

If CaptionBestFit is True, then the FontSize is ignored and the text fills the entire text box.If ShowBorder=True, then rectangle is drawn around the text.
Hide Text BoxxxHides the Text Box with the provided textboxID. For example:

HideTextBox: textbox1

This hides a text box that was previously created with TextBoxID=textbox1
Show Search WindowxxIf visible=true, the Search Window is displayed.
Show Overlay WindowxxIf visible=true, the Overlay Window is displayed.
Show Measure WindowxxIf visible=true, the Measure/Distance Tool Window is displayed.
Show Touch Help WindowIf visible=true, the help window (about using touch on the screen) is displayed.
Show Probe WindowxxIf visible=true, the Probe Window is displayed.
Show Transect WindowxxIf visible=true, the Transect Window is displayed.
Show Tools WindowIf visible=true, the Tools Window is displayed.
Enable Tour PlayerxxTurns the tour player on or off. Note that if a tour makes the tour player window hidden and subsequently calls pauseForInput, the user won't see the Play (continue) button and may get stuck.