User Guide Cancel

Spline Warp | Substance 3D Designer

Node icon

In: Spline & Path Tools > Spline Tools

Description

Displaces the input splines based on the input Intensity Map or Vector Map.

The intensity of the warping effect can be adjusted along the spline using attenuation controls.


Input connectors

Preview Grayscale
The preview of the input splines as a grayscale image.

Spline Coords Color
The coordinates of the input splines’ points encoded in the RGBA channels of a color image:
    R - X position
    G - Y position
    B - Height
    A - Packed data:
        - Sign: Spline is closed (negative) or open (positive);
        - Absolute value: Thickness + 1.

Spline Data Color
Additional data of the input splines encoded in the RGBA channels of a color image.
    R - Tangents X
    G - Tangents Y
    B - Unused
    A - Unused

Spline Amount Integer
The number of input splines.

Intensity Map Grayscale (Available when ‘Use Vector Map’ is set to ‘False’)
The input grayscale image used to control the direction and intensity of the warping effect on the input splines.
The color of each pixel in the image specifies a multiplier for displacing the spline’s points along their normal (I.e., the direction perpendicular to the spline), up to the full span of the image.
The [0; 1] values in the image are remapped to the [-1; 1] range when read as a multiplier: 0 and 1 displace the spline by the same distance but in opposite directions. 0.5 leaves the spline in place.

Vector Map Grayscale (Available when ‘Use Vector Map’ is set to ‘True’)
The input color image used to control the direction and intensity of the warping effect on the input splines.
The color of each pixel in the image specifies vector (X, Y) which coordinates are encoded in the red (X) and green (Y) channels. +X is right and +Y is down.
The [0; 1] values in the image are remapped to the [-1; 1] range when read as vector coordinates: 0 red displaces points left and 0 green displaces points up. 0.5 red and green leaves the spline in place.

Attenuation Curve Grayscale
The image describing a curve using the values of its first row of pixels.
When the Use Attenuation Curve parameter is set to True, this input is used to control the attenuation of the warping effect near the start and end of the spline.
The curve provides a profile for the attenuation, where the first pixel in the row is the intensity of the warping effect at the start of the spline, and the last is the intensity at the end. The grayscale value is the intensity.
You may use a Curve node to author the curve.


Output connectors

Preview Grayscale
The preview of the output splines as a grayscale image.

Spline Coords Color
The coordinates of the output splines’ points encoded in the RGBA channels of a color image.
    R - X position
    G - Y position
    B - Height
    A - Packed data:
        - Sign: Spline is closed (negative) or open (positive);
        - Absolute value: Thickness + 1.

Spline Data Color
Additional data of the output splines encoded in the RGBA channels of a color image.
    R - Tangents X
    G - Tangents Y
    B - Unused
    A - Unused

Spline Amount Integer
The number of output splines.


Parameters

Warp Intensity Float
The intensity by which the splines are displaced.

Warp Center Float
Specifies the Intensity Map value that corresponds to leaving the splines in place.
A value of 0 or 1 means the splines can only be displaced on one side.

Sampling Mode Integer
The method of mapping the values in the Intensity Map or Vector Map to the splines:
- Texture space: The values are applied to the splines where they would be if placed in a texture using the texture’s UV coordinates. This effectively applies the value to the splines ‘in place’;
- Horizontal along spline: The values are applied to the encoded splines’ coordinates directly (see Spline Coords input), where each row is applied to a different spline from top to bottom;
- Hor. along spline (rand. offset X): The values are applied to the encoded splines’ coordinates directly (see Spline Coords input), with a random horizontal offset in the Scale map for each spline (I.e., each row in Spline Coords);
- Hor. along spline (rand. offset Y): The values are applied to the encoded splines’ coordinates directly (see Spline Coords input), with a random vertical offset in the Scale map for each spline (I.e., each row in Spline Coords).

Use Vector Map Boolean
Switches the method of displacing the splines to the use of a Vector Map input for specifying the direction of the displacement.
The color of each pixel in the image specifies vector (X, Y) which coordinates are encoded in the red (X) and green (Y) channels. +X is right and +Y is down.
The [0; 1] values in the image are remapped to the [-1; 1] range when read as vector coordinates: 0 red displaces points left and 0 green displaces points up. 0.5 red and green leaves the spline in place.

Use Attenuation Curve Boolean
Enables controlling the intensity of the warping effect along a spline using a curve encoded in the Attenuation Curve input image.

Intensity Map Tiling Float (Available when ‘Sampling Mode’ is not set to ‘Texture Space’)
Adjusts the tiling of the Intensity Map when mapped to the spline coordinates directly (see Spline Coords input).

Start Attenuation Float (Available when ‘Use Attenuation Curve’ is set to ‘False’)
A multiplier for the attenuation of the warping effect near the start of the spline.
A value of 1 means no warping is applied to the start of the spline.

End Attenuation Float (Available when ‘Use Attenuation Curve’ is set to ‘False’)
A multiplier for the attenuation of the warping effect near the end of the spline.
A value of 1 means no warping is applied to the end of the spline.

Recompute Tangents Boolean
When True, a spline’s tangents are recomputed after the warping effect is applied.
This ensures the spline’s tangents remain consistent with its trajectory when used in nodes such as Scatter on Spline or Spline Flow Mapper.


Examples

SplineWarp-Variant1-Before
SplineWarp-Variant1-After
SplineWarp-Variant2-Before
SplineWarp-Variant2-After
Node example 1

Get help faster and easier

New user?