Module:Compass

From PanoZona

Contents

Compass
Author Marek Standio
Module version 1.2
Compatibility SaladoPlayer 1.0 +

Simple module that displays geographical direction inside panorama.

Configuration structure

Configuration details

Compass

Attribute TypeSub-attribute TypeDefaultValuesDescription
path S - - path to swf file Mandatory attribute. Value points to module swf file.

settings

Attribute TypeSub-attribute TypeDefaultValuesDescription
path S - - path to image description
rotateNeedle B - true true, false description

window

Attribute TypeSub-attribute TypeDefaultValuesDescription
open B - true true, false Determines visibility of module window on SaladoPlayer start.
alpha N - 1.0 0.1 to 1.0 Transparency of module window content.
align O horizontal S left left, center, right Horizontal alignment of module window against panorama window.
vertical S bottom top, middle, bottom Vertical alignment of module window against panorama window.
move O horizontal N 0 - Number of pixels module window is moved horizontally.
vertical N 0 - Number of pixels module window is moved vertically.
transition O type S fade fade, slideUp, slideDown, slideLeft, slideRight Determines kind of transition used when module window is opening/closing.
openTween O transition F Linear.easeNone avaible functions Determines type of animation used when module window is opening.
time N 0.5 - Duration in seconds of module window opening animation.
closeTween O transition F Linear.easeNone avaible functions Determines type of animation used when module window is closing.
time N 0.5 - Duration in seconds of module window closing animation.
onOpen S - - action id Action executed when module window changed state to closed.
onClose S - - action id Action executed when module window changed state to opened.

close

Attribute TypeSub-attribute TypeDefaultValuesDescription
path S - - path to image file Image file that will be used as close button. If path is not set, close button will not be added.
align O horizontal S right left, center, right Horizontal alignment against module window.
vertical S top top, middle, bottom Vertical alignment against module window.
move O horizontal N 0 - Number of pixels close button is moved horizontally.
vertical N 0 - Number of pixels close button is moved vertically.

Functions

setOpen

TypeDescriptionFunction description
B Value assigned to open attribute. Opens / closes map window on demand. Opening window once window is open makes no effect, same thing for closing window.

toggleOpen

TypeDescriptionFunction description
- - Calling this function toggles map window open state. If called when window is opened it closes window, same thing other way around.