Image Plane
Updated: 4 Dec 2023
Render an image or video on a plane in 3D space.
Image Plane
Method #
This node is used to render an image or video on a plane in 3D space. The image may be set directly via the Image parameter or linked via the Video Node input.
Image Plane nodes have similar rendering options to other geometry nodes such as 3D Objects or 3D Primitive nodes.
This node outputs the normal transformation and translation values, but it also outputs A mapped texture which can be used on mask node inputs for Particle Emitters and Particle Affectors.
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 Select an image to be displayed on the image plane.
Visible Control whether the node is visible or not to the scene.
Seen By Rays Allow the mesh to be seen by the raytracer. When set to 0, the mesh will still render in camera but will be ignored by any raytracing nodes.
Normal Map Select a normal map to change how light affects the image plane.
Colour Add a colour filter over the image.
Aspect-Based Scaling Mode Scale the plane by the aspect ratio of the selected image.
- Disabled : The plane won’t scale to fit the image.
- Scale X : The image is scaled along the X axis to fit the image.
- Scale Y : The Image is scaled along the Y axis to fit the image.
- Larger : Whichever is larger of scale X or Y is chosen.
- Smaller : Whichever is smaller of scale X or Y is chosen.
Blend Mode Choose how the image blends into the scene.
- Opaque : the image is solid with alpha values set to black.
- Alpha To Coverage : the alpha values are used to mask out the image.
- Alpha Blend : the image alpha values are blended at the edges.
Blend Function Choose how the blend mode functions. See Blend Modes for more.
Normal Map Mode If a normal map is input, control how it is used in the scene.
- Disabled : Even if a normal map is selected in the node, it won’t be used on the image plane.
- Normal Mapping : the normal map is used to change how light affects the surface of the plane.
- Parallax Mapping : the pixels of the image are given height values, which when viewed at an angle gives a 3D effect; cannot occlude itself.
- Parallax Occlusion Mapping : the pixels of the image are given height values, which when viewed at an angle gives a 3D effect; can occlude itself.
Casts Shadows ERROR: Variable not found: {att-node-geometry-casts-shadows-description}
Lit Toggle whether the object can be lit by scene lights.
Frame If the image is animated, choose which frame is displayed.
Alpha Control the alpha value of the image.
Metallicness Change how metallic the object looks.
Luminosity Change the brightness of the image.
Specularity How much specular light is reflected from the object.
Roughness How rough the surface of the material is.
Displacement The strength of the displacement from the normal map.
UV Remap Filtering Remap the colour image to the Image 2D based on a UV map.
UV Offset X Move the mesh UV along the x axis.
UV Offset Y Move the mesh UV along the y axis.
UV Scale X Scale the mesh UV along the x axis.
UV Scale Y Scale the mesh UV along the y axis.
Texture Mip Bias Bias the distance at which Mip Maps are swapped for original textures.
Texture Filter Mode Controls how textures used by the material are filtered - through point sampling, linear filtering or anisotropic filtering.
Texture Wrap Mode U Controls how textures used by the material are wrapped when the U value range exceeds 0 to 1
Texture Wrap Mode V Controls how textures used by the material are wrapped when the V value range exceeds 0 to 1
Alpha Sort Bias Biases the alpha sort in order to make it render in front or behind other transparent objects.
No Image Behaviour Select what colour should appear in the absence of an image input.
These properties control video playback if a video is added to the image attribute. Videos connected via the video input have their own properties which overrise these settings.
Parameter Details Frame Offset Offset the start frame.
Frame Rate Control the frame rate of the video.
Loop End Frame Choose when the video stops looping.
These properties control sprite sheet animation.
Parameter Details Is Texture Animation Page Toggle whether the input image should be treated as an animation page containing multiple frames of an animation.
Num Frames X The number of animation frames in the X axis contained in the image.
Num Frames Y The number of animation frames in the Y axis contained in the image.
These properties crop the selected image.
Parameter Details Crop Enabled Enable the image to be cropped.
Crop Left How much of the image is cropped from the left.
Crop Right How much of the image is cropped from the right.
Crop Top How much of the image is cropped from the bottom.
Crop Bottom How much of the image is cropped from the top.
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 | Select an image to be displayed on the image plane. |
| Visible | Control whether the node is visible or not to the scene. |
| Seen By Rays | Allow the mesh to be seen by the raytracer. When set to 0, the mesh will still render in camera but will be ignored by any raytracing nodes. |
| Normal Map | Select a normal map to change how light affects the image plane. |
| Colour | Add a colour filter over the image. |
| Aspect-Based Scaling Mode | Scale the plane by the aspect ratio of the selected image.
|
| Blend Mode | Choose how the image blends into the scene.
|
| Blend Function | Choose how the blend mode functions. See Blend Modes for more. |
| Normal Map Mode | If a normal map is input, control how it is used in the scene.
|
| Casts Shadows | ERROR: Variable not found: {att-node-geometry-casts-shadows-description} |
| Lit | Toggle whether the object can be lit by scene lights. |
| Frame | If the image is animated, choose which frame is displayed. |
| Alpha | Control the alpha value of the image. |
| Metallicness | Change how metallic the object looks. |
| Luminosity | Change the brightness of the image. |
| Specularity | How much specular light is reflected from the object. |
| Roughness | How rough the surface of the material is. |
| Displacement | The strength of the displacement from the normal map. |
| UV Remap Filtering | Remap the colour image to the Image 2D based on a UV map. |
| UV Offset X | Move the mesh UV along the x axis. |
| UV Offset Y | Move the mesh UV along the y axis. |
| UV Scale X | Scale the mesh UV along the x axis. |
| UV Scale Y | Scale the mesh UV along the y axis. |
| Texture Mip Bias | Bias the distance at which Mip Maps are swapped for original textures. |
| Texture Filter Mode | Controls how textures used by the material are filtered - through point sampling, linear filtering or anisotropic filtering. |
| Texture Wrap Mode U | Controls how textures used by the material are wrapped when the U value range exceeds 0 to 1 |
| Texture Wrap Mode V | Controls how textures used by the material are wrapped when the V value range exceeds 0 to 1 |
| Alpha Sort Bias | Biases the alpha sort in order to make it render in front or behind other transparent objects. |
| No Image Behaviour | Select what colour should appear in the absence of an image input. |
These properties control video playback if a video is added to the image attribute. Videos connected via the video input have their own properties which overrise these settings.
| Parameter | Details |
|---|---|
| Frame Offset | Offset the start frame. |
| Frame Rate | Control the frame rate of the video. |
| Loop End Frame | Choose when the video stops looping. |
These properties control sprite sheet animation.
| Parameter | Details |
|---|---|
| Is Texture Animation Page | Toggle whether the input image should be treated as an animation page containing multiple frames of an animation. |
| Num Frames X | The number of animation frames in the X axis contained in the image. |
| Num Frames Y | The number of animation frames in the Y axis contained in the image. |
These properties crop the selected image.
| Parameter | Details |
|---|---|
| Crop Enabled | Enable the image to be cropped. |
| Crop Left | How much of the image is cropped from the left. |
| Crop Right | How much of the image is cropped from the right. |
| Crop Top | How much of the image is cropped from the bottom. |
| Crop Bottom | How much of the image is cropped from the top. |
| Name | Description | Typical Input |
|---|---|---|
| Video Node | Add a video to be shown on the image plane. | Loader |
| Alpha Image | Use an image to control the alpha values of the image plane. | Loader |
| UV Remap Image | Use an image to remap the UV of the image plane. | Image Plane |
| 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 |