Method

This node is used to clone 3D objects to pixels in an image or video, using the pixel colours to scale, offset or colour the clones. 3D objects are cloned to positions in a regular 2D grid in the XY plane, with the number of cells defined by the Num Clones X and Num Clones Y parameters. Clones are automatically scaled so that a unit cube would fill one cell exactly, and the Clone Scale parameter is multiplied with this to control the size of the clones. The cell locations are used to sample pixels of an image or video which may be connected to the Image Node input. The colour of the sampled pixel can control the scale of the clone using the Clone Scale Brightness parameter; it can offset the clone in the Z axis using the Clone Offset By Brightness parameter, and it can be applied to the material colours of the cloned objects when the Colour Clones parameter is enabled.

Example
Example Nodegraph

Transform

Name Description
Position X Move its position along the x-axis in local space.
Position Y Move its position along the y-axis in local space.
Position Z Move its position along the z-axis in local space.
Rotation Heading Rotate the object about the x-axis.
Rotation Pitch Rotate the object about the y-axis.
Rotation Bank Rotate the object about the z-axis.
Scale X Scale along the x-axis.
Scale Y Scale along the y-axis.
Scale Z Scale along the z-axis.

Inherit Transform Channels

Toggle which transform channels should be inherited. By default, all are on.

Attributes

Name Description
Image Select a source Image for the clones to be spawned from. Can be overwritten by adding an image input.
Node Spawn Mode Change the order in which the cloned objects are assigned to individual clone instances.
  • All, All of the connected objects are rendered for every clone.
  • Iterate, The objects are rendered sequentially by clone. For example the first clone renders the first object, the second clone renders the second object and so on.
  • Random, The objects are rendered randomly by clone, and are generated at random points from the clone system.
Num Clones X Number of clones created along the X axis.
Num Clones Y Number of clones created along the Y axis.
First Clone X Select which clone is the first clone spawned along the X axis.
First Clone Y Select which clone is the first clone spawned along the Y axis.
Image Scale X Scale the image along the X axis.
Image Scale Y Scale the image along the Y axis.
Scale Image By Aspect Scale the image based on its aspect ratio.
Scale Image By Pixel Size Scale the image based on thew relative size of a pixel.
Brightness Channel Mode Change how the brightness threshold calculates brightness.
  • Luminance, The luminance values of the image are used.
  • Alpha, The alpha values of the image are used.
  • Luminance * Alpha, Luminance values multiplied by the alpha values are used.
Brightness Threshold Limit how bright regions of the image must be for the clones to be spawned.
Clone Scale Brightness Scale the individual clones based on the luminance of the image at that point.
Clone Scale By Brightness Affects X/Y/Z Toggle whether the clone scaling affects the X/Y/Z axis.
Clone Offset By Brightness Offset the individual clones based on the luminance of the image at that point.
Clone Scale Scale the size of all the clones.
Filter Image Applies a Bilinear filter to the image, making it smoothing out some of the values when the image is scaled.
Colour Clones Toggle whether the clones are coloured based on the image, or retain their material values.
Output Shape Select what kind of shape to create the clones in.
  • Plane, Generates clones on a flat square plane.
  • 360 Spherical, Generates clones on to a 360 degree sphere about its center.

UV Clone Deltas

These parameters change how the image will be applied to the child clones.

Name Description
UV Mode Change how the cloned objects UV chanel and Material inputs are affected by the cloner.
  • Linear (Using Clone Index), Each clone keeps unique UV’s.
  • Use Texture Page (Using Clone Index), Speads the UV’s over a number of clones defined by the Texture Num Frames Attribute, and repeats it along the clone index.
  • Use Texture Page (Using Random Index), Randomises the UV’s over the range of clones in the Texture Num Frames Property, and repeats it.
  • Use Texture Page (Using Luminance), Spits up the UVs, and uses different sections depending on the brightness of the Image driving the cloner.
  • Clone UV, Cumulatively changes the clone scale and position using the offset and scale delta properties.
Texture Num Frames X/Y How many columns and rows to split the UV by.
UV Scale X/Y Delta Relative change to the uv scale of the clone’s material.
UV Offset X/Y Delta Relative change to the uv offset of the clone’s material.
Crop Left/Right/Top/Bottom Delta Relative change to the crop on each side of the clone’s material.

Inputs

Name Description Typical Node Input
Image Node The image used to drive the cloner. Video Loader
Effectors Manipulates the clones after they are spawned. Plain Effector
Depth Image Node Overwrite the image brightness with a different image to control clone offset / scale by brightness. Video Loader
Transform Modifier Links all transform properties to the input node. Null
Target Node Always faces the x-axis towards the inputs anchor point. Null
Local Transform Override Override the transformation values of the node, relative to its parent. Null

Outputs

Nodes that are to be cloned by a Cloner should be connected to the output of this node. 3D Objects, 3D Shapes, and Image Planes may be connected, as well as other Cloners.