Current version: 3.1
Zip file
Test page 1
XML file
Test page 3
Test page 4
Test page 5
Test page 6
Test page 7
Test page 8
Test page 10 with swf tween
Test page 11 with swf tween
Test page 12 with swf tween
Test page 13 with swf tween
Test page 1
XML file
Test page 3
Test page 4
Test page 5
Test page 6
Test page 7
Test page 8
Test page 10 with swf tween
Test page 11 with swf tween
Test page 12 with swf tween
Test page 13 with swf tween
logoMeter.swf
This external plugin is active during panorama loading and displays progress information in a box
(optional) together with one or two images (also optional).
It's easy to design your own load meter,
and you can also modify it "on the fly", to have different logos, colors or texts for each pano in a
tour.
The following parameters are supported in the FPP xml file, and they may also be modified at any time
by a command like "external.logometer.imageL=img/logopano2.png":
NOTES: Plugin position is calculated with the salign, offsetX and offsetY parameters. The salign parameter works as described in the FPP documentation, and the offsetX and offsetY values are added to get the final position. If all the different components are used their relative Z-levels would be:
If set to enabled=0 initially, you can avoid showing the logoMeter when a preview pano is loaded. Then you can enable it dynamically ("external.logometer.enabled=1") before the main pano starts loading. The uncover parameter:
If not used, the progress meter works as usual - growing from left to right.
If the parameter is set to uncover="1", the progress meter is drawn in full length from the beginning and used as a mask to cover the background. When loading starts, the mask will gradually shrink to the right, revealing the background. The reload parameter:
If set to reload=1, the meter will also show when a pano is reloaded. The default is reload=0, which means that the meter will only be shown the first time a pano is loaded. The reason for this is that if the pano is reloaded, it has already been cached, so the meter would probably just flash on and off very quickly. The tweenL and tweenU parameters:
The images used can also be Flash .swf files. If they contain tweens that you want to synchronize with the pano loading, they have to meet the following requirements:
The postCommand parameter:
With this parameter you can send commands to FPP when loading of the pano is complete. There is of course an event in FPP that you can use. But if you are using the delay parameter, which is used to keep the meter (logo) visible for a while after loading, you can also delay the execution of these commands. As you can't use the &;=| characters here in the XML file, you have to encode them as follows:
Example FPP xml file:
Version history:
by a command like "external.logometer.imageL=img/logopano2.png":
| Positioning and function: | ||
| salign | salign=RM | relative position of plugin (L,C,R and T,M,B |
| default=CM) | ||
| offsetX | offsetX=-10 | horizontal offset from alignment |
| offsetY | offsetY=50 | vertical offset from alignment |
| enabled | enabled=0 | possibility to turn the meter on/off (default 1=on) |
| reload | reload=1 | shows meter when a pano is reloaded, default=0 |
| alpha | alpha=0.70 | transparency |
| delay | delay=5000 | delay (in ms) before closing box |
| postCommand | postCommand= text2.alpha%3D1,600 | FPP commands when pano loading is ready |
| Background box: | ||
| size | size=200x140 | box size |
| radius | radius=15 | box corner radius |
| bgColor | bgColor=0xFDE018 | background color |
| borderColor | borderColor=0x000000 | border color |
| Lower image: | ||
| imageL | imageL=img/logoeniro.png | lower image path (image below meter) |
| imageLPos | imageLPos=5:5 | lower image position |
| tweenL | tweenL=1 | lower image is an .swf file with tween |
| Upper image: | ||
| imageU | imageU=img/logoeniro.png | upper image path (image above meter) |
| imageUPos | imageUPos=5:5 | upper image position |
| tweenU | tweenU=1 | upper image is an .swf file with tween |
| Meter: | ||
| meterSize | meterSize=150x8 | meter bar size |
| meterPos | meterPos=9:80 | meter bar position |
| meterColor | meterColor=0x0000ff | meter bar color |
| uncover | uncover=1 | meter bar uncovering background |
| Text: | ||
| textAlign | textAlign=C | text alignment: R(ight), C(enter) or L(eft)(default) |
| textPos | textPos=9:100 | text position |
| textColor | textColor=0x303030 | text color |
| font | font=Arial | text font |
| fontSize | fontSize=12 | size of text font |
| textLoaded | textLoaded=We have loaded %L kilobytes | text for "loading progress" |
| textLoadFailure | textLoadFailure=loading failed | text for "loading failure" |
| textParsing | textParsing=parsing | text for "parsing pano" |
NOTES: Plugin position is calculated with the salign, offsetX and offsetY parameters. The salign parameter works as described in the FPP documentation, and the offsetX and offsetY values are added to get the final position. If all the different components are used their relative Z-levels would be:
4 upper image (highest)
3 progress text
2 progress meter
1 lower image
0 background box and border (lowest)
The enabled parameter:3 progress text
2 progress meter
1 lower image
0 background box and border (lowest)
If set to enabled=0 initially, you can avoid showing the logoMeter when a preview pano is loaded. Then you can enable it dynamically ("external.logometer.enabled=1") before the main pano starts loading. The uncover parameter:
If not used, the progress meter works as usual - growing from left to right.
If the parameter is set to uncover="1", the progress meter is drawn in full length from the beginning and used as a mask to cover the background. When loading starts, the mask will gradually shrink to the right, revealing the background. The reload parameter:
If set to reload=1, the meter will also show when a pano is reloaded. The default is reload=0, which means that the meter will only be shown the first time a pano is loaded. The reason for this is that if the pano is reloaded, it has already been cached, so the meter would probably just flash on and off very quickly. The tweenL and tweenU parameters:
The images used can also be Flash .swf files. If they contain tweens that you want to synchronize with the pano loading, they have to meet the following requirements:
- The tweens must run between frames 1 - 100.
- Frame 1 must contain an ActionScript stop(); command to prevent the tweens from playing automatically.
| %L | kilobytes downloaded |
| %T | kilobytes total |
| %P | percentage downloaded |
The postCommand parameter:
With this parameter you can send commands to FPP when loading of the pano is complete. There is of course an event in FPP that you can use. But if you are using the delay parameter, which is used to keep the meter (logo) visible for a while after loading, you can also delay the execution of these commands. As you can't use the &;=| characters here in the XML file, you have to encode them as follows:
& as %26
; as %3B
= as %3D
| as %7C
It might of course be easier to put the commands in a FPP global function and just give
the name of that function - that would probably not need any escape coded characters.
; as %3B
= as %3D
| as %7C
Example FPP xml file:
<logoMeter> salign=MC enabled=0; size=207x125 alpha=1 delay=0 postCommand=global.showTexts() radius=15 bgColor=0xFDE018 borderColor=0x000000 imageL=img/logoeniro.png imageLPos=9:9 imageU=img/enirobar2.png imageUPos=9:79 meterPos=9:80 meterSize=187x15 meterColor=0x0000ff textPos=9:100 textColor=0x303030 textLoaded=We have loaded %L kilobytes textLoadFailure=loading failed textParsing=parsing font=Verdana fontsize=11 </logoMeter>
Version history:
3.1:
Added textAlign parameter. 3.0:
Added possibility to control swf files with tweens.
Modified position parameters.
Removed textSize parameter. 2.20:
New parameter "reload=1" 2.12:
Plugin does not become visible until plugin images are loaded.
Improved plugin fade out coding. 2.11:
Fixed bug when "font" parameter was read before "textSize" parameter. 2.10: Reworked code to make it possible to change all parameters dynamically
Added textAlign parameter. 3.0:
Added possibility to control swf files with tweens.
Modified position parameters.
Removed textSize parameter. 2.20:
New parameter "reload=1" 2.12:
Plugin does not become visible until plugin images are loaded.
Improved plugin fade out coding. 2.11:
Fixed bug when "font" parameter was read before "textSize" parameter. 2.10: Reworked code to make it possible to change all parameters dynamically
