Tumult Hype Documentation

If you’re unfamiliar with Tumult Hype, our documentation is the best way to learn about all of Hype’s amazing features. Get up to speed by reading the other documentation chapters linked on the left side.

Tumult Hype is an HTML5 authoring tool. What is commonly referred to as “HTML5” is really a platform of technologies including the latest HTML tags, CSS styles, and improved JavaScript performance. HTML5’s capabilities allow for stunning visual effects and smooth animations, but previously required difficult hand-coding. There were no designer-friendly tools for building animated HTML5 content… until Tumult Hype.

Tumult Hype’s powerful keyframe-based animations bring your content to life and outputs state-of-the-art HTML5 that works on all modern browsers and mobile devices like iPhones and iPads. No coding required.

Tumult Hype Professional

Tumult Hype Professional is available as an in-app purchase and adds many powerful features to Hype 3.5:

Tumult Hype Professional Interface

This user guide walks you through the entire product, and gives in-depth details on the workings of both Tumult Hype and Tumult Hype Professional. To help distinguish between Standard and Professional features, all documentation chapters or sections covering Professional features begin with the following label:

The Customizable View Handle

Key Terms

There are seven basic key terms to learn for using Tumult Hype: Scenes, Elements, Properties, Keyframes, Animations, Timelines, and Actions. The remainder of the user guide will reference these terms, and by sticking with them you’ll be fluent when conversing with other Tumult Hype users.

Each Tumult Hype document is composed of one or more scenes. Scenes are analogous to slides in a Keynote or PowerPoint presentation, or to cards in HyperCard. Scenes contain elements and timelines. Actions are used to transition between different scenes.

Properties are the attributes which define an element’s style, positioning, and auxiliary information. Most properties are animatable. Properties are defined or changed by manipulating elements in Tumult Hype’s scene editor or by changing values in an inspector. Properties define, among many things, an element’s location, size, color, borders, or the effects applied to the element.

Animations change a property’s value over a period of time; they are defined by two keyframes that set the starting and ending values of the property’s animation. Tumult Hype automatically creates animations between any keyframes which have different values. Animations also have different easing effects, different rates of change, such as ease-in, ease-out, ease-in-out, instant, bounce, and linear. Furthermore, by using motion paths, elements can be animated along arbitrary complex curves.

Timelines contain animations. Each scene has a Main Timeline, which is automatically started when the scene is shown. Scenes can have many timelines which can play in parallel, and actions are used to control timeline playback.

Actions make your document interactive. Among other things, actions are used to change scenes, control timeline playback, start or stop sounds, or run custom JavaScript functions. Actions are triggered in response to user events, such as mouse clicks or tap gestures, and scene events, such as scene loading or timeline playback completion. Actions can also be placed on a timeline, to be triggered at a specific time.

Symbols are a powerful tool which let you easily reuse elements, timelines, and animations. Think of symbols as scenes within scenes: symbols contain their own elements, timelines, actions, and behaviors that can be triggered independently from the scene’s. Because editing one instance of a symbol changes all instances, symbols are also useful for sharing identical elements across multiple scenes or at different positions in the same scene.

Custom behaviors allow you to create your own action handlers that can be triggered like Hype’s built-in action handlers. Just like Hype’s built-in action handlers, your own behaviors can trigger a series of actions. Behaviors ensure you don’t repeat any work when creating and using complex actions.

Scenes

Scenes are a useful way to separate and organize content. They are similar to slides in a Keynote or PowerPoint presentation. Scenes contain elements and timelines. Actions are used to transition between different scenes. Each scene contains a unique set of elements and timelines; modifying an element or timeline on one scene will not affect elements or timelines on other scenes.

Managing Scenes

Every Tumult Hype document starts with one scene by default. The Scenes menu offers a few commands for managing scenes:

New Scene — Creates a new scene and selects the new scene for editing.

Duplicate Scene — Creates an identical copy of the current scene, copying all of the current scene’s elements, timelines, and animations. To duplicate a scene using a keyboard shortcut, select option + drag on the scene.

Duplicate Scene (Without Animations) — Creates an identical copy of the current scene, copying all of the current scene’s elements, but omitting the current scene’s timelines and animations. This command is surprisingly powerful, and is often used to compose complex animations that need to span multiple scenes.

Go To Scene — Offers a submenu listing all of the document’s scenes, and choosing one of the scenes makes that the current scene for editing.

Go to Layout - Offers a submenu listing all layouts in the currently selected scene. HYPE PRO ONLY

Tumult Hype’s Scene Selector – toggled by the Show Scenes toolbar button – offers additional control over scenes. Create new scenes using the Add Scene plus button, rearrange scenes using drag-and-drop, and rename them by double-clicking their name. Finally, scenes can be copied and pasted by selecting a scene in the Scene Selector and choosing Edit > Copy and then choosing Edit > Paste.

Scene Selector

By default, all scenes in a document have the same size, and choosing a different default size or changing the Width or Height values affects all scenes. To change the size of just the current scene, disable “Apply changes to all scenes” in the Scene inspector.

Scene Size Controls (Scene Inspector)

The active scene’s background color is set by the Background color well found in the Color section in the Scene inspector. To make the current document transparent and prevent all scenes from drawing their background colors, open the Document inspector and deselect the Make Background Transparent checkbox in the Options section.

Changing Scenes

Actions are used to transition between different scenes. Tumult Hype affords ways to trigger actions in response to mouse events such as clicks, scene events such as timeline completion, and at specific times. All of those triggers can invoke the Jump to Scene action with one of seven different scene transitions. The Actions chapter has more information about all of Tumult Hype’s action triggers and different actions, including the Jump to Scene action.

Rulers

Show the scene ruler by selecting View > Show Ruler, and hide it with the corresponding View > Hide Ruler command. Tumult Hype indicates the bounds of the currently-selected elements within the ruler.

Guides

Alignment guides appear and disappear as elements are moved on the scene. Guides assist in arranging elements relative to each other and the scene. By default, elements snap to nearby guides; this behavior can be disabled by disabling the Snap to Guides command in the Arrange menu.

The scene and all elements automatically define their own alignment guides. The scene’s automatic guides define its center and edges. Likewise, every element generates automatic guides for its center and edges.

Manual guides can be added to the scene by choosing View > Guides > Add Horizontal Guides or Add Vertical Guides. Manually-created guides can by dragged anywhere on the scene; drag them off the scene to delete them. The View > Guides menu features many commands for showing, hiding, locking, copying, and pasting guides.

One very powerful feature in the View > Guides menu is the Add Multiple Guides command. Choosing this command reveals a dialog from which any number of evenly-spaced guides can be created. Specify either the number of columns or rows to be created, or the pixel distance between each guide. Layout Guides make arranging content in columns or rows a snap.

Layout Guides Dialog

Grid System

To help you arrange your content, Hype Pro supports layout grids. Hype Pro’s layout grids follow the spirit of the popular 960 Grid System by letting you easily create columns and gutters to arrange content.

To create a layout grid, choose View > Layout Grid > Create Grid. In the Layout Grid Editor, you’ll find controls to set the width of the layout grid, define the number of columns, and set the gutter width between each column.

Clicking Create Grid adds an overlay to the current scene that defines the grid’s columns and gutters. Elements snap to the grid, making it easy to arrange your content against the grid. As with user guides and smart guides, element snapping can be temporarily disabled by pressing the Command key while dragging. Likewise, snapping can be permanently disabled by disabling the Arrange > Snap Elements menu item. If you want to use a grid to arrange elements but don’t want the overlay, choose Arrange > Layout Grid > Hide Grid; reveal the grid by then choosing Arrange > Layout Grid > Show Grid.

Elements

Elements are the objects in a scene. They can be shapes, text, buttons, textured buttons, images, videos, audio, or HTML widgets.

Text

Add text to the current scene by choosing the Insert > Text menu item, by using the Elements toolbar button, or typing t. The Typography inspector allows you to change the selected element’s font, size, style, color, shadow, and spacing.

For even more styling control, you can directly edit the text element’s inner HTML by selecting the element and then choosing Edit > Edit Element’s Inner HTML. In the pop-up window which appears, you can enter any HTML and see the results live.

After inserting a new text element it is selected and editable. When you are done editing press the Escape key or click outside the text element. To edit the text at a later point, simply double-click the element. By default, text fields automatically resize to accommodate text entered as you type. Manually resizing an element fixes the element at the specified size.

Images

Tumult Hype supports importing a wide variety of web image formats, including JPEG, GIF, PNG, and SVG. Create image elements by choosing the Insert > Image menu item, or by via the Elements toolbar button. You can also drag-and-drop images onto the scene, or copy and paste them from other applications. Finally, images can be added by dragging-and-dropping from the Media Browser or from the Resource Library (assuming the image is already stored in the current document’s Resource Library).

Images initially preserve their aspect ratio when resized. You can disable this behavior by deselecting the Constrain Proportions checkbox in the Metrics inspector. If an image’s dimensions have been changed, the image can be restored to its actual dimensions by clicking the Original Size button in the Metrics inspector.

Proportion and Sizing Options (Metrics Inspector)

By default, Tumult Hype documents appear to visitors only after all included images have been downloaded. This ensures that scene transitions and animations appear as intended. To disable preloading for individual images, open the Resource Library and deselect the Preload checkbox for any images which should not be preloaded.

Newly created image elements scale the image as the element is resized. If you need an image to repeat horizontally and/or vertically, you can configure those options from the Element inspector’s Background section.

Retina Support & Image Optimization: Tumult Hype automatically optimizes images during export; images are converted to formats supported on the web and resized for optimum support on “retina” screens. For more information, read the Image Optimization section of the Previewing & Exporting chapter chapter.

Background Property (Element Inspector)

Video

Tumult Hype embeds video using HTML’s native <video> tag, whenever possible. If the browser doesn’t support HTML5 video, as is the case with Internet Explorer 6 through 8, Hype falls back to the QuickTime plug-in. For information about playing and controlling video, see the Audio & Video documentation chapter.

Audio

Tumult Hype embeds audio using the web audio api. For information about playing and controlling audio, see the Audio & Video documentation chapter.

Shapes

You may quickly add a Rectangle, Rounded Rectangle, or an Ellipse from the Elements toolbar item or by using the ru or o keyboard shortcuts. The Rectangle element is the most foundational element in Tumult Hype: Rectangle elements can be customized to look and behave like almost all other elements.

Add shapes to your scene by selecting Insert > Shape, or by using the Elements toolbar button.

Default shapes

Buttons

Buttons are elements which present different appearances when the mouse hovers over them, or when they are clicked or tapped. Tumult Hype offers two pre-configured button types, a flat button and a textured button, in its Insert menus. Any element can be converted to a button by choosing Edit > Show Button Controls. Any button element can be transformed back into a normal element by choosing Edit > Clear All Button States and then choosing Edit > Hide Button Controls.

When button elements are selected, Tumult Hype shows a segmented control above the element to toggle between the button’s normal, hover, and pressed states. When the hover or pressed states are active, any changes made to the button — including position, size, and background images or gradients — will be applied when the element is moused over or clicked. To clear the changes made in those states, choose Edit > Clear All Button States.

Button Controls

HTML Widgets

An HTML widget is used to display embedded HTML in your scene or to embed an iframe of a different web page. One use for this element is to embed a code snippet that requires its own JavaScript. Insert HTML Widgets using the Insert menu or the Elements toolbar button.

An HTML widget containing Twitter Widget Code

To display a webpage within the HTML widget, select Specified URL and enter the full URL (make sure to include http:// or https://).

Display a Web Page within an HTML widget

Element Properties

Arrangement, Distribution and Sizing

Elements are rearranged and resized using Tumult Hype’s scene editor. To assist with element arrangement, Tumult Hype’s scene editor provides automatic guides based on the scene’s border and other existing elements. Likewise, it assists with resizing by snapping the element to match the width or height of other elements on the scene. For further control over element positioning, learn more about guides and the grid system.

Rotation

To rotate elements along the Z-axis, select the elements and press the Command key while hovering just outside of the element bounds. The cursor indicates the selected element can be rotated. The Metrics inspector also has controls for rotating elements along the X-, Y-, and Z-axis.

An element’s anchor point sets the element’s Z-axis rotation origin. To move a selected element’s anchor point, press Command to reveal the anchor point crosshair icon and then drag the icon to a new location. The Metrics inspector offers control over the anchor point location in the Rotation Origin section.

Element with Z-axis rotation animation and a custom anchor point

Please note that an element’s anchor point cannot be modified if it is animated using motion paths.

Multiple elements can be moved, rotated, or resized by first drag-selecting elements on the scene and then moving or resizing one of the selected elements.

Color

To pick a color for a selected element, click on the color well in the appropriate inspector. Tumult Hype uses the Standard Mac OS color picker, with the addition of an Opacity slider and hexadecimal/rgba field. When reducing opacity below 100%, the hexadecimal field automatically converts to the RGBa equivalent.

Both the hexadecimal and rgba fields are editable and selectable for copying and pasting from other applications.

Gradients: To use a gradient as an Element background, select the Fill Style dropdown in the Element Inspector and select Gradient. Rotate your element gradient by adjusting the rotation angle value.

Scaling

Scale an element or a group by first making a selection, and holding Command while dragging a corner resize handle. The Scale options in the Metrics inspector provide further control over the scaling ratio, height, and width.

Scaling options in the Metrics Inspector

Scaling several objects proportionally based on the Tumult Hype document’s container:

First, turn on Flexible Layouts in the Document inspector for the document. Set the ‘Scale’ value for Width and Height to be 100%.

Next, select elements on your scene and add them to a group.

With your group selected, switch to the Metrics inspector and select the horizontal and vertical scaling arrows. Next, deselect any pins, and set the scaling behavior to ‘Shrink to Fit’ or ‘Expand to Fill’. Also, select ‘Zoom Contents.’

Scale options for scaling elements proportionally

Positioning & Layer Order

The Arrange menu provides several different commands for arranging, distributing, and resizing elements:

Bring Forward

Bring to Front

Send Backward

Send to Back

Distribute > Horizontally

Distribute > Vertically

Distribute > Horizontally Within Selection

Distribute > Vertically Within Selection

Align > Left

Align > Center

Align > Right

Align > Top

Align > Middle

Align > Bottom

Size > Make Same Width

Size > Make Same Height

Size > Make Same Size

Ordering Toolbar Items

CSS Filter Effects

CSS Filter Effects offer control over the following effects: blur, sepia, saturate, hue, brightness, and contrast. All Filter Effects can be animated. Note that foreground effects are only supported in Chrome 18+, Safari 6+, and iOS 6+, and backdrop effects are only supported in iOS 9+ and Safari 9+.

Like every property, both foreground and backdrop filter effects may be animated on the timeline.

Foreground CSS Filter Effects

CSS filter effects apply adjustments to any elements using properties you may be familiar with from image editing software:

Element Inspector: CSS Filter Effects

Below are a few different filter effects applied to the same image:

CSS Filter Effects Example

Original Image

Sepia: 56%, Saturation 1.5, Brightness 86%

Saturation: 0

Blur 5.2, Saturation 1

Backdrop CSS Filter Effects

When applying Backdrop filter effects to an element, a portion of the element underneath must be visible. To add transparency, use the color picker’s opacity slider:

CSS Filter Effects Example (Backdrop)

The text element above has a background color opacity of 49%, and the following backdrop filters applied: Blur 2.5px, Saturation: 2.6, Contrast .7.

Z-Ordering

The stack order of elements can be changed by choosing Bring Forward, Bring to Front, Send Backward, or Send to Back from the Arrange menu, clicking the Front or Back toolbar buttons, or by reordering elements in the Element List. You can also click and drag elements or groups in the element list and move them up or down to adjust their stack order.

Elements at the top of the layer order receive touch and mouse actions. To pass clicks or touches through elements, select them, and check ‘Ignore all pointer events’ in the Actions inspector.

Identity

The Identity inspector provides access to less common element properties, such as the alt tag, a modifiable element ID, and the display name used within Tumult Hype.

The Identity inspector for a selected button

Inner HTML

Elements are, at their base, HTML divs. Because of this, they can contain arbitrary HTML. Edit any element’s inner HTML of any element by choosing Edit > Edit Element’s Inner HTML. This is useful for pasting your own custom HTML or CSS, or for tweaking text displayed in elements. Keep in mind that if recording is turned on, modifications to an element’s inner HTML will be animated.

Grouping Toolbar Items

Elements can be dragged in or out of groups by rearranging elements in the Element List.

A Group in the Element List

Duplicating

There are many ways to duplicate an element:

Hold option while clicking + dragging on an element to quickly duplicate an element.

Select Edit > Copy, and Edit > Paste.

Select Edit > Copy, and Edit > Paste with Animations to retain any animations linked to that element on the currently-selected timeline.

Duplicate the scene by ctrl + clicking on the scene and selecting ‘Duplicate scene’.

Pointer Events

By default all Hype elements have pointer events set to auto. This means any element will intercept all mouse and touch events for all elements underneath it. To have an element ignore mouse and touch events check ‘Ignore all pointer events’ in the Actions Inspector under the Pointer section.

This is especially useful on group and symbol elements when you don’t want the empty space inside of a group to block events. Setting ‘Ignore all pointer events’ will not propagate to all child elements. For example a child of a group that is ignoring pointer events will still intercept mouse and touch events. You must set this property on every element that you want to ignore pointer events. Pointer events is not an animatable property.

Ignoring pointer events is not fully supported in IE 6-10. Mouseover, mouseout, and hover actions will still be intercepted by elements set to ignore pointer events.

Opacity, Hiding, and Locking Elements

Element Visibility & Locking

Elements locked from the lock button in the element list cannot be selected or moved on the scene, and their properties cannot be changed in the inspector. Hidden elements are not visible on the scene and are also not exported. Multiple elements can be locked or hidden at the same time by selecting multiple elements on the scene or in the Element List and then choosing Arrange > Lock or Arrange > Hide. In the element list, clicking and dragging on the Lock or Visibility icons will also modify their property.

Both individual elements and groups can be locked or hidden. Any adjustment to locking or visibility on a group affects the state of elements within it.

Hidden, Locked, and Unlocked + Visible elements.

There are two notions of ‘Hidden’: Setting the Display value to ‘Hidden’ for an element will set display:none on that element; this is an animatable property. Clicking the eye icon on an element in the element list will remove it from the document.

Each element’s visibility and locking buttons support modifier keys for toggling their state en masse. If you Command-click on an element’s visibility or lock button, all other elements will match the clicked element’s state. Option-clicking will change all other elements’ state, so you can easily hide or lock all other elements. Click and drag up or down on the lock or eye icons to toggle their state quickly.

Opacity & Display

To change the opacity, (also known as the transparency) of an element, adjust the opacity slider in the Element inspector. The Display option sets the visibility of the element. When set to ‘Hidden’, the element will not appear on the scene or in export. Use the ‘display’ option during animations to instantly hide an element, and opacity animations to create fades between two opacity values.

To adjust the opacity of a color used in your document, adjust the opacity slider in when using the color picker.

An element that becomes hidden in a Timeline

Elements at the top of the layer order will intercept mouse or touch actions even if they have a 0% opacity. To disable this behavior, please read the pointer events section above.

Animations

Tumult Hype uses a powerful keyframe-based animation system to give elements motion and transitions. Its recording functionality makes building animations a snap.

Keyframes

Keyframes specify the value for a property at a specific point in time, and animations are composed of two keyframes which define the starting and ending values of a property’s animation.

Animation Keyframes

In traditional hand-drawn animation, creating frames is split between two groups of people: keyframe artists and in-betweeners. The keyframe artists would draw the most significant frames, usually where shifts in action would occur. If they were animating a bouncing ball, they might draw two frames: the top of the bounce and when the ball hits the ground. The in-betweener would do the more tedious work of drawing the intermediate frames to bring the ball to life.

You are the keyframe artist when using Tumult Hype. You can specify keyframes for element properties on the timeline andTumult Hype will automatically generate the in-between frames for you.

Recording

Recording is an intuitive way to automatically generate keyframes when creating animations. Simply click the Record button, move the time cursor, and manipulate elements on the scene or change properties in the inspector. In response to your actions,Tumult Hype creates the necessary keyframes on the current timeline. Recording eliminates the need to manually insert keyframes.

Create an animation of an element moving over three seconds by following these steps:

Click the Record button to turn on recording

Select an element to animate

Move the time cursor to the right and stop at the 3 second tick mark

Drag an element to a new location, or resize an element.

Notice a red animation bar was created on the timeline. The red animation bar may be moved to change the start and end time of the animation. Click and drag the beginning or ending point of this bar to adjust an animations' timing.

The Capo

The Capo pairs with Tumult Hype’s recording feature to let you quickly build animations which start and end at arbitrary times without manually inserting keyframes. With the Record button on, you’ll see a small tab — the Capo — appear at the left edge of the time scale area.

The Capo Tab

The position of the Capo sets the starting time for your animation. The Capo and time cursor are typically moved independently from each other, and you can adjust the position of both simultaneously by holding the control button while dragging either.

An Animation Created Using Recording and the Capo. 1) Animation Starting time defined by the Capo. 2) Animation Ending time (Defined by Time Cursor).

Recording and the Capo are incredibly powerful animation tools. With them in your arsenal, you’ll rarely need to manually insert keyframes for individual properties.

Manually Editing Keyframes

Adding Keyframes

Keyframes operate on specific properties. An animation requires two keyframes: a starting keyframe and an ending keyframe. The in-between frames are automatically formed and will smoothly transition the property value from the start to the end.

To add a starting keyframe, select an element in the scene editor. Your selected element will also appear highlighted in the element list below the scene area. In the property list below the element, you can select a specific property that you want to animate. For example, if you wanted an object to fade in, you would select the opacity property. Next, you can move the time cursor to where you want the animation to begin. Click the Add Keyframe button. This will visibly place a keyframe on the timeline. At this point, you’ll set the value of the property you want to animate. For the fade in, you would go to the Element inspector and set the opacity value to 0%.

To add the ending keyframe, move the time cursor to the point on the timeline you’d like the animation to end at. Click the Add Keyframe button again to create a second keyframe on the timeline. Finally, you’ll want to set the property to its ending value. To complete the fade in, set the opacity to 100%. A bar between the keyframes will appear; this indicates the property is animating.

Per-Property Add Keyframe Buttons

By default, clicking a property’s Add Keyframe button adds a keyframe for the associated property at the time cursor’s current time. Option-clicking the Add Keyframe button adds keyframes for all visible properties in the properties list.

Setting Keyframes on Any Property

By default, when you click on an element in the element list the only properties that are shown in the properties list are the opacity, origin, and size. These are the properties you’ll likely be manipulating, but Tumult Hype is capable of animating most properties you can set in the inspector. To manually add keyframes for other properties, you’ll need to add them to the currently selected element’s property list. To do this, click on the Properties pop-down menu and select which property you’d like to animate. Now this property can be selected for adding keyframes.

Animation Keyframes

If you are recording, Tumult Hype automatically adds properties to the properties list as you manipulate elements on the scene or change values in the inspector.

Modifying Properties

For manipulating properties with keyframes, there are two rules to note:

If the time cursor is on a keyframe for a property and that property is manipulated through the inspector, the keyframe value itself will change.

If the time cursor is not directly on a keyframe for a property that has keyframes, and the property is changed, then the keyframes will all be offset.

Time Cursor On Keyframe | Time Cursor Off Keyframe

These rules are best illustrated by considering an example involving an animation of an element’s Origin (Left) property. The animation is defined by two keyframes: one placed at the 1 second mark with a value of 10px, and a second at the 2 second mark with a value of 20px. With those keyframes, the animation will start at 1 second and, over a full second, will move the element to the right by 10 pixels until it reaches the ending keyframe’s value of 20px.

With this animation, placing the time cursor at either 1 second or 2 seconds will allow you to modify the value of those two Origin (Left) keyframes; any changes made to the element’s Origin (Left) value when the time cursor is over those keyframes will change the value of those keyframes and thus change the distance the element will move. Conversely, when the time cursor is at any other time on the timeline, changing the element’s Origin (Left) property will change the location of the element itself; the starting and ending points of the animation will change, but the actual animation itself is unchanged.

Manipulating Keyframes

Keyframes support most standard manipulations; multiple keyframes can be selected, dragged to move, copied, and pasted. While keyframes are represented by diamonds in the property area, the duration and span of animations are represented by the bars between keyframes. To the right of the elements are animation overview bars, which represent keyframes as white lines. These bars can be resized and dragged to adjust animations. They can also be multiply selected, copied and pasted, just as with keyframes.

Animation Overview Bar and Keyframe indicators

By default, the playhead, keyframes, and animations snap to second markers and other keyframes when dragged. Disable this behavior by deselecting the Animation > Snap to Seconds or Animation > Snap to Keyframes menu items.

Delete both keyframes and animations by drag selecting them in the timeline view and then pressing Delete. When adjacent keyframes are deleted, the animation between those keyframes is also deleted. Deleting an element-level animation overview bar will delete all associated property animations.

Copying and Pasting Animations

To duplicate an element and its animations, first select the element on the scene or in the element list, then select Edit > Copy, and finally select Edit > Paste with Animations. Keyframes and animations can also be copied from and pasted to the timeline.

Motion Paths

Elements can be animated along complex and arbitrary curves using motion paths.

Creating a Motion Path

A motion path is a curved animation between two or more points. Create a motion path by first creating a basic animation between two points.

Click the Record button to turn on recording.

Advance the time cursor to your animation’s desired ending time.

Move the element to the desired ending location.

Turn off recording by once again clicking the Record button.

Now that there’s an animation, convert the basic path to a motion path by first clicking on the animation’s path to select it for editing, and then clicking once again to add a motion path control point. Dragging the control point or the control handles alters the curve, and additional control points can be added anywhere on the path by clicking the path.

Creating a Motion Path by clicking on an Animation Path

Motion paths unify Origin (Top) and Origin (Left) properties under one single Origin (Motion Path) property, because the motion path itself controls the top and left position of the element. As a result, Tumult Hype warns you if you attempt to convert a linear animation with different timing functions for Origin (Top) and Origin (Left), because the new motion path can only support one timing function.

Furthermore, converting an element to use motion paths will change all of that element’s animations on all timelines to use motion paths. To preserve standard animations in different timelines, create a copy of your element by selecting your element and choosing Edit > Copy and then choosing Edit > Paste with Animations.

By default, elements move along motion paths without rotating. When the ‘Rotation follows motion path’ option in the Metrics inspector is enabled, elements instead rotate so they’re always perpendicular with respect to their motion path with their right edge forward. If your right edge is not the “front” of the image you may need to rotate your element on the Z axis so that the correct edge is on the right side. For example if your object is moving from right to left you will likely need to rotate your image by 180 degrees.

Adjusting a Motion Path

Shape: To adjust a motion path’s curve, click once on the path and then click and drag any control point to change it’s location, or any control handles to change the nature of the curve.

Adding and Removing Control Points: Add control points by first selecting a path; once a path is selected, clicking anywhere on the path will add a control point. This cursor indicates a control point will be added when the path is clicked: . Any control point can be removed by clicking on the control point and then pressing Delete. Because the starting and ending control points define the element’s animation, those can only be deleted by deleting the animation itself as is described in the Manipulating Keyframes section.

Rotation: By default, elements move along motion paths without rotating. When the “Rotation follows motion path” option in the Metrics inspector is enabled, elements instead rotate so they’re always perpendicular with respect to their motion path.

Easing & Animation Timing Functions

By default, animations use the Ease In Ease Out timing function. Ease-in-out smooths the beginning and ending movements of an animation so that changes slowly accelerate and then decelerate. To change an animation’s easing, click the animation bar between any two keyframes, then choose a different timing function from the Easing menu on the right side of the Timeline view. You can also double-click any animation bar to reveal an animation pop-up which features the same Easing menu.

Tumult Hype supports the following animation timing functions:

Instant – The property jumps to the value of the ending keyframe, at the time of the ending keyframe.

Ease In Ease Out (Default) – Accelerates change during first half of the animation; decelerates change during the second half.

Bounce – The properties quickly change towards the ending keyframe’s value, then “bounces” off that value twice. Often used for creating natural vertical bouncing animations, by applying this timing function to an animation of an element’s Top property.

Back - This function slightly overshoots its target and returns.

Easily reverse or select different variants of easing transition in the easing selection popover:

By default, animations use the Ease In Ease Out timing function. Ease-in-out smooths the beginning and ending movements of an animation so that changes slowly accelerate and then decelerate. To change an animation’s easing, click the animation bar between any two keyframes, then choose a different timing function from the Easing menu on the right side of the Timeline view. You can also double-click any animation bar to reveal an animation pop-up which features the same Easing menu.

Editable Timing Functions

In addition to the 24 new default timing functions added to Hype 3, Hype Pro lets you create your own timing functions. All of the default timing functions show the bezier path control points that define their behavior, and adding, deleting, or editing those points creates a new timing function based on the original. You can also create new timing functions from scratch by clicking the plus button in the lower left corner of the popover.

You edit timing functions just as you edit element motion paths:

Add a bezier path control point by clicking on the path.

Click and drag a control point or its corresponding handles to change the curve.

Click on a point and press Delete to remove a control point.

All of the motion path keyboard shortcuts work while editing timing functions.

Custom Timing Function Editor

As you edit a timing function, the animations you have selected will immediately use your new custom function. To save this custom function to use in other animations click Add to list. If you need to update your saved function in the future simply make your desired edits and click Update. All animations that are using your saved timing function will be updated to use your new version.

Timelines

Timelines contain animations. Each scene has at least one timeline known as the Main Timeline whose playback is started when the scene is first loaded. Scenes can have many timelines, and using actions to start, pause, or continue timelines creates rich and complex documents.

Managing Timelines

There are three ways to create timelines:

Timeline Selector Menu

Timelines can be added via the Timeline Selector pop-down menu by clicking on the menu and choosing the New Timeline command. Newly created timelines are automatically selected for editing.

Timeline Selector Menu

Action Handler Menus

Timelines can be created when choosing Start Timeline, Pause Timeline, Continue Timeline, or Go to Time in Timeline as an action handler. (The Actions chapter has more information about Tumult Hype’s various action handlers.) Choosing one of those actions presents a Timeline pop-up menu, and choosing New Timeline will create a timeline.

Action Handler Menus

Scene Inspector’s Animation Timelines

Timelines can be added in the Scene Inspector’s Animation Timelines section. Click the ‘+’ button to add a new timeline.

Animation Timelines Properties in the Scene Inspector

Timelines can also be removed and modified in the Animation Timelines section. Double-click on a timeline name to rename it, and click the Minus button to delete the selected timeline. To load a timeline, select it and click Show Timeline.

Deleting Timelines

Delete a timeline by selecting it in the Animation Timelines area of the Scene Inspector and clicking the ‘-’ button.

Duplicating Timelines

Duplicate a timeline by selecting it in the Animation Timelines area of the Scene Inspector and clicking the Duplicate button.

Controlling Timeline Playback

Animations on the Main Timeline run when the scene is first loaded. Additional timelines act as containers for animations that use elements in the scene, but are not to be run when first loading a scene. (It is possible to have additional timelines run when a scene is loaded: create an On Scene Load action handler that invokes Play Timeline for one or more alternate timelines.) Switch between different timelines by using the Timeline Selector menu. Timelines can also be controlled by the On Drag action handler at either the scene or element level. This technique is useful for giving users control over “scrubbing” timelines, or for building complex drag animations.

Timeline Selector Menu

Animations on the Main Timeline are started automatically when a scene is loaded. Actions are used to control playback of both the Main Timeline and alternate timelines. Please see the Actions chapter for more information.

Timeline Playback Direction

Timelines may be played either forwards or backwards. By default, a timeline plays forwards and only once. To play a timeline in the opposite direction, select ‘Play in reverse‘. To start a timeline from its ending point, create a ‘Start Timeline’ action, and check ‘Play in reverse.’ To play a timeline in reverse at the end of its animation, use a timeline action to Continue Timeline and check Play in reverse as shown below:

This Timeline Action will reverse the timeline at 4 seconds.

Timelines Playback Example

The document below demonstrates playback of the main timeline, additional timelines, and reversed timelines within Tumult Hype.

Looping Timelines

An easy way to loop timelines is to add a Timeline Action at the end of the timeline that will run a Continue Timeline action on the current timeline, with ‘Can restart timeline’ checked. If you want a timeline to oscillate (play forward and then in reverse) add a Continue Timeline action with the Play in reverse option checked at the end of the timeline. To loop this you can also add a Continue Timeline forward action at the beginning of the timeline. This demo document illustrates oscillating timelines and looped timelines.

Generally it is better to use ‘Continue’ to change the direction of a timeline. Only use ‘Start in reverse’ if you want to jump to the end and play in reverse. Using Continue Timeline to change the direction will only play the actions in that action chain once unless you have ‘Can restart timeline’ checked. However if you use a Start Timeline action the timeline will complete all actions chained with this action and then start over from the end playing all actions in the chain a second time before continuing in reverse.

Absolute and Relative Keyframes

Timelines contain starting keyframes that are either absolute or relative. By default, all timelines are created with absolute starting keyframes. The difference between absolute and relative starting keyframes is subtle but important. When a timeline has absolute starting keyframes, elements animated by that timeline will have their animated properties set to the values defined by the starting keyframes when those keyframes are triggered, and will then animate to the values defined by their ending keyframes. When a timeline has relative starting keyframes, elements animated by that timeline will use their current values when the starting keyframes are triggered, and will then animate to the values set by their ending keyframes.

This difference makes timelines with absolute starting keyframes useful for effects such as looping. When looping, it’s often desirable to have elements jump back to their starting properties; when building complex animations, it can be handy to use timelines with relative starting keyframes that animate elements from their current state, whatever it may be, rather than forcing elements to a pre-defined initial state.

Making a Timeline Relative or Absolute

Toggle whether a timeline’s first keyframes should be relative by opening the Scene inspector and selecting the Relative checkbox in that timeline’s entry in the Animation Timelines table. Absolute keyframes are always drawn with a diamond, while relative keyframes are drawn as a circle.

Animation Timelines in the Scene Inspector

Because relative keyframes take the element’s property’s current value when the timeline is started, there are some situations where Tumult Hype cannot definitively indicate whether an animation will happen. In the example below, the Move Soccerball timeline is active and uses relative keyframes. Because the Origin (Left) animation has different starting and ending values,Tumult Hype knows that animation will always take place. The Origin (Top) animation, however, has the same starting and ending values. As such, that animation will only happen if the element is currently at a different Origin (Top) value when the timeline is started. Because of this uncertainty, Tumult Hype draws the Origin (Top) animation bar slightly transparent, indicating that the Origin (Top) animation between the starting relative keyframe and ending absolute keyframe may not have any effect on the scene.

Potential Animation With Relative Keyframes

Relative Keyframes Example

Because relative keyframes take into account the position of elements on other timelines, they can be taken advantage of to create smooth animations that animate elements across timelines. (This demo document) below shows this technique in action.

Actions

Scenes, timelines, and animations are the foundation of all Tumult Hype documents. Actions link together this foundation and make documents interactive. Actions are triggered five different ways:

In response to mouse or touch events.

In response to scene events.

In response to keyboard events.

At specific times on a timeline.

Via JavaScript.

This chapter will discuss the first three triggers, as well as the types of actions and action chaining. Tumult Hype’s JavaScript API is discussed in the JavaScript chapter.

Mouse and Touch Actions

Any element can respond to both mouse and touch actions. Set an action on an element by selecting the element, opening the Actions inspector, and then clicking the Plus button next to any action handler. If Use Touch Events is enabled in the Document inspector, events are mapped to the tap action in parenthesis. The following six actions can be detected:

Mouse Click (Tap) — A complete click (a mouse down followed by mouse up) has been completed.

Mouse Down (Touch Start) — Once the pointing device has been depressed on the element.

Mouse Up (Touch End) — The mouse button has been released after being pressed.

Mouse Over — The cursor has entered the bounds of the element.

Mouse Out — The cursor is no longer within the bounds of the element.

On Drag — A drag has begun on the indicated element.

Control Element Position — Controls the position of the element when dragged.

Control Timeline — Horizontally or vertically dragging across the selected element controls playback of the selected timeline. The axis dropdown defines whether a horizontal or vertical drag controls the timeline. The direction dropdown defines whether the indicated timeline plays forwards or backwards. Use the ‘Speed’ setting to define how a gesture translates to playback speed. Select ‘Continue after drag’ to maintain the momentum of the timeline’s playback after releasing.

On Drag Action to Control a Timeline

Most mouse actions translate logically to touch actions. For example, tapping an element invokes that element’s touchstart action. For more information about touch support, please see the Touch & Mobile chapter. By default, a tap on a mobile device will be triggered at the start of a

touchstart event. To change this behavior, disable Use touch Events in the Document inspector.

To correctly trigger mouse actions, elements must not have other elements above them or overlapping with them.

Set an action on a button by selecting the button, activating the Mouse Action inspector, and then clicking the Plus button next to the On Mouse Click action header:

A Mouse Action Set on a Button

Viewport Actions

Viewport actions are commonly used to delay starting an animation until an element is scrolled into view, or to reset an animation when an element is scrolled out of view.

On Enter Viewport — This element has scrolled vertically into the viewport.

On Exit Viewport — The element has scrolled vertically out of the viewport.

These actions will fire each time the element scrolls into or out of view. If the element is visible when the page loads, the action will fire immediately after the On Scene Load action.

Note: If your document is in an iFrame these actions will fire as you scroll the iFrame, not the main frame. If your iFrame is not scrollable and the element is visible when the iFrame loads, the action will fire immediately, even if the iFrame itself is not currently visible in the browser.

Scene Actions

Scene actions trigger in response to scene events and are useful for scene-specific interactivity. The following scene actions can be triggered:

On Scene Load — Triggered when entering the scene.

On Scene Unload — Triggered when leaving the scene.

On Layout Load - Triggered when the currently-selected layout loads. HYPE PRO ONLY

On Layout Unload - Triggered when the currently-selected layout unloads. HYPE PRO ONLY

On Key Press — Triggered when a character key has been pressed and released.

On Key Down — Triggered when pressing a keyboard key.

On Key Up — Triggered when a keyboard key has been released.

On Swipe Left — Triggered when the scene is swiped from right to left.

On Swipe Right — Triggered when the scene is swiped from left to right.

On On Swipe Up — Triggered when the scene is swiped from bottom to top.

On Swipe Down — Triggered when the scene is swiped from top to bottom.

On Drag — Triggered when the scene area is dragged.

Control Timeline — Horizontally or vertically dragging across the scene controls playback of the selected timeline.

Custom Behaviors - A Custom Behavior is a reusable set of instructions which can be triggered from an action on the scene. View the Behaviors section for more information. HYPE PRO ONLY

Timeline Actions

Timeline actions fire at a certain point in a timeline. Add a new timeline action at the playhead’s current position by clicking the Plus button in the Timeline Actions gutter, or by double clicking anywhere on the Timeline Actions’ timeline. Existing Timeline Actions can be edited by double clicking on their associated keyframe. For further control over actions beyond Timeline Actions, please see the JavaScript API documentation.

Timeline Actions

Edit an existing Timeline Action by double clicking on its associated keyframe to open the Timeline Action pop-up window:

Timeline Actions Pop-up Window

Example Timeline Actions

Here are a few examples of what Timeline Actions can be used for:

Looping an animation — To loop an animation, you can set a timeline action to either Start Timeline or Go to Time in Timeline for the same timeline.

Jumping to a scene or running an alternate timeline — Create interactivity that navigates to specific points in scenes and timelines. You would create multiple animations on one timeline, and use the Pause and Continue actions to move between them.

Adding Actions

Symbols

Symbols are a powerful tool which let you easily reuse elements, timelines, and animations. Think of symbols as scenes within scenes: symbols contain their own elements, timelines, actions, and behaviors that can be triggered independently from the scene’s. Because editing one instance of a symbol changes all instances, symbols are also useful for sharing identical elements across multiple scenes or at different positions in the same scene.

Symbols can be created either through the Symbol menu or the Symbols toolbar button.

The New Symbol and New Persistent Symbol items create empty symbols ready for you to dive in and edit, while the New Symbol from Selection and New Persistent Symbol from Selection items take your currently selected items and all of their associated timelines, animations, and behaviors and place them in a new symbol.

Note: Creating a symbol from selected elements will not move any Timeline Actions.

Standard Symbols

Standard symbols can have multiple instances in a scene, and exist within the scene itself just as normal elements do. Copying and pasting a symbol creates a new instance of the symbol that is identical to the original symbol. In fact, editing any copy of a symbol will edit all instances of that symbol.

Persistent Symbols

Persistent symbols exist outside of scenes at the document level. They are not destroyed when scenes change, and can even be displayed and animated during a scene transition. Because of this each scene can have only one instance of each persistent symbol. Persistent symbols are fantastic for creating things like menus or master elements that shouldn’t reset when scenes are loaded or unloaded and need to always be visible.

Editing Symbols

Edit any symbol by double clicking on the symbol in the scene editor or in the element list. When you enter a symbol for editing, the symbol path bar appears:

As symbols can themselves contain symbols, you sometimes find yourself diving deep into the hierarchy. The symbol path bar both tells you which symbols you’re editing and helps you navigate the hierarchy. Click on any symbol on the path to jump up to its level and click the Close button on the far left to stop editing all symbols and return back to the scene’s level.

The Symbol menu also has commands with keyboard shortcuts (Option-Command-Up Arrow and Option-Command-Down Arrow) for navigating a symbol’s hierarchy.

Scaling Symbols: Symbols can be scaled like any element. Select your symbol, and hold command while dragging on the symbol’s resize handle. When scaling a standard symbol, it will not affect its scale on other scenes. Scaling a persistent symbol scales it on all scenes. Read more about scaling.

Symbol Inspector

Symbols have their own inspector for settings, timelines, and symbol level action handlers (symbol load, swipe, drag, etc). It is hidden by default, but when you enter a symbol to edit it the Symbol Inspector replaces the Scene Inspector.

Managing Symbols

Just like images, videos, and other resources, symbols are managed in the Resource Library.

By default deleting the last instance of a symbol in your Document will also remove it from the Resource Library. To change this behavior select the symbol in the Resource Library and uncheck “Remove when no longer referenced”.

Deleting a symbol from the Resource Library removes all instances of it from the document. When selected, symbols can be duplicated using the Duplicate Symbol button presented at the bottom of the Resource Library. The Symbol menu also has commands for deleting and duplicating symbols.

Playing Symbol Timelines

Just like scenes, symbol’s can have multiple timelines. There are four ways to kick off a symbol’s timeline.

Symbol Timeline Actions: When a symbol element is selected, a new property called Symbol Actions appears in the timeline. These work just like timeline actions, but can control timelines inside of the selected symbol. You can use symbol actions to play, pause, go to time, and continue symbol timelines. When you use symbol actions, animations inside of the symbol will play in Hype along with animations outside.

Action Handlers on the symbol element: When a symbol element is selected, the symbol’s timelines will show up in the element actions (mouse click, mouse over, etc) in addition to the scene level timelines.

Behaviors: Behaviors are a great way to control multiple symbols at once. See the behaviors section for more information.

On Symbol Load action: You can use the On Symbol Load action in the Symbol Inspector to kick off timelines the first time the symbol is shown. This is a great place to start timelines on a persistent symbol.

By default symbols will not kick off their Main Timeline. However standard symbols are automatically given a Symbol Timeline Action to start the Main Timeline and persistent symbols are automatically given an On Scene Load start Main Timeline action.

Configuring Persistent Symbols

When you create a persistent symbol you can choose if you want to add it to all current scenes and layouts. If you choose to add it to all scenes the symbol will automatically be added to any new scenes as well. To disable this behavior uncheck Automatically add to new scenes in the Symbol Inspector.

By default persistent symbols are shown on top of all other elements during a scene transition. You can show persistent symbols below other elements by going to the Symbol Inspector and unchecking Display on top during scene transitions. This is useful for creating animated backgrounds.

Renaming Symbols

You can rename a symbol by double-clicking its name in the element list or the Resource Library. Changing a symbol’s name will update the name of all instances of that symbol in your document and in the Resource Library.

Importing and Exporting

Symbols can be exported and imported for re-use in other documents via the Symbol > Import Symbol and Symbol > Export Symbol. Do note that symbol changes do not propagate across documents.

Behaviors

Custom behaviors allow you to create your own action handlers that can be triggered like Hype’s built-in action handlers. Just like Hype’s built-in action handlers, your own behaviors can trigger a series of actions. Behaviors ensure you don’t repeat any work when creating and using complex actions. For example, you might want to simultaneously start three timelines when a scene loads and then later start those same three timelines when the user clicks a button. Before behaviors you would have to set up those three Start Timeline actions both in an On Scene Load and an On Mouse Click action handler. Now, with behaviors, you can create one new behavior that invokes Start Timeline and have the On Scene Load and On Mouse Click action handlers run that behavior. Furthermore, if you decide to change which timelines are run, only need to make changes once for the behavior.

To create a new behavior:

At the bottom of either the Scene or Action inspector, click Add New Behavior.

Give the new behavior a unique name.

Add any number of actions.

Invoke the new behavior using the Trigger Custom Behavior action.

Behaviors are particularly useful when combined with symbols: you can create behaviors with names that describe how a symbol should react (like “Wave” or “Take Off”), and trigger the appropriate actions within the scene to animate the behavior.

Video

Tumult Hype embeds video using HTML’s native <video> tag, whenever possible. If the browser doesn’t support HTML5 video, as is the case with Internet Explorer 6 through 8, Hype falls back to the QuickTime plug-in.

Video Sources (Resource Library)

Video Sources and Options (Element Inspector)

Adding Video

Add video elements by choosing Insert > Video, or by clicking the Insert Elements toolbar button and choosing Video. You can also drag-and-drop videos onto the scene, or copy and paste them from other applications. Tumult Hype supports importing files with .mov, .ogg, .ogv, .webm, .mp4, and .m4v extensions, though only .mov, .mp4, and .m4v files can be viewed from within Tumult Hype.

Browser Support

Please see this page for information on browser support for the various video formats. In most cases, a single .MP4 file will suffice for broad browser support. Video added to Tumult Hype use the <video> tag, which supports multiple sources for one element. Adding a single video in Tumult Hype creates a video group to which other formats may be added. To add additional video formats, select your video and click Add Video Source in the Resource Library, or select your video and add your source in the Element inspector.

Controlling Video

Autoplay — Video will play when it is shown (see compatibility note below).

Controls — When checked, video controls are shown.

Loop — Video will loop when complete

Muted — Audio will not play for the video.

Compatibility Notes

iOS: Video will not play in Mobile Safari without user interaction. Thus, videos played ‘On Scene Load’, ‘On Scene Unload’, or using a timeline action will not play back on iPhones, iPads, or iPod touches. Use Mouse Click actions to play video on iOS.

iBooks Author: Ensure that your video files do not contain spaces or foreign characters in their filenames.

Audio

Audio Sources (Resource Manager)

Audio played by a Timeline Action

On the newest browsers, Tumult Hype plays audio using the powerful Web Audio API. On less recent browsers, Hype falls back to the standard <audio> tag. On old browsers like Internet Explorer 6 through 8, Hype relies on the QuickTime plug-in.

Adding Audio

To add audio to your project, first create your file formats based on your desired browser compatibility. To quickly add multiple formats as a single audio group, use the same filenames. For example, create: whalesounds.mp3, whalesounds.ogg and whalesounds.wav. Dragging these files into the resource library will create an audio source group called whalesounds. You can also individually add audio formats by selecting the audio source group and adding missing formats.

The Audio group ‘Crowd’ shown in the Resource Library

Browser Support

The table below outlines MP3 & Theora audio format support for major desktop and mobile browsers. Please see caniuse.com for the latest information on browser compatibility.

In most cases, a single MP3 variant of your audio will suffice. For the broadest browser compatibility, we recommend supplying MP3 and OGG files for each audio group. One audio source group may contain any combination of MP3, OGG, or WAV files. We recommend converting between the various audio formats using Miro Video Converter. For generating other audio formats, we recommend Audacity.

Controlling Audio

Once an audio source group exists in your document, audio can be played or stopped using scene, mouse/touch, or timeline action handlers. The Play Sound and Stop Sound actions can be invoked by any action handler, and those actions let you choose from any of your document’s audio groups. When playing audio, the Loop option continuously plays the chosen audio group in a loop. Likewise, the Preload option controls whether the audio group’s files should be downloaded before your Hype animation begins playing. For a list of all available actions, see the Actions chapter. Below are a few examples of how actions can control audio playback:

Start audio when a scene begins by adding an On Scene Load action handler and then choosing the Play Sound action.

Start audio after clicking or tapping an element by adding an On Mouse Click (Tap) action handler to the element, and then choosing the Play Sound action.

Start audio three seconds after the beginning of a timeline by adding timeline action to the timeline, and have the timeline action invoke Play Sound.

Stop audio when exiting a scene by adding an On Scene Unload action handler and then choosing the Stop Sound action.

iOS: Audio will not play on iOS devices without user interaction. Thus, audio played ‘On Scene Load’, ‘On Scene Unload’, or using a timeline action will not play back on iPhones, iPads, or iPod touches. Use Mouse Click actions to play audio on iOS. Please see this forum thread for workarounds.

iBooks Author: Ensure that your audio files do not contain spaces or foreign characters in their filenames.

Deleting Media

Typography

Text is central to almost every document, and Tumult Hype offers powerful tools for styling text. Tumult Hype’s Text inspector contains numerous options for customizing text. Change text size, styling, shadows and spacing. Hype also allows you to choose from a set of Web- or iOS-safe fonts, or to even add Web fonts from Google’s Font Directory, Monotype’s Fonts.com, or from your own curated web font collection.

Choosing Fonts

Changing the font for selected text is as simple as clicking a font’s name in the Text inspector. By default, Tumult Hype offers a set of fonts that are considered “Web safe” and work on a broad array of browsers, as well as a set of fonts available on all iOS devices. Furthermore, you can add fonts from the diverse and free set of web fonts offered by Google’s Font Directory or licensed fonts from Monotype. You can even add your own CSS Web fonts should you have your own set of curated fonts.

Select from the Web, iOS, Google, Monotype, or Custom font family selection menu to choose different fonts.

Font Family Selection

Adding Fonts

In addition to the default fonts available in Hype’s Text inspector, you can add fonts to your document by choosing fonts from Google’s Web Fonts library, Monotype’s Fonts.com library, by adding code provided by a 3rd party Web font service, or by adding your own @font-face CSS styles.

Adding Fonts From Google’s Font Directory

Choose ‘Google Fonts…’ from the ‘Add More Fonts…’ popup button in the Typography inspector.

Choose a font from the list of Google Fonts.

Choose a font weight (if applicable).

Click Add Font.

Select an element and change the font family to the added font.

To use your newly added Google Web Font, select text or an element containing text, and then choose the font from Hype’s font list. You can filter the font list to include just Google Web Fonts by choosing Google Fonts from the filter menu above the font family listing.

Adding a Google Font

iOS: Google Fonts require a network connection. If you check ‘Create offline application cache’ in the document inspector, offline users will receive a network error if they haven’t yet launched your web app. If they have launched the web app, text using Google Fonts will appear in a fallback font.

Adding Fonts From Monotype

Monotype offers over 50,000 professional-level web fonts from their Fonts.com library. A set of fonts are available royalty-free, but most fonts require licensing via a Fonts.com account. Monotype’s font service also allows uploading your own font kits and they will host and ensure appropriate licensing and payment.

Add Monotype fonts via these steps:

Choose ‘Monotype Fonts…’ from the ‘Add More Fonts…’ popup button in the Typography inspector

Choose a font from the list of Monotype Fonts.

Choose a font variant (if applicable).

Click Add Font.

Select an element and change the font family to the added font.

The default listing of fonts in a new document are all royalty free, but their entire library of licensed fonts is also available

Browsing for Additional Licensed Fonts

While in the Add More Fonts panel, click the ‘Browse More Fonts…’ button. This will reveal an additional sheet showing over 50,000 additional fonts along with previews and a search interface. After a font has been selected, it will appear in the Font Family list. You can then choose a variant and add the font to the Hype document.

Uploading Your Own Font Kits

Monotype also supports uploading your own font kits. They will be hosted on Monotype’s servers. Monotype will take care of all the licensing for you.

While in the Add More Fonts panel, click the ‘Upload…’ button. This will reveal an additional sheet allowing an upload. You may drag a font kit or click the ‘Browse for .zip…’ button to select one from the Finder. After a font has been successfully uploaded, it will appear in the Font Family list. You can then choose a variant and add the font to the Hype document.

Exporting with Monotype Fonts for Licensing

Many Monotype fonts must be licensed and paid for. When exporting a Hype document containing Monotype fonts, a sheet will appear which completes the publish process. You will need to login with a valid Fonts.com account to use the fonts. If you do not have an appropriate account, you can continue to export your document by clicking the ‘Export without Monotype Fonts’ button. In this case, any text using Monotype fonts will use a fallback instead.

Offline usage of Monotype Fonts

Monotype fonts currently require an online connection to display. A fallback will be shown instead if the user is offline.

Third Party Services

Third party services such as Typekit can be added to the Text inspector’s Font Family list by using the Add More Fonts button in the Text inspector. Many third party libraries require a snippet of code to be placed in the <head>…</head> area of your exported .html file. This knowledgebase article illustrates this process for services like Typekit and Font Awesome. The general steps are:

In the Text inspector, click Add More Fonts.

From the Source drop down menu, choose Custom CSS.

Add a descriptive name for your font in the Display Name field.

In the CSS Font-Family field, add your CSS font-family name.

Based on instructions from your Web font provider, paste any code required into the Embedded Head HTML field.

Click Add Font. Your font is now listed in the Text inspector’s Font Family list.

Since Typekit doesn’t provide a protocol when providing an embed code, your font may not work when previewing on your computer or a local network. You may need to replace //use.typekit.net/xxxxxx.js with http://use.typekit.net/xxxxxx.js to fix this.

Declaring an @font-face style

If you have your own custom web fonts not hosted on other services, add them to Hype by following these steps:

Prepare your CSS defining your custom font face. Our CSS example below loads a set of Futura Bold font files, and links those files to the font family FuturaTOTBold, with Arial and Helvetica as fallbacks shown on the right. Make sure that you enclose your font family in <style> … </style> as shown below:

Click the Resource Library toolbar icon and drag-and-drop each of the font files referenced in the CSS into the Resource Library. For the broadest compatibility, font sets should include the following formats:

In the CSS Font-Family field, add your CSS font-family name. Font providers set this name, and typically offer fallbacks as well. For our example, the Font-Family name is 'FuturaTOTBold', Helvetica, Arial.

Paste the CSS code prepared above into the Embedded Head HTML field.

Click Add Font. Your font is now listed in the Text inspector’s Font Family list.

Copying Fonts

Copying Google Fonts

To copy a Google Font, copy a text element that uses that font into another scene or document. When copying between documents, the Google Font name will appear in the document’s resource library and the text inspector’s ‘Google Fonts’ font menu.

Copying Custom Fonts

To copy custom fonts into another Tumult Hype document:

Select ‘Edit Head HTML’ in the document inspector and copy any custom @font-face styles used for your font.

In the other document, select ‘Add Font’ and follow the instructions from this section of the documentation.

Removing Fonts

Custom fonts and Google Web Fonts added to your document appear in the document’s Resource Library. To remove a font, choose it in the Resource Library and click the Minus button. If you have added font files (e.g. .otf or .ttf files) you should also remove those from the Resource Library.

Physics

Physics introduces a whole new way of animating elements in Hype. Hype Pro offers you control over an element’s physical properties – bounce, friction, air drag, and density – and over the scene’s gravity. Together, those properties enable complex, dynamic animations that would be difficult to create with just a keyframe based animation system.

Due to its interactive and simulated nature, Physics-based animations can only be viewed when previewing or exporting (that is, not within Hype’s scene editor).

Scene Physics Gravity

Scene Physics Gravity defines the force and angle of gravity in the current scene. Lower numbers equate to a smaller gravity force, and higher numbers increase gravity. The default gravity angle (180°) and force (1.0) simulate regular Earthly gravity. To change the direction of gravity based on a device’s current orientation, enable ‘Control gravity with device tilt’.

Device Tilt

Symbol Physics Gravity

To set the gravity within a symbol, select a symbol and adjust the ‘Symbol Physics Gravity’ properties in the Physics inspector. This change propagates to instances of that symbol and allows you to use multiple gravity settings in a single scene.

Collision Behavior

Static and dynamic elements on the same scene collide and interact with each other. To isolate elements from colliding with other elements, add them to a symbol. Symbols define a new physics space where collisions take place.

Element Physics

By default, new elements have no physics properties applied and are considered inactive. They don’t play any role in Hype’s physics engine. There are two additional element physics states:

Dynamic - Full Physics Body: Gravity settings for the scene affect dynamic physics bodies on scene load. These elements will collide with other dynamic bodies and static bodies on the same scene.

Dynamic elements will not interact with other physics bodies within other symbols. Physics bodies within a symbol will likewise not interact with bodies outside of the symbol.

Physics Properties

Density: Density is the area divided by the mass. If an element increases in size and stays the same density, its mass will therefore grow.

Bounce: (Also known as restitution) Higher bounce factors will make for more elastic collisions. A bounce factor over 1.0 will add energy to the collision.

Friction: determines how two bodies will slide against each other.

Air Drag: The friction air provides when an object falls. A beach ball would have high air drag and a bowling ball low air drag.

Tips and Tricks

Physics is a simulation and may run differently depending on various browser and animation conditions

To simulate physics from a top-down perspective, set the scene’s gravity to 0. Then use the air drag property as friction for the surface.

To apply a force to an element, use traditional keyframe animations for the top/left properties. The timing function should generally be linear as if it were a function that eased-out the velocity would decrease and not animate as expected

To create an invisible edge through which dynamic elements cannot pass, add a rectangle to the scene, make it a ‘static’ element, and then set its opacity to 0.

The demo document below covers the following techniques in Tumult Hype Professional:

Element Types: Static, Inactive, and Dynamic

Setting different gravity values on the same scene using Symbols

Defining dynamic element edges

Manipulating physics bodies with animations

Creating top-down physics environments

Animation easing vs. physics animations

Creating element containers

Creating collisions

Advanced Physics with animations: Using keyframes to change physics properties

Physics Tutorial Document

Responsive Layouts

Responsive layouts make it easy to make your document look great on every size screen. Hype allows you to create multiple layouts for a single scene which are shown at specific breakpoints. When displayed in a browser Hype will dynamically load the correct layout based on the current width of the device’s viewport.

To test your responsive layouts while previewing, we recommend using Safari’s responsive design mode. To test responsive layouts on an iOS device, use responsive preview mode in Hype Reflect.

Creating New Layouts

There are two ways to create new layouts:

Reveal the layout selector by clicking the Layouts toolbar button at the top left of the Hype window, then click the + button in the layout selector’s header.

Click the Add New Layout button in the Scene inspector’s Responsive Layout section.

Targeting the iPad’s Portrait Orientation

The breakpoint width you specify tells Hype to display that layout at that specific width and above. Hype will continue to display that layout as the browser width grows until it hits the next layout’s breakpoint.

When you create a new layout Hype will copy all elements, animations, and timelines from one of your existing layouts which best matches the new breakpoint you created.

Any changes made to elements or animations on one layout will not affect other layouts. Symbols are a great way to share content across multiple layouts.

Adjusting Layouts

Adjusting a layout’s dimensions will by default change the dimensions of all layouts which have the same breakpoint width. (You can see a layout’s breakpoint width in the Scene inspector’s Responsive Layout section.) For example, adjusting the height of the default iPhone layout will change the height of all layouts which also have a breakpoint width of 320px. To modify only the selected layout disable the “Apply to matching layouts” option in the Scene inspector’s Layout Size section.

Deleting Layouts

Delete a layout by Control-clicking on the layout and choosing Delete Layout from the contextual menu.

Renaming Layouts

Rename a layout by Control-clicking on the layout and choosing Rename Layout from the contextual menu, or by double clicking on the layout’s name.

Duplicating Layouts

To copy a layout from one scene to another:

Select the layout.

Choose Edit > Copy.

Switch to the destination scene.

Choose Edit > Paste.

Advanced Layout Configurations

To see examples of responsive layouts in action, visit the Responsive section on the forums.

Embedding within a responsive document

To create an animation for embedding within another website, you will need to think about the mobile theme for that website, and the types of breakpoints already present in your website design. Before building all of your layouts out, embed a test document within your site to ensure that your various layouts are shown when you expect. Safari’s Responsive Design Mode is great for testing breakpoints.

A responsive Tumult Hype document expands to fit the available space of its parent element. If the container where you place your document has a maximum width of 500px, that should be your largest layout’s width. If you are embedding your document in a site with no responsive features, there’s no need to create additional layouts.

Note: Use only ‘width’ scaling to avoid common issues when embedding within another site. If your document scales based on both the width and height, it may not appear when embedded. When using height scaling, your document will fit the available space of the containing element. If there is no height set on that element, your animation might not appear because it will have a height of 0. For help troubleshooting this, please see this thread.

Flexible Layout

Tumult Hype offers a powerful layout system for resizing and scaling documents, allowing Hype animations to respond as the browser’s window or device’s viewport changes size.

Document Scaling

By default, Tumult Hype animations have a fixed width and height, and do not respond to window or viewport size changes. To make your animation responsive to size changes, you must first select the Width and Height Scale checkboxes in Hype’s Document inspector. Enabling these options allows your document to respond to width or height size changes as desired. The Width and Height Scale options are complimented by percentage fields which define how much of the containing window or div the Hype document should fill. The default value is 100%, which means the Hype document will expand or contract to fill the width or height of its container. Reducing this number restricts how the document will expand. For example, setting the value to 50% means the Hype document will only expand to fill half of the width or height of its container.

Document Scale Settings

Element Pinning and Sizing

Enabling document scaling is only the first step for creating a completely responsive document. After deciding how your document should scale, you then need to define how elements in the document should adapt to size changes. This is done by “pinning” elements to edges of the scene, allowing the elements to resize horizontally or vertically, and, for proportionally sized elements like images, controlling how they should scale. Hype’s Metrics inspector offers a Flexible Layout section which contains all of the controls for managing how elements should adapt to document size changes. Please note that this section will be disabled if you have not first set scaling settings in the Document inspector.

Element Scale Settings

Pinning

Pinning an element to an edge instructs that element to move as the edge itself moves. When pinned to non-opposing edges, such as the bottom and right edge, the distance from the element to those edges remains fixed. In other words, an element that is placed 100 pixels away from the right edge and is also pinned to the right edge will change its location as the document resizes so it’s always 100 pixels away from the right edge. When an element is pinned to opposing edges, the element’s location changes so the proportion of the distance from the element’s center to the opposing edges is always preserved. The best example for this case is element centering: an element that is centered between the right and left edges and is also pinned to those edges will always be centered regardless of how the document’s size changes. A more complex example is an element in a 1000px wide document whose center is 200px from the left edge and 800px from the right edge. When this element is pinned to both edges and the document has width scaling enabled, the element’s center will always be positioned so that 20% of the document’s width is between itself and the document’s left edge while 80% of the distance is between itself and the right edge.

Sizing

Element resizing is controlled by the two sizing arrows presented in the Metric inspector’s Flexible Layouts section. By default, both sizing arrows are disabled which means that neither the element’s width nor height will change as the document’s size changes. Enabling either one or both of the arrows allows the element to change its size either horizontally or vertically. Like pinning, an element’s size changes proportionally to the document’s size. Thus, an element whose height is 20% of the document’s height will resize to ensure its height is always 20% of the document’s height.

Scaling Behavior

The scaling behavior control allows you to change how elements should be resized. This control is only enabled when an element is allowed to resize both its width and height. When an element is allowed to resize in both dimensions, the default scaling behavior is to stretch the element. This is ideal in most situations, but there are times — such as when an image is being resized — where an element should not be arbitrarily stretched and instead its proportions should be preserved. To handle those situations, Hype offers two additional scaling behaviors which preserve the element’s aspect ratio: Shrink to Fit and Expand to Fill. When Shrink to Fit is chosen, Hype ensures that the element will never expand outside of its bounding region. Conversely, when Expand to Fill is chosen, Hype will make sure the element always fills its bounding region, even if that means it may spill outside. As an analogy, consider what happens when watching wide-screen content on a TV: viewing that content letterboxed is similar to Shrink to Fit as all of the content is always visible on the TV. Likewise, viewing the same content fullscreen is similar to Expand to Fill, as the video expands to fill the TV even though some content falls off the screen.

Stretch (Distorting)

Shrink to Fit (Will not distort)

Expand to Fill (Will not distort)

Animations

Both standard animations and motion paths take into account the element’s sizing and pinning settings, and adapt to the element’s position and size changes as needed.

Viewport Settings

Documents with a scaling turned on for the height dimension will not display vertical scrollbars. Likewise, documents with a scale percentage set on their width dimension will not display horizontal scrollbars. If small screen sizes conceal parts of your document outside of the viewport, uncheck the ‘height’ scale checkbox. To specifically address issues with hidden content on mobile devices, set the viewport width property of your document to ‘device height’. For more information on the viewport property, read the Touch & Mobile chapter.

Flexible Layouts Example

The document demonstrates scaling and pinning elements using the Flexible Layouts feature:

Connecting to Hype Reflect

Make sure that your Mac and your iOS devices are connected to the same Wi-Fi network.

In Tumult Hype on your Mac, click the Preview menu in the toolbar and choose your iOS device.

Your current Hype document should appear on your iOS device, in Hype Reflect.

Preview drop-down in Tumult Hype: Available devices highlighted blue

If you close Tumult Hype on your Mac or leave your WiFi network, the preview will close in Hype Reflect.

Mirror Mode

While in Mirror Mode, Hype Reflect instantly mirrors every single change made in Tumult Hype. This makes Mirror Mode a fantastic tool for designing iOS content. Enable Mirror Mode by tapping the icon.

Preview Mode

When you initially preview your document, your document is in Preview mode. In this mode, your document behaves almost exactly as if it were viewed in Mobile Safari itself.

Switch between different scenes within Hype Reflect by tapping the Scenes icon in the upper left hand corner and choosing your desired scene. Reload the document by tapping the reload button; this is a quick way to get most recent changes made in Tumult Hype.

Left: Preview, Right: Preview in Responsive Mode

Responsive Preview Mode

Responsive preview mode is a great way to test Responsive Layouts and Flexible Layouts in your document. Tap the responsive preview icon to enter this mode. When selected, device icons appear at the bottom of Hype Reflect for switching to smaller device widths. When selecting smaller devices, drag handles appear on either side of your document. This feature is supported when previewing from Hype Professional on an iPhone 6 or larger. Your device will allow previewing at your current resolution and smaller. Previewing on an iPad is preferable, as a wide array of iOS device widths can be tested.

More Options

While using Hype Reflect on an iPhone or iPod, you may enable the following options by tapping the icons in Hype Reflect’s top toolbar:

Open in Safari – Opens the current document within Mobile Safari.

Console – Displays any JavaScript console logs.

Fullscreen – Simulates a full screen web app. To exit fullscreen, click the icon in the lower left hand corner.

Testing and Previewing

For tutorials on how to preview your document on additional platforms like Chrome on Android, and Internet Explorer running on Windows, read this forum post.

Hype Reflect FAQ

I’m unable to connect to Hype Reflect. What do I do?

Make sure that your iOS device and your computer are connected to the same WIFI network.

Open System Preferences on your Mac and open the ‘Security and Privacy’ or ‘Security’ area. In the ‘Firewall’ section, click ‘More Options’ and make sure that ‘Block all incoming connections’ is not checked. (View Screenshot).

Make sure that firewall applications such as Little Snitch do not block connections requested by Tumult Hype. To edit blocked applications, open Little Snitch’s preferences.

Make sure that devices on your local area network can connect to other devices on your network. Your router should not be blocking connections between local devices; you may need to contact your network administrator to resolve this issue.

If the suggestions above do not work, you can connect to Hype Reflect by creating an ad hoc network between your Mac and your iOS device based on these instructions. Please note this may disrupt your connection to the Internet. Please get in touch if you continue to have issues connecting.

Document Options

Document Size – When selecting a document size, choose from many different mobile device sizes in the document size drop down.

Create offline application cache – When selected, Tumult Hype generates a cache manifest file for resources used in your project. With this option selected, your document, when loaded as a web app, will download and locally save everything needed to ensure the document works even when the device is offline. Note: Your document will need to be loaded once as a web app to prime the cache. Also, Google fonts require an Internet connection as they cannot be cached on the device.

Allow user scaling – When selected, users can pinch and zoom to zoom in to and out of your document.

Use touch events – When selected, actions set in the Actions inspector default to tap events when possible. For example, a Mouse Click will be fired after a Tap without any delay.

Show tap highlight – When selected, the default tap highlight color appears when tapping elements. Tap highlight does not appear when ‘Use Touch Events’ is selected.

Home screen web app – This option allows visitors to add your web app to their iOS device’s home screen and choose a color for the status bar. To add the Apple Touch Startup images to your document, click here.

Scene Touch Actions

Scene level touch actions — such as swiping and dragging on the scene — can trigger one or more actions. Swipe actions are a great way to introduce mobile device support in your document’s navigation. For example, the following action creates a natural swiping motion between scenes. In addition to swiping up, down, left and right, you may also trigger actions from Drag events. Drag events at the scene level can control the playback of a timeline when dragging horizontally or vertically, or it may optionally trigger JavaScript. OurJavaScript API offers more options for the dragging API.

Element Touch Actions

By default, Tumult Hype optimizes events that occur on touch events. For example, a tap on a link in Mobile Safari fires only after a 300ms delay, regardless of the speed of the tap. With Use Touch Events enabled in the document inspector, tap actions fire after the finger has left the surface of the screen. The tables below provide a bit more information on these events and how they behave with or without Use Touch Events.

“Use Touch Events” Enabled

Action Name

Mouse Event

Touch Event

On Mouse Click

Mouse Click

Tap on Element

On Mouse Down

Mouse Down

`touchstart`

On Mouse Up

Mouse Up

`touchend`

On Mouse Over

Hover

n/a

On Mouse Out

End Hover

n/a

On Drag

Click and Drag

Tap and Drag

Scrolling & Touch Events: The mouse click event fires after the element has been tapped. It triggers on Touch End but will cancel if a scroll begins before that occurs. If touch events are enabled, a scrolling movement that begins on an element with a Mouse Down event, the action will fire.

“Use Touch Events” Disabled

Action Name

Mouse Event

Touch Event

On Mouse Click

Mouse Click

Emulated Mouse Event +300ms delay

On Mouse Down

Mouse Down

Emulated Mouse Event +300ms delay

On Mouse Up

Mouse Up

Emulated Mouse Event +300ms delay

On Mouse Over

Hover

n/a

On Mouse Out

End Hover

n/a

On Drag

Click and Drag

Tap and Drag

When Use Touch Events is disabled, if you begin scrolling on an element with a Mouse Down event, a Mouse Down event will not fire. For more information about touch events and emulated mouse events, please see Safari Web Content Guide: Handling Events.

Testing

Touch actions work on mobile and desktop browsers, but to really test how a touchable interface behaves, test on the mobile browser and device you’d like to support and host your document from a staging server.

Hype Reflect is a free companion iOS app that streamlines previewing Hype documents on iOS devices. When Reflect is open on an iOS device, Hype Reflect appears as a preview option alongside Safari, Chrome, and other browsers. When previewing responsive layouts in Hype Pro on an iPad 6 or larger device, Hype Reflect’s responsive design mode lets you simulate difference device sizes. Learn more about Hype Reflect and visit the Previewing Chapter. Use Mobile Safari’s developer tools to profile and test actions, events, and resources from your Mac.

Note that Hype Reflect also has a console for reading console.log(); events. When designing for touch devices, make sure your tappable elements are the right size for fingers. Read Configuring Web Applications on Apple’s support site for tips on designing for touch screens.

Tips

Exporting to different platforms and content management systems: Please see our Exporting FAQ.

Apple Touch Images: When a web page is added to the home screen of an iOS device, images may be used to define icons and startup images for the various device sizes. You may define images to use for iPhone and iPad users’ home screen icons and startup/loading images. First, add your images to your resource library, and reference them using the ${resourcesFolderName} variable. Use the code snippet below in the <head>…<head> area to load these images. Edit the contents of the <head>…<head> of your exported .html file by selecting Edit HTML Head in the Document Inspector.

Preview & Export

This chapter covers previewing your Tumult Hype document on local browsers and and exporting your document to the web.

Preview in a Browser

By default, your system’s default browser is presented as the icon for the Preview toolbar button, and clicking the button opens your current document in the default browser. Clicking the dropdown menu next to the Preview button displays a list of all common installed browsers, and choosing from any of those browsers will both preview your document in that browser and make that browser the new default for the Preview toolbar button. To preview just the current scene being edited, choose File > Preview in Browser > Preview Current Scene in Browser, or Option-click the Preview toolbar button.

To preview directly on an iOS device, please see the Hype Reflect chapter.

By default, only common browsers will be shown in the Preview menus. You prevent this filtering by disabling the “Only show recommended browsers in preview menu” option in Hype’s preferences.

Available Preview Options

Exporting

Tumult Hype exports documents to HTML5. Exporting is a one-way process; Tumult Hype will not read back any modifications made to the exported code. However, if you need to recreate a .hype document from an export, jump to the document recovery section.

Generated HTML

An .html document

Open this HTML document in your browser to see your document in action. If you need to put your content into a different document, see Embedding in Other HTML Documents.

A resources folder

This folder contains all image, video, and file resources stored in the document, along with these files:

HYPE.js — The main runtime for all Tumult Hype documents.

documentName_hype_generated_script.js — The document-specific data which defines all scenes, timelines, elements, and animations for the document.

PIE.htc — An HTML component for Internet Explorer, used in Internet Explorer 6 through 8 to improve browser compatibility. See css3pie.com for more info.

blank.gif — A special image which improves transparent GIF rendering in Internet Explorer 6 through 8.

cache.manifest — Enumerates the document’s resources for offline caching. Only present if the Create Offline Application Cache option is enabled in the Document inspector.

HYPE.ie.js — JavaScript used by IE6–8 for compatibility.

####-restorable.plist — Document restoration file which can be used to recover the original Hype document from the exported content. Learn more about this file in the Document Recovery section later in this chapter.

Export Options

At export time, there are several different options you can toggle:

Export Options

Also save .html file

If this is enabled, it will output the HTML file mentioned above. Disabling this option is useful if you’ve made modifications to the HTML file and do not want it to be overwritten, or if you have a different HTML file you are using instead.

Include text contents for search engines

When enabled, Hype will include all of the text found in your document’s elements in special hidden text elements appended to the HTML file. Those text elements help your document be indexed by Google and other search engines.

Create enclosing folder

When this is enabled, Tumult Hype will create a top-level folder which will hold the .html file and the *.hyperesources folder. Disable this option if you want Tumult Hype to only write these in the specified folder.

Show “Built with Tumult Hype”

Tumult Hype documents will show a small “Built with Hype” watermark in the lower left corner. If you disable this, the watermark will not be shown.

Image Optimization

To help minimize document size, improve compatibility with all browsers, and improve rendering on high resolution “retina” displays, Tumult Hype will by default:

Convert non-web safe images — any image that is not a PNG, JPEG, GIF, or SVG — to a PNG or JPEG. If the source image has any transparency, Tumult Hype will convert it to a PNG to preserve that transparency. Otherwise the non-web safe image is converted to a JPEG to minimize size.

Resize images so they’re only as large as is needed for the document. For example, if you use an 18 megapixel 5184px × 3456px image as the background for a 600px × 400px scene, Tumult Hype will resize the image on export and reduce the final download size by several megabytes.

Create high resolution _2x images that will be downloaded by devices with “retina” displays, if the source image is large enough. Automatically generated high resolution images are only downloaded by devices with retina displays, so they don’t affect download times for anyone else.

Convert PNGs without transparency to JPGs if doing so reduces the file size.

Given a 200px × 200px JPEG displayed as a 50px × 50px image, Tumult Hype generates a 50px × 50px image during export that is downloaded and displayed to most users. A high resolution 100px × 100px image is also generated, and is provided to users with “retina” displays.

Given a PDF displayed as a 100px × 100px image, Tumult Hype will convert the first page to a 100px × 100px PNG for standard displays as well as a 200px × 200px PNG for high resolution displays.

Given a 100px × 100px image JPG named file@2x.jpg and a 50px × 50px image named file.jpg, Tumult Hype will group the two images. The @2x image will be loaded on ‘retina’ screens, and the non-retina image will be loaded on non-retina screens.

Tumult Hype’s automatic image optimization can be disabled by choosing an image in the Resource Library and deselecting the “Automatically optimize when exporting” option. This option should be disabled if you need to access the resource using the ${resourcesFolderName} variable.

Hosting Your Document on the Web

The quickest way to host your Tumult Hype document on the web is to upload your exported .html file and the .hyperesources folder to your hosting provider. You can then visit the URL of your .html file to load your document.

For a video walkthrough on getting your Tumult Hype document on the web, please see this article.

Embedding in Other HTML Documents

Loading…

A good starting point for embedding is to set the export option to save the HTML file. The file is relatively bare-bones and contains three critical lines which will actually kick off the document:

These lines can be copied and pasted into other documents; the open/close div tags and one script tag are all you need. They reference the .hyperesources folder, which also needs to be placed at the same level as the HTML file. To open HTML files, you’ll need a HTML editor. Here are a few we recommend. Note: this example uses “documentName” as the exported document’s name, so the lines in other exported documents will be different. Please be certain to replace any instances of “documentName” with the proper document name if you’re copying directly from this example.

OAM Widget

To export your animation as an OAM widget, select this option. This format creates a package you can import to InDesign with DPS, Adobe Muse, or Dreamweaver.

Dropbox

Please note: Dropbox is disabling this service soon, and upcoming versions of Tumult Hype will not support this feature. Dropbox allows you to sync your files online and across your computers automatically. To learn more or sign up for a Dropbox account, visit dropbox.com.

All documents published to Dropbox are public, so you can easily share your work with others. Dropbox must first be set up in Tumult Hype’s application preferences. To export to Dropbox, choose File > Export as HTML5 > Dropbox. After uploading, Tumult Hype will let you view the page from Dropbox’s servers or copy the URL to share with others.

Video, Animated GIF, & PNG Sequence

Create a video, animated GIF, or sequence of PNG images of your Tumult Hype document by choosing File > Export as Movie. The export dialog which appears allows you to change the duration, frame rate, and dimensions of the video, GIF, or number of frames. Clicking Save creates the appropriate files in the location you choose.

The duration defaults to the time it will take for all animations to finish. If a loop is detected, the duration will max to five minutes. Physics-based animations do not count in the time, so manual adjustments may be required to capture all physics simulations. Timeline and scene actions can be used to extend the recordable portion of your document. For example, create a Timeline Action at the end of the Main Timeline to transition to the next scene. If the animation on your first scene was 5 seconds, and the animation on your second scene was 10 seconds, the default video duration will be 15 seconds.

Note that any audio embedded in your document is not included in either video or animated GIF exports. Also note that video exporting is only supported on OS X 10.7 “Lion” and later. For information on capturing audio please view this forum post.

Export as Movie Dialog

Export as Animated GIF Dialog

Exporting to Other CMSs and Platforms

Since Tumult Hype documents are built in HTML, Javascript, and CSS, they can be run displayed on a large number of devices. We have covered step-by-step instructions for many platforms in this Exporting FAQ.

Advanced Export

A typical Hype export includes all scenes, layouts, and resources. Advanced Export gives you full control over what Scenes, Layouts, and Resources are included in your export, and provides advanced control for situations where you require small download sizes. Let’s say you’re working on a series of three advertisements:

An example document containing three separate layouts

When you open the Advanced Export window (File > Advanced Export…) you are presented with a list of export slices representing all scenes and layouts in your document. Each slice represents a separate Hype Export complete with its own html file, resources, and Hype javascript runtime. For our advertisement example, we can quickly create three separate HTML files from a single HTML document by exporting individual layouts:

The Advanced Export Panel

The options above will create three separate folders, each containing separate HTML documents.

Slice Export Options

Each slice represents a separate exported document. To modify the options for a slice, select it from the slice list on the left hand side and modify the slice options in the box on the right. On the right side, you can select which scenes resources to include. If a resource checkbox is disabled that means it is referenced by an element or animation in one of the selected scenes.

You can add, remove, and duplicate slices by selecting a slice and selecting an option at bottom of the Advanced Export window. Rename slices by double-clicking on the slice name. Slice names define the folder within which document content is exported.

Once you define slice options, save the current options for any new slices by selecting the ‘Default Options’ dropdown at the bottom of the panel.

The following options can be set on a per-slice basis:

Support Internet Explorer 6-9 – The Hype javascript runtime contains extra code to support as many features as possible on IE 6-9. If you don’t need to support IE 6-9 you can uncheck this option to reduce the export size.

Create Enclosing Folder – Exports your document into a folder under the document name set during export.

Also save .html file – Generates an HTML file for your document.

Include text contents for search engines – Includes the full text of your document within the page for search engines.

Name as “index.html” (requires enclosing folder) – Creates an index.html file for each slice.

Inline data file+loader – Instead of generating a JavaScript file with your document, a script will be included directly on the page. The HYPE.js file will be loaded from a regular JS file.

Support Internet Explorer 6-9: Unchecking this option will reduce the code required to load your document.

Use External runtime URL: Setting a runtime URL will load runtime files from an external server. To generate runtime files, export a blank document using File > Export as HTML5 > Folder, and copy all files to your server except the generated JS file and the .plist file. Your server should contain these files:

blank.gif
HYPE-518.full.min.js
HYPE-518.thin.min.js
PIE.htc

Please note that after every Tumult Hype Upgrade, you’ll need to re-export the HYPE-###.full.min.js and HYPE-###.thin.min.js files. These are newly-generated for each version. The files blank.gif and PIE.htc will not change. There are no issues hosting multiple runtime versions in a single folder.

Create restorable document file: For more information, view #document-recovery. Does not affect final download size.

Managing Custom Slice Configurations

Creating a configuration: To create a new advanced export configuration, or slice, click the + button at the bottom left-hand corner of the panel.

Deleting: To remove a slice configuration, select the - button while a slice is selected.

Default Slices: To save a slice as the default configuration, select your slice, and select the Default Options dropdown.

Exporting Scenes or Layouts Individually

Hype will automatically generate slices for exporting each layout and scene individually. You cannot modify which scenes or layouts are included in these slices, but you can change the other export and resource options. Keep in mind you can always duplicate a slice if you want to modify it.

You can export multiple slices at the same time. Simply check the box next to any slices you wish to export and click “Export Slices”.

Slice File Size

At the bottom of the slice options you can view the estimated export size of the individual slice:

All Files – The on disk size of all files exported by the slice

@1x Download – The estimated download size on a modern web browser running on a non-retina display

@2x Download – The estimated download size on a modern web browser running on a retina display

Actual download sizes will be smaller for the majority of servers due to gzip compression. See below.

Reducing Initial Download

Advanced Export is built for bandwidth-sensitive applications such as advertising network deployments, or deployments for mobile device interfaces. Some deployments limit you based on the size of a zip file uploaded to their network, while others measure the amount of content downloaded by the end user. If you are having issues with deployment to an ad network, please visit the Advertising category in our forums. Below are a few guidelines to export with the lowest possible file size.

If you don’t require IE 6-9 support, you can save several bytes by unchecking that option during export.

Tumult Hype will automatically optimize your images to ensure a retina version will be served to retina-enabled devices. If you would prefer to bypass that optimization, uncheck ‘Automatically optimize while exporting’ while selecting that image in your Resource Library.

Prior to deploying your exported document to a server, drag and drop your resource folder into Imageoptim. This will squeeze additional bytes out of your images.

Document Recovery

By default, Tumult Hype exports a recovery file from which the original Hype document can be recreated. This file is never downloaded by users viewing your document online, so it does not impact download times. Also, the file name is randomized per-document, so that it’s not easy for someone else to download and recreate your source Tumult Hype document.

If you have lost your source Hype document, you can recover it by following these steps:

Download the exported “.hyperesources” folder.

Choose Help > Restore Document from Export and select the “.hyperesources” folder.

Choose where to save your recovered document.

The recovery process re-creates your source Hype document based on what was exported. If “Automatically optimize when exporting” is checked for images, the scaled down version will be only recoverable image available. The recovery process is no replacement for a true back up system; please use a back up system like Time Machine to protect your valuable data.

If for some reason you don’t want restorable document data included in your exports, disable this behavior by deselecting the “Create restorable document file when exporting” option in Hype’s General preferences or in the Advanced Export pane.

Additional questions?

Templates

Templates are “freeze dried” Hype documents – opening a Hype template creates a new document based on the opened template. Any document can be saved as a template by choosing File > Save Template. Once created, templates cannot be edited. Thus to change a template, you’ll want to create a new document by opening that template and then save over the old template by choosing File > Save Template.

While only the Professional edition of Hype can create templates, any edition of Hype can create new documents from templates.

Visit the Template Gallery in the forums to check out forum member-created templates.

Resources

Resources are the images, videos, JavaScript functions, and other files that have been added to a Tumult Hype document. Unlike elements, which are unique to each scene, resources are shared across the entire Tumult Hype document. When playing back in a browser, Tumult Hype documents are careful to only download one copy of each resource and share that copy across all scenes.

Managing Resources

Resource Library

Tumult Hype’s Resource Library offers control over a document’s resources. Open the Resource library by choosing View > Resource Library or clicking the Resource toolbar button. The Resource Library offers controls for filtering and searching resources, and also provides numerous controls for managing resources.

Adding Resources

Clicking the Resource Library’s Plus button provides a menu from which new files can be added to or new JavaScript functions can be created in the front-most document. Any file can be added to the Resource Library and will be included in the .hyperesources folder upon export. Images and videos in the Resource Library can be added to a scene by dragging them from the Resource Library and dropping them on the scene.

Removing Resources

Clicking the Minus button removes any resources that aren’t actively used by elements in the document’s scenes. Any images and videos that are currently used in the document cannot be deleted until all elements using those resources have first been deleted.

By default, Tumult Hype automatically deletes image and video resources when all elements using those resources have themselves been deleted. To prevent this behavior so that images and videos persist in the document even after all elements using those resources have been deleted, deselect the “Remove when no longer referenced” checkbox.

Updating Resources

Every time a file-based resource is added to a Tumult Hype document, Tumult Hype stores a copy of the file in the document and also keeps a link to the original file. Whenever the original file is modified, Tumult Hype automatically prompts to see if the copy stored in the current Tumult Hype document should be updated to match the original file outside of Tumult Hype. Clicking the Refresh button manually updates the file. Sometimes the connection between the original files and Tumult Hype’s copy is broken; this often happens when the Tumult Hype document is moved to a different computer, or if the original source file is saved under a different name. Should this happen, Tumult Hype displays a Choose dialog so you can find the original file, restore the connection, and update the current Tumult Hype document’s copy of the file.

Replacing Resources

To replace any file-based resource with a different file, click the Replace button. The Choose dialog which appears lets you pick the replacement file. This is a very powerful tool for quickly replacing all copies of an image or video across all scenes in a document.

Resource Groups

Images, videos, and audio resources all create resource groups, where one resource references multiple files. Resource groups are used to collect different file variants which may be used by the resource in different contexts. Audio and video resource groups have place holders for the different file encodings which are required by browsers, and image resource groups offer place holders for standard resolution images and “@2x” images. It’s important to note that adding additional files to a resource group will not adversely affect the document’s download time: browsers will only ever download the single file they need from a resource group, ignoring the other files in the group.

To add additional audio or video sources to a resource group, select the grayed out source in the Resource Library, click the Add Source button, and then choose the appropriate audio, video, or image file. For example, a “video/webm” resource may be added to the Video2 resource group shown on the right. Additional sources can also be dragged onto the Resource Library, and Hype will attempt to add those resources to the correct resource group.

Resource Optimization

Controlling Preloading

By default, Tumult Hype documents preload all image resources before beginning any animation. This is done to ensure viewers always see the document as it appears in Tumult Hype, with no missing images. This behavior can be disabled on a per-image basis by first choosing an image from the resource list and then deselecting the Preload checkbox. Videos are not preloaded so there is no control for this behavior.

Image Optimization

To help minimize document size, improve compatibility with all browsers, and improve rendering on high resolution “retina” displays, Tumult Hype will by default:

Convert non-web safe images — any image that is not a PNG, JPEG, GIF, or SVG — to a PNG or JPEG. If the source image has any transparency, Tumult Hype will convert it to a PNG to preserve that transparency. Otherwise the non-web safe image is converted to a JPEG to minimize size.

Resize images so they’re only as large as is needed for the document. For example, if you use an 18 megapixel 5184px × 3456px image as the background for a 600px × 400px scene, Tumult Hype will resize the image on export and reduce the final download size by megabytes.

Create high resolution “@2x” images that will be downloaded by devices with “retina” displays, if the source image is large enough. Automatically generated high resolution images are only downloaded by devices with retina displays, so they don’t affect download times for anyone else.

Given a 200px × 200px JPEG displayed as a 50px × 50px image, Tumult Hype generates a 50px × 50px image during export that is downloaded and displayed to most users. A high resolution 100px × 100px image is also generated, and is provided to users with “retina” displays.

Given a PDF displayed as a 100px × 100px image, Tumult Hype will convert the first page to a 100px × 100px PNG for standard displays as well as a 200px × 200px PNG for high resolution displays.

Tumult Hype’s automatic image optimization can be disabled by choosing an image in the Resource Library and deselecting the “Automatically optimize when exporting” option:

Advanced Resources

Including CSS and JavaScript in Document <head>

When CSS or JavaScript files are tracked by a document’s Resource Library,Tumult Hype can automatically include references to those files in the document’s header when exporting. This behavior is the default; to disable, choose the CSS or JavaScript file which should not be included in the document’s header and deselect the “Include in document <head>” checkbox.

Referencing Resources in Code

Because resources stored in Tumult Hype documents are exported into an animation’s resources, it’s possible to reliably refer to them in the document’s <head> or in JavaScript functions created within Tumult Hype.

In a Document’s <head> or an Element’s Inner HTML

Tumult Hype provides a special HTML variable, ${resourcesFolderName}, which always references the resources folder Tumult Hype creates when exporting a document. Use this this variable anywhere a URL path is expected. For example, after adding the file jquery-1.8.2.min.js to your document using the Resource Library, reference that file in your document’s head via

<script src="${resourcesFolderName}/jquery-1.8.2.min.js">

Similarly, after adding the image globe.png to your document, you could refer to the image in an element’s inner HTML with

<imgsrc="${resourcesFolderName}/globe.png">

Please note that you should deselect ‘Automatically optimize when exporting’ in the resource library to access an image resource’s original file. When exporting the document, Tumult Hype will always replace the ${resourcesFolderName} variable with the correct path.

In JavaScript Functions

Tumult Hype offers a JavaScript API for returning the string value of the document’s resources folder URL: hypeDocument.resourcesFolderURL(). Use this in any JavaScript functions to reliably access the document’s associated resources folder. For example, if the document had an image named logo.png, the image’ path could be constructed in a JavaScript function via

varlogoImagePath=hypeDocument.resourcesFolderURL()+"/logo.png";

JavaScript

Using JavaScript

Creating a new JavaScript

JavaScript functions within Tumult Hype are generally run in response to user events. In any action panel, such as the panels found in the Mouse Actions inspector, create a JavaScript function by following these steps:

Click the Plus button in the action’s header to add a new action.

Click the Action menu and choose Run JavaScript.

Click the Function menu and choose New Function.

This will open a new JavaScript Editor tab where custom JavaScript functions can be written. A sample JavaScript function looks like the following:

You can edit the name of the function by editing the “untitledFunction” portion of the code or by editing the name in the Resource Library. JavaScript function names must not start with a number. Function code can only be inserted between the curly brackets. The portion (hypeDocument, element, event) is required and therefore not editable.

JavaScript Documentation Viewer

The Documentation Viewer below the editing area can be helpful for quickly building JavaScript functions based on API functions. Tumult Hype’s Documentation Viewer provides in-app documentation for all of Tumult Hype’s JavaScript API functions, and also allows functions to be quickly inserted into the JavaScript editor. To insert any function:

Place the editor’s cursor where you want the function to be inserted.

Select the JavaScript function you wish to be inserted.

Click the Insert button to the right of the function name.

Functions can also be inserted by dragging-and-dropping them from the functions listing or by double-clicking their row.

The JavaScript Documentation Viewer

API Functions

Tumult Hype offers many JavaScript APIs to control various aspects of a document. These APIs can be called both by JavaScript functions written within Tumult Hype, and by scripts external to the document.

Document

hypeDocument.documentName()

Returns the name of the document. This value can be used in the global HYPE.documents[documentName].

hypeDocument.documentId()

Returns the id of the container div for the document. This value can be used with document.getElementId() to retrieve the container element itself.

hypeDocument.resourcesFolderURL()

Returns the string value for the document’s resources folder URL. Use this to reference assets added via the Resource Library.

hypeDocument.functions()

Returns an array of all user-defined JavaScript functions in the Tumult Hype Document.

hypeDocument.getElementById(id)

Searches the current document for the specified id (entered through the Identity inspector’s “Unique Element ID”) and returns the DOM HTML Element. This is similar to the typical document.getElementById, however the API version should be used instead as Tumult Hype may reassign ids in cases of collision.

hypeDocument.getElementProperty(element, propertyName)

Gets a property of an element based on the Hype runtime’s knowledge. The element argument must be a DOM element, generally obtained by the hypeDocument.getElementById() function.

Sets a property of an element in a manner compatible with the Hype runtime. If the optionalDuration is provided, it will perform a transition animation from the current value to the specified value over the specified number of seconds. The default value is 0.

The element argument must be a DOM element, generally obtained by the hypeDocument.getElementById() function.

Valid property names (quotes required):

'top''left''width''height''rotateZ''scaleX''scaleY''opacity''z-index'

optionalTimingFunction will default to ‘easeinout’ if not provided. Valid timing function names include (quotes required):

'easeinout''easein''easeout''linear'

To perform an instant transition, the optionalDuration does not need to be set because the value default is 0.

Example: Use the height of element 1 (tower) to match the height of another (tree) using an easeout transition over 2 seconds:

hypeDocument.currentSceneName()

Changes to the specified scene. If the optionalTransition is not specified it will default to the instant transition. See below for a list of valid transition constants.

The optionalDuration parameter is given in seconds; the default value is 1.1.

Scene names are user-defined and uniqueness is not enforced. If you are going to use this function, be sure that no two scenes in any document have the same name.

hypeDocument.showNextScene(optionalTransition)

Shows the next scene, based on the order in the scene selector interface. If the optionalTransition is not specified it will default to the instant transition. See below for a list of valid transition constants.

hypeDocument.showPreviousScene(optionalTransition)

Shows the previous scene, based on the order in the scene selector interface. If the optionalTransition is not specified it will default to the instant transition. See below for a list of valid transition constants.

Timelines

hypeDocument.startTimelineNamed('timelineName', direction)

Starts the specified timeline at the beginning for the current scene. Note: timelines are user-defined, so they are not enforced to be unique. If you are going to use this function, be sure that no two timelines in any scene have the same name!

Direction to play timeline:

hypeDocument.kDirectionForwardhypeDocument.kDirectionReverse

Note: this function was named hypeDocument.playTimelineNamed(timelineName) in Tumult Hype 1.5 and earlier.

hypeDocument.pauseTimelineNamed('timelineName')

Continues the specified timeline in the direction specified where it left off for the current scene. Note: timelines are user-defined, so they are not enforced to be unique. If you are going to use this function, be sure that no two timelines in any scene have the same name!

By default, continue will not start the timeline over if it is at the end. To change this behavior pass true for canRestartTimeline.

Direction to play timeline:

hypeDocument.kDirectionForwardhypeDocument.kDirectionReverse

An example that plays the Main Timeline of the current scene in the forward direction and will start the timeline over if the end has already been reached: hypeDocument.continueTimelineNamed('Main Timeline', hypeDocument.kDirectionForward, true)

hypeDocument.goToTimeInTimelineNamed(timeInSeconds, 'timelineName')

Jumps to a specific time in the specified timeline for the current scene.

.

hypeDocument.currentTimeInTimelineNamed('timelineName')

Returns the current time of the specified timeline in seconds.

hypeDocument.durationForTimelineNamed('timelineName')

Returns the duration of the specified timeline in seconds.

hypeDocument.currentDirectionForTimelineNamed('timelineName')

Returns the playback direction of the specified timeline.

Possible return values:

hypeDocument.kDirectionForwardhypeDocument.kDirectionReverse

hypeDocument.isPlayingTimelineNamed('timelineName')

Returns true if the timeline is playing and false if it is not.

Timeline names are user-defined and uniqueness is not enforced. If you are going to use these functions, be sure that no two timelines in any scene have the same name.

Symbols

For an explanation of Symbols jump to the Symbols documentation chapter.

hypeDocument.getSymbolInstanceById(id)

Returns the symbolInstance for the symbol with the specified id.

The symbol instance can be used to control timelines in the symbol. See the Symbol Instances section for more information.

hypeDocument.getSymbolInstancesByName(symbolName)

Returns all symbolInstances with the specified name. A symbol’s name can be found in the Symbol Library. The symbol instance can be used to control timelines in the symbol. See the Symbol Instances section for more information.

Symbol Instances

symbolInstance.getSymbolInstancesByName(symbolName)

Returns all symbolInstances with the specified name that are children of symbolInstance.element(). A symbol’s name can be found in the Symbol Library.

symbolInstance.symbolName()

Returns the name of the symbol.

symbolInstance.element()

Returns the element representing the symbol.

symbolInstance.startTimelineNamed(timelineName, direction)

Starts the specified timeline at the beginning for the symbol. Note: timelines are user-defined, so they are not enforced to be unique. If you are going to use this function, be sure that no two timelines in the symbol have the same name!

Direction to play timeline:

hypeDocument.kDirectionForwardhypeDocument.kDirectionReverse

symbolInstance.pauseTimelineNamed(timelineName)

Pauses the specified timeline for the symbol. Note: timelines are user-defined, so they are not enforced to be unique. If you are going to use this function, be sure that no two timelines in the symbol have the same name!

symbolInstance.continueTimelineNamed(timelineName, direction)

Continues the specified timeline where it left off for the symbol. Note: timelines are user-defined, so they are not enforced to be unique. If you are going to use this function, be sure that no two timelines in the symbol have the same name!

Direction to play timeline:

hypeDocument.kDirectionForwardhypeDocument.kDirectionReverse

symbolInstance.goToTimeInTimelineNamed(timeInSeconds, timelineName)

Jumps to a specific time in the specified timeline for the symbol. Note: timelines are user-defined, so they are not enforced to be unique. If you are going to use this function, be sure that no two timelines in the symbol have the same name!

symbolInstance.isPlayingTimelineNamed(timelineName)

Dragging

JavaScript functions invoked by the On Drag handler can gather information about the current drag gesture.

event['hypeGesturePhase']

When receiving a callback for the On Drag event with the Run Javascript… action the event object also offers information about whether the current drag gesture has just started or ended, was canceled, or the coordinates were updated. To get that state, access the hypeGesturePhase property in the event object:

Invoking API from outside of Tumult Hype

To access the Tumult Hype API from a JavaScript outside of the embedded document, you can use the global Tumult Hype object:

HYPE.documents[documentName]

The document may not be an exact match for the filename. To figure out the value, you can look inside the exported Resources folder for the *_hype_generated_script.js file and find the document’s name there. You can also call the hypeDocument.documentName() function from within a JavaScript action to determine it.

Events

To help external JavaScripts integrate and interact with embedded documents Tumult Hype offers an event callback system, allowing external JavaScript functions to be triggered in response to events in embedded documents. One purpose for an externally invoked event would be to jump between scenes using controls outside of your Tumult Hype document for a slideshow. At this time, four event callbacks are offered, so functions can be registered for document loading, scene loading and unloading, and timeline completion:

HypeDocumentLoad HypeSceneLoad HypeSceneUnload HypeTimelineComplete

The HypeTimelineComplete event also adds a name property to the event object, so you can determine which timeline raised the event.

Examples

The following example registers an event to be run after the HypeDocumentLoad event has occurred:

<script>functionmyCallback(hypeDocument,element,event){// display the name of the Hype container and the event calledalert("id: "+element.id+" type: "+event.type);// show the scene named SecondScenehypeDocument.showSceneNamed('SecondScene');// return false so it does not load the initial scenereturnfalse;}if("HYPE_eventListeners"inwindow===false){window.HYPE_eventListeners=Array();}window.HYPE_eventListeners.push({"type":"HypeDocumentLoad","callback":myCallback});</script>

The following line in the above JavaScript receives the HypeDocumentLoad event callback:

In the above code, HypeDocumentLoad is the event for which the callback should be triggered, and myCallback is the JavaScript function which should be invoked by the event. This JavaScript can be invoked outside of Tumult Hype, and can potentially be placed within the <head>...</head> of the exported .html file generated by Tumult Hype by clicking on ‘Edit HTML Head’ in the Document Inspector. To see this function in action, download this example file. When previewed in a browser, the code in the document’s head will load the second scene and an additional timeline on that scene.

<buttontype="button"onclick ="HYPE.documents['scenes-transitions'].showSceneNamed('Scene2',HYPE.documents['scenes-transitions'].kSceneTransitionPushRightToLeft);">
Show Scene 2 (Push Right to Left)
</button>

Switch to a scene named Red from a document named HypeExample using the Push Right to Left transition:

<ahref="#"onclick="HYPE.documents['HypeExample'].showSceneNamed('Red',HYPE.documents['HypeExample'].kSceneTransitionPushRightToLeft);">Go to the Red Scene.

Switch to the next scene in a document named HypeExample using the Crossfade transition:

<ahref="#"onclick="HYPE.documents['HypeExample'].showNextScene(HYPE.documents['HypeExample'].hypeDocument.kSceneTransitionCrossfade);">Crossfade to next Scene</a>.

Note: Because the HYPE global variable may not be available immediately after HTML document has been loaded, this is the only reliable way to trigger external JavaScript functions in response to an embedded Tumult Hype document being loaded.

JavaScript Forums

The JavaScript category of the Tumult forums contains a wide assortment of code samples and example documents. The Hype Extension Project, for example, covers several powerful functions to extend Tumult Hype’s functionality with the help of the JavaScript API.

Inspectors

Inspectors are accessible from the View menu, or by clicking the Inspector toolbar button. Document and Scene inspectors establish rules and settings for the document and scene. The Metrics, Element, Symbol, Text, Mouse Action, and Identity inspectors become active when selecting one or more elements or symbols. Tumult Hype Pro includes two additional inspectors to modify symbol and physics properties.

Document Inspector

The Document inspector provides many controls for initial document setup.

HTML Page Title – Defines the title of the exported HTML document. By default, the title is the same as the exported file name.

Options

Show Loading Indicator – Controls the display of a loading indicator. When enabled, the Tumult Hype document will display “Loading…” as the document’s image resources are downloaded and cached. For tips on customizing the preloading screen, please read our support article on Custom Preloaders.

Create offline application cache – When selected, Tumult Hype generates a cache manifest file for resources used in your project. With this option selected, your document, when loaded as a web app, will download and locally save everything needed to ensure the document works even when the device is offline. Note: Your document will need to be loaded once as a web app to prime the cache. Also, Google fonts require an Internet connection as they cannot be cached on the device.

Edit the Head HTML – Clicking this button opens an HTML editor, allowing the editing of the document’s <head>. Any changes made to the document’s header are represented in Tumult Hype’s scene editor and are also included when the document is exported.

Advanced Options

Protect from External Styles - When unchecked, elements will not be protected from CSS styles defined outside of your Tumult Hype document.

Use Webkit Graphics Acceleration – When selected, animations can use the system’s GPU when displayed in Webkit-based browsers, which includes Safari, Mobile Safari, and Chrome. This almost always leads to better animation performance, but some browsers or devices may have problems properly rendering accelerated content. If you see rendering problems, try deselecting this option.

Position with CSS left/top - When checked, elements animate using CSS’s left & top values. Check this box if you are manipulating element positions directly with JavaScript or with Jquery.

Mobile Options – These options set properties on the exported .html page

Allow user scaling – When selected, users can pinch and zoom to zoom in to and out of your document.

Use touch events – When selected, actions set in the Actions inspector default to tap events when possible. For example, a Mouse Click will be fired after a Tap without any delay.

Home screen web app – This option allows visitors to add your web app to their iOS device’s home screen and choose a color for the status bar. To add the Apple Touch Startup images to your document, click here.

Show Browser Compatibility Warnings – Warnings for browsers equal to or older than the selected version will be shown. Changing settings here will not affect document compatibility, only the warnings reported by Tumult Hype. Documents created with Tumult Hype always have the best possible compatibility with all browsers. Use the Advanced Export feature to turn off IE compatibility.

Scene Inspector

Width and Height – Control over the exact width and height of the document, in pixels. The scene size adjusts the size of all scenes unless ‘Apply changes to all scenes’ is unchecked. - Use a percentage-based width or height to use Flexible Layouts

Scale – Controls whether the document should scale horizontally and/or vertically. When enabled, the controls offer the ability to specify how much of the containing window or div the Hype document should expand to fill. See the Flexible Layout Chapter to learn more.

Responsive Layout

By default, scenes only have one layout that layout is always displayed regardless of the browser’s width. To take advantage of Hype Pro’s responsive layouts, click the Add New Layout button and add layouts as desired. The “Breakpoint width” field is used to control which layout is displayed for a given browser width. Read more about Responsive Layouts.

Breakpoint width - Sets the breakpoint width of the current responsive layout.

Add New Layout… - Adds an additional layout.

Animation Timelines

This area displays the timelines on the current scene, their duration, and toggles whether timelines are relative or absolute. (Learn more about relative and absolute timelines. Add timelines to the current scene by clicking the Plus button; remove them by clicking the Minus button. Rename timelines by double clicking on their name.

Background – Sets the background color of the current scene. Scene colors set on the first scene sets the background color of the exported .html file.

Symbol Inspector

Hype replaces the Scene inspector with the Symbol inspector when you are actively editing a symbol’s content. Double click a symbol to enter editing mode and display this inspector.

Type

Standard - Standard symbols can have multiple instances in a scene and exist within the scene itself just as normal elements do.

Persistent - Persistent symbols can only exist once on a scene and, unlike elements or standard symbols, exist outside of scenes. As such, they are not destroyed when scenes change, and can even be displayed while a scene transition happens.

Automatically add to new scenes - New scenes will contain the selected persistent symbol when the scene is created.

Display on top during scene transition: No matter the layer order of the symbol, it will appear above all elements during scene transitions.

Metrics Inspector

The Metrics inspector controls size, content overflow behavior, placement, and rotation properties of selected elements. While rotation, position, and scaling can all be manipulated directly in the scene area with mouse controls, this inspector offers fine tuning and may be more useful during multiple selection.

Content Overflow – Determines how text and inner elements are displayed when it extends beyond the bounds of the element, and whether a scroll bar should appear.

Scales up or down the selected selected element(s) or group. This uses CSS’s transform:scale() property.“ Setting negative values in either dimension will flip the element. To scale width or height independently, uncheck Constrain ratio. To reset scale to 100%, click the Original Size button.

Flexible Layout

Selecting and deselecting the pins and scaling arrows define how selected elements should behave as the exported Hype document is resized. For more information, please see the Flexible Layout chapter.

Scaling Behavior – Defines how elements should resize. In particular, offers control over how proportionally sized elements, like images, should be resized to preserve their aspect ratio.

Rotation

Sets the X, Y, and Z rotation angles. At this time only one rotation angle may be selected at one time. Negative values like -180° or values exceeding 360° are accepted. For example, to set a new rotation value for three full rotations clockwise, use 1080°.

Rotation follows motion path – When selected, element will rotate with the direction of a motion path. Rotation angles may be applied in addition to this setting.

Transform Origin – Sets the X and Y offset percentages for the selected element’s rotation and scale origin. This setting can also be adjusted by selecting an element, holding command, and adjusting the center point.

Element Inspector

The Element inspector contains stylistic properties for the selected element or elements.

Background Fill Style – Sets the background style as either an Image, Fill, Gradient, or None.

Gradients contain two colors (with or without alpha transparency) and may be rotated.

Images may be scaled to fit the element, repeated horizontally, or repeated vertically.

Border – Creates a border with the selected style (None, Solid, Double, Dotted, Dashed, Groove, Ridge, Inset, Outset) around the selected element. The border and radius of an element’s four sides and corners can be set in this panel, as well as the color and style of the border. The padding setting controls the distance between the border and the element.

Visibility – A value of 0% opacity sets selected elements as completely invisible. Note: An element with a 0% opacity will interfere with mouse actions on elements ordered below it in the scene. For an element to respond to mouse actions at a region in the document, it must not be covered by any other element, visible or invisible, at that point.

Display - Toggles the visibility of the selected element(s).

Shadow - Simulates a box shadow of the selected element, with settings for its color, position, and blur radius amount.

Foreground - Setting values on foreground filter effects will modify the element’s blur, sepia, saturation, hue, brightness, or contrast. Backdrop - These properties define how elements underneath the selected element appear. Your element must have a opacity value under 1.0 to perceive these effects. Lower the opacity slider at the bottom of the color picker to add transparency to your element. Note: Supported in iOS 9+ and Safari 9+ - Reflection – This property creates a reflection of the selected element, with optional depth and offset values.

Dynamic - Full physics body: Gravity settings for the scene affect dynamic physics bodies on scene load. These elements will collide with other dynamic bodies and static bodies on the same scene.

Physics Properties

Bounce: Controls the elasticity of the element’s collisions. A value of zero means the element is inelastic and will not bounce in a collision; the higher the value, the more the element will bounce.

Friction: Sets the coefficient of friction for the element. A value of zero means the element will not slow down as it moves through the scene, while a higher value means it will slow more quickly as it moves.

Density: Changes an element’s mass and thus how the element will affect other elements during a collision. Mass is determined by an element’s size and density. A larger, less dense element can have the same mass as a smaller, more dense element.

Air Drag: The friction air provides when an object falls. A beach ball would have high air drag and a bowling ball low air drag.

Scene/Symbol Physics Gravity

Force: Sets the strength of gravity in the scene or symbol. 1.0 is Earth-like.

Angle: Controls the direction of gravity. The default value of 180° pulls affected elements to the bottom of the scene.

Control gravity with device tilt: When enabled, the direction of gravity is controlled by the devices orientation angle so that tilting the device will change the direction of gravity.

Identity Inspector

The identity inspector provides access to metadata for elements and information for screen reading technologies:

Alternate Text – Sets the alt tag and accessibility title for images and the title tag for divs. Setting this value is useful for accessibility and for displaying tooltips.

Include in keyboard Navigation- Sets the tab index value for the selected element.

Display Name – Sets the element’s name in the element list.

Unique Element ID – Sets the element’s ID for accessing the element directly in a custom function or JavaScript. Please see the JavaScript chapter for more details.

Class Name - Sets a CSS class name for the element.

Example: A button with the ‘Alternate Text’ set to ‘Next Scene’, a ‘Tab Index’ value of 6, and a Unique element id set to ‘nextscene-button’ will output the following HTML during export:

Editing Motion Paths

Action

Shortcut

Add control points to (or remove them from) previously selected control points

Command–click control point

Add selected point and all in-between points to the selected control points

Shift–click control point

Convert a rounded control point into a corner control point

Option–click control point

Constrain movement of control handles to 45° angles

Shift–drag control handle

Keep control handles equidistant from control point

Option–drag control handle

Move one control handle independent from its counterpart

Command–drag control handle

Using the Inspector

Action

Shortcut

Show the Document Inspector

Command–1

Show the Scene Inspector

Command–2

Show the Element Inspector

Command–3

Show the Metrics Inspector

Command–4

Show the Text Inspector

Command–5 or Command–T

Show the Mouse Action Inspector

Command–6

Show the Physics Inspector

Command–7 (Pro)

Show the Identity Inspector

Command–7 (Standard) or Command-8 (Pro)

Version History

How to Update Tumult Hype

Purchased through the Mac App Store

If you purchased Tumult Hype through the Mac App Store, you can install the latest update by following these steps:

Open the App Store by going to the Apple menu and selecting App Store

Click the Updates tab at the top of the App Store window

Tumult Hype should be listed in the Updates section, and clicking the Update button will install the latest update for free.

If Tumult Hype isn’t listed in the Updates section, it’s either not installed at all or the latest version is already installed. If you are having issues, please try restarting your computer and signing out of the App Store application. Then, sign in again and check the Updates tab.

Purchased through the Tumult Store

If you purchased Tumult Hype through the Tumult Store, you can install the latest update by following these steps:

JavaScript APIs for setting/getting timeline direction, getting the current time, getting a timeline’s playback state, getting a timeline’s duration, setting a scene transition’s duration, reversing playback, and relaying out a document

Pixel positions displayed when moving guides

Distribute Within Selection menu item

More clear indication of when recording

Group single objects

Timeline actions are always shown

Linen texture begone!

Exporting creates a restorable document file which can be loaded from the Help menu

Document inspector control to edit HTML page title

Added a preset document size for Tumblr

Viewport initial-scale=1.0 option

Changed viewport options

A drag action is no longer cancelled if a second finger touches the screen

Changing relative timelines will mark the document as dirty

Deleting a completely blank scene does not warn about deletion

Opens scene selector when pasting scene

Fixed an errant audio warning when having wav and mp3 sources

Fixed 2.0.1 regression where you can only type one character at a time in the Resource Library search field

Selection box does not display if selection drag starts on a locked element

Scene size takes into account 3D rotated elements

Scene now allows selection of elements which were animated beyond the scene bounds

Fixed issue in IE where background images could be sized wrong with padding

Fixed issue where padding would inset background images

Adding a border no longer offsets element

Feedback Reporter supports large files

Feedback Reporter attempts to resend on failure

Fixed issue where rotation selection handle could show up when it isn’t supposed to

Fixed issue where playhead could be in wrong position when retiming animation

Can now move guides while editing text

Changing a scene name immediately changes the window title

Fixed issue where adding media to a group in the resource library would not be reflected in the inspector

Update files dialog cannot be resized too small

Motion paths always show animation segments even if they start/stop at the same spot

Improved export checkbox spacing

Prevents a ‘Control Position’ drag from moving elements off the scene

Videos will now always be added and autoplayed on the main timeline

Fixed issue with animating blurs jiggling

Can now get HypeSwipeAction event types in JavaScript

Tapping on a scene with a drag will no longer cause the drag to be fired

Alphabetically sorts the JavaScripts in the Run JavaScript action popup

Tweaked look of timeline action bar

Fixed bug where hit area for motion path targets was too large when zoomed in

Improved audio context resource usage by our runtime

Fixed UI inconsistency of preview drop-down menu not acting like a dropdown

“Clear Recently Previewed Devices” is disabled if there were none

Reveal in Resource Library works better when there are groups

Fixed issue where elements below a hidden group weren’t selectable

Fixed bug where tabbing out of the document size settings wouldn’t show the “px” or “%” indicator

Fixed bug where editing the timecode view could change the color of an element

Fix crash when exporting a document with SVGs

Fix crash when reverting document

Dragging in a PDF now works correctly, and will be automatically optimized

Smoother rotation animations within Hype

Fixed issue where Inner HTML might display differently in Hype than in Exports

Using Command-Control-K to set Capo will turn on recording if it was off

Hardening against Resource Library corruption

Fixed bug where clicks in Chrome on Windows 8.1 would not register

Removed Retina versions of document size defaults since we better support Retina images

Fix some top crashes

Buttons with drag handlers will now exit the pressed state

Resource Library does not allow opening in external editor when using the Quick Look feature

Rotation now works correctly in IE 9

Fixed issue where a warning would incorrectly appear when making a motion path

Go to time will now more aggressively set properties from the timeline

Fixed regression where

${resourcesFolderName} was not being substituted in JavaScript - Fixed an issue where log file could grow too large - Fixed bug where audio would not play in Chrome 32+

2.0.2 - November 14, 2013

Fix audio not working on Firefox 25

Workaround for issue where iBooks would crash with audio by using HTML5 audio instead of the Web Audio API

Fix issue where a non-preloaded audio would require two taps to play on iOS

Fix issue where audio would not play in an epub in iBooks on iOS

Rotation follows motion path now works on IE6-8

If “Draw scene backgrounds” is unchecked it will not set a document background color

Fix issue where scene does not fully transition out on scene unload

Fix an issue where Go to Time in Timeline may not work correctly

Fix issue where scrolling won’t work if a mouse event is set

Does not show incorrect browser warning when having wav and mp3

Fix error when uploading documents via Feedback Reporter on 10.9

2.0.1 - September 30, 2013

Fixed crashes

Cache manifest will now work when resources have spaces in their filename

Fixed bug where timelines would not run on scene unload

Fix exception when using custom fonts with IE 6-8

Typekit fonts will now preview within Hype if “localhost” is set on the kit as a valid server

Fixed bug where fonts would be duplicated when reverting document

Quick Look preview properly shows mulitple scenes

Fixed bug where elements would not move and rotate along path in Safari 5.1

Fixed bug where text alignment could be wrong in new text boxes

Fixed issue where QuickTime videos would not play in Chrome

Some motion paths animate more smoothly

Timelines triggered in the kHypeGesturePhaseEnd can animate properties from the drag timeline

Fixed HTML Widget positioning on Safari 6.1 and 7

Fixed a bug where videos with autoplay might not play at the right time

No longer draws non-animating segments in the timeline when motion paths are active

Documentation viewer has the right URL for gestures

Fixed issue where edited text would jump to the bottom when adding a font

Fixed regression where SVGs could not be replaced with SVGs in the Resource Library

Fixed bug where scrolling would be off after expanding a group in the timeline view

Fixed bug where play sound timeline action would be pre-populated with last action

Fixed issue reverting with certain head HTML

Editing Head HTML now marks a document as dirty

Reverting Head HTML now works correctly

Fixed bug where selection halo may be incorrect when using motion paths

Fixed bug when scrollbars may not appear correctly when toggling system display preference

Fixed typo mentioning “Hype Preview” instead of “Hype Reflect”

Disable “Use touch events” in the document inspector when no documents are active