magnet

magnet

definition_in
Magnet
Easing
Fade Field
Easing Function
Amount Field
filter
magnet
RayTK
v0.42

Pulls or twists space within an area.

If the magnet definition input is connected, that operator is used to determine how much transformation to apply at each point in space. If there is no magnet definition connected, the magnet is based around a center point with a radius, and a blending region.

Parameters

Name Description Regular Handling Read-Only Handling
Enable
Amount

How much effect to apply overall.

 Runtime Baked
Center

The center position of the magnet (used if the magnet definition is not connected).

 Runtime Baked
Radius

The radius of the magnet area.

 Runtime Baked
Fade

The width of the blending region between the magnet and the rest of space.

 Runtime Baked
Scale

Scaling to be applied within the magnet area.

 Runtime Baked
Rotate

Rotation to be applied within the magnet area.

 Runtime Baked
Translate

Amount of translation along each axis. For 2D, only X and Y are used.

 Runtime Baked
Scale Type Semi-Baked Semi-Baked
  • Separate XYZ:
  • Uniform:
Uniform Scale Runtime Baked

Inputs

  • definition_in: (required)
    • Coordinate Types: float vec2 vec3
    • Context Types: Context MaterialContext CameraContext LightContext RayContext ParticleContext VertexContext PixelContext
    • Return Types: float vec4 Sdf Volume Ray Light Particle
    • Supports Variables From Inputs: magnet_definition_in easing_definition_in
  • Magnet: (optional) Magnet definition used to determine how much transformation to apply at each point. If this is an operator that produces an SDF or float value, that value is used to decide how far each point is from the magnet. If it returns a vec4, it is used to determine where the magnet center position is relative to each point.
    • Coordinate Types: float vec2 vec3
    • Context Types: Context MaterialContext CameraContext LightContext RayContext ParticleContext VertexContext PixelContext
    • Return Types: float vec4 Sdf
  • Easing: (optional) Easing function used to control how the blending region is smoothed.
    • Coordinate Types: float vec2 vec3 vec4
    • Context Types: Context MaterialContext CameraContext LightContext RayContext ParticleContext VertexContext PixelContext
    • Return Types: float
    • Supports Variables From Inputs: magnet
  • Fade 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: magnet radiusField
  • Easing Function: (optional)
    • Coordinate Types: float
    • Context Types: Context MaterialContext CameraContext LightContext RayContext ParticleContext VertexContext PixelContext
    • Return Types: float
    • Supports Variables From Inputs: magnet radiusField fadeField
  • Amount 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: magnet radiusField easing amountField