krpano Plugin Interface Version 1.20.11

Select Version:

• 1.21
• 1.20.11
• 1.20.10
• 1.20.9
• 1.20.8
• 1.20.7
• 1.20.6
• 1.20.5
• 1.20.4
• 1.20.2
• 1.20.1
• 1.20
• 1.19-pr16
• 1.19-pr15
• 1.19-pr14
• 1.19-pr13
• 1.19-pr12
• 1.16
• 1.0.8.15
• 1.0.8.14
• 1.0.7

• krpanointerface
  The krpano Interface Object - this object provides access to interfacing functions and to the whole krpano data structure.
• pluginpath
  A String with the 'full path' to the plugin object, e.g. "plugin[name]".
• pluginobject
  The krpano Plugin Object - this object provides direct access to all plugin attributes and functions.

• 0 = DEBUG message - will be only shown with enabled debugmode
• 1 = INFO message
• 2 = WARNING message
• 3 = ERROR message - will also open the log automatically.
• 4 = FATAL ERROR - this message will be shown in the middle of the viewer.

• rqurl
  The request url that was used on the loadFile call.
• url
  The parsed and resolved url of the file.
• data
  Javascript: The loaded file as String.
  Flash: The loaded file as ByteArray.
  
• errmsg
  A boolean flag with the default value 'true' that indicates if krpano should show an automatic loading error message. Only for usage in the errorcallback function! Set it to 'false' to disable the default loading error message.

• spheretospace - an Object with x,y,z properties.
• spacetosphere - an Object with h,v,depth properties.

<action type="Javascript" autorun="preinit"><![CDATA[
  krpano.customParsePath = function(url)
  {
    console.log("url:",url);
    
    // load 'image2.jpg' instead of 'image1.jpg':
    if(url == "image1.jpg") url = "image2.jpg";
    
    return url;
  }
]]></action>	

• url - the base tile-url template.
• cube - the cube side index, range 0-5, an index into the cubelabels values. Non-cubical panos will use the value 1 here.
• level - the level index, range baseindex to N.
• h, v - horizontal and vertical tile index, range baseindex to N.
• stereo - stereo side, 0 or 1, an index into the stereolabels values.
• image - the related xml <image> element as object.

• In Actionscript the setter/getter are special objects. Accessing them direct like normal variables/attributes is not possible because the Actionscript language doesn't have/support dynamic setter/getters. For accessing the value these objects have a set(value) function for setting the new value and a get() function for getting the value.
• In Javascript the setter/getter behave as normal attributes. They can be used directly like normal variables/attributes.

• Setter and getters are a very powerful instrument for building data structures.
• They can be used to get informed anytime when the value of an attribute will be changed / updated.
• With them it possible to check and if necessary correct the value on setting.
• And/or to set flags and call other functions when the value will be changed.

• source
  • A GLSL fragment shader source code as string.
  • The shaders code needs to have:
    • A sm named sampler2D - this will be the current screen as input texture.
    • A tx named vec2 varying - this will be the current texture coordinate.
    • Optionally a sz vec2 uniform - this will contain the screen size.
• uniforms
  • A comma separated list of the uniform names used in the shader.
  • The 'uniform location' will be automatically stored at the returned shader object with the same name.
• name (optionally)
  • A name for the shader.
• onrendercallback (optionally)
  • A Javascript callback function that will be called before rendering the shader.
  • That could be used to set or update uniform values.
  • Function parameters:

    function onrendercallback(side, shader, gl)

    • side - the stereo side, 0=non-stereo, 1=left, 2=right
    • shader - the current shader object
    • gl - the current WebGL context

• A krpano 'Shader' object.
• Can be added to the ppShaderArray or ppShaderArray2 arrays.

• width, height - The size in pixels. When set to 0 the current size will be used.
  When the size will be larger than possible by the browser, then the size will be automatically proportionally downscaled.
• hotspots - Render also the (webgl) hotspots: true or false (false by default).
• type - This setting defines what will be returned by the function:
  • "jpeg" - A JPEG image as data-url / base64 encoded string. (default)
  • "png" - A PNG image as data-url / base64 encoded string.
  • "raw" - The direct pixels as Uint8Array with RGBA bytes per pixel.
  • "canvas" - A 2D Canvas Object with the screenshot image.
• jpegquality - The JPEG image / compression quality, from 0.0 (worst) to 1.0 (best) and 0.85 by default. Only used for type="jpeg" and ignored for all other types.
• crop - An optional Object with {x,y,w,h} properties to define an optional cropping of the screenshot image.
• sizeinfo - An optional Object with {w,h} properties to pass to get information about the pixel size of the resulting image (useful for raw and image types).
• cache - An optional empty Object where krpano can store internal buffers. When doing several screenshots with the same size, this can makeScreenshot calls faster. That object should be stored somewhere on application side and passed to all makeScreenshot calls.