Accessibility
 
Home > Products > Director > Support > Lingo, Behaviors and Parent Scripts
Macromedia Director Support Center - Lingo, Behaviors and Parent Scripts
QuickTime VR Lingo for Director

The following Lingo controls QuickTime VR functionality.

enableHotSpot

Syntax enableHotSpot(sprite whichQTVRSprite , hotSpotID , trueOrFalse )
 
Description  QTVR command; determines whether the specified hot spot for the specified QTVR sprite is enabled ( TRUE ), or disabled ( FALSE ).

fieldOfView

Syntax fieldOfView of sprite whichQTVRSprite
 
Description  QTVR sprite property; gives the specified sprite's current field of view in degrees.

This property can be tested and set.

getHotSpotRect()

Syntax getHotSpotRect( whichQTVRSprite , hotSpotID)
 
Description  QTVR function; returns an approximate bounding rectangle for the hot spot specified by hotSpotId. If the hot spot doesn't exist or isn't visible on the Stage, this function returns rect(0, 0, 0, 0) . If the hot spot is partially visible, this function returns the bounding rectangle for the visible portion.

hotSpotEnterCallback

Syntax hotSpotEnterCallback of sprite whichQTVRSprite
 
Description QTVR sprite property; contains the name of the handler that runs when the cursor enters a QTVR hot spot that is visible on the Stage. The QTVR sprite receives the message first. The message has two arguments: the me parameter and the ID of the hot spot that the cursor entered. The property accepts or returns the handler name as a symbol.

To clear the callback, set this property to 0.

To avoid a performance penalty, set a callback property only when necessary.

This property can be tested and set.
 

See Also  hotSpotExitCallback , nodeEnterCallback , nodeExitCallback , triggerCallback

hotSpotExitCallback
hotSpotExitCallback of sprite whichQTVRSprite
 

Description  QTVR sprite property; contains the name of the handler that runs when the cursor leaves a QTVR hot spot that is visible on the Stage. The QTVR sprite receives the message first. The message has two arguments: the me parameter and the ID of the hot spot that the cursor entered. The property accepts or returns the handler name as a symbol.

To clear the callback, set this property to 0.

To avoid a performance penalty, set a callback property only when necessary.

This property can be tested and set.
 

See Also  nodeEnterCallback , nodeExitCallback , triggerCallback

motionQuality

Syntax motionQuality of sprite whichQTVRSprite
 
Description  QTVR sprite property; the codec quality used when the user clicks and drags the QTVR sprite. The property's value can be #minQuality , #maxQuality , or #normalQuality.

This property can be tested and set.

node

Syntax node of sprite whichQTVRSprite
 
Description  QTVR sprite property; the current node ID displayed by the sprite.

This property can be tested and set.

nodeEnterCallback

Syntax nodeEnterCallback of sprite whichQTVRSprite
 
Description  QTVR sprite property; contains the name of the handler that runs after the QTVR movie switches to a new active node on the Stage. The message has two arguments: the me parameter and the ID of the node that is being displayed. The property accepts or returns the handler name as a symbol.

The QTVR sprite receives the message first.

To clear the callback, set this property to 0.

To avoid a performance penalty, set a callback property only when necessary.

This property can be tested and set.
 

See Also  hotSpotEnterCallback, hotSpotExitCallback, nodeExitCallback , triggerCallback

nodeExitCallback

Syntax nodeExitCallback of sprite whichQTVRSprite
 
Description  QTVR sprite property; contains the name of the handler that runs when the QTVR movie is about to switch to a new active node on the Stage. The message has three arguments: the me parameter, the ID of the node that the movie is about to leave, and the ID of the node that the movie is about to switch to. The property accepts or returns the handler name as a symbol.

The value that the handler returns determines whether the movie goes on to the next node. If the handler returns #continue , the QTVR sprite continues with a normal node transition. If the handler returns #cancel, the transition doesn't occur and the movie stays in the original node.

Set this property to 0 to clear the callback.

The QTVR sprite receives the message first.

To avoid a performance penalty, set a callback property only when necessary.

This property can be tested and set.
 

See Also  hotSpotEnterCallback, hotSpotExitCallback, nodeExitCallback , triggerCallback

nudge

Syntax nudge(sprite whichQTVRSprite , #direction )
 
Description  QTVR command; nudges the specified QTVR sprite in the direction specified by #direction. Possible values for #direction are #down , #downLeft , #downRight , #left , #right , #up , #upLeft , and #upRight .

The nudge command has no return value.

pan

Syntax pan of sprite whichQTVRSprite
 
Description  QTVR sprite property; the current pan of the QTVR movie. The value is in degrees.

This property can be tested and set.

ptToHotSpotID()

Syntax ptToHotSpotID( whichQTVRSprite , point )
 
Description  QTVR function; returns the ID of the hot spot, if any, that is at the specified point. If there is no hot spot, the function returns 0 .

staticQuality

Syntax staticQuality of sprite whichQTVRSprite
 
Description  QTVR sprite property; specifies the codec quality used when the panorama image is static. Possible values are #minQuality , #maxQuality , and #normalQuality.

This property can be tested and set.

swing()

Syntax swing ( whichQTVRSprite, pan, tilt, fieldOfView , speedToSwing )
 
Description  QTVR sprite function; swings a QT3 sprite containing a VR Pano around to the new view settings. The swing is a smooth, camera dolly effect.

whichQTVRSprite—Sprite number of the sprite with the QTVR member.
pan—New pan position, in degrees.
tilt—New tilt, in degrees.
fieldOfView—New field of view, in degrees.
speedToSwing—Rate at which the swing should take place, an integer from 1 to 10 (slow to fast). This parameter works only in Director 7.

The function returns immediately, but the sprite continues to change view until it reaches the final view. The duration required to change to the final settings varies depending on machine type, size of the sprite rect, color depth of the screen, and other normal performance effecting parameters.

To check if the swing has completed, check if the pan of sprite has arrived at the final value.
 

See Also  pan

tilt

Syntax tilt of sprite whichQTVRSprite
 
Description  QTVR sprite property; the current tilt, in degrees, of the QTVR movie.

This property can be tested and set.

triggerCallback

Syntax triggerCallback of sprite whichQTVRSprite
 
Description  QTVR sprite property; contains the name of the handler that runs when the user clicks a hot spot in a QTVR movie. The handler is sent two arguments: the me parameter and the ID of the hot spot that the user clicked. The property accepts and returns the handler name as a symbol.

The value that the handler returns determines how the movie processes the hot spot. If the handler returns #continue , the QTVR sprite continues to process the hot spot normally. If the handler returns #cancel , the default behavior for the hot spot is canceled.

Set this property to 0 to clear the callback.

The QTVR sprite receives the message first.

To avoid an performance penalty, set a callback property only when necessary.

This property can be tested and set.
 

Example  This statement sets the callback handler for a QTVR sprite to the handler named MyHotSpotCallback when the playback head first enters the sprite span. Every time that hot spot is triggered, the MyHotSpotCallback handler is executed. When the playback head leaves the sprite span, the callback is canceled.

property pMySpriteNum 
 on beginSprite 
 	set pMySpriteNum = the spriteNum of me 
 	set the VRtriggerCallback of sprite pMySpriteNum = #MyHotSpotCallback 
 end 

 on MyHotSpotCallback me, hotSpotID 
 	put "Hotspot"&&hotSpotID&&"was just triggered" 
 end	 
 on endSprite me 
 	set the VRtriggerCallback of sprite pMySpriteNum = 0 
 end

warpMode

Syntax warpMode of sprite whichQTVRSprite
 
Description  QTVR sprite property; specifies the type of warping performed on a panorama.

Possible values are #full , #partial , and #none .

This property can be tested and set. When tested, if the values for the static and motion modes differ, the property's value is the value set for the current mode. When set, the property determines the warping for both the static and motion modes.

To Table of Contents Back to Previous document