helixSdf

helixSdf

Keywords:
  • coil
  • helix
  • spiral
Thickness Field
Radius Field
Spread Field
Cross Section Shape
sdf
helixSdf
RayTK
v0.42

SDF for a helix (an elongated spiral).

There are two variations of the helix: dual and single. The dual variation can do two parallel rails, and supports using a 2D cross-section SDF, but no UV coordinates. The single variation is just one part, and does not support cross-sections, but does have UV coordinates.

The single variation is based on Helix Distance by tdhooper.

Parameters

Name Description Regular Handling Read-Only Handling
Enable
Axis Runtime Semi-Baked
  • X:
  • Y:
  • Z:
Translate Runtime Baked
Radius Runtime Baked
Thickness Runtime Baked
Spread Runtime Baked
Dual Spread Runtime Baked
Helix Type Runtime Semi-Baked
  • Dual:
  • Single:
Reverse Runtime Semi-Baked
Offset Runtime Baked

Inputs

  • Thickness Field: (optional) Field used to multiply the `Radius` parameter. If it uses 1D coordinates, it is provided the position along the axis. If it uses 3D coordinates, it uses the absolute position.
    • Coordinate Types: vec3
    • Context Types: Context MaterialContext CameraContext LightContext RayContext ParticleContext VertexContext PixelContext
    • Return Types: float
    • Supports Variables: axisoffset angle normangle
  • Radius Field: (optional) Field used to multiply the `Thickness` parameter. If it uses 1D coordinates, it is provided the position along the axis. If it uses 3D coordinates, it uses the absolute position.
    • Coordinate Types: vec3
    • Context Types: Context MaterialContext CameraContext LightContext RayContext ParticleContext VertexContext PixelContext
    • Return Types: float
    • Supports Variables: axisoffset angle normangle
    • Supports Variables From Inputs: thicknessField
  • Spread Field: (optional)
    • Coordinate Types: vec3
    • Context Types: Context MaterialContext CameraContext LightContext RayContext ParticleContext VertexContext PixelContext
    • Return Types: float
    • Supports Variables: axisoffset angle normangle
    • Supports Variables From Inputs: thicknessField radiusField
  • Cross Section Shape: (optional)
    • Coordinate Types: vec2
    • Context Types: Context MaterialContext CameraContext LightContext RayContext ParticleContext VertexContext PixelContext
    • Return Types: float Sdf
    • Supports Variables: axisoffset angle normangle
    • Supports Variables From Inputs: thicknessField radiusField spreadField

Variables

  • Offset Along Axis:
  • Angle Around Axis (Deg):
  • Normalized Angle (0..1):