Wave

Description

This effect displays a circular wave-like effect at the coordinates contained in the input array.

Properties

Array properties

Any properties in the input array that matches the name of these properties will be used and displayed accordingly.
These properties can also be shown as inputs on the node by toggling the icon.
In the dropdown menu you can choose how values from the array interact with values from the Editor panel or the input between : Replace, Add or Multiply.
More information can be found on the GPU Multi category page.

• X : Sets the X value for the coordinates of the effect.
  Default : Width / 2

• Y : Sets the Y value for the coordinates of the effect.
  Default : Height / 2

• Lifetime : This is the property from the input array that will be used to animate the waves. If there is no Lifetime property in your input array, the effect will not be visible. This property can be activated in the Editor to add a default value that can interact with the ones in the array.
  (Default : Inactive property)

• Celerity : When the waves are animated (Lifetime property present in input array), this property will control the speed of their propagation.
  (Default : 1.5)

• Amplitude : Sets inside the circle of influence the strength of the deformation. A value of 0 will make the waves disappear. Negative and Positive values will have inverted effects.
  (Default : 1)

• Phase Offset : Sets an offset on the phase used by the waves. Note that as the waves are animated using the Lifetime property of a sensor, different detections occurring at different moments in time will already produce offsets between each other in the animations.
  (Default : 0)

• Fading : Works in conjunction with the Fading type property and sets the amount or strength of the fading. Note that it will not produce any effect on the Fading Types None and Linear. The fading is applied on the ripples in their relationship to each other. Higher values meld the ripples more into each other until it eventually makes the effect disappear (around values near 1.0)
  (Default : 0)

• Distance Max : Sets how far the wave will travel through the image. A value of 0 will make the waves disappear. Values are expressed in 1/1000 of pixels (e.g. a value of 0.540) will make the wave travel 540 pixels in every direction.
  (Default : 0.2)

• Length : Sets the width of a ripple in the wave.
  (Default : 0.5)

Global properties

• Water Depth : Sets how much of the image will arc around the waves and find itself on the other sides.
  (Default : 1)
  

  Depth : 0	Depth : 1

Options

• Wave Type : Choose between different types of wave animations.
  (Default : Propagating)
  

  Solitary	Propagating	Stationary

• Deformation : Choose between two deformations inside the waves : Zoom and Diffraction
  (Default : Diffraction)
  

  Zoom	Diffraction

• Fading Type : Works in conjunction with the Fading property. Choose between different types of Fade. Note that Fade types None and Linear are not affected by the value set in Fading. The fading is applied on the ripples in their relationship to each other. Higher values meld the ripples more into each other until it eventually makes the effect disappear (around values near 1.0)
  (Default : None)

Inputs

This lists only the inputs present by default at the creation of the node. The inputs that appear can be tuned by toggling the button in the Editor panel.

Outputs

Example

• Celerity : 1.5
• Amplitude : 1.0
• Phase Offset : 0.0
• Fading : 0.0
• Distance Max : 0.2
• Length : 0.5
• Water Depth : 1.0
• Wave Type : Propagating
• Deformation : Diffraction
• Fading Type : None