Error getting tags :
error 404Error getting tags :
error 404 visual effect | revDocs | RunRev
Welcome Guest (Log in)
Product Edition
visual effect
Expander triangle

visual [effect] effectName [speed] [to finalImage] [with sound audioClip] [and param_1 value_1 and ...]

Platform Support
MacOS,Mac OS X,Windows,Linux
None required
Adds a transition effect to navigation between cards.

visual effect dissolve
visual effect iris close slowly
visual effect zoom close with sound "Cheers"
visual effect wipe up to black with sound "doom.wav"

Additional Comments
Expander triangle

Use the visual effect command to add a special effect the next time there is a move to another card.


The effectName is either an encoded QuickTime special effect description generated by the answer effect command, the name of a Core Image Transition Effect, or one of the following:

* plain

* dissolve

* checkerboard

* venetian blinds

* iris close or iris open

* zoom close, zoom in, zoom open, or zoom out

* barn door close or barn door open

* scroll up, scroll down, scroll right, or scroll left

* wipe up, wipe down, wipe right, or wipe left

* push up, push down, push right, or push left

* reveal up, reveal down, reveal right, or reveal left

* shrink to bottom, shrink to center, or shrink to top

* stretch from bottom, stretch from center, or stretch from top

The speed is one of very slow, slow, normal, fast, or very fast. If no speed is specified, the visual effect takes place at normal speed.

The finalImage is one of black, white, gray, inverse, or card.

The audioClip is a reference to an audio clip in an open stack, or the file path of a sound file. The sound is played during the transition.


When you issue a visual effect command, it is stored to be used the next time you navigate to another card in the same window with the go, find, or pop command. Usually, you place the visual effect command immediately before these commands in a handler, like this:

visual effect dissolve -- sets up the effect

go to card "Index" -- effect is seen during the "go"

However, it is not necessary to execute the navigation command immediately; the visual effect is stored and used the next time you navigate. You can even issue a visual effect command in one handler and the navigation command in another handler. All visual effects are cleared when all pending handlers exit.

The visual effect command affects only navigation within a window. If you want to create a transition effect when moving between stacks, use the window form of the go command:

visual effect wipe down

go stack "Index" in window "Part 2" -- replaces stack on screen

You can issue more than one visual effect in order to "stack up" several effects. All the pending visual effects are executed in the order they were issued during the card transition. This example makes the card appear to shrink and then re-expand:

visual effect shrink to center to black

visual effect stretch from center to card

go card "Showoff"

The speed of visual effects is controlled by the setting of the effectRate property.

To execute a visual effect without moving to another card, lock the screen, make any changes you want to the card's appearance, and use the unlock screen with visual effect form of the lock screen command.

Visual effects do not affect the rectangle of a player whose alwaysBuffer property is set to false. For visual effects to be seen in a player's rectangle, the player's alwaysBuffer must be true.

All visual effects will function correctly on stacks with a deep mask. In this case, the alpha channel is taken into account and will move with the colour of the pixel. For example, a Core Image ripple effect will appear to ripple the actual window itself, not just its contents.

If either the dontUseQT or dontUseQTEffects property is set to true, only the built-in visual effects can be used, and the additional effects generated by the answer effect command are not available.

For technical information about QuickTime special effects, see Apple Computer's QuickTime developer documentation at <>.

The Core Image visual effects are only available on MacOS 10.4 and later. For technical information about these effects, see Apple Computer' Core Image developer documentation <>.

Changes to Revolution:

The ability to use QuickTime special effects was introduced in version 1.1. In previous versions, only the built-in visual effects listed in the Parameters section were available.

The ability to use Core Image transition effects together with the enhanced syntax for parameter passing was introduced in version 2.6.

User Comments
Expander triangle