waveField

waveField

Coordinate Field
Period Field
Phase Field
Wave Function
Amplitude Field
field
waveField
RayTK
v0.42

A field that uses a periodic wave.

If there is an input, that rop is used to get the coordinate that is fed into the wave function. Without an input, the Axis is used to run the wave function on the position along the selected axis.

Parameters

Name Description Regular Handling Read-Only Handling
Enable
Wave

The type of wave.

 Runtime Baked
  • Sine:
  • Cosine:
  • Triangle:
  • Ramp:
  • Reverse Ramp:
  • Square:
  • Additive Square (2):
  • Additive Square (4):
  • Additive Square (8):
  • Smooth Square (.1):
  • Smooth Square (.3):
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.

 Semi-Baked Semi-Baked
  • X:
  • Y:
  • Z:
  • Distance From Origin: Uses distance from the origin instead of an axis.
Coord Type
  • Auto:
  • 1D:
  • 2D:
  • 3D:
Period

The length of a single cycle of the wave.
Phase

Offset of the wave along the axis / coordinates.
Amplitude

The height of the wave, which scales the range of output values. If this is set to 3 (and Offset is 0), a ramp wave will produce values from 0 to 3.

 Runtime Baked
Offset

Adds to the values produced by the wave. If this is set to 0.5 (and Amplitude is set to 1), a ramp wave will produce values from 0.5 to 1.5.

 Runtime Baked
Contexttype

Inputs

  • Coordinate Field: (optional) If attached, the wave will use this to determine the numbers that it passes to the wave function (instead of using the position along the chosen `Axis`).
    • Coordinate Types: float vec2 vec3 vec4
    • Context Types: Context MaterialContext CameraContext LightContext RayContext ParticleContext VertexContext PixelContext
    • Return Types: float vec4
  • Period Field: (optional) If attached, the wave will use this field to multiply the `Period` parameter, which can be used for frequency modulation.
    • Coordinate Types: float vec2 vec3 vec4
    • Context Types: Context MaterialContext CameraContext LightContext RayContext ParticleContext VertexContext PixelContext
    • Return Types: float
    • Supports Variables From Inputs: coordField
  • Phase Field: (optional)
    • Coordinate Types: float vec2 vec3 vec4
    • Context Types: Context MaterialContext CameraContext LightContext RayContext ParticleContext VertexContext PixelContext
    • Return Types: float
    • Supports Variables From Inputs: coordField periodField
  • Wave Function: (optional)
    • Coordinate Types: float
    • Context Types: Context MaterialContext CameraContext LightContext RayContext ParticleContext VertexContext PixelContext
    • Return Types: float vec4
    • Supports Variables From Inputs: coordField periodField phaseField
  • Amplitude Field: (optional)
    • Coordinate Types: float vec2 vec3 vec4
    • Context Types: Context MaterialContext CameraContext LightContext RayContext ParticleContext VertexContext PixelContext
    • Return Types: float
    • Supports Variables From Inputs: coordField periodField phaseField waveFunc