create_instances

Creates an instance object consisting of shapes attached to the point positions of the input geometry. Multiple shapes are supported, and can be assigned in various ways.

Inputs

points

The geometry with points at which to create instanced shapes.

instance_geometries

One or more geometries to be instanced. You can also connect instance shapes, such as the output of a geo_instance node.

mask_weights

The probabilities that a shape will be instanced at each point.

• 0 or less means that a shape is never instanced at a point's position.
• Values in the range 0—1 are the chance of some shape being instanced at a point's position. For example, 0.5 means that there is a 50% probability of a shape being instanced.
• 1.0 or more means that some shape is always instanced at a point's position.

If nothing is connected, the default weight is 1 for all points. This is an interpreted auto port that accepts the following types:

• A single float is interpreted as a constant value for all points.
• An array<bool> is interpreted as values of 0 (false) or 1 (true) per point.
• An array<float> is interpreted as values per point. The array gets resized to match the number of points, if necessary.
• A string is interpreted as the name of an existing geo property, and its values are used.
• A ScalarField is sampled at each position of the geometry's components.
• An array<long> specifies the indices to be assigned a value of 1. Other indices are assigned 0.

Selection

selection_mode

How the shapes are assigned to points:

• None assigns the first shape to all instances.
• Sequential loops over the shapes. The first shape is assigned to the first point, the second shape to the second point, and so on.
• Random assigns shapes randomly. Use probability_curve to control the distribution.

instance_id_override

Optionally, connect an array<long> containing the shape indices to assign per point. This gives direct controls over the shapes assigned.

Randomization

probability_curve

An FCurve that controls the distribution of random IDs when selection_mode is Random. The default shape has no bias, but you can edit the curve to favor higher or lower IDs. This is mostly useful if the order of IDs has a meaning, for example, if they are in order of size.

seed

The seed of the random number generator used when selection_mode is Random.

Preview Geometry

preview_mode

Specifies what to show in the viewport, as opposed to final renders.

• BoundingBox shows bounding boxes enclosing the extents of instance geometries.
• PreviewGeometry shows the geometries connected to preview_geometries. If nothing is connected, the instance geometries are shown instead.
• InstanceGeometry shows the instance geometries, even when preview geometries are connected.

preview_geometries

Optionally, connect geometry to display in the viewport. Simpler geometries give faster previews.