Image Affector
Updated: 4 Dec 2023
Attract or repel particles from an image.
Image Affector
Method #
This node is used to attract or repel particles from pixels in an image. This is typically used to make particles form into a given image. The image can be set directly using the Image attribute or connected from a video node via the Video Nodes input.
The image is pre-processed to determine which pixels should be used to attract or repel from by thresholding either the alpha value or luminance value.
This node requires a video node to be connected via the video nodes input.
All nodes connected to this node are treated as if flowing to the parent node, and inherits any transformation changes along the chain.
Parameters
These properties control the 3D transforms of the node. Transforms will generally be inherited by child nodes, although they can be ignored through the Inherit Transform Channels attributes.
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.
Control the inheritance of the transforms from the parent.
Parameter Details Position
Toggle inheritance of the Position from the parent.
Rotation
Toggle inheritance of the Rotation from the parent.
Scale
Toggle inheritance of the Scale from the parent.
World Position Only
Inherit the world position from the parent only, rotation and scale will be ignored. Overrides above properties.
Inherit Time
Toggle inheritance of time from the parent.
These properties control the core behaviours of the node.
Parameter Details Image
Override the input image with an image selected from the drop down menu.
Flip Image
How much the particle colours adapt to the image colours.
Velocity Scale
Scale the strength of the affectors velocity on the particles.
Radius
Alter the outer radius at which the affector is no longer effective.
Inner Radius
The radius up until which the affector is fully effective.
Mode
Choose how the image affector affects the particles.
- Repel : Particles move away from the node.
- Attract : Particles are moved toward the image affector, and generate an image by colliding with the image plane.
- Collision : Particles collide with image pixels.
Image Search Mode
Choose how the particles find a place in the image.
- Pixels : The particles spread to the positions of individual pixels in the image.
- Closest : All the particles move toward the closest pixel in the image.
Life Effect Coeffs
How much the particles are affected by the affector at different stages of the particles life cycle. Values 1 and 2 are control points used to control a bezier curve between values 0 and 3.
Randomness
How much randomness is added in the particles movement.
Use Thickness
Toggle whether to emit the particles on a 2d plane, or in three dimensions.
Thickness
Change the thickness of the three dimensional area the particles can spawn in. Only functions if ‘Use Thickness’ is on.
Pixel Cull/Thickness Mode
Change how the depth of the particle generation is calculated and which pixels are used by the affector.
- Alpha Channel : Higher alpha values will have greater depth.
- Luminescence : Brighter parts of the image will have greater depth.
Alpha Threshold
Manage the threshold on where the particles will emit based on the alpha or luminance.
Image Colour Adaption
How much the particle colours adapt to the image colours.
Avi FPS
Change the frames per second the video is played at.
Time Offset
Offset the time the effect is running.
Luminance Offset Scale
Offsets the points on the image in the depth axis by their luminance.
How the image colours should blend with the particle colours.
Parameter Details Blend Mode
Choose how the particle colours blend to the source colours
Blend Weight
Controls how much the result of the affector is blended with results from preceding affectors.
Inputs
These properties control the 3D transforms of the node. Transforms will generally be inherited by child nodes, although they can be ignored through the Inherit Transform Channels attributes.
| 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. |
Control the inheritance of the transforms from the parent.
| Parameter | Details |
|---|---|
| Position | Toggle inheritance of the Position from the parent. |
| Rotation | Toggle inheritance of the Rotation from the parent. |
| Scale | Toggle inheritance of the Scale from the parent. |
| World Position Only | Inherit the world position from the parent only, rotation and scale will be ignored. Overrides above properties. |
| Inherit Time | Toggle inheritance of time from the parent. |
These properties control the core behaviours of the node.
| Parameter | Details |
|---|---|
| Image | Override the input image with an image selected from the drop down menu. |
| Flip Image | How much the particle colours adapt to the image colours. |
| Velocity Scale | Scale the strength of the affectors velocity on the particles. |
| Radius | Alter the outer radius at which the affector is no longer effective. |
| Inner Radius | The radius up until which the affector is fully effective. |
| Mode |
Choose how the image affector affects the particles.
|
| Image Search Mode |
Choose how the particles find a place in the image.
|
| Life Effect Coeffs | How much the particles are affected by the affector at different stages of the particles life cycle. Values 1 and 2 are control points used to control a bezier curve between values 0 and 3. |
| Randomness | How much randomness is added in the particles movement. |
| Use Thickness | Toggle whether to emit the particles on a 2d plane, or in three dimensions. |
| Thickness | Change the thickness of the three dimensional area the particles can spawn in. Only functions if ‘Use Thickness’ is on. |
| Pixel Cull/Thickness Mode |
Change how the depth of the particle generation is calculated and which pixels are used by the affector.
|
| Alpha Threshold | Manage the threshold on where the particles will emit based on the alpha or luminance. |
| Image Colour Adaption | How much the particle colours adapt to the image colours. |
| Avi FPS | Change the frames per second the video is played at. |
| Time Offset | Offset the time the effect is running. |
| Luminance Offset Scale | Offsets the points on the image in the depth axis by their luminance. |
How the image colours should blend with the particle colours.
| Parameter | Details |
|---|---|
| Blend Mode | Choose how the particle colours blend to the source colours |
| Blend Weight | Controls how much the result of the affector is blended with results from preceding affectors. |
| Name | Description | Typical Input |
|---|---|---|
| Video Nodes | The image node | ERROR: Variable not found: {input-node-particles-transform-node-typical-input} |
| Affected Emitters | Choose which particle emitters can be affected by the affector. | Primitive Emitter |
| Procedural Falloff | Use the distance field from a procedural system to vary how strong the affector is. | Procedural Root |
| 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 |