News Examples Documentation Download Buy Forum Contact

Snow / Rain Plugin snow.js Version 1.22

  • A weather effect plugin that adds snow or rain to the pano.
  • The snow flakes can be made out of pixels (default) or individual images.

Syntax

Usage example with all attributes and their default values:
<plugin name="snow"
        url="%VIEWER%/plugins/snow.js"
        blendmode="normal"
        mode="snow"
        imageurl=""
        imagescale="1.0"
        flakes="4000"
        color="0xFFFFFF"
        floor="0.3"
        speed="1.0"
        spreading="4.0"
        shake="4.0"
        speedvariance="2.0"
        wind="0.0"
        winddir="0.0"
        rainwidth="0.5"
        rainalpha="0.5"
        invert="false"
        />

Plugin Attributes

All attributes of the snow plugin can also be set or changed dynamically.
  • mode
    • Weather effect mode.
      Possible settings:
      • snow   (default)
        The snow flakes will be made out of small pixels. The color of the pixels can adjusted by the color settings.
      • rain
        Instead of snow flakes there are falling down lines to simulate raining. The style of the rain lines can be adjusted by the color, rainwidth and rainalpha settings.
      • image
        The snow flakes will be made out of images. The image must be set by imageurl setting. And the scaling of the image can adjusted the imagescale setting.
  • imageurl  (needed for mode="image")
    • Set the url / path for the snow flake image.
  • imagescale  (optionally)
    • The scaling of the imageurl flake images, default=1.0.
  • flakes  (optionally)
    • The number of the snow flakes or rain drops, default=4000.
  • color  (optionally)
    • The color of the snow flakes or rain drops, defaul=0xFFFFFF.
  • floor  (optionally)
    • The floor setting defines a virtual floor where the snow flakes are hitting the floor and stop falling. Possible settings are in the range from 0.0 to 1.0. The setting 0.0 would define the floor to be the middle of the pano/screen. The default setting is 0.3.
  • speed  (optionally)
    • The falling speed of the snow flakes, default=1.0.
  • spreading  (optionally)
    • The spreading setting defines the range / depth of the snow field in the virtual 3D world, default=4.0.
  • shake  (optionally)
    • The random shaking range of the snow flakes, default=4.0.
  • speedvariance  (optionally)
    • How much can the falling speed vary randomly, default=2.0.
  • wind  (optionally)
    • The wind strength that changes the falling directing of the snow flakes, default=0.0.
  • winddir  (optionally)
    • The direction of the wind in degrees, 0-360, default=0.
  • rainwidth  (optionally)
    • The line-width of the rain drop lines, default=0.5.
  • rainalpha  (optionally)
    • The alpha of the rain drop lines, default=0.5.
  • invert  (optionally)
    • Invert the falling direction. Instead of falling down, the images will move upward. E.g. could be used for bubbles. Values: true or false, default=false.