FPP twcompass plugin

twcompass: external plugin with dual function - showing a compass or a pano radar

Current version: 1.16

twcompass.swf

An external plugin with dual function - either for showing a compass needle or for use as a radar. When used as a compass, the neeedle rotates to always point to the north when the user changes the pan angle in the pano image. The radar function is of course to follow the user when he is panning, and to show - for example on a floor map - which way he is looking.

The following parameters are supported:

url	url=compassrose2.png	compass/radar image file
radar	radar=1	function (0=compass, 1=radar)
salign	salign=RM	position (L,C,R and T,M,B
offsetX	offsetX="10"	horizontal distance from alignment point
offsetY	offsetY="-10"	vertical distance from alignment point
visible	visible=1	0 or 1, anything else will toggle visibility
scale	scale=0.75	scaling of compass/radar image
alpha	alpha=0.60	image transparency
delay	delay=40	compass speed (0=no delay, 10-100=slower)
offsetNorth	offsetNorth=316	pano offset in degrees (example: 0° pan = 316° direction - NNW)
or
offset		deprecated - use offsetNorth=nnn

NOTE:
All parameters can be updated dynamically from FPP. Example:

external.twcompass.alpha=0.75

Example plugin XML file:

<?xml version = '1.0'?>
<panorama>
   <parameters>
      zoom = 1
      panHome = 93
      tiltHome = -1
      friction = 0.90 
      segments = 30

      layer_1 = ../glassMeter.swf
      layer_2 = ../tooltips.swf
      layer_3 = ../hotspots.swf
      layer_4 = ../menuFullscreen.swf
      layer_5 = ../twcompass.swf
   </parameters>

   <hotspots>
      <global
         pano_move="pano.pan=129,4000,elastic;pano.tilt=-9.5,5000,elastic;pano.zoom=1.8,10000"
      >
         <spot id="FSbutton" url="full.png" alt="Fullscreen on/off" static="1" salignX="-0.47" salignY="-0.46" scale="1" alpha="0.65" onClick="fullscreen(-)" />
      </global>
   </hotspots>

   <twcompass>
      url=compassrose2.png
      salign=TR
      offsetX=-15
      offsetY=10
      scale=1.0
      delay=40
      offsetNorth=316
   </twcompass>

</panorama>

Version history:

1.16:
margin parameter is replaced with offsetX=nn and offsetY=nn parameters. offset=nnn parameter is deprecated - use offsetNorth=nnn

1.15:
Fixed an alpha setting bug.

1.14:
Removed "posX" and "posY" parameters. Modified radar/compass position calculation.

1.13:
Added "salign" and "margin" parameters.

1.12:
Added "visible" parameter.