Swirl
Updated: 11 Sep 2024
Generates a configurable 2D swirl pattern.
Swirl
Method #
This node generates a configurable 2D swirl pattern.
Parameters
Parameter Details Position X
The objects position along the local x-axis.
Position Y
The objects position along the local y-axis.
Position Z
The objects position along the local z-axis.
Rotation Heading
The objects rotation around the local y-axis.
Rotation Pitch
The objects rotation around the local x-axis.
Rotation Bank
The objects rotation around the local z-axis.
Scale X
The objects scale along the local x-axis.
Scale Y
The objects scale along the local y-axis.
Scale Z
The objects scale along the local z-axis.
These properties control the core behaviours of the node.
Parameter Details Active
Enables or disables the effect. Disabling the effect means it will no longer compute, so disabling a node when not in use can improve performance.
Preview In Viewport
Preview the generated image as an overlay in the viewport.
- Off : No preview is generated.
- RGBA : Preview the image blended with alpha in the viewport.
- RGB : Preview the colour channels in the viewport.
- Alpha : Preview the alpha channel in the viewport.
- PIP : Preview the image blended with alpha in the viewport, in a smaller picture in picture display, on top of the existing content.
Width
The resolution of the generated image horizontally.
Height
The resolution of the generated image vertically.
Update Time Mode
How the generator updates with relation to the timecode.
- Locked To Timecode : The generator animations are locked to the timecode and the same time will always yield the same result.
- Running / Loopable : The generator animations are disconnected from the timecode and will run seamlessly at the end of the composition.
Rings
The number of rings in the swirl pattern.
Radius
The radius of the swirl pattern.
Animation Speed
The speed of the animation.
Distort
An optional checkbox to distort the swirl pattern.
Distort Amount
How much to distort the swirl pattern by. Use smaller values for a smoother result.
Parameter Details Colour
Add a colour filter over the image.
Blend Amount
The amount the generated image blends with the project, depending on the compositing mode chosen.
Blend Mode
Choose how the image blends with the scene. See Blend Modes for details.
Inputs
| Parameter | Details |
|---|---|
| Position X | The objects position along the local x-axis. |
| Position Y | The objects position along the local y-axis. |
| Position Z | The objects position along the local z-axis. |
| Rotation Heading | The objects rotation around the local y-axis. |
| Rotation Pitch | The objects rotation around the local x-axis. |
| Rotation Bank | The objects rotation around the local z-axis. |
| Scale X | The objects scale along the local x-axis. |
| Scale Y | The objects scale along the local y-axis. |
| Scale Z | The objects scale along the local z-axis. |
These properties control the core behaviours of the node.
| Parameter | Details |
|---|---|
| Active | Enables or disables the effect. Disabling the effect means it will no longer compute, so disabling a node when not in use can improve performance. |
| Preview In Viewport |
Preview the generated image as an overlay in the viewport.
|
| Width | The resolution of the generated image horizontally. |
| Height | The resolution of the generated image vertically. |
| Update Time Mode |
How the generator updates with relation to the timecode.
|
| Rings | The number of rings in the swirl pattern. |
| Radius | The radius of the swirl pattern. |
| Animation Speed | The speed of the animation. |
| Distort | An optional checkbox to distort the swirl pattern. |
| Distort Amount | How much to distort the swirl pattern by. Use smaller values for a smoother result. |
| Parameter | Details |
|---|---|
| Colour | Add a colour filter over the image. |
| Blend Amount | The amount the generated image blends with the project, depending on the compositing mode chosen. |
| Blend Mode | Choose how the image blends with the scene. See Blend Modes for details. |
| Name | Description | Typical Input |
|---|---|---|
| Colour Ramp | Specify a range of colours the generator can use through its gradient. | Colour Ramp |
| Transform Modifiers | Apply the transforms of another node to this node. | Null |
| Target Node | Modifiy the rotations of the node to always direct the z axis towards the input. | Null |
| Local Transform Override | Apply the transforms of another node to this node, relative to its parent. | Null |