zFilter Plugin zfilter.js WebGL + HTML5 only

by indexofrefraction - (send forum message)

Description

Table of Contents

• Description
• Syntax / XML Usage Example
• Plugin Attributes
• 32bit ARGB values
• Layers and Hotspots
• Buy / Order the Plugin
• Examples
• Forum Discussion Thread

Syntax / XML Usage Example

<plugin name="zfilter"
	url="zfilter.js"
	preload="true"
	keep="true"
	enabled="true"
	phase="2"
	order=""
	webvr="2"
	gamma="2.2"
	brightness="0"
	contrast="0"
	exposure="0"
	hue="0"
	saturation="0"
	vibrance="0"
	sepia="0"
	swirl="0"
	pixelate="0"
	ripple="0"
	sobel="0"
	split="0"
	fquality.mobile="3"
	fquality.tablet="6"
	fquality.desktop="9"
	fblur="0"
	blur="0"
	blendcolor="0" blendmode="add"
	vignettecolor="0"
	mixcolor="0"
        />

• Add zfilter.js to your project folder
• In your html (index/tour.html) ensure that you embedd krpano with html5:"only+webgl"
  

  embedpano({ html5:"only+webgl", ... });

• In your main xml (tour.xml) add
  

  <plugin name="zfilter" url="zfilter.js"
  	preload="true" keep="true" />

  or just use the full block above with all attibutes on their default values.
• A simple intro for example, can be done by setting initial attribute values
  in combination with an onstart action tweening the attributes back to the defaults.
  

  <plugin name="zfilter" url="zfilter.js"
  	preload="true" keep="true"
  	mixcolor="0xff000000" />
  <action name="intro" autorun="onstart">
  	tween(plugin[zfilter].mixcolor, 0x00000000, 2.0);
  </action>

• Note: zFilter is optimized to minimize the performance load on your devices.
  If all attributes are set to their default values, the plugin stays idle and does
  not affect the performance at all.

Plugin Attributes

32bit ARGB values

• You can set 32bit ARGB values by Numbers or Strings in decimal or hex format
  
• Reading a 32bit ARGB value returns a String in hexadecimal format
  
• Examples:
  • an ARGB value of 0x801eff64 means:
    0x8000ff00 --> A = 0x80/128, R = 0x1e/30, G = 0xFF/255, B = 0x64/100
  • set(plugin[zfilter].blendcolor, 0x8000ff00);
  • tween(plugin[zfilter].blendcolor, 0xffff0000, 2.0);
  • copy(col, plugin[zfilter].blendcolor);

Layers and Hotspots

• Hotspots and layers must be initialized first ! (may change in the future)
• Supported attributes are: brightness, contrast, saturation, hue, sepia and blur
• Hotspots need to be rendered by css3d (renderer=css3d)
• Browser support may vary (should work on most current browsers)

• set(hotspot[myhotspot].saturation, -1);
• tween(layer[mylayer].blur, 15, 1);
• tween(layer[mylayer].blur|layer[mylayer].alpha, 15|0, 1);

addzfilter(layer or hotspot)

removezfilter(layer or hotspot)

zfiltersupport(variable)

Buy / Order the plugin

• krpano 1.19-pr15 or newer, html5 + webgl only! (Flash is not supported)
• krpano 1.20 or newer to use the postprocessing phase and order attributes
• zFilter works on the panorama image and on hotspots with renderer=webgl
• Layer and hotspot filters support a limited set of effects and require renderer=css3d
• Browser support for layer and hotpot filters my vary and is not guaranteed
• support for true webVR is experimental only
• zFilter is tied to your krpano license (needs a registered version of krpano)

• All copyrights to zFilter are exclusively owned by indexofrefraction.
• This plugin is offered as a commercial plugin. It is provided "As Is" without warranty of any kind, either express or implied, including any warranty of quality, merchantability, or fitness for a particular purpose. In no event will the author of the plugin be liable for loss of data, costs of procurement of substitute goods or services or any special, consequential or incidental damages, under any cause of action and regardless of whether or not the plugin author have been advised of the possibility of such damage. This limitation will apply notwithstanding any failure of essential purpose of any limited remedy provided herein. In any event the plugin author will have no liability arising out of this agreement.

Examples

krpano Forum Discussion Thread