Table of Contents - Object2VR 4 Documentation

A map to all help pages for Pano2VR.

What's New?
Here you'll find an ongoing list of new features, fixes, and changes added to each release.
User Guide
Welcome to our User Guides where you'll find step-by-step instructions.
1. Getting Started
  The documents in this section outline the basic workflows, installation, and project set-ups.
  1. Installation
    Installing requires downloading the software from ggnome.com and installing the program on to your desktop computer.
2. Importing Images
  Import images by dragging them in, using an image sequence pattern, or capturing the images directly to Object2VR.
  1. Import Using the Light Table
    Use the Light Table to bring images in the project.
  2. Capture Input
    Capture images directly from the camera to Object2VR Studio.
  3. Import Using an Image Sequence
    Importing your images as an image sequence is most convenient for projects with a large number of images.
  4. Image Sequence Pattern
    The image sequence pattern is a way to describe your file naming convention to Object2VR in order for it to recognize your images as a sequence pattern.
3. Image Processing
  The Image Processing Tools are found in Object2VR Pro and Studio and help to quickly clean up and mask images after capturing them.
4. Convert Images
  Use the Convert option to quickly create a new project using your newly processed images.
5. Working with Hotspots
  Hotspots are points or areas of interaction within the project. They can open other images, open websites, and pop up information boxes, images, and videos.
  1. Adding Point Hotspots
    Point Hotspots are points of interactivity within the project. Learn how to add them to your project.
  2. Add a Polygon Hotspot
    Polygon hotspots require you to draw a shape as opposed to creating a single point of interactivity.
  3. Create Tooltips
    Tooltips are the bit of text that appears when a mouse enters an element or area that uses them. They are widely used for node type hotspots and show the title of the next node or as information pop-up texts. They can also be used to simply show information.
  4. Animated Hotspots
    Learn how to create an animated point hotspot in the Skin Editor using a skin variable with a Timer.
  5. Custom Hotspot Images
    Each hotspot can have its own image. The custom hotspot image can be added in the skin to affect all hotspots using hotspot templates. Or you can add a custom image to individual hotspots.
6. Creating Popups
  Learn how to create video and image pop-ups and more with hotspots and viewer elements.
  1. Built-in Popups
    The simplest way to add popups to your project is to use the built-in skins or the the built-in components. Both require using Point Hotspots.
  2. Polygon Hotspot Activated Popups
    Popups can be activated by Polygon Hotspots by using the Hotspot Proxy ID in the Skin Editor.
  3. Create a Website Popup
    Learn how to create a popup up window using the URL type Point Hotspot and a Text Element in the skin.
7. Create a Multilingual Project
  Learn how to create multilingual projects with the translation tools. in multiple languages.
  1. Translating Skins
    Learn how to translate the skin in the Skin Editor.
8. Creating Skins
  Use the Skin Editor to create and design interactive overlays for your virtual tours.
  1. Using the Color Tool
    The Color Tool, found in the Skin Editor, lets you quickly change the colors of a skin or a selection of elements.
  2. Creating and Using Components
    Components are a group of skin elements that are saved as a single element in the Components Toolbox and can be reused.
  3. Scale an Element Based on Player Width
    You can use logic blocks to create a responsive skin (where the skin elements scale to the player's width). This will require a logic block with multiple expressions.
  4. Hide Elements When Player is Active
    Learn to use a logic block to hide elements when the player is active. You use a timer that has a logic block by default.
  5. Video Element Tips
    Learn how to hide videos when they are not playing, how to fade videos in and out, and how to fill a video's container when there is an aspect ratio mismatch.
  6. Using Action Filters
    Action filters let you define conditions for the execution of actions assigned to an element.
  7. Introduction to Using Variables
    Variables are powerful tools that help simplify automation within a skin.
  8. Search in the Skin Editor
    Use the Search tool in the Skin Editor to find elements and variables.
  9. Mapping Keys to the Skin
    You can map keyboard keys to actions in the Skin Editor. This allows a user to use either the mouse or the keyboard to control and interact with the panorama or tour.
  10. Using Regular Expressions
    Regular expressions let you address multiple elements within the Skin Editor with just one action. This will save time when setting up thumbnails or any other multiple element project.
  11. Collection of Components Tutorials
    Use the Skin Editor to create and design interactive overlays.
  12. Styling with CSS
    CSS or Cascading Style Sheets are what the web uses to style a web page. It is a rule-based language that specifies how elements should look or be presented in a web browser.
    1. Adding Google Fonts
      Learn how to add Google Fonts to your project.
    2. Embedding Fonts
      Fonts can be embedded in Pano2VR’s skin. This means that the fonts are served locally, rather than fetching them from third-party servers like Google Fonts.
    3. Create Animated Hotspot Icons
      Learn how to create animated icons for point hotspots. This particular animated icon will consist of to rotating bars hinged at the center.
    4. Create Buttons Using Text Boxes
      Learn how to use a couple of text boxes to create a 2-state button.
    5. Create a Popup Image with Scrolling Text
      Learn how to create a custom image popup with a text box that expands to fit the amount of text.
9. Exporting
  Once you're finished working on your project you can output it for a website, as a flat video, as a different projection, or for social media.
  1. Web Output
    The web output exports all the files needed to add a project to a website for playback in any modern web browser.
    1. Garden Gnome Package
      The Garden Gnome Package (GGPKG) is a package format for offline viewing and for content management systems to easily embed your projects into websites.
      1. Using CMS Plugins
        The Garden Gnome Package (GGPKG) is a package that can be used for content management systems and lets you easily embed your projects into your website.
      2. WordPress Plugin
        We provide a package format (GGPKG) to make it easy for you to embed your panoramas on your CMS site or blog. Below are the instructions for WordPress.
      3. Using the Package Viewer for Desktop
        The Garden Gnome Package Viewer is a native desktop application that opens Pano2VR and Object2VR packages (GGPKG) for viewing content offline.
      4. Joomla Plugin
        We provide a package format to make it easy for you to embed your panoramas on your CMS site or blog. Below are the instructions for Joomla.
      5. Using the Package Viewer for iOS and Android
        The Package Viewer is a mobile app that lets you showcase your virtual tours and object movies without the need for an internet connection; making it ideal for showcasing to clients or at exhibitions.
      6. Drupal Plugin
        We provide a package format to make it easy for you to embed your panoramas on your CMS site or blog. Below are the instructions for Drupal.
    2. Upload to Gnome Cloud
      Gnome Cloud is a service we provide that you can use to host your projects. Upload a project to the cloud from the Web Output.
  2. Integrated Web Server
    A local web server is built in to the software. It simulates an active web server so you can view your project locally (browsers restrict local viewing for security reasons).
    1. Using the Integrated Web Server
      The integrated web server's default settings are set to be used when viewing the output within an HTML page. It was included to allow local viewing of the web output (something most browsers do not allow for security reasons).
10. Practical Tips
  Practical tips, tricks, and how-tos for specific projects.
  1. Adding Custom Text Fields
    Learn how to add more parameters or text fields to User Data and Hotspots.
The Workspace
These pages detail the entire workspace and settings.
1. Menu Bar
  In the menu bar, you'll find more tools and shortcuts. The menu bar also changes for the Skin Editor.
2. Toolbar
  Use the Toolbar at the top of the main project window to show or hide panels.
3. Properties
  The Properties panel is where individual settings are found for various features within the program.
  1. Project Properties
    The Project Properties contain settings for the entire project.
  2. User Data
    Use the User Data panel to add information about an node or image.
  3. Viewing Parameters
    The viewing parameters section lets you choose which image will be the first to be viewed and how the object movie will be controlled.
4. The Viewer
  The center of Object2VR features the Viewer. This is where you add hotspots to the object. It also where you'll used some of the image processing tools, like crop and transformation.
5. Viewer Modes
  Viewer Modes are used to pin elements to the panorama in the Viewer.
  1. Image Processing Tools
    Use the Image Processing Tools to make quick image adjustments. Avaliable in Object2VR Pro and Studio.
  2. Point Hotspot Properties
    Point Hotspots are interactive points that open websites, PDFs, videos, informational texts, and more. This article covers all the properties of a point hotspots.
  3. Polygon Hotspot Properties
    Here you'll find the properties for the polygon hotspots which are found in the Properties panel once a hotspot is added or selected.
6. Output Panel
  The Output panel is where you choose output formats for your project. There is also a button to open the Gnome Cloud Browser.
  1. Web Output Properties
    The Web Output Properties open in the Properties panel. This is where set player-based parameters like the context menu, HTML file, and hotspot settings.
  2. HTML Templates
    The Web Output exports an HTML file to playback the project in a browser. This is a template that can be edited to your project's needs.
    1. Normal Template
      The normal HTML template is the default template that is used when exporting a web output. Use the template parameters to quickly configure it.
    2. Garden Gnome Package Template
      Edit this Garden Gnome Package HTML template to create a custom GGPKG output or select for Droplet use.
7. Capture Panel
  Use the Capture panel to control both the camera and turntable.
  1. Capture Properties
    Open the Capture Panel to access the capture properties.
8. History Panel
  The History panel shows you a list of all the actions you've done. And you can go back in history by clicking up the list (similar to Photoshop).
9. Hotspot List
  Hotspots in Object2VR are created in the Hotspot List.
10. Overview
  The Overview panel provides an overview of the entire project.
11. The Light Table
  The Light Table is used to import and organize the images that make up the object VR. It organizes the images into columns, rows and view states making it easy to rearrange or delete images within a series.
12. Skin Editor
  A skin, as a whole, is a graphical element (interface) that is layered over the panorama and can include images, maps, buttons, text, and sounds.
  1. Skin Editor Tree
    The Tree supports a parent-child layering organization. An element treated as a parent will have a child or children that is/are "connected" to it, making it easier to group the elements and move them together in the canvas. The layering of the elements is like Photoshop; the top-most element is the front-most layer.
  2. Skin Editor Canvas
    The Canvas is where all the elements (images, buttons, etc.) are placed and arranged. Consider it your workspace for designing your skin.
  3. Skin Editor Properties
    The Properties section is where the settings for skins elements are located. It also holds the settings for the Canvas and the skin itself. All the properties are grouped in collapsable panels.
  4. Skin Editor Toolbar
    The toolbar is found at the top of the skin editor window and holds all the tools needed for adding elements in the editor, zooming in to the canvas and accessing additional tools.
  5. Skin Editor Menu Bar
    The menu bar is found at the top of the program's window in Windows and Linux or at the top of the screen in Mac OS. This is the menu bar for the Skin Editor only.
  6. The Color Tool
    The Color Tool, found in the Skin Editor, lets you quickly change the colors of a skin or a selection of elements.
  7. Components Toolbox
    The Components Toolbox holds a collection of predefined skin elements including icons and Lottie animations.
  8. Skin Elements
    A skin element is any object added to the skin.
    1. Container
      A container is an invisible element that allows you to group elements together in the tree or canvas.
    2. Rectangle
      The rectangle element can be drawn to any size. Use it as a button or as a screen tint. Or even as a fix to create active areas in 3D distorted hotspot images.
    3. Text Box
      Text Box are for adding text to the skin. You can use basic HTML tags to format the text, or use CSS.
    4. Image
      The image element is used to add images to the skin. Once you click on the Canvas, you'll be instructed to selected an image.
    5. Button Element
      The button element provides multiple states of a button. Each state can have a different image which provides visual indications of interaction.
    6. SVG
      Click the *Add Scalable Vector Graphics* button in the Toolbar and then click in the Editor to choose a SVG file. Or, just drag the SVG in to the editor.
    7. Lottie Animation
      Lottie files are small animations designed to work on all devices. Use them for buttons and hotspots.
    8. PDF
      Use the PDF element to embed PDF documents in the skin.
    9. External Image
      Use the external image to add images that need to be loaded externally rather than embedded in to the skin. This is especially useful if you have a lot of thumbnails in a tour and are not using the Node Image element.
    10. Scroll Area
      A scroll area is a container that will add scrollbars around an element or group of elements, if necessary. It can also be used to clip content.
    11. Cloner Element
      The cloner is a useful tool that creates lists for building menus. The cloner is used to create thumbnails of nodes within a tour, creating a thumbnail menu. The cloner is also used to create a multi-level menu, a multilingual menu, a menu of all hotspots, or a menu of all floor plans.
    12. Timer Element
      The timer is a container that is useful for timing actions in the skin. For example, you can use a timer to hide a Welcome Screen (or splash screen) after 5 seconds.
    13. Hotspot Template
      A hotspot template lets you add a custom image to a point hotspot.
    14. Video Element
      Use this to add videos to your skin. You can use local files, URLs or YouTube and Vimeo IDs.
    15. Seekbar
      Seekbars can be used to seek or move backwards and forwards in time for background sounds, all pinned sounds and videos of the project, as well as skin sounds and skin videos, and even 360° video panoramas (except embedded YouTube and Vimeo videos).
    16. Code Element
      The code element is used to apply Javascript to the skin.
  9. Skin Actions and Modifiers
    Actions are like a set of directions that are applied to any element added to the skin to create interactivity.
    1. Skin Sources
      In the actions section of the Actions/Modifiers tab in the Skin Editor, you'll find a column called Sources with a pop-up menu. These sources represent the triggers that cause the actions.
    2. Skin Actions
      Actions or a set of directions can be applied to any element added to the skin to create interactivity.
    3. Skin Modifiers
      Use modifiers to affect a skin element's behavior. Open the Modifiers panel and double-click in the table or click the plus sign to the right to open the Modifier Settings.
    4. Skin Actions Examples
      Here you'll find a few examples of common actions. You can assign actions to any element in the skin editor.
  10. Logic Blocks and Action Filters
    Logic blocks are a way of automatically altering values of skin elements, making it possible to react to certain circumstances using logic. Action Filters are applied to actions and define conditions for the execution of actions assigned to an element.
    1. Logic Block Triggers
      Triggers are start of events for a condition of a logic block.
13. Gnome Cloud Browser
  The Gnome Cloud is a service we provide that you can use to host your projects. Use the Browser to view projects and data associated with them.
14. Layout Customization
  Pano2VR has a modular interface which allows for custom layouts.
15. Object2VR Settings
  Customize Object2VR's settings by changing the language, the theme, folder name defaults, and more.
Reference
This is the reference section for APIs, Keyboard Shortcuts, and more.
1. List of Placeholders
  A placeholder is like a shortcut for using data or text from other sections of the software.
2. Keyboard Shortcuts
  A list of all keyboard shortcuts found in the main project window and the Skin Editor.
3. JavaScript API
  The player has an external API so it can be controlled with JavaScript.
4. HTML Template
  Use the Garden Gnome Template files as a basis for the HTML output.
5. Creating a Support Package
  The Support Package is available for you to collect all the project files our support team would need to help you. Learn how to create a pared-down version of your large project as a support package.
Glossary
A list of terms used throughout Pano2VR.
1. Action
  Actions are like a set of directions that are applied to any element added to the skin to create interactivity.
2. Asset
  Assets are media associated with a project.
3. Container
  A container is an invisible skin element used to group elements.
4. Default View
  The default view is the project's initial opening view or angle.
5. Custom Property
  Custom properties provide extra text input fields or properties that can be targeted by the skin.
6. Element
  Viewer elements include hotspots and pinned images, and Skin Elements include text boxes and hotspot templates.
7. hotspot proxy ID
  A hotspot proxy ID is used to make a link between hotspots and skin elements and their actions.
8. Hotspot
  Hotspots are definable, interactive areas within the panorama.
9. Hotspot Template
  A placeholder that links the Hotspot Image in the skin to the hotspot in the image.
10. Loading Bar
  A loading bar is a set of graphical elements (or a single element) that is used to illustrate how much of the panorama has loaded.
11. Placeholder
  A placeholder represents a value for content that will be filled in later.
12. Skin
  A skin is a collection of text and graphical elements overlaid on the image.
13. SVG
  Scalable Vector Graphics are an XML based 2D vector graphics format used in Pano2VR as skin elements.
14. Component
  A component is a pre-defined skin element or group of skin elements.
15. Toggle
  This is a command generally used in an action for a skin element to show and hide or play and pause, for example.
16. View State
  A view state is how the object appears at any time.
Table of Contents
A map to all help pages for Pano2VR.
Tags
A list of tags to help you better find what you're looking for.