springSdf

springSdf

A coiled spring shape.

This is similar to helixSdf, but with the fixed height rather than infinite.

Parameters

Name Description Regular Handling Read-Only Handling
Axis Runtime Semi-Baked
  • X:
  • Y:
  • Z:
Reverse Runtime Semi-Baked
Radius

The radius of the spring, i.e. the distance of the spring from the center axis.

Runtime Baked
Height

Height or length of the spring.

Runtime Baked
Coils

The number of rotations in the spring. Larger values mean a tighter coil.

Runtime Baked
Thickness

Thickness of the spring, used when no cross-section SDF is attached.

Runtime Baked

Inputs

  • Height Field: (optional)
    • Coordinate Types: vec3
    • Context Types: Context MaterialContext CameraContext LightContext RayContext ParticleContext VertexContext PixelContext
    • Return Types: float
    • Supports Variables: axisoffset angle normangle
  • Radius Field: (optional)
    • Coordinate Types: vec3
    • Context Types: Context MaterialContext CameraContext LightContext RayContext ParticleContext VertexContext PixelContext
    • Return Types: float
    • Supports Variables: axisoffset normoffset angle normangle
    • Supports Variables From Inputs: heightField
  • Coils Field: (optional)
    • Coordinate Types: vec3
    • Context Types: Context MaterialContext CameraContext LightContext RayContext ParticleContext VertexContext PixelContext
    • Return Types: float
    • Supports Variables: axisoffset normoffset angle normangle
    • Supports Variables From Inputs: heightField radiusField
  • Thickness Field: (optional)
    • Coordinate Types: vec3
    • Context Types: Context MaterialContext CameraContext LightContext RayContext ParticleContext VertexContext PixelContext
    • Return Types: float
    • Supports Variables: axisoffset normoffset angle normangle
    • Supports Variables From Inputs: heightField radiusField coilsField
  • Cross Section Shape: (optional) Optional 2D SDF used as the cross-section for the shape.
    • Coordinate Types: vec2
    • Context Types: Context MaterialContext CameraContext LightContext RayContext ParticleContext VertexContext PixelContext
    • Return Types: Sdf
    • Supports Variables: axisoffset normoffset angle normangle
    • Supports Variables From Inputs: heightField radiusField coilsField

Variables

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