enhancedWaveField

beta
raytkAbstractions
field
enhancedWaveField
RayTK
v0.42

Field that produces different types of values based on wave functions.

This is an enhanced version of the waveField operator with added convenience features, including:

  • More wave functions including the pausingWaveFn, which is sort of like a square wave with ramped edges.
  • More control over the output value, including the ability to output vectors and colors.
  • Animation controls for the wave phase.

Parameters

Name Description Regular Handling Read-Only Handling
Axis

Axis used for the wave function phase. If there is a coordinate field, this controls which part of the returned value is used. Otherwise, it controls which part of the position in used.
  • X:
  • Y:
  • Z:
  • Distance From Origin XY:
  • Distance From Origin YZ:
  • Distance From Origin XZ:
  • Distance From Origin XYZ:
Center

The point from which distance is measured.
Wave

The type of wave.
  • Sine:
  • Cosine:
  • Triangle:
  • Ramp:
  • Reverse Ramp:
  • Square:
  • Additive Square (2):
  • Additive Square (4):
  • Additive Square (8):
  • Smooth Square (.1):
  • Smooth Square (.3):
  • Pausing Wave:
Period

The length of a single cycle of the wave.
Phase

Offset of the wave along the axis / coordinates.
Low Width

For the pausing wave, this is the width of the low part of the wave. The ramp area is between this and Highwidth.
High Width

For the pausing wave, this is the width of the high part of the wave.
Value Mode

How the wave should produce values.
  • Float Range: Produce a single float value by defining a low and high range. Waves that typically produce negative values (like sine) are scaled to match the range, just like waves that typically produce 0..1 (like ramp).
  • Float Offset & Amplitude: Produce a single float value by defining an amplitude and offset. The wave is scaled to match the amplitude, and then the offset is added.
  • Vector Range: Produce a vector value by defining a low and high range for each component.
  • Vector Offset & Amplitude: Produce a vector value by defining an amplitude and offset for each component.
  • Color Range: Produce a vector value by defining a range of values as colors.
Range Low (Float)
Range High (Float)
Amplitude (Float)
Offset (Float)
Range Low (Vector)
Range High (Vector)
Amplitude (Vector)
Offset (Vector)
Range Low (Color)
Range High (Color)
Enable Phase Animation

Whether animation should be enabled for the wave phase. When off, the phase will stay constant.
Play

Whether the animation should be playing or paused at whatever offset it was at when it was paused.
Reverse
Speed

How fast the phase should increase.
Speed Multiplier

Multiplies the speed of the animation, making it easier to have speed mapped to something like audio levels while also having a separate slider to scale that speed.