<krpano> <include> <preview> <image> <view> <area> <display> <control> <cursors> <autorotate> <plugin> <layer> <hotspot> <style> <events> <action> <contextmenu> <progress> <network> <memory> <security> <textstyle> <lensflareset> <lensflare> <data> <scene> </krpano>
devices="html5"
devices="flash"
devices="mobile"
devices="tablet"
devices="iphone|ipad"
devices="desktop|tablet+html5"
devices="android+flash"
devices="html5+!iphone"
devices="iphone+retina" = iPhone 4, iPhone 5
devices="ipad+retina" = iPad 3, iPad 4
devices="ipad+iOS5.1" = iPad with iOS 5.1 or higher
devices="flash|webgl" = systems with fisheye-distortion support
<krpano version="1.17" onstart="" basedir="%FIRSTXML%" bgcolor="" idletime="0.5" colorcorrection="default" logkey="true" showerrors="true" debugmode="false" > ... </krpano>
Attribute name | Full variable name | Type | Default value |
version | xmlversion | String | "1.17" |
---|---|---|---|
Information about the krpano version that was used when creating the xml file. This is only an optional information value, but it should be still defined to allow handling potential compatibility-related version changes. | |||
Attribute name | Full variable name | Type | Default value |
onstart | onstart | Action Event | |
The "onstart" event - here any actions / functions that will be called "on start"
of the pano viewing can be defined. |
|||
Attribute name | Full variable name | Type | Default value |
basedir | basedir | String | "%FIRSTXML%" |
Defines the base directory for the loadpano() actions. This can be a relative or an absolute path and it's also possible to use the url placeholders there. The defaultvalue is %FIRSTXML%, that means the paths of all following XML files, loaded by the loadpano(), are relative to the first loaded XML file. |
|||
Attribute name | Full variable name | Type | Default value |
bgcolor | bgcolor | String | "" |
The background color. For partial panos / flat images where the background of the viewer becomes visible.
|
|||
Attribute name | Full variable name | Type | Default value |
idletime | idletime | Number | 0.5 |
The time in seconds without any user interaction before calling the idle event. | |||
Attribute name | Full variable name | Type | Default value |
colorcorrection | colorcorrection | String | "default" |
Change the color correction settings of the Flashplayer 10. See here for more details: Flashplayer10 colorCorrection Possible settings: "default", "on", "off" Warning - there can be performance degrades when set to "on" ! |
|||
Attribute name | Full variable name | Type | Default value |
logkey | logkey | Boolean | true |
Enable/disable the 'O' keyboard key, which switches the Output / log window on / off. Note - this parameter will be only checked once at startup! | |||
Attribute name | Full variable name | Type | Default value |
showerrors | showerrors | Boolean | true |
Should the output/trace log window open automatically when an error happens to show the error message. | |||
Attribute name | Full variable name | Type | Default value |
debugmode | debugmode | Boolean | false |
Should the debug trace messages from krpano or from plugins be shown. |
<krpano version="1.17" onstart="loadscene(scene1);"> <scene name="scene1"> ... </scene> </krpano>
<include url="path/name-of-the-other-xml-file.xml" />
Attribute name | Full variable name | Type | Default value |
url | - | String | |
---|---|---|---|
url/path of the xml file which should be included |
<include url="settings.xml" />
<include url="skin/skin.xml" />
<include url="%SWFPATH%/global.xml" />
<preview type="" url="previewpano.jpg" striporder="LFRBUD" details="16" />
Attribute name | Full variable name | Type | Default value |
type | preview.type | String | "" |
---|---|---|---|
Set the panoramic type of the preview image. Possible settings:
|
|||
Attribute name | Full variable name | Type | Default value |
url | preview.url | String | |
The url/path of the preview image. This can be a spherical, cylindrical or a cubestrip (1x6,6x1,2x3 or 3x2) image. When a partial pano image will be used, then the hfov / vfov / voffset settings from the <image> element will be used. |
|||
Attribute name | Full variable name | Type | Default value |
striporder | preview.striporder | String | "LFRBUD" |
Defines the order of the images in the cubestrip image. | |||
Attribute name | Full variable name | Type | Default value |
details | preview.details | int | 16 |
Internal rendering tesslation details, a higher details value will result in a more detailed internal 3D-geometry. When using the Flashplayer 10 and cubical images without any distortion (fisheye,stereographic,...) then this setting will be ignored, because a tesslation will be no necessary. |
<preview url="pano_preview.jpg" />
<preview type="grid(CUBE,16,16,512,0xCCCCCC,0xFFFFFF,0x999999);" />
<preview type="SPHERE" url="spherepreview.jpg" details="16" />
<preview type="CUBESTRIP" url="cspreview.jpg" />
<image type="CUBE" tiled="false" tiledimagewidth="..." tiledimageheight="..." tilesize="..." baseindex="1" frames="1" frame="1" prealign="" type="CUBE" multires="true" multiresthreshold="0.025" progressive="true" tilesize="..." baseindex="1" frames="1" frame="1" prealign="" > <level tiledimagewidth="..." tiledimageheight="..." details="" download="auto" decode="auto" aspreview="false" > <cube url="pano_%s_%v_%u.jpg" /> </level> <level ...> ... </level> ... </image> where "%s" is the placeholder of the cube-side character (l,f,r,b,u,d) or <image type="CUBE" tiled="false" tiledimagewidth="..." tiledimageheight="..." tilesize="..." baseindex="1" frames="1" frame="1" prealign="" type="CUBE" multires="true" multiresthreshold="0.025" progressive="true" tilesize="..." baseindex="1" frames="1" frame="1" prealign="" > <level tiledimagewidth="..." tiledimageheight="..." details="" download="auto" decode="auto" aspreview="false" > <left url="pano_l_%v_%u.jpg" rotate="0" flip="" /> <front url="pano_f_%v_%u.jpg" rotate="0" flip="" /> <right url="pano_r_%v_%u.jpg" rotate="0" flip="" /> <back url="pano_b_%v_%u.jpg" rotate="0" flip="" /> <up url="pano_u_%v_%u.jpg" rotate="0" flip="" /> <down url="pano_d_%v_%u.jpg" rotate="0" flip="" /> </level> <level ...> ... </level> ... </image>
<image type="CUBESTRIP"> <cubestrip url="cubestrip.jpg" /> <left strip="0" rotate="0" flip="" /> <front strip="1" rotate="0" flip="" /> <right strip="2" rotate="0" flip="" /> <back strip="3" rotate="0" flip="" /> <up strip="4" rotate="0" flip="" /> <down strip="5" rotate="0" flip="" /> </image>
<image type="SPHERE" hfov="360" vfov="" voffset="0" tiled="false" tiledimagewidth="..." tiledimageheight="..." tilesize="..." baseindex="1" frames="1" frame="1" prealign="" type="SPHERE" hfov="360" vfov="" voffset="0" multires="true" multiresthreshold="0.025" progressive="true" tilesize="..." baseindex="1" frames="1" frame="1" prealign="" > <level tiledimagewidth="..." tiledimageheight="..." details="" download="auto" decode="auto" aspreview="false" > <sphere url="pano_%v_%u.jpg" /> </level> <level ...> ... </level> ... </image>
<image type="CYLINDER" hfov="360" vfov="" voffset="0" tiled="false" tiledimagewidth="..." tiledimageheight="..." tilesize="..." baseindex="1" frames="1" frame="1" prealign="" type="CYLINDER" hfov="360" vfov="" voffset="0" multires="true" multiresthreshold="0.025" progressive="true" tilesize="..." baseindex="1" frames="1" frame="1" prealign="" > <level tiledimagewidth="..." tiledimageheight="..." details="" download="auto" decode="auto" aspreview="false" > <cylinder url="pano_%v_%u.jpg" /> </level> <level ...> ... </level> ... </image>
<image type="CYLINDER" hfov="1.0" tiled="false" tiledimagewidth="..." tiledimageheight="..." tilesize="..." baseindex="1" frames="1" frame="1" prealign="" multires="true" multiresthreshold="0.025" progressive="true" tilesize="..." baseindex="1" frames="1" frame="1" prealign="" > <level tiledimagewidth="..." tiledimageheight="..." download="auto" decode="auto" aspreview="false" > <cylinder url="image_%v_%u.jpg" /> </level> <level ...> ... </level> ... </image>
<image type="ZOOMIFY" hfov="..." vfov="" voffset="0" multiresthreshold="0.025" progressive="true" > <zoomify url="zoomifypano/ImageProperties.xml" type="SPHERE" setview="true" /> </image>
<plugin name="video" url="videoplayer.swf" videourl="..." /> <image type="SPHERE" hfov="360" vfov="" voffset="0" prealign="" > <sphere url="plugin:video" /> </image> or <image type="CYLINDER" hfov="360" vfov="" voffset="0" prealign="" > <cylinder url="plugin:video" /> </image> where "video" is the name of the videoplayer plugin that plays the video
Attribute name | Full variable name | Type | Default value |
type | image.type | String | |
---|---|---|---|
Define the type of the panorama image. Possible values:
Note - when using simple non-multi-resolution images the type setting can be left unset, in this case the type will be autodetected by the tags inside the <image> tag. |
|||
Attribute name | Full variable name | Type | Default value |
hfov | image.hfov | Number | |
Defines the horizontal field of view (hfov) of the pano image in degrees. This is the visible range that was captured on the pano image. The default value is 360, which means a view all around. Use a smaller value for partial panos. For Flat panos (or normal images) the value "1.0" should be used. |
|||
Attribute name | Full variable name | Type | Default value |
vfov | image.vfov | Number | |
Defines the vertical field of view (vfov) of the pano image in degrees. By default (when no value was set), this value will be calculated automatically by using the hfov, the type of the pano and the side aspect of the pano image. |
|||
Attribute name | Full variable name | Type | Default value |
voffset | image.voffset | Number | 0.0 |
Defines the vertical offset of the pano image in degrees. By default the pano image will be centered in the 3D space. This means the viewing range will be from -hfov/2 to +hfov/2 and from -vfov/2 to +vfov/2. Now when using a partial pano image where the horizon is not in the middle of image (not at 0 degree), then this image will be displayed distorted. The voffset can be used to shift the fov range up or down to center the image correctly in the 3D space. How to get the correct voffset value: When the vertical range of the pano image is known, then it can be calculated: voffset = (vfov_min + vfov_max) / 2 e.g. for a 240x100 pano with the fov from -75 to +25: vfov_min = -75 vfov_max = +25 voffset = (-75 + 25) / 2 = -25or see the result for a 360x180 pano with -90 to +90: vfov_min = -90 vfov_max = +90 voffset = (-90 + 90) / 2 = 0.0 When the vertical range is unknown - just try out some values (negative and positive ones in the range from -90 to +90). Additionally it can be helpful here to set <view limitview="off" />in the xml to allow viewing the whole partial image without viewing limitations. |
|||
Attribute name | Full variable name | Type | Default value |
tiled | image.tiled | Boolean | false |
Enables the usage of a tiled/sliced image. When set to true, then also the tiledimagewidth, the tiledimageheight and the tilesize attributes must be set to define the image and tilesize. |
|||
Attribute name | Full variable name | Type | Default value |
tiledimagewidth tiledimageheight |
image.tiledimagewidth image.tiledimageheight | int int |
|
Set the full size of the tiled image. | |||
Attribute name | Full variable name | Type | Default value |
tilesize | image.tilesize | int | |
Defines the tilesize for tiled or multires images. | |||
Attribute name | Full variable name | Type | Default value |
baseindex | image.baseindex | int | 1 |
The index base (numbering start) for the tile indicies. | |||
Attribute name | Full variable name | Type | Default value |
multires | image.multires | Boolean | false |
Enables the usage of a tiled/sliced multi-resolution images. When set to true, then the <image> element need to contain several <level> elements with the image definitions for each multi-resolution level. |
|||
Attribute name | Full variable name | Type | Default value |
multiresthreshold | image.multiresthreshold | Number | 0.025 |
The threshold that controls when to switch from one multi-resolution level to the next one. Reasonable values are from -1.0 to +1.0 but lower or higher values are also possible. | |||
Attribute name | Full variable name | Type | Default value |
progressive | image.progressive | Boolean | true |
Enables or disables progressive multi-resolution loading. Progressive loading means that the multi-resolution pano will be loaded step by step from low to high resolution. Only the tiles in the current viewing range will be loaded from level level. When disabled, then the tiles for current resolution will be loaded at first, and then when the loading of all current visible tiles was done, it will start preloading the lower resolutions of the current view. |
|||
Attribute name | Full variable name | Type | Default value |
prealign | image.prealign | String | |
With the prealign setting the pano image itself can be aligned/rotated.
This can be used to correct a miss-aligned pano. The syntax: prealign="X|Y|Z"where X, Y, Z defines the rotation about these axis in degrees. |
|||
Attribute name | Full variable name | Type | Default value |
frames frame |
image.frames image.frame |
int int |
1 1 |
Current frame and number of frames of the pano. It's possible to use several frames for a pano image, there the %f placeholder must be used in the image urls. That placeholder will be replaced with the current set frame number. |
|||
Full variable name (as3 usage only) | Type | Default value | |
image.layer | Sprite | ||
Actionscript 3 Sprite object of the pano image layer. |
|||
Attribute name | Full variable name | Type | Default value |
cube.url | image.cube.url | String | |
Defines the paths/urls for a cubical pano image. The path should contain a %s placeholder for the cube side (l,f,r,b,u,d). |
|||
Attribute name | Full variable name | Type | Default value |
left.url front.url right.url back.url up.url down.url |
image.left.url image.front.url image.right.url image.back.url image.up.url image.down.url |
String String String String String String |
|
Defines the paths/urls for the cube face images. Note - see also the notes about tile index placeholders - tile placeholders |
|||
Attribute name | Full variable name | Type | Default value |
left.strip front.strip right.strip back.strip up.strip down.strip |
image.left.strip image.front.strip image.right.strip image.back.strip image.up.strip image.down.strip |
int int int int int int |
0 1 2 3 4 5 |
For cubestrip panos, define which image part/strip of the cubestrip is the image for the cubeface. | |||
Attribute name | Full variable name | Type | Default value |
left.rotate front.rotate right.rotate back.rotate up.rotate down.rotate |
image.left.rotate image.front.rotate image.right.rotate image.back.rotate image.up.rotate image.down.rotate |
int int int int int int |
0 0 0 0 0 0 |
Rotate a cube side in degrees. Can be used for other/non-krpano cube images. | |||
Attribute name | Full variable name | Type | Default value |
left.flip front.flip right.flip back.flip up.flip down.flip |
image.left.flip image.front.flip image.right.flip image.back.flip image.up.flip image.down.flip |
String String String String String String |
|
Flip/mirror the image along the X and/or Y axis. Possible values: "X" or "Y" or "XY" or "", default="" |
|||
Attribute name | Full variable name | Type | Default value |
cubestrip.url | image.cubestrip.url | String | |
Defines the path/url for a cube strip image. |
|||
Attribute name | Full variable name | Type | Default value |
sphere.url | image.sphere.url | String | |
Defines the path/url for a spherical or partial spherical pano image. Note - see also the notes about tile index placeholders - tile placeholders |
|||
Attribute name | Full variable name | Type | Default value |
cylinder.url | image.cylinder.url | String | |
Defines the path/url for a cylindrical or partial cylindrical pano image. Note - see also the notes about tile index placeholders - tile placeholders |
|||
Attribute name | Full variable name | Type | Default value |
qtvr.url | image.qtvr.url | String | |
Defines the path/url for a QTVR .mov pano image. Only cubical QTVR files with jpeg encoded files are possible. |
|||
Attribute name | Full variable name | Type | Default value |
qtvr.preview | image.qtvr.preview | Boolean | true |
Defines if the embedded preview image of the QTVR .mov file should be used. | |||
Attribute name | Full variable name | Type | Default value |
qtvr.setview | image.qtvr.setview | Boolean | true |
Defines if the viewng direction settings from QTVR .mov file should be used/set. | |||
Attribute name | Full variable name | Type | Default value |
zoomify.url | image.zoomify.url | String | |
Defines the path/url to the Zoomify XML file, typical named "ImageProperties.xml". The Zoomify tiles must be in the same folder as this xml file. | |||
Attribute name | Full variable name | Type | Default value |
zoomify.type | image.zoomify.type | String | "SPHERE" |
Defines the pano type of the Zoomify image. Possible values are "SPHERE" or "CYLINDER". |
|||
Attribute name | Full variable name | Type | Default value |
zoomify.setview | image.zoomify.setview | Boolean | true |
When enabled the viewing settings will be adjusted for Zoomify usage. (no fisheye and maxpixelzoom=0.95) |
|||
Full variable name (read only) | Type | Default value | |
image.level.count | int | 0 | |
The count / number of all image level elements. | |||
Attribute name | Full variable name | Type | Default value |
level[..].tiledimagewidth level[..].tiledimageheight | image.level[..].tiledimagewidth image.level[..].tiledimageheight | int int |
|
Set the full size of the tiled image for this level. | |||
Attribute name | Full variable name | Type | Default value |
level[..].tilesize | image.level[..].tilesize | int | |
This setting will overrule the main image.tilesize setting for this level. | |||
Attribute name | Full variable name | Type | Default value |
level[..].download level[..].decode |
image.level[..].download image.level[..].decode |
String String |
"auto" "auto" |
Defines if the all tiles from that level should be downloaded and decoded or only the onces
that were currently need for viewing. Possible values: "all", "view" or "auto"
|
|||
Attribute name | Full variable name | Type | Default value |
level[..].details | image.level[..].details | int | |
This setting will overrule the default display.details setting. | |||
Attribute name | Full variable name | Type | Default value |
level[..].aspreview | image.level[..].aspreview | Boolean | false |
Use this level as preview image. This also forces the whole level to be loaded. |
|||
Attribute name | Full variable name | Type | Default value |
level[..].left.url level[..].front.url level[..].right.url level[..].back.url level[..].up.url level[..].down.url |
image.level[..].left.url image.level[..].front.url image.level[..].right.url image.level[..].back.url image.level[..].up.url image.level[..].down.url |
String String String String String String |
|
Defines the paths/urls for the cube face images for this level. Note - see also the notes about tile index placeholders - tile placeholders |
|||
Attribute name | Full variable name | Type | Default value |
level[..].sphere.url | image.level[..].sphere.url | String | |
Defines the path/url for a spherical or partial spherical pano image for this level. Note - see also the notes about tile index placeholders - tile placeholders |
|||
Attribute name | Full variable name | Type | Default value |
level[..].cylinder.url | image.level[..].cylinder.url | String | |
Defines the path/url for a cylindrical or partial cylindrical pano image for this level. Note - see also the notes about tile index placeholders - tile placeholders |
tile_%y_%x.jpg = tile_1_1.jpg, tile_1_2.jpg ... tile_8_16.jpg
t_%0y_%0x.jpg = t_01_01.jpg, t_01_02.jpg ... t_08_16.jpg
t_%00V_%00H.jpg = t_001_001.jpg, t_001_002.jpg ... t_008_016.jpg
<view hlookat="0.0" vlookat="0.0" camroll="0.0" fovtype="VFOV" fov="90.0" fovmin="1.0" fovmax="179.0" maxpixelzoom="" fisheye="0.0" fisheyefovlink="0.5" stereographic="false" pannini="false" architectural="0.0" architecturalonlymiddle="false" limitview="auto" hlookatmin="" hlookatmax="" vlookatmin="" vlookatmax="" />
Attribute name | Full variable name | Type | Default value |
hlookat | view.hlookat | Number | 0.0 |
---|---|---|---|
The horizontal looking direction in spherical coordinates (-180 ... +180). Note - the value will not automatically wrap around the 360. |
|||
Attribute name | Full variable name | Type | Default value |
vlookat | view.vlookat | Number | 0.0 |
The veritcal looking direction in spherical coordinates (-90 ... +90). -90 = Zenith view, +90 = Nadir view. |
|||
Attribute name | Full variable name | Type | Default value |
camroll | view.camroll | Number | 0.0 |
The roll / rotation of the view camera. See also: control.camrollreset |
|||
Attribute name | Full variable name | Type | Default value |
fovtype | view.fovtype | String | "VFOV" |
Defines the type of fov (field of view). Possible settings:
|
|||
Attribute name | Full variable name | Type | Default value |
fov | view.fov | Number | 90.0 |
The current field of view (in degrees, 0.0 ... 179.0). | |||
Attribute name | Full variable name (read only) | Type | Default value |
hfov | view.hfov | Number | |
The current horizonal fov (read only). | |||
Attribute name | Full variable name (read only) | Type | Default value |
vfov | view.vfov | Number | |
The current vertical fov (read only). | |||
Attribute name | Full variable name | Type | Default value |
fovmin | view.fovmin | Number | 1.0 |
The minimum fov value, this will limit the in-zooming to this value. Note - maxpixelzoom can be used instead! |
|||
Attribute name | Full variable name | Type | Default value |
fovmax | view.fovmax | Number | 179.0 |
The maximum fov value, this will limit the out-zooming to this value. |
|||
Attribute name | Full variable name | Type | Default value |
maxpixelzoom | view.maxpixelzoom | Number | |
The maximum pixel zoom factor of the pano image. This will limit the fov automatically depending on the pano resolution and the current viewing window, e.g. 1.0 = limit to 100% zoom, no pixel scaling of the source image will be visible. Note - when set, this setting will overrule the fovmin setting, the fovmin value will be dynamically updated in this case. |
|||
Attribute name | Full variable name | Type | Default value |
fisheye | view.fisheye | Number | 0.0 |
Fisheye distortion effect (0.0 - 1.0) This value contolls the interpolation between the normal rectiliniear view and the fisheye distorted view. 0.0 = no distortion / rectiliniear 1.0 = full distortion There are two fisheye modes: - normal (view.stereographic="false") - stereographic (view.stereographic="true") |
|||
Attribute name | Full variable name | Type | Default value |
fisheyefovlink | view.fisheyefovlink | Number | 0.5 |
The fov and fisheye settings are linked together (when zooming in - the fisheye effect will be reduced)
this value is the correlation between these values: (0.0 - 3.0), 0=linear correlation, 3=dynamic correlation) - default="0.5" |
|||
Attribute name | Full variable name | Type | Default value |
stereographic | view.stereographic | Boolean | false |
Enables/disables the stereographic fisheye projection. The "strongness" of the projection it is controlled by the "fisheye" variable. The stereographic projection allowes very interessting panorama views like the Little Planet Views. |
|||
Attribute name | Full variable name | Type | Default value |
pannini | view.pannini | Boolean | false |
Enables/disables the "Pannini/Vedutismo" Projection. The "strongness" of the projection it is controlled by the "fisheye" variable. |
|||
Attribute name | Full variable name | Type | Default value |
architectural | view.architectural | Number | 0.0 |
Architectural projection (0.0 - 1.0). This value interpolates between the current projection (0.0) and the architectural projection mode (1.0). |
|||
Attribute name | Full variable name | Type | Default value |
architecturalonlymiddle | view.architecturalonlymiddle | Boolean | false |
When enabled, the architectural projection will be only used in the 'middle' area of the pano. When looking more up and down then the architectural projection will slowly switch back to normal projection. | |||
Attribute name | Full variable name | Type | Default value |
limitview | view.limitview | String | "auto" |
Limit the viewing range in the pano. Possible values:
when the "hlookatmin", "hlookatmax", "vlookatmin", "vlookatmax" values were not set, they will be automatically calculated from the size of the pano image. |
|||
Attribute name | Full variable name | Type | Default value |
hlookatmin | view.hlookatmin | Number | |
The minimum horizontal looking position in spherical coordinates (-180 .. +180). (When hlookatmax-hlookatmin=360 then no limiting will be done) |
|||
Attribute name | Full variable name | Type | Default value |
hlookatmax | view.hlookatmax | Number | |
The maximum horizontal looking position in spherical coordinates (-180 .. +180). (When hlookatmax-hlookatmin=360 then no limiting will be done) |
|||
Attribute name | Full variable name | Type | Default value |
vlookatmin | view.vlookatmin | Number | |
The minimum vertical looking position in spherical coordinates (-90 .. +90). |
|||
Attribute name | Full variable name | Type | Default value |
vlookatmax | view.vlookatmax | Number | |
The maximum vertical looking position in spherical coordinates (-90 .. +90). |
|||
Attribute name | Full variable name (read only) | Type | Default value |
hlookatrange | view.hlookatrange | Number | |
The current maximum horizontal looking range (same as hlookatmax - hlookatmin). |
|||
Attribute name | Full variable name (read only) | Type | Default value |
vlookatrange | view.vlookatrange | Number | |
The current maximum vertical looking range (same as vlookatmax - vlookatmin). |
<view hlookat="0" vlookat="0" fov="80" />
<view hlookat="0" vlookat="90" fisheye="1.0" stereographic="true" fov="150" fovmax="150" />
<view hlookat="0" vlookat="0" maxpixelzoom="1.0" limitview="fullrange" />
<area mode="align" align="lefttop" x="0" y="0" width="100%" height="100%" />
<area mode="border" left="0" top="0" right="0" bottom="0" />
Attribute name | Full variable name | Type | Default value |
mode | area.mode | String | "align" |
---|---|---|---|
Select the area positioning / sizing mode. Possible settings: "align" or "border". |
|||
Attribute name | Full variable name | Type | Default value |
align | area.align | String | "lefttop" |
Alignment / origin-point position of the area window on the screen. Possible values: lefttop, left, leftbottom, top, center, bottom, righttop, right, rightbottom. |
|||
Attribute name | Full variable name | Type | Default value |
x | area.x | String | "0" |
The x-distance from the align point to the area window. This can be an absolute pixel value or a relative to the screen width percent value. |
|||
Attribute name | Full variable name | Type | Default value |
y | area.y | String | "0" |
The y-distance from the align point to the area window. This can be an absolute pixel value or a relative to the screen height percent value. |
|||
Attribute name | Full variable name | Type | Default value |
width | area.width | String | "100%" |
The width of the area. This can be an absolute pixel value or a relative to the screen width percent value. |
|||
Attribute name | Full variable name | Type | Default value |
height | area.height | String | "100%" |
The height of the area. This can be an absolute pixel value or a relative to the screen height percent value. |
|||
Attribute name | Full variable name | Type | Default value |
left | area.left | String | "0" |
The distance from the left edge of the screen to the area window (= the left border). This can be an absolute pixel value or a relative to the screen width percent value. |
|||
Attribute name | Full variable name | Type | Default value |
top | area.top | String | "0" |
The distance from the top edge of the screen to the area window (= the top border). This can be an absolute pixel value or a relative to the screen height percent value. |
|||
Attribute name | Full variable name | Type | Default value |
right | area.right | String | "0" |
The distance from the right edge of the screen to the area window (= the right border). This can be an absolute pixel value or a relative to the screen width percent value. |
|||
Attribute name | Full variable name | Type | Default value |
bottom | area.bottom | String | "0" |
The distance from the bottom edge of the screen to the area window (= the bottom border). This can be an absolute pixel value or a relative to the screen height percent value. |
|||
Full variable name (read only) | Type | Default value | |
area.pixelx | int | ||
The final x-position in pixels (read-only). |
|||
Full variable name (read only) | Type | Default value | |
area.pixely | int | ||
The final y-position in pixels (read-only). |
|||
Full variable name (read only) | Type | Default value | |
area.pixelwidth | int | ||
The final width in pixels (read-only). |
|||
Full variable name (read only) | Type | Default value | |
area.pixelheight | int | ||
The final height in pixels (read-only). |
<area align="center" width="640" height="480" />
<area mode="border" top="10" bottom="100" />
<area x="25%" width="75%" />
<events onresize="fixaspectresize(16,9);" /> <action name="fixaspectresize"> div(aspect,%1,%2); mul(destwidth, stagewidth, aspect); copy(destheight, stagewidth); if(destwidth GT stagewidth, div(dwnscale,stagewidth,destwidth), set(dwnscale,1.0) ); mul(destwidth, dwnscale); mul(destheight, dwnscale); if(destheight GT stageheight, div(dwnscale,stageheight,destheight), set(dwnscale,1.0) ); mul(destwidth, dwnscale); mul(destheight, dwnscale); sub(destx, stagewidth, destwidth); sub(desty, stageheight, destheight); mul(destx, 0.5); mul(desty, 0.5); copy(area.x, destx); copy(area.y, desty); copy(area.width, destwidth); copy(area.height, destheight); </action>
<display fps="60" details="24" tessmode="-1" movequality="LOW" stillquality="HIGH" flash10="on" movequality10="HIGH" stillquality10="HIGH" sharpen="12" stilltime="0.25" showpolys="false" />
<display hardwarelimit="" usedesktopimages="" mipmapping="auto" loadwhilemoving="auto" />
Attribute name | Full variable name | Type | Default value |
fps | display.fps | int | 60 |
---|---|---|---|
The framerate in frames per second (fps) of the Flashplayer. It should be something between 30 and 100, the default is 60. Note - in the Flashplayer there is only one global framerate, this means the framerate setting can affect other flash elements when their animation is based on the framerate. |
|||
Attribute name | Full variable name (read only) | Type | Default value |
currentfps | display.currentfps | Number | |
The current average framerate. | |||
Attribute name | Full variable name | Type | Default value |
details | display.details | int | 24 |
Internal rendering tesslation details, a higher details value will result in a more detailed internal 3D-geometry. When using the Flashplayer 10 and cubical images without any distortion (fisheye,stereographic,...) then this setting will be ignored, because a tesslation will be no necessary. | |||
Attribute name | Full variable name | Type | Default value |
tessmode | display.tessmode | int | -1 |
The tesslation mode / the arrangement of the internal triangles, 1-5 or -1 (=automatic) -1 means 0 for spheres and 3 for cubes. |
|||
Attribute name | Full variable name | Type | Default value |
movequality | display.movequality | String | "LOW" |
The Flashplayer rendering quality while moving. (only with flash10="off" or when using the Flashplayer 9) Possible values: LOW, HIGH, BEST or HIGHSHARP* |
|||
Attribute name | Full variable name | Type | Default value |
stillquality | display.stillquality | String | "HIGH" |
The Flashplayer rendering quality when not moving for
stilltime seconds. (only with flash10="off" or when using the Flashplayer 9) Possible values: LOW, HIGH, BEST or HIGHSHARP* |
|||
Attribute name | Full variable name | Type | Default value |
flash10 | display.flash10 | String | "on" |
Enable/disable the usage of the Flashplayer 10 rendering possibilities. Possible values: "on", "off" Since the Flashplayer 10 there are new rendering functions in the Flashplayer avialable. This functions allow to render flat surfaces (bitmaps) with a perfect 3D perspective distortion. In the older Flashplayer 9 on the other side, it was only possible to simulate the 3D perspective distortion bytesslating/spliting the 3D model into many small elements and draw the small elements without perspective distortion. The new functions have advantages and disadvantages:
|
|||
Attribute name | Full variable name | Type | Default value |
movequality10 | display.movequality10 | String | "HIGH" |
The Flashplayer rendering quality while moving. (only with flash10="on" and using a Flashplayer 10 or higher) Possible values: LOW, HIGH, BEST or HIGHSHARP* |
|||
Attribute name | Full variable name | Type | Default value |
stillquality10 | display.stillquality10 | String | "HIGH" |
The Flashplayer rendering quality when not moving for stilltime seconds. (only with flash10="on" and using a Flashplayer 10 or higher) Possible values: LOW, HIGH, BEST or HIGHSHARP* |
|||
Attribute name | Full variable name | Type | Default value |
sharpen | display.sharpen | int | 12 |
When the rendering quality is set to HIGHSHARP then the rendered image will be sharpened as post-process. With the sharpen setting it is possible to control the strength of that sharpen effect. Possible values are from 0 to 14. | |||
Attribute name | Full variable name | Type | Default value |
stilltime | display.stilltime | Number | 0.25 |
The time in seconds after last movement in the pano before swtiching from movequality(10) to stillquality(10). | |||
Attribute name | Full variable name | Type | Default value |
showpolys | display.showpolys | Boolean | false |
Show the polygons of the internal 3D geometry. |
Attribute name | Full variable name | Type | Default value |
hardwarelimit | display.hardwarelimit | int | |
---|---|---|---|
Set the maximum cube image pixel size.
Larger images will be automatically downscaled to this size.
This setting works only with html5rendermode=1.
It should be used only together with the devices setting for certain devices and situations. The current default limits are: • Desktop - 2560 • iPad - 1024 • iPhone (Retina) with iOS 6.0 (or higher) - 1024 • iPhone (Retina) with iOS below 6.0 - 800 • iPod (Retina) - 640 • iPhone / iPod Touch (Non-Retina) - 600 |
|||
Attribute name | Full variable name | Type | Default value |
usedesktopimages | display.usedesktopimages | Boolean | |
On mobile and tablet devices the mobile/tablet images will be used by default. But with the usedesktopimages setting, it is possible to tell the viewer to use the desktop images also on these devices. | |||
Attribute name | Full variable name | Type | Default value |
mipmapping | display.mipmapping | String | "auto" |
Define if mipmapping should be used when displaying panos with WebGL. Mipmapping can give a better visual quality and reducing aliasing. The usage of mipmapping is only possible when the size of a cube-face-image is 1024px, 2048px or 4096px.
|
|||
Attribute name | Full variable name | Type | Default value |
loadwhilemoving | display.loadwhilemoving | String | ... |
Control the tile reloading during movement (panning, zooming).
The loading and adding of new tiles can interrupt smooth movements on slow devices.
|
<display flash10="off" details="28" />
<display flash10="off" stillquality="HIGHSHARP" />
<display html5rendermode="1" devices="iPad+Retina" />
<display hardwarelimit="512" devices="Android" />
<display usedesktopimages="true" hardwarelimit="1800" devices="iPad+Retina+iOS6" />
<control usercontrol="all" mousetype="moveto" touchtype="drag2d" zoomtocursor="false" zoomoutcursor="true" mouseaccelerate="1.0" mousespeed="10.0" mousefriction="0.8" mouseyfriction="1.0" mousefovchange="1.0" keybaccelerate="0.5" keybspeed="10.0" keybfriction="0.9" keybfovchange="0.75" keybinvert="false" fovspeed="3.0" fovfriction="0.9" movetocursor="none" cursorsize="10.0" headswing="0.0" camrollreset="true" keycodesleft="37" keycodesright="39" keycodesup="38" keycodesdown="40" keycodesin="" keycodesout="" bouncinglimits="false" touchfriction="0.87" />
Attribute name | Full variable name | Type | Default value |
usercontrol | control.usercontrol | String | "all" |
---|---|---|---|
Allowed user control modes: "all" or "keyb" or "mouse" or "off" | |||
Attribute name | Full variable name | Type | Default value |
mousetype | control.mousetype | String | "moveto" |
The type of the mouse control: moveto = click and move to set a moving vector drag2d = drag and move the panorama on a 2D axis drag2dsmooth = a 'smoothed' drag2d mode (Flash only) drag3d = drag and move the panorama on a free 3D axis (Flash only) |
|||
Attribute name | Full variable name | Type | Default value |
touchtype | control.touchtype | String | "drag2d" |
The type of the control on touch devices (iPhone,iPad,Android): drag2d = drag and move the panorama on a 2D axis drag2dsmooth = a 'smoothed' drag2d mode (Flash only) moveto = click and move to set a moving vector Note - in the Android Flashplayer the drag2dsmooth mode was automatically used when using drag2d to improve the visual response. |
|||
Attribute name | Full variable name | Type | Default value |
zoomtocursor | control.zoomtocursor | Boolean | false |
When enabled and zooming in by the mousewheel the pano will zoom toward the position of the mouse cursor. | |||
Attribute name | Full variable name | Type | Default value |
zoomoutcursor | control.zoomoutcursor | Boolean | true |
When zoomtocursor and this setting are enabled and zooming out by the mousewheel the pano will zoom away from the position of the mouse cursor. Otherwise the pano will zoom away from the center of the screen. | |||
Attribute name | Full variable name | Type | Default value |
mouseaccelerate | control.mouseaccelerate | Number | 1.0 |
The acceleration of the mouse controlled moving. | |||
Attribute name | Full variable name | Type | Default value |
mousespeed | control.mousespeed | Number | 10.0 |
The maximum moving speed of the mouse controlled moving. | |||
Attribute name | Full variable name | Type | Default value |
mousefriction | control.mousefriction | Number | 0.8 |
The moving friction of the mouse controlled moves. | |||
Attribute name | Full variable name | Type | Default value |
mouseyfriction | control.mouseyfriction | Number | 1.0 |
An additionally friction for the vertical movement in the moveto control mode. Can be used, with values lower than 1.0, to make the vertical moving less responsive. | |||
Attribute name | Full variable name | Type | Default value |
mousefovchange | control.mousefovchange | Number | 1.0 |
The mouse wheel fov (zoom) change in degrees (=mouse wheel zoom sensibility). | |||
Attribute name | Full variable name | Type | Default value |
keybaccelerate | control.keybaccelerate | Number | 0.5 |
The acceleration of the keyboard / button controlled moving. |
|||
Attribute name | Full variable name | Type | Default value |
keybspeed | control.keybspeed | Number | 10.0 |
The maximum moving speed of the keyboard / button controlled moving. | |||
Attribute name | Full variable name | Type | Default value |
keybfriction | control.keybfriction | Number | 0.9 |
The moving friction of the keyboard / button controlled moves. | |||
Attribute name | Full variable name | Type | Default value |
keybfovchange | control.keybfovchange | Number | 0.75 |
The keyboard / button fov (zoom) change in degrees (=zoom sensibility). | |||
Attribute name | Full variable name | Type | Default value |
keybinvert | control.keybinvert | Boolean | false |
Invert keyboard / button up and down moves. | |||
Attribute name | Full variable name | Type | Default value |
fovspeed | control.fovspeed | Number | 3.0 |
The maximum fov change / zooming speed. | |||
Attribute name | Full variable name | Type | Default value |
fovfriction | control.fovfriction | Number | 0.9 |
The friction of fov changes / zoomings. | |||
Attribute name | Full variable name | Type | Default value |
movetocursor | control.movetocursor | String | "none" |
Enable a direction cursor for the "moveto" mousetype. Possible values: none - no special cursor, use the default system arrow cursor vector - a direction vector cursor arrow - a rotating arrow cursor Note - it also possible to define custom mouse cursors with the <cursors> settings. |
|||
Attribute name | Full variable name | Type | Default value |
cursorsize | control.cursorsize | Number | 10.0 |
Size of the movetocursor cursor. | |||
Attribute name | Full variable name | Type | Default value |
headswing | control.headswing | Number | 0.0 |
Swing / tilt the head / view when fast moving left or right (moveto mode only). This value sets the strength of this effect, from 0 to 10 and higher. |
|||
Attribute name | Full variable name | Type | Default value |
camrollreset | control.camrollreset | Boolean | true |
Should the roll of the camera (view.camroll) be reset back to horizont when moving in the moveto or drag2d mode. | |||
Attribute name | Full variable name | Type | Default value |
keycodesleft | control.keycodesleft | String | "37" |
Keyboard keycodes for moving left, default="37" (cursor left) | |||
Attribute name | Full variable name | Type | Default value |
keycodesright | control.keycodesright | String | "39" |
Keyboard keycodes for moving right, default="39" (cursor right) | |||
Attribute name | Full variable name | Type | Default value |
keycodesup | control.keycodesup | String | "38" |
Keyboard keycodes for moving up, default="38" (cursor up) | |||
Attribute name | Full variable name | Type | Default value |
keycodesdown | control.keycodesdown | String | "40" |
Keyboard keycodes for moving down, default="40" (cursor down) | |||
Attribute name | Full variable name | Type | Default value |
keycodesin | control.keycodesin | String | "" |
Keyboard keycodes for zooming-in. Example: to allow zooming-in with the Shift-key, the A-key, and the Plus-key: keycodesin="16,65,107" |
|||
Attribute name | Full variable name | Type | Default value |
keycodesout | control.keycodesout | String | "" |
Keyboard keycodes for zooming-out. Example: to allow zooming-out with the CTRL-key, the Y/Z-keys, and the Minus-key: keycodesout="17,89,90,109" |
|||
Attribute name | Full variable name (HTML5 only) | Type | Default value |
bouncinglimits | control.bouncinglimits | Boolean | false |
Bounce back when hitting the panning or zooming limits (drag control only). | |||
Attribute name | Full variable name | Type | Default value |
touchfriction | control.touchfriction | Number | 0.87 |
The moving friction for touch controls (iPhone/iPad/Android). |
<control mousetype="drag2D" />
<control zoomtocursor="true" />
<control keycodesin="16,65,107" keycodesout="17,89,90,109" />
<cursors url="" type="8way" move="" drag="" arrow_l="" arrow_r="" arrow_u="" arrow_d="" arrow_lu="" arrow_ru="" arrow_ld="" arrow_rd="" />
Attribute name | Full variable name | Type | Default value |
url | cursors.url | String | "" |
---|---|---|---|
Path/url to the cursors images. This image must contain all images for all cursor states. The image for the certain cursor is selected by defining the position and size of a (crop) rectangle. | |||
Attribute name | Full variable name | Type | Default value |
type | cursors.type | String | "8way" |
drag = move/drag 4way = move/drag/arrow_l/arrow_u,arrow_r,arrow_d 8way = all |
|||
Attribute name | Full variable name | Type | Default value |
move drag arrow_l arrow_r arrow_u arrow_d arrow_lu arrow_ru arrow_ld arrow_rd |
cursors.move cursors.drag cursors.arrow_l cursors.arrow_r cursors.arrow_u cursors.arrow_d cursors.arrow_lu cursors.arrow_ru cursors.arrow_ld cursors.arrow_rd |
String String String String String String String String String String |
|
move = during normal moving (without mouse button down) drag = mouse button down arrow_* = mouse button down and moving in direction |
<control mousetype="drag2D" /> <cursors url="drag-cursors.png" type="drag" move="2|0|30|32" drag="37|0|30|32" />
<control mousetype="moveto" /> <cursors url="arrow-cursors.png" type="4way" move="112|0|28|28" drag="112|0|28|28" arrow_r="0|0|28|28" arrow_d="28|0|28|28" arrow_l="56|0|28|28" arrow_u="84|0|28|28" />
<autorotate enabled="false" waittime="1.5" accel="1.0" speed="10.0" horizon="0.0" tofov="off" />
Attribute name | Full variable name | Type | Default value |
enabled | autorotate.enabled | Boolean | false |
---|---|---|---|
Enable/disable the automatic rotation. | |||
Attribute name | Full variable name | Type | Default value |
waittime | autorotate.waittime | Number | 1.5 |
The time in seconds to wait after the last user-interaction before starting the automatic rotation. | |||
Attribute name | Full variable name | Type | Default value |
accel | autorotate.accel | Number | 1.0 |
The rotation acceleration in degrees/second. | |||
Attribute name | Full variable name | Type | Default value |
speed | autorotate.speed | Number | 10.0 |
The maximum rotation speed in degrees/second. Use a negative value for a rotation to left. |
|||
Attribute name | Full variable name | Type | Default value |
horizon | autorotate.horizon | Number | 0.0 |
Move / rotate to the given horizon (0.0 = middle of the pano). Set the value to "off" or any other non-number value to disable it. |
|||
Attribute name | Full variable name | Type | Default value |
tofov | autorotate.tofov | Number | NaN |
Zoom to the given field of view (fov). Set it to "off" or any other non-number value to disable it. |
<autorotate enabled="true" />
<autorotate enabled="true" waittime="5.0" speed="-3.0" horizon="0.0" tofov="120.0" />
<plugin name="..." type="image" url="..." alturl="" keep="false" devices="all" parent="" visible="true" enabled="true" handcursor="true" maskchildren="false" scalechildren="false" zorder="" capture="true" children="true" preload="false" blendmode="normal" style="" align="" edge="" x="" y="" ox="" oy="" rotate="0.0" width="" height="" scale="1.0" pixelhittest="false" smoothing="true" accuracy="0" alpha="1.0" autoalpha="false" usecontentsize="false" scale9grid="" crop="" onovercrop="" ondowncrop="" mask="" effect="" jsborder="" bgcolor="0x000000" bgalpha="0.0" bgcapture="false" onover="" onhover="" onout="" onclick="" ondown="" onup="" onloaded="" />
<layer name="..." type="image" url="..." alturl="" keep="false" devices="all" parent="" visible="true" enabled="true" handcursor="true" maskchildren="false" scalechildren="false" zorder="" capture="true" children="true" preload="false" blendmode="normal" style="" align="" edge="" x="" y="" ox="" oy="" rotate="0.0" width="" height="" scale="1.0" pixelhittest="false" smoothing="true" accuracy="0" alpha="1.0" autoalpha="false" usecontentsize="false" scale9grid="" crop="" onovercrop="" ondowncrop="" mask="" effect="" jsborder="" bgcolor="0x000000" bgalpha="0.0" bgcapture="false" onover="" onhover="" onout="" onclick="" ondown="" onup="" onloaded="" />
Full variable name (read only) | Type | Default value | |
plugin.countlayer.count | int | 0 | |
---|---|---|---|
The count / number of all layer/plugin elements. | |||
Full variable name | Type | Default value | |
plugin.enabledlayer.enabled | Boolean | true | |
Enable/disable the whole layer/plugin layer for receiving mouse events. | |||
Full variable name | Type | Default value | |
plugin.visiblelayer.visible | Boolean | true | |
Show/hide the whole layer/plugin layer. | |||
Full variable name | Type | Default value | |
plugin.alphalayer.alpha | Number | 1.0 | |
Controls the transparency / alpha of the whole layer/plugin layer. | |||
Full variable name (as3 usage only) | Type | Default value | |
plugin.layerlayer.layer | Sprite | ||
Actionscript 3 Sprite object of the layer/plugin layer. | |||
Attribute name | Full variable name | Type | Default value |
name | plugin[name].name | String | |
name | layer[name].name | String | |
The name of the current layer/plugin element (see the name notes). | |||
Attribute name | Full variable name (read only) | Type | Default value |
indexindex | plugin[name].indexlayer[name].index | int | |
The index of the current layer/plugin element. | |||
Attribute name | Full variable name | Type | Default value |
type | plugin[name].type | String | "image" |
type | layer[name].type | String | "image" |
Type of the layer/plugin element.
Possible settings:
| |||
Attribute name | Full variable name | Type | Default value |
url | plugin[name].url | String | |
url | layer[name].url | String | |
The path/url to the layer/plugin image file. (see also the url notes) Supported file types: SWF, JPG, PNG, GIF. | |||
Attribute name | Full variable name | Type | Default value |
alturl | plugin[name].alturl | String | |
alturl | layer[name].alturl | String | |
An 'alternative' path/url for the layer/plugin image file for the krpano HTML5 viewer.
When setting the alturl setting, the normal url setting will be overwritten in the HTML5 viewer - that means, declare the alturl always after the url setting.
This can be used to use an alternative image, e.g. an animated gif instead of an animated flash. Supported file types: JPG, PNG, GIF and Animated GIF. Note - the alturl setting should be used only in the static-xml-code! Inside dynamic/actions code, if() actions like: if(device.html5, set(url,html5.png), set(url,flash.png) );should be used to set different urls. | |||
Attribute name | Full variable name | Type | Default value |
keep | plugin[name].keep | Boolean | false |
keep | layer[name].keep | Boolean | false |
Should this layer/plugin element be kept or removed when loading a new pano. See also the loadpano() action. | |||
Attribute name | Full variable name | Type | Default value |
visible | plugin[name].visible | Boolean | true |
visible | layer[name].visible | Boolean | true |
Visibility of the layer/plugin element. | |||
Attribute name | Full variable name | Type | Default value |
enabled | plugin[name].enabled | Boolean | true |
enabled | layer[name].enabled | Boolean | true |
Enables the layer/plugin element to receive mouse events.
When set to "false" then the mouse events will be routed to the underlying elements. | |||
Attribute name | Full variable name | Type | Default value |
handcursor | plugin[name].handcursor | Boolean | true |
handcursor | layer[name].handcursor | Boolean | true |
Show a hand cursor when mouse is over the layer/plugin element. | |||
Attribute name | Full variable name | Type | Default value |
maskchildren | plugin[name].maskchildren | Boolean | false |
maskchildren | layer[name].maskchildren | Boolean | false |
When set to true then all child elements that are outside of the parent element will be clipped / masked out. | |||
Attribute name | Full variable name | Type | Default value |
zorder | plugin[name].zorder | String | |
zorder | layer[name].zorder | String | |
Deep / 'Z' ordering of the layer/plugin elements. This value can be any string or number. All layer/plugin elements with a zorder setting will be sorted by the given value. When nothing is set - then the order is undefined and depends on the loading/finishing order of the browser. Note - this is an important setting for overlapping elements! HTML5 Notes - the zorder should be a value between 0 and 100, no negative values! | |||
Attribute name | Full variable name | Type | Default value |
capturecapture | layer[name].captureplugin[name].capture | Boolean | true |
This is an additional setting to the enabled setting: When enabled=true and capture=true then the mouse events will be only sent to this layer/plugin, no movement / controlling of the pano is possible. When enabled=true and capture=false then the mouse events will be sent to the layer/plugin and also to all underlying elements, controlling the pano will be still possible. | |||
Attribute name | Full variable name | Type | Default value |
childrenchildren | layer[name].childrenplugin[name].children | Boolean | true |
Enables the children elements of the current layer/plugin element for receiving mouse events. | |||
Attribute name | Full variable name | Type | Default value |
preloadpreload | layer[name].preloadplugin[name].preload | Boolean | false |
Preload the layer/plugin url before loading the pano and before executing any actions. This
can be used to force some element to be there and ready before everything else starts. Note - the onloaded event doesn't work / can't be used when preloading is enabled! | |||
Attribute name | Full variable name (Flash only) | Type | Default value |
blendmodeblendmode | layer[name].blendmodeplugin[name].blendmode | String | "normal" |
Blending / mixing mode - possible settings: normal, layer, screen, add, subtract, difference, multiply, overlay, lighten, darken, hardlight, invert. See here for more details about all available blending modes: http://help.adobe.com/.../BlendMode.html And here for some illustrations / examples: http://help.adobe.com/.../DisplayObject.html#blendMode | |||
Attribute name | Full variable name | Type | Default value |
style | plugin[name].style | String | |
style | layer[name].style | String | |
Load the attributes from one or more <style> elements. This can be used to reduce the xml code - the attributes that are the same for more layer/plugin or hotspot elements can be stored together at one place in a <style> element. To specify more than one style, separate the style names by pipe | characters. Note - the attributes that were defined in a style can NOT be overwritten in the layer / plugin / hotspots definition! Example: <style name="style1" alpha="0.5" scale="0.5" ... /> A style can be also loaded dynamically by the loadstyle(name) action. | |||
Attribute name | Full variable name | Type | Default value |
align | plugin[name].align | String | |
align | layer[name].align | String | |
Alignment / origin-point position of the layer/plugin element on the screen. Possible values: lefttop, left, leftbottom, top, center, bottom, righttop, right, rightbottom - or - no value (empty or null) When NOT set (the default) no positioning will be done by krpano (useful / necessary for some flash/swf plugins). | |||
Attribute name | Full variable name | Type | Default value |
edge | plugin[name].edge | String | |
edge | layer[name].edge | String | |
Edge / anchor-point of the layer/plugin element. Possible values: lefttop, left, leftbottom, top, center, bottom, righttop, right, rightbottom - or - no value (empty or null) When NOT set (the default) the same setting as in the align attribute will be used. | |||
Attribute name | Full variable name | Type | Default value |
x y | plugin[name].x plugin[name].y | String String | |
x y | layer[name].x layer[name].y | String String | |
Distance from the align point to the edge point. This can be a absolute pixel value or a relative (to the screenwidth or screenheight) percent value. Note - for right/bottom aligned elements this distance will be measured from the right/bottom side. | |||
Attribute name | Full variable name | Type | Default value |
ox oyox oy | layer[name].ox layer[name].oyplugin[name].ox plugin[name].oy | String String | |
Offset / parallel-shift of the layer/plugin element. This values will be added to the x/y values. This can be a absolute pixel value or a relative (to layer/plugin size) percent value. | |||
Attribute name | Full variable name | Type | Default value |
rotate | plugin[name].rotate | Number | 0.0 |
rotate | layer[name].rotate | Number | 0.0 |
Rotation of the layer/plugin element in degrees. | |||
Attribute name | Full variable name | Type | Default value |
width height | plugin[name].width plugin[name].height | String String | |
width height | layer[name].width layer[name].height | String String | |
Destination size of the layer/plugin element - the image will be scaled to that size. This can be a absolute pixel value or a relative (to the screenwidth or screenheight) percent value. When not set - the size of the loaded image will be used. Negative values - when using negative values as size, then the resulting size will be the size of the parent element (or the size of the stage when there is no parent) without the given negative value. Additionally it's possible to use the special value "prop" to scale an image via width or height by keeping it proportions (e.g. set width or height to a value and the other setting to "prop" - width="500" height="prop"). | |||
Attribute name | Full variable name (read only) | Type | Default value |
imagewidth imageheightimagewidth imageheight | layer[name].imagewidth layer[name].imageheightplugin[name].imagewidth plugin[name].imageheight | int int | |
These variables contain the original unscaled pixel size of the loaded image, this information are first available after the onloaded event. | |||
Attribute name | Full variable name (read only) | Type | Default value |
pixelwidth pixelheightpixelwidth pixelheight | layer[name].pixelwidth layer[name].pixelheightplugin[name].pixelwidth plugin[name].pixelheight | int int | |
These variables contain the final pixel size of the element, but note - they don't get updated immediately when changing the normal width/height/scale variables, the update happens after a screen refresh or when calling the updatepos() action. | |||
Attribute name | Full variable name | Type | Default value |
scale | plugin[name].scale | Number | 1.0 |
scale | layer[name].scale | Number | 1.0 |
Scaling of the layer/plugin element. | |||
Attribute name | Full variable name (Flash only) | Type | Default value |
pixelhittestpixelhittest | layer[name].pixelhittestplugin[name].pixelhittest | Boolean | false |
Enabling a pixel accurate hit testing which respects the transparency of the image instead of using the bounding box (Flash only). Note - use this setting with care! The pixel accurate hit-test is a much heavier operation than the normal default bounding box check! | |||
Attribute name | Full variable name (Flash only) | Type | Default value |
smoothingsmoothing | layer[name].smoothingplugin[name].smoothing | Boolean | true |
Pixel smoothing when scaling. | |||
Attribute name | Full variable name | Type | Default value |
accuracyaccuracy | layer[name].accuracyplugin[name].accuracy | int | 0 |
Accuracy of the layer/plugin image positioning: When set to 0 (the default) the pixel positions will be rounded to full pixel values. This avoids jumpy movements when changing the rendering quality of the Flashplayer. When set to 1 no rounding of the position values will be done. HTML5 Notes - since iOS 5 it's also possible to use floating point precision for positions and sizes on iPhone/iPad and co., set accuracy=1 to use that. | |||
Attribute name | Full variable name | Type | Default value |
alpha | plugin[name].alpha | Number | 1.0 |
alpha | layer[name].alpha | Number | 1.0 |
Alpha value / transparency of the layer/plugin element. 0.0 = fully transparent, 1.0 = fully visible Note - even when set to 0.0 - the element will be still there and click-able - to hide it completely the visible attribute must be set to false! | |||
Attribute name | Full variable name | Type | Default value |
autoalphaautoalpha | layer[name].autoalphaplugin[name].autoalpha | Boolean | false |
When set to "true", then visible will be automatically set to "false" when alpha is 0.0 and back to "true" when alpha is bigger then 0.0. | |||
Attribute name | Full variable name (Flash only) | Type | Default value |
usecontentsizeusecontentsize | layer[name].usecontentsizeplugin[name].usecontentsize | Boolean | false |
When a .swf file will be loaded, then are two possibilities to determinate its size / dimension - either the size of full canvas of the flash object will be used (usecontentsize=false, the default) - or - only the size of the drawn content there (usecontentsize=true). | |||
Attribute name | Full variable name | Type | Default value |
scale9gridscale9grid | layer[name].scale9gridplugin[name].scale9grid | String | |
Defines a grid in pixel coordinates that splits the layer/plugin image into 9 segments.
And when scaling the layer/plugin via the width / height / scale values, the 'edge' segments
will be kept unscaled and only the 'middle' segments will be scaled. When using scale9grid, then scalechildren always will be false. Syntax: scale9grid="x-position|y-position|width|height|prescale*"
| |||
Attribute name | Full variable name | Type | Default value |
crop onovercrop ondowncrop | plugin[name].crop plugin[name].onovercrop plugin[name].ondowncrop | String String String | |
crop onovercrop ondowncrop | layer[name].crop layer[name].onovercrop layer[name].ondowncrop | String String String | |
Crop / cut out a rectangular area of the source image. Usefull to use only one single image
for serval image elements. onovercrop / ondowncrop - different crop areas for mouse over and mouse button down states. Syntax: crop="x-position|y-position|width|height" | |||
Attribute name | Full variable name | Type | Default value |
parent | plugin[name].parent | String | |
parent | layer[name].parent | String | |
Assign the current layer/plugin to be a child element of an other layer/plugin or hotspot element.
The assigned layer/plugin will be aligned inside the parent element. There are two special predefined parent elements:
Syntax: Either use only the name of the parent layer/plugin: parent="name"Or the full path/name of the layer/plugin or hotspot that should be the parent element: parent="layer[name]" parent="hotspot[name]"Or to align the layer/plugin element on the outside or behind the pano area: parent="STAGE" parent="BGLAYER" Note - distorted hotspots can't be used as parent at the moment! | |||
Attribute name | Full variable name | Type | Default value |
scalechildren | plugin[name].scalechildren | Boolean | false |
scalechildren | layer[name].scalechildren | Boolean | false |
Should a child layer/plugin element, that have been assigned by parent also be scaled when the current layer/plugin element will scaled. | |||
Attribute name | Full variable name (Flash only) | Type | Default value |
maskmask | layer[name].maskplugin[name].mask | String | |
Use an other layer/plugin or hotspot image as mask. The image should have an alpha channel (e.g. use a .png image for it).
Without alpha channel the bounding box area of the layer/plugin will be used as mask. Syntax: Either use only the name of a other layer/plugin: mask="name"Or the full path/name of the layer/plugin or hotspot that should be used as mask: mask="layer[name]" mask="hotspot[name]" Note - for rendering performance reasons the mask shouldn't not be used with distorted hotspots! | |||
Attribute name | Full variable name (Flash only) | Type | Default value |
effecteffect | layer[name].effectplugin[name].effect | String | |
Apply bitmap effects to the layer/plugin image. That can be any combinations of these effect functions: glow(color,alpha,range,strength); dropshadow(depth,angle,color,range,strength); blur(radius); | |||
Attribute name | Full variable name (HTML5 only) | Type | Default value |
jsborderjsborder | layer[name].jsborderplugin[name].jsborder | String | |
Javascript CSS border settings. | |||
Attribute name | Full variable name | Type | Default value |
bgcolor | plugin[name].bgcolor | int | 0x000000 |
bgcolor | layer[name].bgcolor | int | 0x000000 |
Background color of the container element (only available when type="container"). | |||
Attribute name | Full variable name | Type | Default value |
bgalpha | plugin[name].bgalpha | Number | 0.0 |
bgalpha | layer[name].bgalpha | Number | 0.0 |
Transparency / alpha of the background color of the container element (only available when type="container"). | |||
Attribute name | Full variable name | Type | Default value |
bgcapture | plugin[name].bgcapture | Boolean | false |
bgcapture | layer[name].bgcapture | Boolean | false |
Capture mouse events on the background of the container element (only available when type="container" and bgalpha > 0.0). | |||
Attribute name | Full variable name (read only) | Type | Default value |
loadingloading | layer[name].loadingplugin[name].loading | Boolean | false |
A boolean read-only variable that indicates that the layer/plugin is currently loading an image. | |||
Attribute name | Full variable name (read only) | Type | Default value |
loadedloaded | layer[name].loadedplugin[name].loaded | Boolean | false |
A boolean read-only variable that indicates that the layer/plugin has loaded the given image. | |||
Attribute name | Full variable name (read only) | Type | Default value |
loadedurlloadedurl | layer[name].loadedurlplugin[name].loadedurl | String | |
The loadedurl attribute contains the full url of the currently loaded image. | |||
Attribute name | Full variable name (read only) | Type | Default value |
hoveringhovering | layer[name].hoveringplugin[name].hovering | Boolean | false |
A boolean read-only variable that indicates that the mouse cursor it currently over the layer/plugin. | |||
Attribute name | Full variable name (read only) | Type | Default value |
pressedpressed | layer[name].pressedplugin[name].pressed | Boolean | false |
A boolean read-only variable that indicates that the mouse button was pressed on the layer/plugin and is still hold down. | |||
Attribute name | Full variable name | Type | Default value |
onover | plugin[name].onover | Action Event | |
onover | layer[name].onover | Action Event | |
Actions / functions that will be called when the mouse moves over the layer/plugin element. | |||
Attribute name | Full variable name | Type | Default value |
onhover | plugin[name].onhover | Action Event | |
onhover | layer[name].onhover | Action Event | |
Actions / functions that will be called in intervals (15 times per second) when the mouse stays over / hovers the layer/plugin element. | |||
Attribute name | Full variable name | Type | Default value |
onout | plugin[name].onout | Action Event | |
onout | layer[name].onout | Action Event | |
Actions / functions that will be called when the mouse moves out of the layer/plugin element. | |||
Attribute name | Full variable name | Type | Default value |
onclick | plugin[name].onclick | Action Event | |
onclick | layer[name].onclick | Action Event | |
Actions / functions that will be called when there is a mouse click on the layer/plugin element. | |||
Attribute name | Full variable name | Type | Default value |
ondown | plugin[name].ondown | Action Event | |
ondown | layer[name].ondown | Action Event | |
Actions / functions that will be called when the mouse button will be pressed down on the layer/plugin element. | |||
Attribute name | Full variable name | Type | Default value |
onup | plugin[name].onup | Action Event | |
onup | layer[name].onup | Action Event | |
Actions / functions that will be called when the previously pressed mouse button will be released. | |||
Attribute name | Full variable name | Type | Default value |
onloaded | plugin[name].onloaded | Action Event | |
onloaded | layer[name].onloaded | Action Event | |
Actions / functions that will be called when the loading of the layer/plugin image is done. | |||
Attribute name | Full variable name | Type | Default value |
loaderloader | layer[name].loaderplugin[name].loader | ||
Flash: Actionscript 3 Loader object of the loaded layer/plugin image. HTML5: HTML Image element. | |||
Attribute name | Full variable name | Type | Default value |
spritesprite | layer[name].spriteplugin[name].sprite | ||
Flash: Actionscript 3 Sprite object of the layer/plugin element. HTML5: HTML DOM element (div) of the layer/plugin element. | |||
function name | Type | ||
layer[name].loadstyle(name)plugin[name].loadstyle(name) | Action | ||
An action of the layer/plugin element to load interactively settings from a <style> tag. | |||
function name | Type | ||
layer[name].registercontentsize(width,height)plugin[name].registercontentsize(width,height) | Action | ||
The registercontentsize action can be used to set / register the 'original / source / unscaled' size of the layer/plugin element.
By default the imagesize or the size of the swf file will be used - this source size can be changed here. For HTML5 / Javascript Plugins that want to draw custom stuff this function call is necessary to set the source size because Javascript Plugins don't have any information about its size. | |||
function name | Type | ||
layer[name].resetsize()plugin[name].resetsize() | Action | ||
An action to set the width and height values back to the source size of the loaded image. This can be used after changing the url value to get the size of the new loaded image. | |||
function name | Type | ||
layer[name].updatepos()plugin[name].updatepos() | Action | ||
Updates / recalculates the position and size of the layer/plugin immediately (normally this will be done automatically with the next screen refresh). After calling this actions the pixelwidth and pixelheight variables will contain the final pixel sizes of the layer/plugin element. | |||
function name | Type | ||
layer[name].changeorigin(align,edge)plugin[name].changeorigin(align,edge) | Action | ||
An action to change the alignment and edge of a layer/plugin element without changing its current position. The x/y values will be recalculated to keep the current position. | |||
function name (plugininterface only) | Type | return | |
layer[name].getfullpath()plugin[name].getfullpath() | Action | String | |
A function that returns the full path/name of the layer/plugin element. Because of the return value this action is only callable from the plugin interface. |
<layer name="logo" url="logoimage.png" align="rightbottom" x="20" y="20" onclick="openurl('http://...');" >
<layer name="imagebar" type="container" width="100%" height="200" align="leftbottom" bgcolor="0x000000" bgalpha="0.5"> <layer name="item1" url="image1.jpg" align="left" x="10" /> <layer name="item2" url="image2.jpg" align="left" x="110" /> <layer name="item3" url="image3.jpg" align="left" x="210" /> </layer>
<hotspot name="..." type="image" url="..." alturl="..." keep="false" devices="all" visible="true" enabled="true" handcursor="true" maskchildren="false" zorder="" zorder2="0.0" capture="true" children="true" blendmode="normal" style="" ath="0.0" atv="0.0" edge="center" ox="0" oy="0" zoom="false" distorted="false" rx="0.0" ry="0.0" rz="0.0" details="8" inverserotation="false" flying="0.0" width="" height="" scale="1.0" rotate="0.0" pixelhittest="false" smoothing="true" accuracy="1" accuracy2="1" alpha="1.0" autoalpha="false" usecontentsize="false" scale9grid="" crop="" onovercrop="" ondowncrop="" scalechildren="false" mask="" effect="" onover="" onhover="" onout="" onclick="" ondown="" onup="" onloaded="" />
<hotspot name="..." keep="false" visible="true" enabled="true" handcursor="true" zorder="" capture="true" blendmode="normal" style="" alpha="1.0" autoalpha="false" fillcolor="0xFFFFFF" fillcolorhover="0xFFFFFF" fillalpha="0.0" fillalphahover="0.1" borderwidth="0.0" borderwidthhover="4.0" bordercolor="0xFFFFFF" bordercolorhover="0xFFFFFF" borderalpha="0.0" borderalphahover="0.8" fadeintime="0.15" fadeincurve="1.1" fadeouttime="0.3" fadeoutcurve="0.7" onover="" onhover="" onout="" onclick="" ondown="" onup="" > <point ath="..." atv="..." /> <point ath="..." atv="..." /> <point ath="..." atv="..." /> ... </hotspot>
Full variable name (read only) | Type | Default value | |
hotspot.count | int | 0 | |
---|---|---|---|
The count / number of all hotspot elements. | |||
Full variable name | Type | Default value | |
hotspot.enabled | Boolean | true | |
Enable/disable the whole hotspots layer for receiving mouse events. | |||
Full variable name | Type | Default value | |
hotspot.visible | Boolean | true | |
Show/hide the whole hotspots layer. | |||
Full variable name | Type | Default value | |
hotspot.alpha | Number | 1.0 | |
Controls the transparency / alpha of the whole hotspots layer. | |||
Full variable name (as3 usage only) | Type | Default value | |
hotspot.layer | Sprite | ||
Actionscript 3 Sprite object of the hotspots layer. |
|||
Attribute name | Full variable name | Type | Default value |
name | hotspot[name].name | String | |
The name of the current hotspot element (see the name notes). | |||
Attribute name | Full variable name (read only) | Type | Default value |
index | hotspot[name].index | int | |
The index of the current hotspot element. | |||
Attribute name | Full variable name | Type | Default value |
type | hotspot[name].type | String | "image" |
Type of the hotspot element. Possible settings:
|
|||
Attribute name | Full variable name | Type | Default value |
url | hotspot[name].url | String | |
The path/url to the hotspot image file. (see also the url notes) Supported file types: SWF, JPG, PNG, GIF. Note - when "url" will be set, the hotspot will be an image hotspot! |
|||
Attribute name | Full variable name | Type | Default value |
alturl | hotspot[name].alturl | String | |
An 'alternative' path/url for the hotspot image file for the krpano HTML5 viewer.
When setting the alturl setting, the normal url setting will be overwritten in the HTML5 viewer - that means, declare the alturl always after the url setting.
This can be used to use an alternative image, e.g. an animated gif instead of an animated flash. Supported file types: JPG, PNG, GIF and Animated GIF. Note - the alturl setting should be used only in the static-xml-code! Inside dynamic/actions code, if() actions like: if(device.html5, set(url,html5.png), set(url,flash.png) );should be used to set different urls. |
|||
Attribute name | Full variable name | Type | Default value |
keep | hotspot[name].keep | Boolean | false |
Should this hotspot element be kept or removed when loading a new pano. See also the loadpano() action. |
|||
Attribute name | Full variable name | Type | Default value |
visible | hotspot[name].visible | Boolean | true |
Visibility of the hotspot element. | |||
Attribute name | Full variable name | Type | Default value |
enabled | hotspot[name].enabled | Boolean | true |
Enables the hotspot element to receive mouse events.
When set to "false" then the mouse events will be routed to the underlying elements. |
|||
Attribute name | Full variable name | Type | Default value |
handcursor | hotspot[name].handcursor | Boolean | true |
Show a hand cursor when mouse is over the hotspot element. | |||
Attribute name | Full variable name | Type | Default value |
maskchildren | hotspot[name].maskchildren | Boolean | false |
When set to true then all child elements that are outside of the parent element will be clipped / masked out. | |||
Attribute name | Full variable name | Type | Default value |
zorder | hotspot[name].zorder | String | |
Deep / "Z" ordering of the hotspot elements. This value can be any string or number. All hotspot elements with a zorder setting will be sorted by the given value. When nothing is set - then the order is undefined and depends on the loading/finishing order of the browser. Note - this is an important setting for overlapping elements! HTML5 Note - the zorder should be a value between 0 and 100, no negative values! |
|||
Attribute name | Full variable name (HTML5 only) | Type | Default value |
zorder2 | hotspot[name].zorder2 | Number | 0.0 |
The zorder2 setting is for ordering normal and distorted hotspots in the HTML5 viewer.
Due browser/css related limitations it is not always possible to mix / order normal hotspots and distorted hotspots
withhin the same layer. But by using the new zorder2 setting, it is possible to define if a normal, non-distorted
hotspot should be above or below the other distorted hotspots. Usage:
|
|||
Attribute name | Full variable name | Type | Default value |
capture | hotspot[name].capture | Boolean | true |
This is an additional setting to the enabled setting: When enabled=true and capture=true then the mouse events will be only sent to this hotspot, no movement / controlling of the pano is possible. When enabled=true and capture=false then the mouse events will be sent to the hotspot and also to all underlying elements, controlling the pano will be still possible. |
|||
Attribute name | Full variable name | Type | Default value |
children | hotspot[name].children | Boolean | true |
Enables the children elements of the current hotspot element for receiving mouse events. | |||
Attribute name | Full variable name (Flash only) | Type | Default value |
blendmode | hotspot[name].blendmode | String | "normal" |
Blending / mixing mode - possible settings: normal, layer, screen, add, subtract, difference, multiply, overlay, lighten, darken, hardlight, invert. See here for more details about all available blending modes: http://help.adobe.com/.../BlendMode.html And here for some illustrations / examples: http://help.adobe.com/.../DisplayObject.html#blendMode |
|||
Attribute name | Full variable name | Type | Default value |
style | hotspot[name].style | String | |
Load the attributes from one or more <style> elements. This can be used to reduce the xml code - the attributes that are the same for more layer/plugin or hotspot elements can be stored together at one place in a <style> element. To specify more than one style, separate the style names by pipe | characters. Note - the attributes that were defined in a style can NOT be overwritten in the layer / plugin / hotspots definition! Example: <style name="style1" alpha="0.5" scale="0.5" ... /> A style can be also loaded dynamically by the loadstyle(name) action. |
|||
Attribute name | Full variable name | Type | Default value |
ath atv |
hotspot[name].ath hotspot[name].atv |
Number Number |
0.0 0.0 |
The spherical coordinates of the hotspot in degrees. There the hotspot image will be aligned by the in the edge setting defined point. | |||
Attribute name | Full variable name | Type | Default value |
edge | hotspot[name].edge | String | "center" |
Edge / anchor-point of the hotspot element. Possible values: lefttop, left, leftbottom, top, center, bottom, righttop, right, rightbottom |
|||
Attribute name | Full variable name | Type | Default value |
ox oy |
hotspot[name].ox hotspot[name].oy |
String String |
|
Offset / parallel-shift of the hotspot element from the edge point. This can be a absolute pixel value or a relative (to hotspot size) percent value. |
|||
Attribute name | Full variable name | Type | Default value |
zoom | hotspot[name].zoom | Boolean | false |
Should the size of the hotspot image change together with the pano when zooming. | |||
Attribute name | Full variable name | Type | Default value |
distorted | hotspot[name].distorted | Boolean | false |
Should the hotspot image be distorted in the 3D space together with the current pano/viewing distortion.
When distorted use rx / ry / rz settings
to rotate the hotspot in 3D space. Note 1 - When enabled, a size of 1000 pixels will be used as reference for pixel sizes. And this 1000 pixels are covering a field of view of 90 degrees in 3D space. Note 2 - Distorted hotspots can't and shouldn't have children elements. They will be probably not displayed correctly. Note 3 - Displaying Flash plugins as distorted hotspots should be possible but not the direct interaction with them. In this case the plugin will not display directly, only a kind of 'screenshot'-image of it. Note 4 - In HTML5 the sorting of normal and distorted hotspots via zorder is not possible, the zorder2 setting can be used additionally for normal hotspots to move them above the distorted hotspots. |
|||
Attribute name | Full variable name | Type | Default value |
rx ry rz |
hotspot[name].rx hotspot[name].ry hotspot[name].rz |
Number Number Number |
0.0 0.0 0.0 |
3D Rotation in degrees over the X / Y / Z axes. (axis order: Y-X-Z) Note - can only be used when distorted="true"! |
|||
Attribute name | Full variable name (Flash only) | Type | Default value |
details | hotspot[name].details | int | 8 |
Internal rendering tesslation details, a higher details value will result in a more detailed internal 3D-geometry. When using the Flashplayer 10 and cubical images without any distortion (fisheye,stereographic,...) then this setting will be ignored, because a tesslation will be no necessary. | |||
Attribute name | Full variable name | Type | Default value |
inverserotation | hotspot[name].inverserotation | Boolean | false |
Inverses the rotation and the axis order of the rx / ry / rz settings. | |||
Attribute name | Full variable name | Type | Default value |
flying | hotspot[name].flying | Number | 0.0 |
This setting interpolates automatically the ath/atv and scale values to the current viewing values. The value range is from 0.0 to 1.0. At 1.0 the hotspot image will be locked always to the middle to screen and it's size will be relative to 1000 pixel in screen height. | |||
Attribute name | Full variable name | Type | Default value |
width height |
hotspot[name].width hotspot[name].height |
String String |
|
Destination size of the hotspot element - the image will be scaled to that size. This can be a absolute pixel value or a relative (to the screenwidth or screenheight) percent value. When not set - the size of the loaded image will be used. Additionally it's possible to use the special value "prop" to scale an image via width or height by keeping it proportions (e.g. set width or height to a value and the other setting to "prop" - width="500" height="prop"). Note - when using distorted hotspots, then the size is relative to an internal base-size where 1000 pixel are covering a 90 degree field of view. |
|||
Attribute name | Full variable name (read only) | Type | Default value |
imagewidth imageheight |
hotspot[name].imagewidth hotspot[name].imageheight |
int int |
|
These variables contain the original unscaled pixel size of the loaded image, this information are first available after the onloaded event. | |||
Attribute name | Full variable name | Type | Default value |
scale | hotspot[name].scale | Number | 1.0 |
Scaling of the hotspot element. | |||
Attribute name | Full variable name | Type | Default value |
rotate | hotspot[name].rotate | Number | 0.0 |
Rotation of the hotspot element in degrees. Note - this setting should NOT be used together with distorted="true"! |
|||
Attribute name | Full variable name (Flash only) | Type | Default value |
pixelhittest | hotspot[name].pixelhittest | Boolean | false |
Enabling a pixel accurate hit testing which respects the transparency of the image instead of using the bounding box. Note - use this setting with care! The pixel accurate hit-test is a much heavier operation than the normal default bounding box check! |
|||
Attribute name | Full variable name (Flash only) | Type | Default value |
smoothing | hotspot[name].smoothing | Boolean | true |
Pixel smoothing when scaling. | |||
Attribute name | Full variable name | Type | Default value |
accuracy | hotspot[name].accuracy | int | 1 |
Accuracy of the hotspot image positioning:
|
|||
Attribute name | Full variable name (HTML5 only) | Type | Default value |
accuracy2 | hotspot[name].accuracy2 | int | 1 |
The accuracy2 setting controls the rounding of the position-coordinates of non-distorted hotspots on the screen:
|
|||
Attribute name | Full variable name | Type | Default value |
alpha | hotspot[name].alpha | Number | 1.0 |
Alpha value / transparency of the hotspot element. 0.0 = fully transparent, 1.0 = fully visible Note - even when set to 0.0 - the element will be still there and click-able - to hide it completely the visible attribute must be set to false! |
|||
Attribute name | Full variable name | Type | Default value |
autoalpha | hotspot[name].autoalpha | Boolean | false |
When set to "true", then visible will be automatically set to "false" when alpha is 0.0 and back to "true" when alpha is bigger then 0.0. | |||
Attribute name | Full variable name (Flash only) | Type | Default value |
usecontentsize | hotspot[name].usecontentsize | Boolean | false |
When a .swf file will be loaded, then are two possibilities to determinate its size / dimension - either the size of full canvas of the flash object will be used (usecontentsize=false, the default) - or - only the size of the drawn content there (usecontentsize=true). | |||
Attribute name | Full variable name | Type | Default value |
scale9grid | hotspot[name].scale9grid | String | |
Defines a grid in pixel coordinates that splits the hotspot image into 9 segments.
And when scaling the layer/plugin via the width / height / scale values, the 'edge' segments
will be kept unscaled and only the 'middle' segments will be scaled. When using scale9grid, then scalechildren always will be false. Syntax: scale9grid="x-position|y-position|width|height|prescale*"
|
|||
Attribute name | Full variable name | Type | Default value |
crop onovercrop ondowncrop |
hotspot[name].crop hotspot[name].onovercrop hotspot[name].ondowncrop |
String String String |
|
Crop / cut out a rectangular area of the source image. Useful to use only one single image
for several image elements. onovercrop / ondowncrop - different crop areas for mouse over and mouse button down states. Syntax: crop="x-position|y-position|width|height" |
|||
Attribute name | Full variable name | Type | Default value |
scalechildren | hotspot[name].scalechildren | Boolean | false |
Should a child layer/plugin element, that have been assigned by parent also be scaled when the current hotspot element will scaled. | |||
Attribute name | Full variable name (Flash only) | Type | Default value |
mask | hotspot[name].mask | String | |
Use an other layer/plugin or hotspot image as mask. The image should have an alpha channel (e.g. use a .png image for it).
Without alpha channel the bounding box area of the layer/plugin will be used as mask. Syntax: Either use only the name of a hotspot: mask="name"Or the full path/name of the layer/plugin or hotspot that should be used as mask: mask="layer[name]" mask="hotspot[name]" Note - for rendering performance reasons the mask shoudn't not be used with distorted hotspots! |
|||
Attribute name | Full variable name (Flash only) | Type | Default value |
effect | hotspot[name].effect | String | |
Apply bitmap effects to the hotspot image. That can be any combinations of these effect functions: glow(color,alpha,range,strength); dropshadow(depth,angle,color,range,strength); blur(radius); |
|||
Attribute name | Full variable name | Type | Default value |
fillcolor fillcolorhover |
hotspot[name].fillcolor hotspot[name].fillcolorhover |
int int |
0xFFFFFF 0xFFFFFF |
The fill color of a polygonal hotspot. Normal and during mouse hovering. | |||
Attribute name | Full variable name | Type | Default value |
fillalpha fillalphahover |
hotspot[name].fillalpha hotspot[name].fillalphahover |
Number Number |
0.0 0.1 |
The alpha value / transparency of the filling color of polygonal hotspot. Normal and during mouse hovering. | |||
Attribute name | Full variable name | Type | Default value |
borderwidth borderwidthhover |
hotspot[name].borderwidth hotspot[name].borderwidthhover |
Number Number |
0.0 4.0 |
The with of the line border of a polygonal hotspot. Normal and during mouse hovering. | |||
Attribute name | Full variable name | Type | Default value |
bordercolor bordercolorhover |
hotspot[name].bordercolor hotspot[name].bordercolorhover |
int int |
0xFFFFFF 0xFFFFFF |
The color of the line border of a polygonal hotspot. Normal and during mouse hovering. | |||
Attribute name | Full variable name | Type | Default value |
borderalpha borderalphahover |
hotspot[name].borderalpha hotspot[name].borderalphahover |
Number Number |
0.0 0.8 |
The alpha value / transparency of the line border of a polygonal hotspot. Normal and during mouse hovering. | |||
Attribute name | Full variable name | Type | Default value |
fadeintime fadeincurve fadeouttime fadeoutcurve |
hotspot[name].fadeintime hotspot[name].fadeincurve hotspot[name].fadeouttime hotspot[name].fadeoutcurve |
Number Number Number Number |
0.15 1.1 0.3 0.7 |
The times and 'curves' for the change from normal to hovering state and back for polygonal hotspots. | |||
Full variable name (read only) | Type | Default value | |
hotspot[name].point.count | int | 0 | |
Number of polygon points. |
|||
Attribute name | Full variable name | Type | Default value |
point[..].ath point[..].atv |
hotspot[name].point[..].ath hotspot[name].point[..].atv |
Number Number |
|
The spherical coordinates of the polygonal hotspot points in degrees. | |||
Attribute name | Full variable name (read only) | Type | Default value |
loading | hotspot[name].loading | Boolean | false |
A boolean read-only variable that indicates that the hotspot is currently loading an image. |
|||
Attribute name | Full variable name (read only) | Type | Default value |
loaded | hotspot[name].loaded | Boolean | false |
A boolean read-only variable that indicates that the hotspot has loaded the given image. | |||
Attribute name | Full variable name (read only) | Type | Default value |
loadedurl | hotspot[name].loadedurl | String | |
The loadedurl attribute contains the full url of the currently loaded image. | |||
Attribute name | Full variable name (read only) | Type | Default value |
hovering | hotspot[name].hovering | Boolean | false |
A boolean read-only variable that indicates that the mouse cursor it currently over the hotspot. | |||
Attribute name | Full variable name (read only) | Type | Default value |
pressed | hotspot[name].pressed | Boolean | false |
A boolean read-only variable that indicates that the mouse button was pressed on the hotspot and is still hold down. | |||
Attribute name | Full variable name | Type | Default value |
onover | hotspot[name].onover | Action Event | |
Actions / functions that will be called when the mouse moves over the hotspot element. | |||
Attribute name | Full variable name | Type | Default value |
onhover | hotspot[name].onhover | Action Event | |
Actions / functions that will be called in intervals (15 times per second) when the mouse stays over / hovers the hotspot element. | |||
Attribute name | Full variable name | Type | Default value |
onout | hotspot[name].onout | Action Event | |
Actions / functions that will be called when the mouse moves out of the hotspot element. | |||
Attribute name | Full variable name | Type | Default value |
onclick | hotspot[name].onclick | Action Event | |
Actions / functions that will be called when there is a mouse click on the hotspot element. | |||
Attribute name | Full variable name | Type | Default value |
ondown | hotspot[name].ondown | Action Event | |
Actions / functions that will be called when the mouse button will be pressed down on the hotspot element. | |||
Attribute name | Full variable name | Type | Default value |
onup | hotspot[name].onup | Action Event | |
Actions / functions that will be called when the previously pressed mouse button will be released. | |||
Attribute name | Full variable name | Type | Default value |
onloaded | hotspot[name].onloaded | Action Event | |
Actions / functions that will be called when the loading of the hotspot image is done. | |||
Attribute name | Full variable name (as3 usage only) | Type | Default value |
loader | hotspot[name].loader | Loader | |
Actionscript 3 Loader object of the loaded hotspot image. |
|||
Attribute name | Full variable name (as3 usage only) | Type | Default value |
sprite | hotspot[name].sprite | Loader | |
Actionscript 3 Sprite object of the hotspot. |
|||
function name | Type | ||
hotspot[name].loadstyle(name) | Action | ||
An action of the hotspot element to load interactively settings from a <style> tag. | |||
function name | Type | ||
hotspot[name].resetsize() | Action | ||
An action to set the width and height values back to the source size of the loaded image. This can be used after changing the url value to get the size of the new loaded image. | |||
function name (as3 usage only) | Type | return | |
hotspot[name].getfullpath() | AS3 Action | String | |
A only from AS3 callable function that returns the full path/name of the hotspot element. | |||
function name | Type | return | |
hotspot[name].getcenter(ath,atv) | (AS3) Action | Object | |
This functions saves the center position of the hotspot to the given variables.
When the variables don't exist they will be created. AS3: This function is also callable direct from AS3. In this case it is not nesecery to use the ath/atv parameters, the function directly returns an AS3 Object with the center ath/atv coordinates of the hotspot. This object has x and y attributes, where x=ath and y=atv. |
<style name="..." ... any plugin or hotspot or self defined attributes ... />
Full variable name (read only) | Type | Default value | |
style.count | int | 0 | |
---|---|---|---|
The count / number of all <style> elements. | |||
Attribute name | Full variable name | Type | Default value |
style | style[name].name | String | |
The name of the style element. (see the name notes) | |||
Full variable name (read only) | Type | Default value | |
style[name].index | int | ||
The numeric index of the style element. |
<events onenterfullscreen="" onexitfullscreen="" onxmlcomplete="" onpreviewcomplete="" onloadcomplete="" onnewpano="" onremovepano="" onnewscene="" onloaderror="" onkeydown="" onkeyup="" onclick="" onmousedown="" onmouseup="" onmousewheel="" onidle="" onviewchange="" onviewchanged="" onresize="" />
<events name="..." keep="false" ... any events ... />
Attribute name | Full variable name | Type | Default value |
name | events[...].name | String | |
---|---|---|---|
When a name attribute will be defined then this events element will be an independent local events element. Without name attribute the global events were set. | |||
Attribute name | Full variable name | Type | Default value |
keep | events[...].keep | Boolean | false |
Should this named events element be kept or removed when loading a new pano. See also the loadpano() action. |
|||
Attribute name | Full variable name | Type | Default value |
onenterfullscreen | events.onenterfullscreen | Action Event | |
This event will be called when switching to fullscreen mode. | |||
Attribute name | Full variable name | Type | Default value |
onexitfullscreen | events.onexitfullscreen | Action Event | |
This event will be called when switching back from the fullscreen mode to the normal window mode. | |||
Attribute name | Full variable name | Type | Default value |
onxmlcomplete | events.onxmlcomplete | Action Event | |
This event will be called when the loading of the xml file or the xml code of scene was done. After this event the pano-viewing and the loading of the pano images will start. | |||
Attribute name | Full variable name | Type | Default value |
onpreviewcomplete | events.onpreviewcomplete | Action Event | |
This event will be called when the loading of the preview images was done. | |||
Attribute name | Full variable name | Type | Default value |
onloadcomplete | events.onloadcomplete | Action Event | |
This event will be called when the loading of the pano image is done. When using multi-resolution images, then this event will be called once when all parts for the current-view were loaded completely. | |||
Attribute name | Full variable name | Type | Default value |
onnewpano | events.onnewpano | Action Event | |
This event will be called when there is a new pano image and all information about it (type, imagesize, hfov, vfov) are available. | |||
Attribute name | Full variable name | Type | Default value |
onremovepano | events.onremovepano | Action Event | |
This event will be called when the current pano will be removed (e.g. before loading a new pano). | |||
Attribute name | Full variable name | Type | Default value |
onnewscene | events.onnewscene | Action Event | |
This event will be called when a new scene will be loaded (similar to the onxmlcomplete event but only for scenes). | |||
Attribute name | Full variable name | Type | Default value |
onloaderror | events.onloaderror | Action Event | |
This event will be called when there is a loading error. The error message will be stored in the lasterror variable. When this event is set, no error will be shown from krpano itself. |
|||
Attribute name | Full variable name | Type | Default value |
onkeydown | events.onkeydown | Action Event | |
This event will be called when a key is pressed down. They keycode of the pressed key is stored in the keycode variable. |
|||
Attribute name | Full variable name | Type | Default value |
onkeyup | events.onkeyup | Action Event | |
This event will be called when a pressed key is released. They keycode of the released key is stored in the keycode variable. |
|||
Attribute name | Full variable name | Type | Default value |
onclick | events.onclick | Action Event | |
This event will be called when there is a mouse click in the pano. |
|||
Attribute name | Full variable name | Type | Default value |
onmousedown | events.onmousedown | Action Event | |
This event will be called when the mouse button is pressed down in the pano. |
|||
Attribute name | Full variable name | Type | Default value |
onmouseup | events.onmouseup | Action Event | |
This event will be called when the pressed mouse button is released. |
|||
Attribute name | Full variable name | Type | Default value |
onmousewheel | events.onmousewheel | Action Event | |
This event will be called when the mouse wheel was used. The delta of the mouse wheel usage is stored in the wheeldelta variable. |
|||
Attribute name | Full variable name | Type | Default value |
onidle | events.onidle | Action Event | |
This event will be called after idletime seconds without user interaction. | |||
Attribute name | Full variable name | Type | Default value |
onviewchange | events.onviewchange | Action Event | |
This event will be called every time when the current view was changed but before final rendering.
That means changing the view itself before final rendering is possible here. Note - use this event carefully, when doing too much stuff there it can affect the rendering/execution performance! |
|||
Attribute name | Full variable name | Type | Default value |
onviewchanged | events.onviewchanged | Action Event | |
This event will be called every time when the current view was changed and rendered. Note - use this event carefully, when doing too much stuff there it can affect the rendering/execution performance! |
|||
Attribute name | Full variable name | Type | Default value |
onresize | events.onresize | Action Event | |
This event will be called when the screen/window or the area size has changed. The new screen size is stored in the stagewidth and stageheight variables. |
<action name="..." secure="false"> action1(); action2(); ... </action>
Attribute name | Full variable name | Type | Default value |
name | action[name].name | String | |
---|---|---|---|
Name of the action. (see the name notes) | |||
Attribute name | Full variable name | Type | Default value |
secure | action[name].secure | Boolean | false |
When secure will be set to true, the action will be callable from the Javascript interface,
even when the Javascript interface is disabled. This makes it possible to implement special limited external interfaces. |
|||
Full variable name | Type | Default value | |
action[name].content | String | ||
The content of the action tag. This can also be set or changed dynamicallly. |
|||
Full variable name (read only) | Type | Default value | |
action.count | int | 0 | |
The count / number of all <action> elements. |
<krpano onstart="intro();"> ... <action name="intro"> lookat(0,0,90); wait(LOAD); lookto(120,10,110); lookto(-50,40,110); lookto(0,0,90); </action> ... </krpano>
<action name="overaction"> tween(scale, 2.0); tween(alpha, 1.0); </action> <action name="outaction"> tween(scale, 1.0); tween(alpha, 0.5); </action> <plugin name="pic1" ... onover="overaction();" onout="outaction();" /> <plugin name="pic2" ... onover="overaction();" onout="outaction();" />
<action name="test"> showlog(); trace('parameter1=',%1); trace('parameter2=',%2); </action> <action name="parameterpassingtest"> test('Test1', 'Test2'); </action>
<progress showload="auto" showwait="loopings()" showreloads="false" parent="" />
Attribute name | Full variable name (Flash only) | Type | Default value |
showload | progress.showload | String | "none" |
---|---|---|---|
Show loading progress function - none or auto or bar(...) auto means none for multi-resolution panos and bar() for normal panos. bar syntax: (all parameters are optional) bar(origin,width,height,offsetx,offsety,style,backcolor,loadcolor,decodecolor,bordercolor,borderwidth,glowcolor,glowwidth)
|
|||
Attribute name | Full variable name (Flash only) | Type | Default value |
showwait | progress.showwait | String | "none" |
Show waiting function - none or auto or loopings(...) auto means none for multi-resolution panos and loopings() for normal panos. loopings syntax: (all parameters are optional) loopings(color,points,size,bigpoint,smallpoint,glowcolor,glowwidth,xpos,ypos,align)
|
|||
Attribute name | Full variable name (Flash only) | Type | Default value |
showreloads | progress.showreloads | Boolean | false |
A setting for multi-resolutions panos - should the loading bar be shown again when starting to load new tiles. | |||
Attribute name | Full variable name (Flash only) | Type | Default value |
parent | progress.parent | String | |
By default the progress animations were shown inside the pano area. To show the animations at the Flashplayer 'Stage' level use parent="STAGE". | |||
Full variable name (read only) | Type | Default value | |
progress.progress | Number | 0.0 | |
The current loading progress as linear value from 0.00 to 1.00. Can be used to create custom loading animations. Use the onxmlcomplete event for starting the loading animation, and the onloadcomplete event for stopping. |
|||
Full variable name (read only, Flash only) | Type | Default value | |
progress.isloading | Boolean | false | |
A boolean value that indicates that the viewer is currently loading the pano. | |||
Full variable name (read only, Flash only) | Type | Default value | |
progress.loaddone | Boolean | false | |
A boolean value that will be set when the loading of the pano was done. | |||
Full variable name (read only, Flash only) | Type | Default value | |
progress.isblending | Boolean | false | |
A boolean value that indicates that the viewer is currently blending the pano. | |||
Full variable name (read only, Flash only) | Type | Default value | |
progress.blenddone | Boolean | false | |
A boolean value that will be set when the blending of the pano was done. | |||
Full variable name (read only, Flash only) | Type | Default value | |
progress.previewdone | Boolean | false | |
A boolean value that will be set when the loading of the preview pano was done. | |||
Full variable name (read only, Flash only) | Type | Default value | |
progress.bytesloaded | Number | 0.0 | |
The number of current loaded bytes (not usable for multi-resoltions panos). | |||
Full variable name (read only, Flash only) | Type | Default value | |
progress.bytestotal | Number | 0.0 | |
The number of current total loaded bytes, this can be adjust step by step when the size information of the new files become available (not usable for multi-resoltions panos). |
<network downloadqueues="0" decodequeues="0" retrycount="2" caching="true" cachesize="7" />
Attribute name | Full variable name | Type | Default value |
downloadqueues | network.downloadqueues | int | 0 |
---|---|---|---|
The number of images (tiles) that will be downloaded at the same time (0=automatic). |
|||
Attribute name | Full variable name | Type | Default value |
decodequeues | network.decodequeues | int | 0 |
The number of images (tiles) that will be decoded (jpeg ⇒ pixels) at the same time (0=automatic). WARNING - don't use high values here, the decoding is very heavy processing operation, and unfortunatly the Flashplayer can't decode in 'background' so during decoding the viewer will be blocked! |
|||
Attribute name | Full variable name | Type | Default value |
retrycount | network.retrycount | int | 2 |
The number of automatic download retries on loading (server) errors before showing an error message. | |||
Attribute name | Full variable name | Type | Default value |
caching | network.caching | Boolean | true |
Enable/disable the caching of all other (not pano image related, e.g. layer/plugin and hotspot) files. | |||
Attribute name | Full variable name | Type | Default value |
cachesize | network.cachesize | Number | 7.0 |
The size of the cache buffer in MB. |
<memory maxmem="..." devices="..." />
Attribute name | Full variable name | Type | Default value |
maxmem | memory.maxmem | int | ... |
---|---|---|---|
Set the maximum memory usage for the decoded image tiles in MB.
The calculation of the tile memory size in MB is done by: 'tile-image-width * tile-image-height * 4 / 1024 / 1024'
(e.g. a 512x512px tile needs exactly 1 MB memory).
When the maxmem limit will be reached, the memory of currently not used (needed/visible) tiles will be freeed/returned. Note - use this setting with care! It can affect the performance and the browser stability. The current default settings are:
|
<security cors=""> <crossdomainxml url="http://.../crossdomain.xml" /> <crossdomainxml url="..." /> ... <allowdomain domain="www.other-domain.com" /> <allowdomain domain="..." /> ... </security>
Attribute name | Full variable name (HTML5 only) | Type | Default value |
cors | security.cors | String | "" |
---|---|---|---|
HTML5 CORS (Cross Origin Resource Sharing) Images. Set the default value for the crossOrigin property for all images that will be loaded by the krpano HTML5 viewer. Allowed values are:
For details about enabling CORS on the server please see here: http://enable-cors.org/ http://enable-cors.org/server.html Example: If your Web-server is an Apache-server, the easiest way to enable CORS would be to put a .htaccess named file with the following content into the folder of the files that should be accessible: Header set Access-Control-Allow-Origin "*" |
|||
Attribute name | Full variable name (Flash only) | Type | Default value |
crossdomainxml[...].url | security.crossdomainxml[...].url | String | |
Path to the crossdomain.xml on the other server. Loads a cross-domain policy file from a location specified by the url parameter. By default the Flash Player looks for the policy file located in root of a domain with the filename crossdomain.xml on the server to which a data-loading request is being made. With the crossdomain.url setting the Flash Player can load a policy file from a arbitrary locations. For more Information have a look at the Adobe site: http://www.adobe.com/devnet/articles/crossdomain_policy_file_spec.html |
|||
Attribute name | Full variable name (Flash only) | Type | Default value |
allowdomain[...].domain | security.allowdomain[...].domain | String | |
Allow access to other domains (necessary for plugins that want access other domains).
You can also specify the special domain "*" to allow access from all domains.
Specifying "*" is the only way to allow access to nonlocal SWF files from local SWF files that have been published using Access Network Only for the Local Playback Security option in the Flash authoring tool. |
<textstyle name="..." font="Times" fontsize="12.0" bold="true" italic="false" background="true" backgroundcolor="0xFFFFFF" border="true" bordercolor="0x000000" textcolor="0x000000" alpha="1.0" blendmode="normal" effect="" origin="cursor" edge="bottom" textalign="none" xoffset="0" yoffset="-3" showtime="0.1" fadetime="0.0" fadeintime="0.0" noclip="true" />
Full variable name (read only) | Type | Default value | |
textstyle.count | int | 1 | |
---|---|---|---|
The count / number of all textstyle elements. This is 1 by default because this is a predefined DEFAULT element. |
|||
Attribute name | Full variable name | Type | Default value |
name | textstyle[name].name | String | |
The name of the textstyle (see the name notes). Use DEFAULT as name to overwrite the default textstyle settings. |
|||
Full variable name (read only) | Type | Default value | |
textstyle[name].index | int | ||
The index of the current textstyle element. | |||
Attribute name | Full variable name | Type | Default value |
font | textstyle[name].font | String | "Times" |
The name of the font. | |||
Attribute name | Full variable name | Type | Default value |
fontsize | textstyle[name].fontsize | Number | 12.0 |
The point size of the text. | |||
Attribute name | Full variable name | Type | Default value |
bold | textstyle[name].bold | Boolean | true |
Specifies whether the text is boldface. | |||
Attribute name | Full variable name | Type | Default value |
italic | textstyle[name].italic | Boolean | false |
Indicates whether text is italicized. | |||
Attribute name | Full variable name | Type | Default value |
background | textstyle[name].background | Boolean | true |
Specifies whether the text field has a background fill. | |||
Attribute name | Full variable name | Type | Default value |
backgroundcolor | textstyle[name].backgroundcolor | int | 0xFFFFFF |
The color of the text field background. | |||
Attribute name | Full variable name | Type | Default value |
border | textstyle[name].border | Boolean | true |
Specifies whether the text field has a border. | |||
Attribute name | Full variable name | Type | Default value |
bordercolor | textstyle[name].bordercolor | int | 0x000000 |
The color of the text field border. | |||
Attribute name | Full variable name | Type | Default value |
textcolor | textstyle[name].textcolor | int | 0x000000 |
The default color of the text in a text field. | |||
Attribute name | Full variable name | Type | Default value |
alpha | textstyle[name].alpha | Number | 1.0 |
The alpha (transparency) value (0.0 - 1.0) of the text. | |||
Attribute name | Full variable name | Type | Default value |
blendmode | textstyle[name].blendmode | String | "normal" |
The Flash blending mode. Some modes: "normal", "add", "difference", "multiply", "screen" ... See here for more details about all available blending modes: http://help.adobe.com/.../BlendMode.html And here for some illustrations / examples: http://help.adobe.com/.../DisplayObject.html#blendMode |
|||
Attribute name | Full variable name | Type | Default value |
effect | textstyle[name].effect | String | |
Bitmap effects. This value can be any combination of this effect functions:
|
|||
Attribute name | Full variable name | Type | Default value |
origin | textstyle[name].origin | String | "cursor" |
Origin position of the text. Possible settings: cursor - display the text at the position of mouse cursor or lefttop, left, leftbottom, top, center, bottom, righttop, right, rightbottom. |
|||
Attribute name | Full variable name | Type | Default value |
edge | textstyle[name].edge | String | "bottom" |
Edge/origin positon on the text itself. | |||
Attribute name | Full variable name | Type | Default value |
textalign | textstyle[name].textalign | String | "none" |
Align of the text: none, left, center, right. | |||
Attribute name | Full variable name | Type | Default value |
xoffset | textstyle[name].xoffset | int | 0 |
The x offset in pixels from the origin point to the text. | |||
Attribute name | Full variable name | Type | Default value |
yoffset | textstyle[name].yoffset | int | -3 |
The y offset in pixels from the origin point to the text. | |||
Attribute name | Full variable name | Type | Default value |
showtime | textstyle[name].showtime | Number | 0.1 |
The time to the show the text in seconds. | |||
Attribute name | Full variable name | Type | Default value |
fadetime | textstyle[name].fadetime | Number | 0.0 |
The fade out time in seconds. | |||
Attribute name | Full variable name | Type | Default value |
fadeintime | textstyle[name].fadeintime | Number | 0.0 |
The fade in time in seconds. | |||
Attribute name | Full variable name | Type | Default value |
noclip | textstyle[name].noclip | Boolean | true |
Avoid the clipping of text on screen borders. |
<textstyle name="DEFAULT" font="Arial" fontsize="12" bold="true" italic="true" textcolor="0x000000" background="false" border="false" blendmode="layer" effect="glow(0xFFFFFF,0.85,4,4);dropshadow(2,45,0x000000,4,1);" origin="cursor" edge="bottom" xoffset="15" yoffset="-5" showtime="0.1" fadeintime="0.1" fadetime="0.1" />
<lensflareset name="." url="%SWFPATH%/krpano_default_flares.jpg"> <flare pixsize="128" pixupos="0" pixvpos="0" color="0xFFFFFF" pos="0.0" scale="0.1" /> <flare ... /> <flare ... /> ... </lensflareset>
Full variable name (read only) | Type | Default value | |
lensflareset.count | int | 1 | |
---|---|---|---|
The count / number of all currently declared lensflare sets. There is predefined set named DEFAULT. |
|||
Attribute name | Full variable name | Type | Default value |
name | lensflareset[name].name | String | |
The name of the current lensflare set (see the name notes). Use DEFAULT to overwrite the default one. This name can be referred by the set setting from a lensflare element. |
|||
Attribute name | Full variable name (read only) | Type | Default value |
index | lensflareset[name].index | String | |
The index of the lensflareset element. | |||
Attribute name | Full variable name | Type | Default value |
url | lensflareset[name].url | String | see the text |
The path/url to the base image for the flares. The default value is "%SWFPATH%/krpano_default_flares.jpg". |
|||
Full variable name (read only) | Type | Default value | |
lensflareset[name].flare.count | int | 0 | |
The count / number of all flare element in this lensflare set. | |||
Attribute name | Full variable name (read only) | Type | Default value |
flare[...].index | lensflareset[name].flare[...].index | int | |
The index of the current flare element in this lensflare set. | |||
Attribute name | Full variable name | Type | Default value |
flare[...].name | lensflareset[name].flare[...].name | String | |
The name of the current flare element (see the name notes). It will be set automatically if not defined. |
|||
Attribute name | Full variable name | Type | Default value |
flare[...].pixsize | lensflareset[name].flare[...].pixsize | int | 0 |
The pixel size (width and height) of the crop area for the current flare image. | |||
Attribute name | Full variable name | Type | Default value |
flare[...].pixupos | lensflareset[name].flare[...].pixupos | int | 0 |
The horizontal pixel position of the crop area for the current flare image. | |||
Attribute name | Full variable name | Type | Default value |
flare[...].pixvpos | lensflareset[name].flare[...].pixvpos | int | 0 |
The vertical pixel position of the crop area for the current flare image. | |||
Attribute name | Full variable name | Type | Default value |
flare[...].color | lensflareset[name].flare[...].color | int | 0xFFFFFF |
The mix-color for the current flare image. The source image will be multiplied with this color. | |||
Attribute name | Full variable name | Type | Default value |
flare[...].pos | lensflareset[name].flare[...].pos | Number | 0.0 |
The position of the flare on the screen: 0.0 = at the start point (at the ath,atv position of a lensflare) 1.0 = opposite position from start point Good values can be from -2.0 to +5.0. |
|||
Attribute name | Full variable name | Type | Default value |
flare[...].scale | lensflareset[name].flare[...].scale | Number | 1.0 |
The size of the flare in relation to the screen height. Typical values are from 0.01 to 0.10. |
<lensflare name="..." set="DEFAULT" visible="true" keep="false" ath="0.0" atv="0.0" size="0.8" blind="0.6" blindcurve="4.0" />
Full variable name (read only) | Type | Default value | |
lensflare.count | int | 0 | |
---|---|---|---|
The count / number of all lensflare elements. | |||
Full variable name (read only) | Type | Default value | |
lensflare.visible | Boolean | true | |
Show / hide the whole lensflare layer. | |||
Full variable name (read only) | Type | Default value | |
lensflare.alpha | Number | 1.0 | |
Controls the transparency / alpha of the whole lensflare layer. | |||
Full variable name (as3 usage only) | Type | Default value | |
lensflare.layer | Sprite | ||
Actionscript 3 Sprite object of the lensflare layer. |
|||
Attribute name | Full variable name | Type | Default value |
name | lensflare[name].name | String | |
The name of the lensflare element (see the name notes). | |||
Attribute name | Full variable name (read only) | Type | Default value |
index | lensflare[name].index | int | |
The index of the lensflare element. | |||
Attribute name | Full variable name | Type | Default value |
set | lensflare[name].set | String | "DEFAULT" |
The lensflare set/style to use for this lensflare. | |||
Attribute name | Full variable name | Type | Default value |
visible | lensflare[name].visible | Boolean | true |
Visibility of the lensflare element. | |||
Attribute name | Full variable name | Type | Default value |
keep | lensflare[name].keep | Boolean | false |
Should this lensflare element be kept or removed when loading a new pano. See also the loadpano() action. |
|||
Attribute name | Full variable name | Type | Default value |
ath | lensflare[name].ath | Number | 0.0 |
The horizontal position of the lensflare in spherical coordinates (-180 to +180). | |||
Attribute name | Full variable name | Type | Default value |
atv | lensflare[name].atv | Number | 0.0 |
The vertical position of the lensflare in spherical coordinates (-90 to +90). | |||
Attribute name | Full variable name | Type | Default value |
size | lensflare[name].size | Number | 0.8 |
The size / scale of the flares from the lensflare element. | |||
Attribute name | Full variable name | Type | Default value |
blind | lensflare[name].blind | Number | 0.6 |
The blinding factor - how much will it blind, when you look into the sun: 0.0=no blinding, 1.0=full blinding (=white screen) |
|||
Attribute name | Full variable name | Type | Default value |
blindcurve | lensflare[name].blindcurve | Number | 4.0 |
The blinding curve (1.0 - 10.0) - it controls the increase of the strongness of the blinding when getting near the center position of the flare. |
<data name="..."> ... </data>
<data name="..."><![CDATA[ ... ]]></data>
Full variable name (read only) | Type | Default value | |
data.count | int | 0 | |
---|---|---|---|
The count / number of all data elements. | |||
Attribute name | Full variable name | Type | Default value |
name | data[name].name | int | |
The name of the data element (see the name notes). | |||
Full variable name (read only) | Type | Default value | |
data[name].index | int | ||
The index of the data element. | |||
Full variable name | Type | Default value | |
data[name].content | String | ||
The whole content of the <data> element as text string. |
<scene name="..." onstart=""> ... </scene>
Full variable name (read only) | Type | Default value | |
scene.count | int | 0 | |
---|---|---|---|
The count / number of all scene elements. | |||
Attribute name | Full variable name | Type | Default value |
name | scene[name].name | String | |
The name of the scene element (see the name notes). This is the name to be used when using the loadscene() action. |
|||
Attribute name | Full variable name | Type | Default value |
onstart | scene[name].onstart | Action Event | |
The "onstart" event - here any actions / functions that will be called "on start" of the pano/scene viewing can be defined. | |||
Full variable name (read only) | Type | Default value | |
scene[name].index | int | ||
The index of the scene element. | |||
Full variable name | Type | Default value | |
scene[name].content | String | ||
The whole unparsed content of the <scene> element as text string. |